From 0b49a2507adb756c8930e0bfac61b4dbb2662fb9 Mon Sep 17 00:00:00 2001 From: gimenes Date: Mon, 11 Sep 2023 19:17:04 -0300 Subject: [PATCH 01/21] in hand derref --- scripts/start.ts | 206 +- ...aphql.gen.ts => storefront.graphql.gen.ts} | 0 ...n.graphql.json => storefront.graphql.json} | 0 vnda/utils/openapi/vnda.openapi.gen.ts | 2107 + vnda/utils/openapi/vnda.openapi.json | 19372 +++++++ wake/hooks/context.ts | 2 +- wake/hooks/useCart.ts | 2 +- wake/loaders/cart.ts | 2 +- wake/loaders/productDetailsPage.ts | 2 +- wake/loaders/productList.ts | 2 +- wake/loaders/productListingPage.ts | 2 +- wake/mod.ts | 2 +- ...aphql.gen.ts => storefront.graphql.gen.ts} | 0 ...n.graphql.json => storefront.graphql.json} | 0 .../adiciona-novo-produto.openapi.json | 372 - .../adiciona-novos-atacarejos.openapi.json | 201 - ...re-um-produto-e-uma-categoria.openapi.json | 150 - ...culo-entre-usuario-e-parceiro.openapi.json | 132 - ...imagem-vinculada-a-um-produto.openapi.json | 182 - .../adiciona-uma-nova-informacao.openapi.json | 185 - ...recorrencia-de-uma-assinatura.openapi.json | 150 - ...tera-o-status-de-um-portfolio.openapi.json | 124 - ...aprova-um-cadastro-de-usuario.openapi.json | 152 - ...enas-os-enviados-pelo-request.openapi.json | 159 - ...com-base-no-e-mail-do-usuario.openapi.json | 127 - ...rio-com-base-no-id-do-usuario.openapi.json | 128 - .../ativa-ou-desativa-um-frete.openapi.json | 149 - .../ativa-ou-desativa-um-seller.openapi.json | 118 - ...tiva-ou-inativa-uma-inscricao.openapi.json | 126 - ...tica-de-produtos-de-um-seller.openapi.json | 118 - ...liza-a-autonomia-de-um-seller.openapi.json | 118 - ...-de-um-usuario-via-newsletter.openapi.json | 117 - ...ata-de-cadastro-de-um-produto.openapi.json | 514 - ...a-a-data-de-entrega-do-pedido.openapi.json | 162 - ...s-se-deve-ser-em-todos-ou-nao.openapi.json | 149 - ...s-se-deve-ser-em-todos-ou-nao.openapi.json | 149 - ...-imagem-de-estampa-do-produto.openapi.json | 142 - .../atualiza-a-imagem-do-banner.openapi.json | 172 - ...-de-uma-assinatura-especifica.openapi.json | 141 - ...tatus-de-um-produto-do-pedido.openapi.json | 179 - ...-situacao-do-status-do-pedido.openapi.json | 159 - ...produto-vinculado-a-um-evento.openapi.json | 154 - ...-o-estoque-de-varios-produtos.openapi.json | 238 - ...odos-os-produtos-de-um-pedido.openapi.json | 162 - ...za-o-preco-de-varios-produtos.openapi.json | 209 - ...liacao-de-um-produto-variante.openapi.json | 154 - ...za-o-status-do-banner-pelo-id.openapi.json | 149 - ...o-ativo-true-ou-inativo-false.openapi.json | 149 - ...to-ativando-o-ou-inativando-o.openapi.json | 103 - .../atualiza-o-tipo-evento.openapi.json | 203 - ...dados-de-um-hotsite-existente.openapi.json | 286 - ...ugeridos-de-um-tipo-de-evento.openapi.json | 128 - ...ncontrado-com-o-sku-informado.openapi.json | 195 - ...o-completo-com-os-dados-da-nf.openapi.json | 197 - ...o-completo-com-os-dados-da-nf.openapi.json | 200 - ...treamento-e-urlrastreamento-1.openapi.json | 182 - ...astreamento-e-urlrastreamento.openapi.json | 172 - .../atualiza-um-atacarejo.openapi.json | 176 - .../openapi/atualiza-um-atributo.openapi.json | 175 - .../atualiza-um-banner-existente.openapi.json | 348 - ...adastro-personalizado-pelo-id.openapi.json | 127 - .../openapi/atualiza-um-conteudo.openapi.json | 204 - ...atualiza-um-contrato-de-frete.openapi.json | 216 - ...suario-pelo-e-mail-do-usuario.openapi.json | 159 - ...um-usuario-pelo-id-do-usuario.openapi.json | 160 - .../openapi/atualiza-um-evento.openapi.json | 303 - .../atualiza-um-fabricante.openapi.json | 161 - ...um-novo-seller-no-marketplace.openapi.json | 165 - .../openapi/atualiza-um-parceiro.openapi.json | 175 - .../atualiza-um-portfolio.openapi.json | 118 - ...-um-produto-em-uma-assinatura.openapi.json | 159 - .../openapi/atualiza-um-produto.openapi.json | 395 - .../atualiza-um-script-existente.openapi.json | 206 - ...-seo-de-um-produto-especifico.openapi.json | 159 - ...tualiza-um-usuario-pelo-email.openapi.json | 239 - .../atualiza-um-usuario-pelo-id.openapi.json | 240 - ...um-valor-pre-definido-pelo-id.openapi.json | 123 - ...culo-entre-usuario-e-parceiro.openapi.json | 127 - ...-id-do-erp-como-identificador.openapi.json | 189 - .../atualiza-uma-categoria.openapi.json | 189 - ...-uma-informacao-de-um-produto.openapi.json | 183 - .../atualiza-uma-inscricao.openapi.json | 161 - ...antes-em-uma-tabela-de-precos.openapi.json | 187 - .../atualiza-uma-loja-fisica.openapi.json | 251 - ...atualiza-uma-tabela-de-precos.openapi.json | 132 - .../openapi/atualizar-autor.openapi.json | 153 - ...queia-ou-desbloqueia-usuarios.openapi.json | 138 - ...scricao-por-seu-identificador.openapi.json | 162 - ...usca-o-conteudo-de-uma-versao.openapi.json | 166 - .../busca-o-conteudo-pelo-seu-id.openapi.json | 103 - ...-seo-de-um-produto-especifico.openapi.json | 157 - ...lados-a-um-hotsite-especifico.openapi.json | 147 - ...lados-a-um-hotsite-especifico.openapi.json | 147 - .../openapi/busca-os-estados.openapi.json | 147 - ...lados-de-um-banner-especifico.openapi.json | 157 - ...tags-de-um-produto-especifico.openapi.json | 144 - ...lados-de-um-banner-especifico.openapi.json | 134 - ...posicionamentos-para-o-banner.openapi.json | 139 - ...usca-os-produtos-relacionados.openapi.json | 154 - ...eridos-para-a-lista-de-evento.openapi.json | 121 - ...os-disponiveis-para-inscricao.openapi.json | 111 - ...a-nao-foram-setado-o-complete.openapi.json | 135 - ...odutos-vinculados-a-um-evento.openapi.json | 162 - ...todas-as-inscricoes-inseridas.openapi.json | 153 - ...-conta-corrente-de-um-usuario.openapi.json | 185 - ...todas-as-versoes-de-um-script.openapi.json | 169 - .../openapi/busca-todos-banners.openapi.json | 363 - .../busca-todos-os-conteudos.openapi.json | 192 - ...a-todos-os-hotsites-inseridos.openapi.json | 279 - ...ca-todos-os-scripts-inseridos.openapi.json | 165 - .../busca-um-hotsite-especifico.openapi.json | 283 - .../buscar-autor-pelo-nome.openapi.json | 133 - .../openapi/buscar-autor-por-id.openapi.json | 134 - .../openapi/buscar-banner-por-id.openapi.json | 337 - .../buscar-todos-os-autores.openapi.json | 84 - ...-base-em-uma-lista-de-pedidos.openapi.json | 138 - .../openapi/cria-um-novo-evento.openapi.json | 291 - ...-de-um-produto-como-principal.openapi.json | 142 - ...-seo-de-um-produto-especifico.openapi.json | 115 - ...ites-com-um-banner-especifico.openapi.json | 165 - ...iros-com-um-banner-especifico.openapi.json | 159 - ...ulo-de-um-produto-a-um-evento.openapi.json | 148 - .../openapi/deleta-um-atributo.openapi.json | 133 - ...eleta-um-avatar-de-um-usuario.openapi.json | 102 - .../deleta-um-banner-existente.openapi.json | 134 - ...mente-nao-podem-ser-deletados.openapi.json | 134 - ...m-ou-mais-metatags-de-produto.openapi.json | 140 - .../openapi/deleta-um-portfolio.openapi.json | 103 - ...produtos-de-um-tipo-de-evento.openapi.json | 113 - wake/utils/openapi/deletar-autor.openapi.json | 134 - ...ners-de-um-hotsite-especifico.openapi.json | 159 - ...udos-de-um-hotsite-especifico.openapi.json | 159 - ...total-ou-parcial-de-um-pedido.openapi.json | 151 - ...re-uma-categoria-e-um-produto.openapi.json | 136 - ...alhes-de-um-contrato-de-frete.openapi.json | 134 - .../openapi/exclui-um-fabricante.openapi.json | 134 - .../openapi/exclui-um-parceiro.openapi.json | 122 - .../openapi/exclui-um-script.openapi.json | 134 - ...-id-do-erp-como-identificador.openapi.json | 134 - .../openapi/exclui-uma-categoria.openapi.json | 134 - ...clui-uma-imagem-de-um-produto.openapi.json | 136 - ...-uma-informacao-de-um-produto.openapi.json | 161 - .../exclui-uma-tabela-de-precos.openapi.json | 103 - ...e-do-centro-de-distribuicao-1.openapi.json | 158 - ...ccess-token-expirado-por-data.openapi.json | 111 - ...novo-pedido-para-a-assinatura.openapi.json | 134 - ...icador-do-carrinho-abandonado.openapi.json | 151 - ...dicador-dos-novos-compradores.openapi.json | 151 - ...dores-dos-produtos-no-estoque.openapi.json | 155 - ...te-de-credito-para-um-usuario.openapi.json | 120 - ...um-usuario-pelo-id-do-usuario.openapi.json | 150 - ...-para-um-usuario-pelo-e-mail.openapi.json" | 149 - .../insere-um-novo-atributo.openapi.json | 164 - ...um-novo-avatar-para-o-usuario.openapi.json | 130 - .../insere-um-novo-banner.openapi.json | 336 - ...mpo-de-cadastro-personalizado.openapi.json | 142 - ...sere-um-novo-conteudo-na-loja.openapi.json | 192 - ...ere-um-novo-contrato-de-frete.openapi.json | 204 - ...culado-a-um-contrato-de-frete.openapi.json | 194 - .../insere-um-novo-fabricante.openapi.json | 149 - .../insere-um-novo-hotsite.openapi.json | 274 - .../insere-um-novo-parceiro.openapi.json | 137 - .../insere-um-novo-pedido.openapi.json | 442 - .../insere-um-novo-portfolio.openapi.json | 106 - ...um-novo-produto-na-assinatura.openapi.json | 155 - .../insere-um-novo-script.openapi.json | 194 - ...um-novo-seller-no-marketplace.openapi.json | 154 - ...insere-um-novo-tipo-de-evento.openapi.json | 191 - .../insere-um-novo-usuario.openapi.json | 228 - ...mais-metatags-para-um-produto.openapi.json | 180 - ...nge-de-cep-em-uma-loja-fisica.openapi.json | 157 - ...reamento-e-status-a-um-pedido.openapi.json | 188 - ...-status-a-um-produto-variante.openapi.json | 204 - ...eo-para-um-produto-especifico.openapi.json | 159 - ...acao-para-um-produto-variante.openapi.json | 192 - .../openapi/insere-uma-inscricao.openapi.json | 149 - .../insere-uma-loja-fisica.openapi.json | 239 - .../insere-uma-nova-categoria.openapi.json | 177 - ...ere-uma-nova-tabela-de-precos.openapi.json | 120 - ...rsao-para-um-script-existente.openapi.json | 157 - ...antes-em-uma-tabela-de-precos.openapi.json | 187 - ...-uma-observacao-a-um-pedido-1.openapi.json | 166 - ...ri-uma-observacao-a-um-pedido.openapi.json | 159 - wake/utils/openapi/inserir-autor.openapi.json | 141 - .../liberar-reservas-de-pedidos.openapi.json | 144 - ...uario-no-idm-identity-manager.openapi.json | 122 - ...-na-conta-corrente-do-cliente.openapi.json | 165 - .../realiza-uma-cotacao-de-frete.openapi.json | 238 - ...de-um-grupo-de-personalizacao.openapi.json | 162 - ...culo-entre-usuario-e-parceiro.openapi.json | 118 - .../openapi/remove-um-atacarejo.openapi.json | 155 - ...mpo-de-cadastro-personalizado.openapi.json | 103 - ...roduto-de-uma-tabela-de-preco.openapi.json | 112 - .../remove-um-valor-pre-definido.openapi.json | 103 - ...nge-de-cep-de-uma-loja-fisica.openapi.json | 162 - .../remove-uma-loja-fisica.openapi.json | 134 - ...a-de-produtos-de-um-portfolio.openapi.json | 116 - ...tuacao-reseller-de-um-produto.openapi.json | 126 - ...a-url-do-avatar-de-um-usuario.openapi.json | 111 - ...orna-as-assinaturas-com-erros.openapi.json | 150 - ...ras-de-um-determinado-usuario.openapi.json | 228 - ...orrencias-cadastradas-na-loja.openapi.json | 134 - .../retorna-dados-da-loja.openapi.json | 139 - ...-o-grafico-forma-de-pagamento.openapi.json | 172 - ...egar-o-grafico-do-faturamento.openapi.json | 196 - ...o-e-numero-de-pedidos-da-loja.openapi.json | 231 - ...tacarejos-do-produto-variante.openapi.json | 168 - .../retorna-lista-de-eventos.openapi.json | 363 - ...sdescadastrados-na-newsletter.openapi.json | 189 - .../retorna-loja-fisica-pelo-id.openapi.json | 252 - ...ue-por-centro-de-distribuicao.openapi.json | 168 - ...ico-de-situacoes-de-um-pedido.openapi.json | 160 - ...to-de-um-usuario-especifico-1.openapi.json | 122 - ...dito-de-um-usuario-especifico.openapi.json | 123 - .../retorna-o-parceiro-pelo-id.openapi.json | 150 - .../retorna-o-parceiro-pelo-nome.openapi.json | 149 - .../retorna-o-portfolio-pelo-id.openapi.json | 122 - ...retorna-o-portfolio-pelo-nome.openapi.json | 121 - ...code-e-precopor-de-um-produto.openapi.json | 146 - ...tas-de-um-determinado-periodo.openapi.json | 198 - ...dio-de-um-determinado-periodo.openapi.json | 198 - ...oes-de-um-determinado-periodo.openapi.json | 198 - ...retorna-o-saldo-de-um-usuario.openapi.json | 133 - ...-o-ultimo-status-de-um-pedido.openapi.json | 205 - ...as-as-midias-entre-duas-datas.openapi.json | 111 - ...-especificas-entre-duas-datas.openapi.json | 230 - ...stro-personalizado-existentes.openapi.json | 144 - ...ista-de-desejos-de-um-usuario.openapi.json | 130 - ...e-rastreamentonf-de-um-pedido.openapi.json | 189 - ...onf-dos-produtos-de-um-pedido.openapi.json | 207 - ...tura-a-partir-do-id-do-pedido.openapi.json | 190 - ...-de-uma-assinatura-especifica.openapi.json | 226 - ...hes-da-transacao-de-um-pedido.openapi.json | 134 - ...-detalhes-do-servico-de-frete.openapi.json | 134 - ...-de-uma-assinatura-especifica.openapi.json | 183 - ...-de-uma-assinatura-especifica.openapi.json | 177 - ...dutos-de-uma-tabela-de-precos.openapi.json | 158 - ...-usuarios-pelo-id-do-parceiro.openapi.json | 138 - ...suarios-pelo-nome-do-parceiro.openapi.json | 137 - .../retorna-produtos-por-seller.openapi.json | 526 - ...riante-esta-disponivel-ou-nao.openapi.json | 126 - ...u-o-recebimento-de-newsletter.openapi.json | 112 - ...os-produtos-variantes-da-loja.openapi.json | 207 - ...s-as-categorias-de-um-produto.openapi.json | 213 - .../retorna-todas-as-categorias.openapi.json | 215 - ...s-formas-de-pagamento-da-loja.openapi.json | 147 - ...-as-informacoes-de-um-produto.openapi.json | 152 - ...etorna-todas-as-lojas-fisicas.openapi.json | 263 - ...s-situacoes-de-pedido-da-loja.openapi.json | 116 - ...na-todas-as-tabelas-de-precos.openapi.json | 126 - .../retorna-todos-os-atributos.openapi.json | 132 - ...os-os-centros-de-distribuicao.openapi.json | 149 - .../retorna-todos-os-fabricantes.openapi.json | 156 - ...odos-os-parceiros-com-pedidos.openapi.json | 161 - .../retorna-todos-os-parceiros.openapi.json | 141 - .../retorna-todos-os-portfolios.openapi.json | 113 - ...-os-precos-de-tabela-de-preco.openapi.json | 187 - .../retorna-todos-os-produtos-1.openapi.json | 222 - .../retorna-todos-os-produtos.openapi.json | 558 - ...orna-todos-os-sellers-da-loja.openapi.json | 137 - ...rna-todos-os-tipos-de-eventos.openapi.json | 210 - .../retorna-todos-os-usuarios.openapi.json | 285 - ...s-de-cep-que-essa-loja-atende.openapi.json | 159 - .../retorna-um-atacarejo-pelo-id.openapi.json | 175 - ...etorna-um-atributo-especifico.openapi.json | 155 - .../retorna-um-contrato-de-frete.openapi.json | 217 - .../retorna-um-evento-especifico.openapi.json | 322 - ...fabricante-especifico-pelo-id.openapi.json | 165 - ...bricante-especifico-pelo-nome.openapi.json | 164 - .../retorna-um-pedido-especifico.openapi.json | 1219 - ...scando-pelo-seu-identificador.openapi.json | 530 - ...na-um-rastreamento-de-produto.openapi.json | 241 - ...m-seller-especifico-da-loja-1.openapi.json | 146 - ...-um-seller-especifico-da-loja.openapi.json | 134 - ...-um-tipo-de-evento-especifico.openapi.json | 193 - ...-usuario-especifico-pelo-cnpj.openapi.json | 235 - ...m-usuario-especifico-pelo-cpf.openapi.json | 235 - ...suario-especifico-pelo-e-mail.openapi.json | 235 - ...um-usuario-especifico-pelo-id.openapi.json | 236 - ...-id-do-erp-como-identificador.openapi.json | 206 - ...orna-uma-categoria-especifica.openapi.json | 206 - ...ete-para-o-carrinho-do-pedido.openapi.json | 204 - ...-com-os-dados-das-assinaturas.openapi.json | 251 - ...d-dos-pedidos-de-um-usuario-1.openapi.json | 147 - ...-id-dos-pedidos-de-um-usuario.openapi.json | 135 - ...te-ao-identificador-informado.openapi.json | 228 - ...alhes-de-um-contrato-de-frete.openapi.json | 195 - ...suario-pelo-e-mail-do-usuario.openapi.json | 160 - ...um-usuario-pelo-id-do-usuario.openapi.json | 161 - .../retorna-uma-lista-de-fretes.openapi.json | 208 - ...a-de-grupos-de-personalizacao.openapi.json | 149 - ...ista-de-imagens-de-um-produto.openapi.json | 169 - ...seado-nas-formas-de-pagamento.openapi.json | 1280 - ...eado-nas-situacoes-de-pedidos.openapi.json | 1288 - ...o-do-limite-de-datas-passadas.openapi.json | 1311 - ...-a-um-grupo-de-personalizacao.openapi.json | 155 - ...-limite-de-credito-de-cada-um.openapi.json | 114 - ...ulos-entre-usuario-e-parceiro.openapi.json | 102 - ...endidos-pela-loja-ou-parceiro.openapi.json | 181 - ...s-ultimos-dez-pedidos-da-loja.openapi.json | 160 - .../retorna-uma-tabela-de-precos.openapi.json | 135 - ...upo-de-assinatura-de-uma-loja.openapi.json | 161 - ...cador-como-variante-principal.openapi.json | 126 - .../seta-o-pedido-como-integrado.openapi.json | 147 - ...voinativo-do-produto-variante.openapi.json | 141 - wake/utils/openapi/templates.openapi.json | 91 - ...token-para-acesso-a-nova-loja.openapi.json | 122 - ...ites-com-um-banner-especifico.openapi.json | 159 - ...iros-com-um-banner-especifico.openapi.json | 162 - ...-a-um-grupo-de-personalizacao.openapi.json | 162 - ...nners-a-um-hotsite-especifico.openapi.json | 159 - ...eudos-a-um-hotsite-especifico.openapi.json | 162 - ...utos-vinculados-anteriormente.openapi.json | 159 - ...gestao-para-um-tipo-de-evento.openapi.json | 177 - ...culo-de-produtos-ao-portfolio.openapi.json | 143 - .../{openapi.gen.ts => wake.openapi.gen.ts} | 12565 ++--- wake/utils/openapi/wake.openapi.json | 45132 ++++++++++++++++ 317 files changed, 72236 insertions(+), 63896 deletions(-) rename shopify/utils/{graphql.gen.ts => storefront.graphql.gen.ts} (100%) rename shopify/utils/{introspection.graphql.json => storefront.graphql.json} (100%) create mode 100644 vnda/utils/openapi/vnda.openapi.gen.ts create mode 100644 vnda/utils/openapi/vnda.openapi.json rename wake/utils/graphql/{graphql.gen.ts => storefront.graphql.gen.ts} (100%) rename wake/utils/graphql/{instropection.graphql.json => storefront.graphql.json} (100%) delete mode 100644 wake/utils/openapi/adiciona-novo-produto.openapi.json delete mode 100644 wake/utils/openapi/adiciona-novos-atacarejos.openapi.json delete mode 100644 wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json delete mode 100644 wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json delete mode 100644 wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json delete mode 100644 wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json delete mode 100644 wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json delete mode 100644 wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json delete mode 100644 wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json delete mode 100644 wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json delete mode 100644 wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json delete mode 100644 wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json delete mode 100644 wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json delete mode 100644 wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json delete mode 100644 wake/utils/openapi/atualiza-o-tipo-evento.openapi.json delete mode 100644 wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json delete mode 100644 wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json delete mode 100644 wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json delete mode 100644 wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json delete mode 100644 wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json delete mode 100644 wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json delete mode 100644 wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-atacarejo.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-atributo.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-banner-existente.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-conteudo.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-evento.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-fabricante.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-parceiro.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-portfolio.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-produto.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-script-existente.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-categoria.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-inscricao.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json delete mode 100644 wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/atualizar-autor.openapi.json delete mode 100644 wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json delete mode 100644 wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json delete mode 100644 wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json delete mode 100644 wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json delete mode 100644 wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-estados.openapi.json delete mode 100644 wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json delete mode 100644 wake/utils/openapi/busca-os-produtos-relacionados.openapi.json delete mode 100644 wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json delete mode 100644 wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json delete mode 100644 wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json delete mode 100644 wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json delete mode 100644 wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json delete mode 100644 wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json delete mode 100644 wake/utils/openapi/busca-todos-banners.openapi.json delete mode 100644 wake/utils/openapi/busca-todos-os-conteudos.openapi.json delete mode 100644 wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json delete mode 100644 wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json delete mode 100644 wake/utils/openapi/busca-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/buscar-autor-pelo-nome.openapi.json delete mode 100644 wake/utils/openapi/buscar-autor-por-id.openapi.json delete mode 100644 wake/utils/openapi/buscar-banner-por-id.openapi.json delete mode 100644 wake/utils/openapi/buscar-todos-os-autores.openapi.json delete mode 100644 wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json delete mode 100644 wake/utils/openapi/cria-um-novo-evento.openapi.json delete mode 100644 wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json delete mode 100644 wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json delete mode 100644 wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-atributo.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-banner-existente.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-portfolio.openapi.json delete mode 100644 wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json delete mode 100644 wake/utils/openapi/deletar-autor.openapi.json delete mode 100644 wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json delete mode 100644 wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/exclui-um-fabricante.openapi.json delete mode 100644 wake/utils/openapi/exclui-um-parceiro.openapi.json delete mode 100644 wake/utils/openapi/exclui-um-script.openapi.json delete mode 100644 wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json delete mode 100644 wake/utils/openapi/exclui-uma-categoria.openapi.json delete mode 100644 wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json delete mode 100644 wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json delete mode 100644 wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json delete mode 100644 wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json delete mode 100644 wake/utils/openapi/indicador-dos-novos-compradores.openapi.json delete mode 100644 wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json delete mode 100644 wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json delete mode 100644 "wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" delete mode 100644 wake/utils/openapi/insere-um-novo-atributo.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-banner.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-fabricante.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-hotsite.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-parceiro.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-pedido.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-portfolio.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-script.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json delete mode 100644 wake/utils/openapi/insere-um-novo-usuario.openapi.json delete mode 100644 wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json delete mode 100644 wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json delete mode 100644 wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json delete mode 100644 wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-inscricao.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-loja-fisica.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-nova-categoria.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json delete mode 100644 wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json delete mode 100644 wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/inserir-autor.openapi.json delete mode 100644 wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json delete mode 100644 wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json delete mode 100644 wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json delete mode 100644 wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json delete mode 100644 wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json delete mode 100644 wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json delete mode 100644 wake/utils/openapi/remove-um-atacarejo.openapi.json delete mode 100644 wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json delete mode 100644 wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json delete mode 100644 wake/utils/openapi/remove-um-valor-pre-definido.openapi.json delete mode 100644 wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json delete mode 100644 wake/utils/openapi/remove-uma-loja-fisica.openapi.json delete mode 100644 wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json delete mode 100644 wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json delete mode 100644 wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-dados-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json delete mode 100644 wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json delete mode 100644 wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json delete mode 100644 wake/utils/openapi/retorna-lista-de-eventos.openapi.json delete mode 100644 wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json delete mode 100644 wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json delete mode 100644 wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json delete mode 100644 wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json delete mode 100644 wake/utils/openapi/retorna-produtos-por-seller.openapi.json delete mode 100644 wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json delete mode 100644 wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-categorias.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-atributos.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-parceiros.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-portfolios.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-produtos.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-os-usuarios.openapi.json delete mode 100644 wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-atributo-especifico.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-evento-especifico.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-pedido-especifico.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json delete mode 100644 wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json delete mode 100644 wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json delete mode 100644 wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json delete mode 100644 wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json delete mode 100644 wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json delete mode 100644 wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json delete mode 100644 wake/utils/openapi/templates.openapi.json delete mode 100644 wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json delete mode 100644 wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json delete mode 100644 wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json delete mode 100644 wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json delete mode 100644 wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json delete mode 100644 wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json delete mode 100644 wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json rename wake/utils/openapi/{openapi.gen.ts => wake.openapi.gen.ts} (53%) create mode 100644 wake/utils/openapi/wake.openapi.json diff --git a/scripts/start.ts b/scripts/start.ts index 1d25e9745..bf3f96340 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -9,32 +9,26 @@ import { import { OpenAPIV3 } from "npm:openapi-types"; import { walk } from "std/fs/mod.ts"; import { dirname, join } from "std/path/mod.ts"; +import { basename } from "std/path/win32.ts"; + +const OPENAPI_EXTENSION = ".openapi.json"; +const GRAPHQL_EXTENSION = ".graphql.json"; const allOpenAPIPaths: string[] = []; const allGraphqlPaths: string[] = []; for await (const entry of walk(".")) { if (entry.isFile) { - if (entry.path.endsWith(".openapi.json")) { + if (entry.path.endsWith(OPENAPI_EXTENSION)) { allOpenAPIPaths.push(entry.path); } - if (entry.path.endsWith(".graphql.json")) { + if (entry.path.endsWith(GRAPHQL_EXTENSION)) { allGraphqlPaths.push(entry.path); } } } -const openAPISpecsByModule = allOpenAPIPaths.reduce( - (acc, specPath) => { - const dir = dirname(specPath); - - acc[dir] ||= []; - acc[dir].push(specPath); - - return acc; - }, - {} as Record, -); +const toOutfile = (path: string) => path.replace(".json", ".gen.ts"); // transforms: /a/{b}/c => /a/:b/c const toPathTemplate = (path: string) => @@ -44,7 +38,8 @@ const generateOpenAPI = async () => { const isOpenAPIv3 = (x: any): x is OpenAPIV3.Document => x?.openapi?.startsWith("3."); - const isReferenceObject = (x: any): x is OpenAPIV3.ReferenceObject => x?.$ref; + const isReferenceObject = (x: any): x is OpenAPIV3.ReferenceObject => + Boolean(x?.$ref); const BANNER_COMMENT = ` // DO NOT EDIT. This file is generated by deco. @@ -66,90 +61,123 @@ const generateOpenAPI = async () => { const AUTOGEN_TYPE_NAME = "Autogen"; - for (const [base, paths] of Object.entries(openAPISpecsByModule)) { - const outfile = join(base, "openapi.gen.ts"); + for (const path of allOpenAPIPaths) { + const outfile = toOutfile(path); const types = []; - console.info(`Generating OpenAPI types for specs at ${base}`); - for (const path of paths) { - const document = JSON.parse(await Deno.readTextFile(path)); - - if (!isOpenAPIv3(document)) { - throw new Error("Only OpenAPI@3x is supported"); + console.info(`Generating OpenAPI types for specs at ${path}`); + const document = JSON.parse(await Deno.readTextFile(path)); + + const derrefObject = ( + obj: T | OpenAPIV3.ReferenceObject, + ): T | null => { + if (isReferenceObject(obj)) { + return obj.$ref.split("/").slice(1).reduce( + (acc: any, curr) => acc?.[curr], + document, + ) as T; } - for (const [path, pathItem] of Object.entries(document.paths)) { - const pathTemplate = toPathTemplate(path); + if (!obj) return null; - for (const verb of HTTP_VERBS) { - const item = pathItem?.[verb]; - - if (!item) { - continue; - } + const ret: any = {}; + for (const [key, value] of Object.entries(obj)) { + if (typeof value !== "object" && typeof value !== "symbol") { + ret[key] = value; + } else if (Array.isArray(value)) { + ret[key] = value.map(derrefObject); + } else { + ret[key] = derrefObject(value); + } + } - const { - parameters = [], - requestBody, - responses, - summary, - description, - } = item; + return ret; + }; - const paramsSchema = parameters - .filter((x): x is OpenAPIV3.ParameterObject => - !isReferenceObject(x) - ) - .filter((x) => x.in === "query") - .reduce((schema, item) => { - if (item.schema && !isReferenceObject(item.schema)) { - schema.properties[item.name] = { - required: item.required as any, - description: item.description, - ...item.schema, - }; - } + if (!isOpenAPIv3(document)) { + throw new Error("Only OpenAPI@3x is supported"); + } - return schema; - }, { - type: "object" as const, - properties: {} as Record, - }); + for (const [path, pathItem] of Object.entries(document.paths)) { + const pathTemplate = toPathTemplate(path); - const bodySchema = !isReferenceObject(requestBody) && - requestBody?.content?.[MEDIA_TYPE_JSON]?.schema; + for (const verb of HTTP_VERBS) { + const item = pathItem?.[verb]; - const ok = responses?.["200"] || responses?.["201"] || - responses?.["206"]; - const responseSchema = !isReferenceObject(ok) && - ok?.content?.[MEDIA_TYPE_JSON].schema; + if (!item) { + continue; + } - const [searchParams, body, response] = await Promise.all([ - Object.keys(paramsSchema.properties).length > 0 && paramsSchema, + const { + parameters = [], + requestBody, + responses, + summary, + description, + } = item; + + const paramsSchema = parameters + .map((item) => isReferenceObject(item) ? derrefObject(item) : item) + .reduce((schema, item) => { + if (item.schema && item.in === "query") { + schema.properties[item.name] = { + description: item.description, + ...item.schema, + }; + + if (item.required) { + schema.required.push(item.name); + } + } + + return schema; + }, { + type: "object" as const, + required: [] as string[], + properties: {} as Record, + }); + + const bodySchema = derrefObject( + derrefObject(requestBody)?.content[MEDIA_TYPE_JSON]?.schema, + ); + + const ok = responses?.["200"] || + responses?.["201"] || + responses?.["206"]; + const responseSchema = derrefObject( + derrefObject(ok)?.content?.[MEDIA_TYPE_JSON].schema, + ); + + console.info(bodySchema); + + const [searchParams, body, response] = await Promise.all( + [ + // Object.keys(paramsSchema.properties).length > 0 && paramsSchema, bodySchema, - responseSchema, - ].map((schema) => - schema ? compile(schema, AUTOGEN_TYPE_NAME, COMPILE_OPTIONS) : null - )); - - const docs = (description || summary) && - `/** @description ${description || summary} */`; - - const typed = `${docs}\n "${verb.toUpperCase()} ${pathTemplate}": { - ${ - Object.entries({ searchParams, body, response }) - .filter((e) => Boolean(e[1])) - .map(([key, value]) => - `${key}: ${ - value!.replace(`export interface ${AUTOGEN_TYPE_NAME}`, "") - .replace(`export type ${AUTOGEN_TYPE_NAME} = `, "") - }` - ) - } - }`; - - types.push(typed); + // responseSchema, + ] + .map((schema) => + schema && compile(schema, AUTOGEN_TYPE_NAME, COMPILE_OPTIONS) + ), + ); + + const docs = (description || summary) && + `/** @description ${description || summary} */`; + + const typed = `${docs}\n "${verb.toUpperCase()} ${pathTemplate}": { + ${ + Object.entries({ searchParams, body, response }) + .filter((e) => Boolean(e[1])) + .map(([key, value]) => + `${key}: ${ + value!.replace(`export interface ${AUTOGEN_TYPE_NAME}`, "") + .replace(`export type ${AUTOGEN_TYPE_NAME} = `, "") + }` + ) } + }`; + + types.push(typed); } } @@ -166,16 +194,16 @@ const generateOpenAPI = async () => { const generateGraphQL = async () => { for (const path of allGraphqlPaths) { - const base = dirname(path); - const [appEntrypoint, ...tail] = base.split("/"); + const [folder, base] = [dirname(path), basename(path)]; + const [appEntrypoint, ...tail] = folder.split("/"); - console.info(`Generating GraphQL types for specs at ${base}`); + console.info(`Generating GraphQL types for specs at ${folder}`); const config: CodegenConfig = { silent: true, schema: join(Deno.cwd(), path), documents: [`./**/*.ts`], generates: { - [join(...tail, "graphql.gen.ts")]: { + [toOutfile(join(...tail, base))]: { plugins: [ "typescript", "typescript-operations", diff --git a/shopify/utils/graphql.gen.ts b/shopify/utils/storefront.graphql.gen.ts similarity index 100% rename from shopify/utils/graphql.gen.ts rename to shopify/utils/storefront.graphql.gen.ts diff --git a/shopify/utils/introspection.graphql.json b/shopify/utils/storefront.graphql.json similarity index 100% rename from shopify/utils/introspection.graphql.json rename to shopify/utils/storefront.graphql.json diff --git a/vnda/utils/openapi/vnda.openapi.gen.ts b/vnda/utils/openapi/vnda.openapi.gen.ts new file mode 100644 index 000000000..36edff818 --- /dev/null +++ b/vnda/utils/openapi/vnda.openapi.gen.ts @@ -0,0 +1,2107 @@ + +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno run -A scripts/openAPI.ts + +export interface API { +/** @description Permite autorizar operações usando o access_token e a senha do usuário */ + "POST /api/v2/users/authorize": { + searchParams: { + access_token?: string; + password?: string; +} + + } +/** @description Realiza o login do usuário a partir do email e da senha */ + "POST /api/v2/users/login": { + searchParams: { + email?: string; + password?: string; +} + + } +/** @description Realiza o logout do usuário a partir do access_token do mesmo */ + "POST /api/v2/users/logout": { + searchParams: { + /** + * Token de validação de usuário logado + * + * O `access_token` é gerado quando o usuário loga no Admin + */ + access_token?: string; +} + + } +/** @description Retorna os dados de um usuário pelo seu ID */ + "GET /api/v2/users/:id": { + + } +/** @description Atualiza um usuário */ + "PUT /api/v2/users/:id": { + searchParams: { + email?: string; + name?: string; + role_name?: + | {"0": "A"; "1": "g"; "2": "e"; "3": "n"; "4": "t"; "5": "e"} + | {"0": "G"; "1": "e"; "2": "s"; "3": "t"; "4": "o"; "5": "r"} + | {"0": "L"; "1": "o"; "2": "c"; "3": "a"; "4": "l"}; + password?: string; + password_confirmation?: string; + external_code?: string; + phone_area?: string; + phone?: string; + tags?: string[]; +} + + } +/** @description Retorna as versões da regra de bônus cadastrada */ + "GET /api/v2/credits/rules/versions": { + + } +/** @description Retorna as regras de bônus cadastradas */ + "GET /api/v2/credits/rules": { + + } +/** @description Permite atualizar as regras de bônus */ + "PUT /api/v2/credits/rules": { + searchParams: { + /** + * Percentual em cima do total do pedido que vai ser dado de bônus para o cliente + */ + bonus?: number; + /** + * Número de dias em que o crédito começa a valer + */ + valid_in?: number; + /** + * Número de dias para a expiração do crédito + */ + valid_for?: number; + /** + * Valor mínimo do pedido para que o bônus possa ser transferido para o cliente + */ + minimum_subtotal?: number; + /** + * Percentual do subtotal do pedido que pode ser pago com o bônus + */ + maximum_usage_factor?: number; +} + + } +/** @description Permite remover as regras de bônus, desativando o recurso */ + "DELETE /api/v2/credits/rules": { + + } +/** @description Retorna os dados de um pedido usando o `code` ou `token` */ + "GET /api/v2/orders/:code": { + + } +/** @description Retorna uma lista de pedidos */ + "GET /api/v2/orders": { + + } +/** @description Faz a captura do pagamento no adquirente +Apenas para pedidos pagos com cartão de crédito */ + "POST /api/v2/orders/:code/capture": { + + } +/** @description Altera o status do pedido para "confirmado" */ + "POST /api/v2/orders/:code/confirm": { + searchParams: { + /** + * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/capture" + */ + confirmation_data?: string; +} + + } +/** @description Faz o estorno do pagamento no adquirente +Apenas para pedidos pagos com cartão de crédito */ + "POST /api/v2/orders/:code/chargeback": { + + } +/** @description Altera o status do pedido para "cancelado" */ + "POST /api/v2/orders/:code/cancel": { + searchParams: { + /** + * Deve ser enviado algo que comprove que o pagamento foi devolvido. + * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/chargeback" + */ + cancelation_data?: string; +} + + } +/** @description Altera o status do pacote para "enviado" */ + "PATCH /api/v2/orders/:order_code/packages/:package_code/ship": { + + } +/** @description Altera o pacote para "entregue" */ + "PATCH /api/v2/orders/:order_code/packages/:package_code/deliver": { + + } +/** @description Recebe uma lista JSON com os SKUs que devem ser atualizados. A atualização será executada em segundo plano em aproximadamente 1 minuto */ + "POST /api/v2/variants/quantity": { + searchParams: { + sku?: string; + quantity?: number; + /** + * Informe somente para atualizar o estoque de um local específico + */ + place_id?: number; +}[]; + + } +/** @description Atualiza o estoque de uma variante de um produto */ + "POST /api/v2/variants/:sku/quantity": { + + } +/** @description Atualiza o estoque específico de um local */ + "PATCH /api/v2/variants/:sku/inventories/:place_id": { + + } +/** @description Permite listar as variantes de um produto */ + "GET /api/v2/products/:product_id/variants": { + + } +/** @description Permite criar uma variante */ + "POST /api/v2/products/:product_id/variants": { + searchParams: { + sku?: string; + name?: string; + quantity?: number; + main?: boolean; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + price?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: string; + property2?: string; + property3?: string; + barcode?: string; +} + + } +/** @description Permite remover uma variante */ + "DELETE /api/v2/products/:product_id/variants/:id": { + + } +/** @description Permite atualizar uma variante */ + "PATCH /api/v2/products/:product_id/variants/:id": { + searchParams: { + sku?: string; + name?: string; + quantity?: number; + main?: boolean; + width?: number; + height?: number; + length?: number; + weight?: number; + handling_days?: number; + price?: number; + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: string; + property2?: string; + property3?: string; + barcode?: string; + quantity_sold?: number; +} + + } +/** @description Permite determinar a ordem das variantes dentro de cada produto */ + "POST /api/v2/variants/reorder": { + searchParams: { + /** + * A ordem dos elementos será replicada para as variantes + */ + ids?: number[]; +} + + } +/** @description Retorna um template usando o path dele */ + "GET /api/v2/templates/:path": { + + } +/** @description Remove um template usando o path dele */ + "DELETE /api/v2/templates/:path": { + + } +/** @description Atualiza o conteúdo de um template usando o path dele */ + "PATCH /api/v2/templates/:path": { + searchParams: { + body?: string; +} + + } +/** @description Retorna uma lista de templates */ + "GET /api/v2/templates": { + + } +/** @description Cria um novo template */ + "POST /api/v2/templates": { + searchParams: { + path?: string; + body?: string; +} + + } +/** @description Reativa um usuário que estiver desativado */ + "POST /api/v2/users/:id/activate": { + + } +/** @description Desativa um usuário */ + "POST /api/v2/users/:id/deactivate": { + + } +/** @description Lista os usuários */ + "GET /api/v2/users": { + + } +/** @description Cria um usuário */ + "POST /api/v2/users": { + searchParams: { + email?: string; + name?: string; + role_name?: + | {"0": "A"; "1": "g"; "2": "e"; "3": "n"; "4": "t"; "5": "e"} + | {"0": "G"; "1": "e"; "2": "s"; "3": "t"; "4": "o"; "5": "r"} + | {"0": "L"; "1": "o"; "2": "c"; "3": "a"; "4": "l"}; + password?: string; + password_confirmation?: string; + external_code?: string; + phone_area?: string; + phone?: string; + tags?: string[]; +} + + } +/** @description Lista os usuários */ + "GET /api/v2/users/tags": { + + } +/** @description Retorna a lista de carrinhos ativos nos últimos 60 dias */ + "GET /api/v2/carts": { + + } +/** @description Permite criar um carrinho */ + "POST /api/v2/carts": { + searchParams: /** + * Parâmetros criação e atualização de carrinho + */ +export interface ParametrosDeCarrinhoResumido { + /** + * Agente que criou o carrinho + */ + agent?: string; + /** + * Código de Endereçamento Postal (CEP) do destinatário do pedido + */ + zip?: string; + /** + * Código identificador `ID` do cliente + */ + client_id?: number; + /** + * Código identificador `ID` do desconto do carrinho + */ + coupon_code?: string; + /** + * @deprecated + * Email do cliente + */ + email?: string; + /** + * Token do desconto + */ + rebate_token?: string; +} + + } +/** @description Permite retornar um carrinho */ + "GET /api/v2/carts/:id": { + + } +/** @description Permite criar um carrinho */ + "POST /api/v2/carts/:id": { + searchParams: { + agent?: string; + zip?: string; + client_id?: number; + coupon_code?: string; + /** + * DEPRECATED: enviar o `client_id` + */ + email?: string; + rebate_token?: string; +} + + } +/** @description Permite excluir um carrinho */ + "DELETE /api/v2/carts/:id": { + + } +/** @description Permite atualizar os atributos de um carrinho */ + "PATCH /api/v2/carts/:id": { + searchParams: { + agent?: string; + zip?: string; + client_id?: number; + /** + * DEPRECATED: enviar o `client_id` + */ + email?: string; + rebate_token?: string; +} + + } +/** @description Permite calcular as parcelas referentes ao total do carrinho */ + "GET /api/v2/carts/:id/installments": { + + } +/** @description Lista os locais */ + "GET /api/v2/places": { + + } +/** @description Cria um local */ + "POST /api/v2/places": { + searchParams: { + name?: string; + address_line_1?: string; + address_line_2?: string; + city?: string; + neighborhood?: string; + zip?: string; + home_page?: string; + latitude?: number; + longitude?: number; + images?: string[]; + description?: string; + email?: string; + first_phone?: string; + second_phone?: string; + mobile_phone?: string; + only_cash?: boolean; + categories?: string[]; + marker_url?: string; + state?: string; + opening_hours?: string; + warehouse?: boolean; + legal_name?: string; + cnpj?: string; +} + + } +/** @description Remove um local */ + "DELETE /api/v2/places/:id": { + + } +/** @description Atualiza um local */ + "PATCH /api/v2/places/:id": { + searchParams: { + name?: string; + address_line_1?: string; + address_line_2?: string; + city?: string; + neighborhood?: string; + zip?: string; + home_page?: string; + latitude?: number; + longitude?: number; + images?: string[]; + description?: string; + email?: string; + first_phone?: string; + second_phone?: string; + mobile_phone?: string; + only_cash?: boolean; + categories?: string[]; + marker_url?: string; + state?: string; + opening_hours?: string; + warehouse?: boolean; + legal_name?: string; + cnpj?: string; +} + + } +/** @description Lista as notas fiscais */ + "GET /api/v2/orders/:code/packages/:package_code/invoices": { + + } +/** @description Cria uma nota fiscal */ + "POST /api/v2/orders/:code/packages/:package_code/invoices": { + searchParams: { + number?: number; + series?: number; + issued_at?: string; + key?: string; + volumes?: number; +} + + } +/** @description Remove uma nota fiscal */ + "DELETE /api/v2/orders/:code/packages/:package_code/invoices/:number": { + + } +/** @description Atualiza uma nota fiscal */ + "PATCH /api/v2/orders/:code/packages/:package_code/invoices/:number": { + searchParams: { + number?: number; + series?: number; + issued_at?: string; + key?: string; + volumes?: number; +} + + } +/** @description Será enviado por email um link para o cadastro da nova senha +O link tem validade de 24 horas */ + "POST /api/v2/users/reset_password": { + searchParams: { + email?: string; +} + + } +/** @description Cadastra a nova senha */ + "PATCH /api/v2/users/reset_password": { + searchParams: { + /** + * Token pare renovação de senha enviado por email + */ + token?: string; + /** + * Nova senha para o usuário + */ + password?: string; + /** + * Confirmação da nova senha do usuário + */ + password_confirmation?: string; +} + + } +/** @description Retorna o endereço de entrega */ + "GET /api/v2/orders/:code/shipping_address": { + + } +/** @description Lista os recebedores */ + "GET /api/v2/payment_recipients": { + + } +/** @description Cria um recebedor */ + "POST /api/v2/payment_recipients": { + searchParams: { + tag_id?: number; + recipient_id?: number; + percentage?: number; + active?: boolean; + charge_processing_fee?: boolean; + liable?: boolean; + code?: string; + place_id?: number; + user_id?: number; + /** + * Indica se o frete deve ser incluído no split do pagamento + */ + include_shipping?: boolean; +} + + } +/** @description Retorna um recebedor */ + "GET /api/v2/payment_recipients/:id": { + + } +/** @description Remove um recebedor */ + "DELETE /api/v2/payment_recipients/:id": { + + } +/** @description Atualiza um recebedor */ + "PATCH /api/v2/payment_recipients/:id": { + searchParams: { + tag_id?: number; + recipient_id?: number; + percentage?: number; + active?: boolean; + charge_processing_fee?: boolean; + liable?: boolean; + code?: string; + place_id?: number; + user_id?: number; + /** + * Indica se o frete deve ser incluído no split do pagamento + */ + include_shipping?: boolean; +} + + } +/** @description Permite a listagem de recebíveis do usuário */ + "GET /api/v2/users/:user_id/payables": { + + } +/** @description Lista os membros da audiência */ + "GET /api/v2/audience_members": { + + } +/** @description Permite criar um membro da audiência */ + "POST /api/v2/audience_members": { + searchParams: { + first_name?: string; + last_name?: string; + email?: string; + phone_area?: string; + phone?: string; + tags?: string[]; +} + + } +/** @description Permite remover um membro da audiência */ + "DELETE /api/v2/audience_members/:id": { + + } +/** @description Permite alterar um membro da audiência */ + "PATCH /api/v2/audience_members/:id": { + searchParams: { + first_name?: string; + last_name?: string; + email?: string; + phone_area?: string; + phone?: string; + tags?: string[]; +} + + } +/** @description Lista os rastreios de um pacote de um pedido */ + "GET /api/v2/orders/:order_code/packages/:package_code/trackings": { + + } +/** @description Adiciona um rastreio para um pacote de um pedido */ + "POST /api/v2/orders/:order_code/packages/:package_code/trackings": { + searchParams: { + /** + * Código de rastreio + */ + code?: string; + /** + * Transportadora + */ + company?: string; + /** + * Link de rastreamento + */ + url?: string; +} + + } +/** @description Remove um rastreio */ + "DELETE /api/v2/orders/:order_code/packages/:package_code/trackings/:id": { + + } +/** @description Lista os itens de um carrinho */ + "GET /api/v2/carts/:cart_id/items": { + + } +/** @description Permite criar um item do carrinho */ + "POST /api/v2/carts/:cart_id/items": { + searchParams: /** + * Modelo de carcaterística de produto para item no carrinho + */ +export interface Produto { + /** + * Código SKU da variante do produto + */ + sku?: string; + /** + * Unidades do produto disponíveis fisicamente + */ + quantity?: number; + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra?: {}; + /** + * Código identificador do local do produto + */ + place_id?: number; + /** + * Código de cupom + */ + store_coupon_code?: string; + /** + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto + */ + customizations?: { + /** + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. + * Se por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. + */ + Customization?: string; + }[]; +} + + } +/** @description Remove um item do carrinho */ + "DELETE /api/v2/carts/:cart_id/items/:id": { + + } +/** @description Atualiza um item do carrinho */ + "PATCH /api/v2/carts/:cart_id/items/:id": { + searchParams: { + quantity?: number; + place_id?: number; + extra?: {}; + store_coupon_code?: string; +} + + } +/** @description Permite adicionar itens em bulk ao carrinho */ + "POST /api/v2/carts/:cart_id/items/bulk": { + searchParams: { + sku?: string; + quantity?: number; + extra?: {}; + place_id?: number; + /** + * Itens do carrinho + */ + items?: unknown[][]; +} + + } +/** @description Cria uma promoção */ + "POST /api/v2/discounts": { + searchParams: { + name?: string; + start_at?: string; + end_at?: string; + valid_to?: {"0": "s"; "1": "t"; "2": "o"; "3": "r"; "4": "e"} | {"0": "c"; "1": "a"; "2": "r"; "3": "t"}; + description?: string; + enabled?: boolean; + email?: string; + cpf?: string; + tags?: string; +} + + } +/** @description Retorna uma promoção */ + "GET /api/v2/discounts/:id": { + + } +/** @description Remove uma promoção */ + "DELETE /api/v2/discounts/:id": { + + } +/** @description Altera uma promoção */ + "PATCH /api/v2/discounts/:id": { + searchParams: { + name?: string; + start_at?: string; + end_at?: string; + valid_to?: {"0": "s"; "1": "t"; "2": "o"; "3": "r"; "4": "e"} | {"0": "c"; "1": "a"; "2": "r"; "3": "t"}; + description?: string; + enabled?: boolean; + email?: string; + cpf?: string; + tags?: string; +} + + } +/** @description Lista as regras de desconto de uma promoção */ + "GET /api/v2/discounts/:discount_id/rules": { + + } +/** @description Cria uma regra de desconto */ + "POST /api/v2/discounts/:discount_id/rules": { + searchParams: { + apply_to?: + | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} + | {"0": "t"; "1": "a"; "2": "g"} + | {"0": "s"; "1": "u"; "2": "b"; "3": "t"; "4": "o"; "5": "t"; "6": "a"; "7": "l"} + | {"0": "t"; "1": "o"; "2": "t"; "3": "a"; "4": "l"} + | {"0": "s"; "1": "h"; "2": "i"; "3": "p"; "4": "p"; "5": "i"; "6": "n"; "7": "g"}; + amount_type?: {"0": "R"; "1": "$"} | {"0": "%"}; + amount?: number; + product_id?: number; + tag_name?: string; + min_quantity?: number; + shipping_method?: string; + min_subtotal?: number; + gift?: boolean; + combinated_product_id?: number; + client_tag?: string; + shipping_rule?: string; + gift_quantity?: number; + agent_tag?: string; + regions?: string[]; + channel?: string[]; +} + + } +/** @description Remove uma regra de desconto */ + "DELETE /api/v2/discounts/:discount_id/rules/:id": { + + } +/** @description Altera uma regra de desconto */ + "PATCH /api/v2/discounts/:discount_id/rules/:id": { + searchParams: { + apply_to?: + | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} + | {"0": "t"; "1": "a"; "2": "g"} + | {"0": "s"; "1": "u"; "2": "b"; "3": "t"; "4": "o"; "5": "t"; "6": "a"; "7": "l"} + | {"0": "t"; "1": "o"; "2": "t"; "3": "a"; "4": "l"} + | {"0": "s"; "1": "h"; "2": "i"; "3": "p"; "4": "p"; "5": "i"; "6": "n"; "7": "g"}; + amount_type?: {"0": "R"; "1": "$"} | {"0": "%"}; + amount?: number; + product_id?: number; + tag_id?: number; + min_quantity?: number; + shipping_method?: string; + min_subtotal?: number; + gift?: boolean; + combinated_product_id?: number; + client_tag?: string; + shipping_rule?: string; + gift_quantity?: number; + agent_tag?: string; + regions?: string[]; + channel?: string[]; +} + + } +/** @description Permite listar os cupons de desconto de uma promoção */ + "GET /api/v2/discounts/:discount_id/coupons": { + + } +/** @description Cria um cupom de desconto */ + "POST /api/v2/discounts/:discount_id/coupons": { + searchParams: { + code?: string; + uses_per_code?: number; + uses_per_user?: number; + referrer_email?: string; + quantity?: number; + user_id?: number; +} + + } +/** @description Remove um cupom de desconto */ + "DELETE /api/v2/discounts/:discount_id/coupons:id": { + + } +/** @description Atualiza um cupom de desconto */ + "PATCH /api/v2/discounts/:discount_id/coupons:id": { + searchParams: { + /** + * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + */ + uses_per_code?: number; + /** + * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + */ + uses_per_user?: number; +} + + } +/** @description Lista os produtos */ + "GET /api/v2/products": { + + } +/** @description Cria um produto */ + "POST /api/v2/products": { + searchParams: /** + * Modelo simplificado de um produto para atualização e criação + */ +export interface SimpleProduct { + /** + * Código de Referência do produto + */ + reference?: string; + /** + * Nome do produto + */ + name?: string; + /** + * Descrição do produto + */ + description?: string; + /** + * Indica se o produto está ativo (`true`) ou invativo (`false`) + */ + active?: boolean; + /** + * Tags associadas ao produto + */ + tag_list?: string; + /** + * Tipo de produto + */ + product_type?: + | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} + | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} + | { + "0": "s"; + "1": "u"; + "2": "b"; + "3": "s"; + "4": "c"; + "5": "r"; + "6": "i"; + "7": "p"; + "8": "t"; + "9": "i"; + "10": "o"; + "11": "n"; + }; +} + + } +/** @description Retorna um produto */ + "GET /api/v2/products/:id": { + + } +/** @description Remove um produto */ + "DELETE /api/v2/products/:id": { + + } +/** @description Atualiza um produto */ + "PATCH /api/v2/products/:id": { + searchParams: { + name?: string; + description?: string; + active?: boolean; + reference?: string; + tag_list?: string; +} + + } +/** @description Permite atualizar um produto pela referência */ + "PATCH /api/v2/products/reference/:reference": { + searchParams: { + reference?: string; + name?: string; + description?: string; + active?: boolean; + product_type?: + | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} + | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} + | { + "0": "s"; + "1": "u"; + "2": "b"; + "3": "s"; + "4": "c"; + "5": "r"; + "6": "i"; + "7": "p"; + "8": "t"; + "9": "i"; + "10": "o"; + "11": "n"; + }; +} + + } +/** @description Recebe uma avaliação e recalcula a pontuação atual */ + "POST /api/v2/products/:id/rate": { + + } +/** @description Busca os produtos de acordo com os parâmetros definidos */ + "GET /api/v2/products/search": { + + } +/** @description Retorna uma variante pelo SKU */ + "GET /api/v2/variants/:sku": { + + } +/** @description Permite atualizar uma variante pelo SKU */ + "PATCH /api/v2/variants/:sku": { + searchParams: { + sku?: string; + name?: string; + quantity?: number; + main?: boolean; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + /** + * Preço do item + */ + price?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: VariantProperty; + property2?: VariantProperty; + property3?: VariantProperty; + barcode?: string; + /** + * Quantidade de itens vendidos + */ + quantity_sold?: number; +} +/** + * Modelo que representa uma propriedade de uma variante + */ +export interface VariantProperty { + /** + * Nome da propriedade + */ + name: string; + /** + * Valor da propriedade + */ + value: string; + /** + * Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`) + */ + defining: boolean; +} + + } +/** @description Lista as imagens de uma variante passando o SKU da mesma na URL */ + "GET /api/v2/products/:product_id/variants/:sku/images": { + + } +/** @description Lista as imagens de uma variante passando o SKU da mesma nos parâmetros */ + "GET /api/v2/products/:product_id/variants/images": { + + } +/** @description Calcula o frete para uma determinada variante */ + "GET /api/v2/variants/:sku/shipping_methods": { + searchParams: { + quantity?: number; + zip?: string; +} + + } +/** @description Permite listar as tags */ + "GET /api/v2/tags": { + + } +/** @description Cria uma tag */ + "POST /api/v2/tags": { + searchParams: { + name?: string; + title?: string; + /** + * Equivalente ao subtítulo + */ + blurb?: string; + description?: string; + tag_type?: string; + show_in_carts?: boolean; +} + + } +/** @description Lista os tipos de tags usados em alguma tag */ + "GET /api/v2/tags/types": { + + } +/** @description Retorna uma tag */ + "GET /api/v2/tags/:name": { + + } +/** @description Remove uma tag */ + "DELETE /api/v2/tags/:name": { + + } +/** @description Permite atualizar uma tag */ + "PATCH /api/v2/tags/:name": { + + } +/** @description Retorna os dados de um cupom usando o seu código */ + "GET /api/v2/coupon_codes/:code": { + + } +/** @description Cria um pedido no Paypal para que posteriormente possa receber um pagamento */ + "POST /api/v2/carts/:cart_id/payment/paypal": { + + } +/** @description Retorna uma lista de clientes. Caso seja informado o parâmetro "email", então apenas o cliente com esse email será retornado */ + "GET /api/v2/clients": { + + } +/** @description Permite criar um cliente */ + "POST /api/v2/clients": { + searchParams: { + email?: string; + first_name?: string; + last_name?: string; + birthdate?: string; + gender?: {"0": "M"} | {"0": "F"}; + /** + * separado por vírgula + */ + tags?: string; + lists?: string[]; + password?: string; + password_confirmation?: string; + terms?: boolean; +} + + } +/** @description Permite retornar as informações do cliente +O auth_token do cliente pode ser informado no lugar do ID na URL */ + "GET /api/v2/clients/:id": { + + } +/** @description Permite remover um cliente */ + "DELETE /api/v2/clients/:id": { + + } +/** @description Permite atualizar as informações do cliente */ + "PATCH /api/v2/clients/:id": { + searchParams: { + email?: string; + first_name?: string; + last_name?: string; + birthdate?: string; + gender?: {"0": "M"} | {"0": "F"}; + /** + * separado por vírgula + */ + tags?: string; + lists?: string[]; + password?: string; + password_confirmation?: string; + terms?: boolean; +} + + } +/** @description Retorna a lista de pedidos do cliente */ + "GET /api/v2/clients/:id/orders": { + + } +/** @description Lista os endereços do cliente utilizados nos pedidos que foram confirmados */ + "GET /api/v2/clients/:id/addresses": { + + } +/** @description Lista os endereços cadastrados pelo cliente */ + "GET /api/v2/clients/:client_id/registered_addresses": { + + } +/** @description Permite criar um endereço do cliente */ + "POST /api/v2/clients/:client_id/registered_addresses": { + searchParams: { + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + label?: string; + zip?: string; + reference?: string; +} + + } +/** @description Delete o endereço cadastrado pelo cliente */ + "DELETE /api/v2/clients/:client_id/registered_addresses/:id": { + + } +/** @description Permite atualizar um endereço do cliente */ + "PATCH /api/v2/clients/:client_id/registered_addresses/:id": { + searchParams: { + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + label?: string; + zip?: string; + reference?: string; +} + + } +/** @description Cria uma senha para o cliente e envia por email */ + "POST /api/v2/clients/recover_password": { + + } +/** @description Retorna o saldo de crétitos do cliente */ + "GET /api/v2/clients/:id/credits": { + + } +/** @description Retorna as transfertências de crétidos realizadas */ + "GET /api/v2/clients/:id/credits/transfers": { + + } +/** @description Lista os bônus do cliente que ainda não foram utilizados */ + "GET /api/v2/clients/:id/bonuses": { + + } +/** @description Solicita a remoção (esquecimento) dos dados pessoais de um cliente, de acordo com a LGPD */ + "PATCH /api/v2/clients/:id/remove_personal_data": { + + } +/** @description Faz o login do cliente pelo token salvo no campo auth_token */ + "GET /api/v2/auth/email/:token": { + + } +/** @description Faz o login do cliente por usuário e senha */ + "POST /api/v2/auth/client": { + searchParams: { + email?: string; + password?: string; +} + + } +/** @description Faz o pagamento do carrinho usando a forma de pagamento informada */ + "POST /api/v2/carts/:cart_id/payment": { + searchParams: { + /** + * Meio de pagamento + */ + payment_method?: {"0": "p"; "1": "i"; "2": "x"}; + /** + * Canal de venda do carrinho + */ + channel?: + | {"0": "e"; "1": "c"; "2": "o"; "3": "m"; "4": "m"; "5": "e"; "6": "r"; "7": "c"; "8": "e"} + | {"0": "d"; "1": "i"; "2": "r"; "3": "e"; "4": "c"; "5": "t"}; +} + + } +/** @description Lista os menus */ + "GET /api/v2/menus": { + + } +/** @description Cria um menu */ + "POST /api/v2/menus": { + searchParams: { + label?: string; + tooltip?: string; + description?: string; + type?: string; + url?: string; + page_id?: number; + parent_id?: number; + position?: string; + new_position?: string; + external?: boolean; + tag_id?: number; +} + + } +/** @description Retorna um menu */ + "GET /api/v2/menus/:id": { + + } +/** @description Remove um menu */ + "DELETE /api/v2/menus/:id": { + + } +/** @description Atualiza um menu */ + "PATCH /api/v2/menus/:id": { + searchParams: { + label?: string; + tooltip?: string; + description?: string; + type?: string; + url?: string; + page_id?: number; + parent_id?: number; + position?: string; + new_position?: string; + external?: boolean; + tag_id?: number; +} + + } +/** @description Lista as posições dos menus */ + "GET /api/v2/menus/positions": { + + } +/** @description Reordena os menus na ordem em que seus ids são listados no request */ + "POST /api/v2/menus/reorder": { + searchParams: { + /** + * A ordem dos elementos será replicada para os menus + */ + ids?: number[]; +} + + } +/** @description Retorna os menus em árvore, organizados pela posição */ + "GET /api/v2/menus/tree": { + + } +/** @description Retorna uma mensagem do site */ + "GET /api/v2/site_message": { + + } +/** @description Remove uma mensagem do site */ + "DELETE /api/v2/site_message": { + + } +/** @description Cria ou atualiza uma mensagem do site */ + "PATCH /api/v2/site_message": { + searchParams: { + title?: string; + description?: string; + call_to_action?: string; +} + + } +/** @description Lista as imagens associadas a loja */ + "GET /api/v2/shop/images": { + + } +/** @description Permite cadastrar uma imagem */ + "POST /api/v2/shop/images": { + searchParams: { + position?: string; + file_uid?: string; +} + + } +/** @description Permite remover uma imagem da loja */ + "DELETE /api/v2/shop/images/:id": { + + } +/** @description Permite adicionar um atributo customizado de produto */ + "POST /api/v2/shop/product_attributes": { + searchParams: { + index?: number; + name?: string; + mandatory?: boolean; +} + + } +/** @description Permite listar as personalizações */ + "GET /api/v2/customizations": { + + } +/** @description Permite criar uma personalização */ + "POST /api/v2/customizations": { + searchParams: { + group_name?: string; + group_type?: string; + name?: string; + label?: string; + image_uid?: string; + image_name?: string; + price?: number; + quantity?: number; + handling_days?: number; + tag_id?: number; + sku?: string; + pattern?: string; +} + + } +/** @description Permite retornar uma personalização */ + "GET /api/v2/customizations/:id": { + + } +/** @description Permite remover uma personalização */ + "DELETE /api/v2/customizations/:id": { + + } +/** @description Permite alterar uma personalização */ + "PATCH /api/v2/customizations/:id": { + searchParams: { + group_name?: string; + group_type?: string; + name?: string; + label?: string; + image_uid?: string; + image_name?: string; + price?: string; + quantity?: string; + handling_days?: string; + tag_id?: string; + sku?: string; + pattern?: string; +} + + } +/** @description Permite listar os itens do pedido */ + "GET /api/v2/orders/:order_id/items": { + + } +/** @description Permite listar as personalizações de cada item do pedido */ + "GET /api/v2/orders/:order_id/items/:item_id/customizations": { + + } +/** @description Permite listar as personalizações de cada item do carrinho */ + "GET /api/v2/carts/:cart_id/items/:item_id/customizations": { + + } +/** @description Permite remover uma customização do item do carrinho */ + "DELETE /api/v2/carts/:cart_id/items/:item_id/customizations": { + + } +/** @description Lista os mapeamentos */ + "GET /api/v2/mappings": { + + } +/** @description Cria um mapeamento */ + "POST /api/v2/mappings": { + searchParams: { + key?: string; + from?: string[]; + to?: string; +} + + } +/** @description Retorna os dados de um mapeamento */ + "GET /api/v2/mappings/:id": { + + } +/** @description Remove um mapeamento */ + "DELETE /api/v2/mappings/:id": { + + } +/** @description Atualiza um mapeamento */ + "PATCH /api/v2/mappings/:id": { + searchParams: { + key?: string; + from?: string[]; + to?: string; +} + + } +/** @description Retorna a lista de banners */ + "GET /api/v2/banners": { + + } +/** @description Retorna os dados de um banner */ + "GET /api/v2/banners/:id": { + + } +/** @description Retorna todos os banners disponíveis agrupados por tag */ + "GET /api/v2/banners/all": { + + } +/** @description Permite calcular o frete para pedidos internacionais */ + "GET /api/v2/carts/:cart_id/shipping_methods/intl": { + + } +/** @description Lista as amostras disponíveis para determinado carrinho */ + "GET /api/v2/carts/:cart_id/samples": { + + } +/** @description Retorna o endereço de entrega */ + "GET /api/v2/carts/:cart_id/shipping_address": { + + } +/** @description Adiciona um endereço de entrega no carrinho */ + "POST /api/v2/carts/:cart_id/shipping_address": { + searchParams: /** + * Modelo de endereço de envio para carrinho e pedido + */ +export interface EnderecoDeEnvio { + /** + * Nome do cliente + */ + first_name?: string; + /** + * Sobrenome do cliente + */ + last_name?: string; + /** + * Nome da empresa (para clientes jurídicos) + */ + company_name?: string; + /** + * Email do cliente + */ + email?: string; + /** + * Código de Discagem Direta à Distância (DDD) + */ + first_phone_area?: string; + /** + * Telefone do cliente + */ + first_phone?: string; + /** + * Código de Discagem Direta à Distância (DDD) + */ + second_phone_area?: string; + /** + * Telefone do cliente + */ + second_phone?: string; + /** + * Nome do recebedor + */ + recipient_name?: { + [k: string]: unknown; + }; + /** + * Logradouro + */ + street_name?: string; + /** + * Número + */ + street_number?: string; + /** + * Complemento + */ + complement?: string; + /** + * Bairro + */ + neighborhood?: string; + /** + * Ponto de referência + */ + reference?: string; + /** + * Código de Endereçamento Postal (CEP) + */ + zip?: string; + documents?: { + /** + * Cadastro de Pessoa Física + */ + cpf?: string; + /** + * Registro Geral + */ + rg?: string; + /** + * Cadastro Nacional de Pessoas Jurídicas + */ + cnpj?: string; + /** + * Inscrição Estadual + */ + ie?: string; + }[]; +} + + } +/** @description Associa um código de cupom ao carrinho */ + "POST /api/v2/carts/:cart_id/coupon_code": { + searchParams: { + /** + * Código do cupom + */ + code?: string; +} + + } +/** @description Lista todos os channels usados nos pedidos criados */ + "GET /api/v2/orders/channels": { + + } +/** @description Lista todos os estados usados nos pedidos criados */ + "GET /api/v2/orders/states": { + + } +/** @description Retorna o preço do produto e das variantes */ + "GET /api/v2/products/:product_id/price": { + + } +/** @description Lista as imagens do produto */ + "GET /api/v2/products/:product_id/images": { + + } +/** @description Cria uma imagem do produto */ + "POST /api/v2/products/:product_id/images": { + searchParams: { + file_url?: string; + /** + * IDs da variantes associadas a imagem + */ + variant_ids?: number[]; +} + + } +/** @description Deleta uma imagem do produto */ + "DELETE /api/v2/products/:product_id/images/:id": { + + } +/** @description Reordena as imagens do produto */ + "POST /api/v2/products/:product_id/images/reorder": { + searchParams: { + ids?: number[]; +} + + } +/** @description Associa a imagem com uma variante */ + "POST /api/v2/products/:product_id/images/:id/add_variant": { + searchParams: { + variant_id?: number; +} + + } +/** @description Remove a associação da imagem com uma variante */ + "POST /api/v2/products/:product_id/images/:id/remove_variant": { + searchParams: { + variant_id?: number; +} + + } +/** @description Retorna uma lista de pacotes de um pedido */ + "GET /api/v2/orders/:order_code/packages": { + + } +/** @description Indica para a API que dererminado evento aconteceu e que ela deve disparar as ações relacionadas */ + "POST /api/v2/events": { + + } +/** @description Permite a listagem de recebíveis (comissão) de um usuário vendedor da loja, quando ocorre split de pagamentos via Pagarme */ + "GET /api/v2/users/:id/payables": { + + } +/** @description Retorna um produto pelo código identificador (`product_id`) */ + "GET /api/v2/products/:product_id": { + + } +/** @description Remove um produto do catálogo pelo código indentificador (`product_id`) */ + "DELETE /api/v2/products/:product_id": { + + } +/** @description Atualiza informações de um produto no catálogo pelo código identificador (`product_id`) */ + "PATCH /api/v2/products/:product_id": { + searchParams: /** + * Modelo simplificado de um produto para atualização e criação + */ +export interface SimpleProduct { + /** + * Código de Referência do produto + */ + reference?: string; + /** + * Nome do produto + */ + name?: string; + /** + * Descrição do produto + */ + description?: string; + /** + * Indica se o produto está ativo (`true`) ou invativo (`false`) + */ + active?: boolean; + /** + * Tags associadas ao produto + */ + tag_list?: string; + /** + * Tipo de produto + */ + product_type?: + | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} + | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} + | { + "0": "s"; + "1": "u"; + "2": "b"; + "3": "s"; + "4": "c"; + "5": "r"; + "6": "i"; + "7": "p"; + "8": "t"; + "9": "i"; + "10": "o"; + "11": "n"; + }; +} + + } +/** @description Recebe uma avaliação e recalcula a pontuação atual */ + "POST /api/v2/products/:product_id/rate": { + + } +/** @description Permite remover uma variante */ + "DELETE /api/v2/products/:product_id/variants/:variant_id": { + + } +/** @description Atualiza as informações de um variante */ + "PATCH /api/v2/products/:product_id/variants/:variant_id": { + searchParams: { + sku?: string; + name?: string; + quantity?: number; + main?: boolean; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + price?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: { + name?: string; + value?: string; + defining?: boolean; + }; + property2?: { + name?: string; + value?: string; + defining?: boolean; + }; + property3?: { + name?: string; + value?: string; + defining?: boolean; + }; + barcode?: string; + /** + * Quantidade de itens vendidos + */ + quantity_sold?: number; +} + + } +/** @description Deleta uma imagem do produto */ + "DELETE /api/v2/products/:product_id/images/:image_id": { + + } +/** @description Associa a imagem com uma variante */ + "POST /api/v2/products/:product_id/images/:image_id/add_variant": { + searchParams: { + variant_id?: number; +} + + } +/** @description Remove a associação da imagem com uma variante */ + "POST /api/v2/products/:product_id/images/:image_id/remove_variant": { + searchParams: { + variant_id?: number; +} + + } +/** @description Retorna as informações de um carrinho pelo seu `id` ou `token` */ + "GET /api/v2/carts/:cart_id": { + + } +/** @description Permite excluir um carrinho */ + "DELETE /api/v2/carts/:cart_id": { + + } +/** @description Permite atualizar os atributos de um carrinho */ + "PATCH /api/v2/carts/:cart_id": { + searchParams: /** + * Parâmetros criação e atualização de carrinho + */ +export interface ParametrosDeCarrinhoResumido { + /** + * Agente que criou o carrinho + */ + agent?: string; + /** + * Código de Endereçamento Postal (CEP) do destinatário do pedido + */ + zip?: string; + /** + * Código identificador `ID` do cliente + */ + client_id?: number; + /** + * Código identificador `ID` do desconto do carrinho + */ + coupon_code?: string; + /** + * @deprecated + * Email do cliente + */ + email?: string; + /** + * Token do desconto + */ + rebate_token?: string; +} + + } +/** @description Remove um item do carrinho */ + "DELETE /api/v2/carts/:cart_id/items/:item_id": { + + } +/** @description Atualiza um item do carrinho */ + "PATCH /api/v2/carts/:cart_id/items/:item_id": { + searchParams: /** + * Modelo de carcaterística de produto para item no carrinho + */ +export interface Produto { + /** + * Código SKU da variante do produto + */ + sku?: string; + /** + * Unidades do produto disponíveis fisicamente + */ + quantity?: number; + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra?: {}; + /** + * Código identificador do local do produto + */ + place_id?: number; + /** + * Código de cupom + */ + store_coupon_code?: string; + /** + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto + */ + customizations?: { + /** + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. + * Se por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. + */ + Customization?: string; + }[]; +} + + } +/** @description Atualiza o método para o envio dos itens do carrinho */ + "PATCH /api/v2/carts/:cart_id/shipping_methods/:value_method": { + searchParams: /** + * Modelo que representa as formas de entrega na API + */ +export interface ShippingMethods { + /** + * Nome do tipo de entrega, como por exemplo Normal, Expressa e Agendada + */ + name?: string; + /** + * Identificador do método de envio + */ + value?: string; + /** + * Preço de envio + */ + price?: number; + /** + * Descrição do tipo de envio e prazo + */ + description?: string; + /** + * Número em dias do prazo de envio + */ + delivery_days?: number; + /** + * Valor restante da compra para que o carrinho fique elegível para frete grátis + */ + value_needed_to_discount?: number; + /** + * Código identificador `ID` do tipo de envio + */ + shipping_method_id?: number; + /** + * Mensagem ou observação sobre a forma de envio + */ + notice?: string; + /** + * Empresa responsável pelo envio + */ + fulfillment_company?: string; +} + + } +/** @description Calculo os método de envio disponíveis para o carrinho */ + "GET /api/v2/carts/:cart_id/shipping_methods": { + + } +/** @description Calcula as parcelas de pagamento para valor total do carrinho */ + "GET /api/v2/carts/:cart_id/installments": { + + } +/** @description Retorna os dados de um pedido pelo `code` ou `token` do pedido */ + "GET /api/v2/orders/:order_code": { + + } +/** @description Atualiza o campo de dados extras de um pedido pelo `code` do pedido */ + "PATCH /api/v2/orders/:order_code": { + searchParams: { + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra?: {}; +} + + } +/** @description Retorna a *timeline* de eventos ocorridos em um pedido */ + "GET /api/v2/orders/:order_code/events": { + + } +/** @description Retorna a avaliação que o cliente fez em um pedido */ + "GET /api/v2/orders/:order_code/reviews": { + + } +/** @description Retorna os descontos de um pedido pelo `code` ou `token` do pedido */ + "GET /api/v2/orders/:order_code/discounts": { + + } +/** @description Retorna o endereço de envio pelo `code` do pedido */ + "GET /api/v2/orders/:order_code/shipping_address": { + + } +/** @description Atualiza dados de endereço do pedido */ + "PATCH /api/v2/orders/:order_code/shipping_address": { + searchParams: /** + * Modelo de endereço de envio para carrinho e pedido + */ +export interface EnderecoDeEnvio { + /** + * Nome do cliente + */ + first_name?: string; + /** + * Sobrenome do cliente + */ + last_name?: string; + /** + * Nome da empresa (para clientes jurídicos) + */ + company_name?: string; + /** + * Email do cliente + */ + email?: string; + /** + * Código de Discagem Direta à Distância (DDD) + */ + first_phone_area?: string; + /** + * Telefone do cliente + */ + first_phone?: string; + /** + * Código de Discagem Direta à Distância (DDD) + */ + second_phone_area?: string; + /** + * Telefone do cliente + */ + second_phone?: string; + /** + * Nome do recebedor + */ + recipient_name?: { + [k: string]: unknown; + }; + /** + * Logradouro + */ + street_name?: string; + /** + * Número + */ + street_number?: string; + /** + * Complemento + */ + complement?: string; + /** + * Bairro + */ + neighborhood?: string; + /** + * Ponto de referência + */ + reference?: string; + /** + * Código de Endereçamento Postal (CEP) + */ + zip?: string; + documents?: { + /** + * Cadastro de Pessoa Física + */ + cpf?: string; + /** + * Registro Geral + */ + rg?: string; + /** + * Cadastro Nacional de Pessoas Jurídicas + */ + cnpj?: string; + /** + * Inscrição Estadual + */ + ie?: string; + }[]; +} + + } +/** @description Captura o pagamento no adquirente para pedidos com pagamento por cartão de crédito. */ + "POST /api/v2/orders/:order_code/capture": { + + } +/** @description Confirma um pedido */ + "POST /api/v2/orders/:order_code/confirm": { + searchParams: { + /** + * Parâmetro para incluir o retorno [da requisição de captura do pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-capture). + * Esse parâmetro é **obrigatório** para pedidos com pagamento por cartão de crédito. + */ + confirmation_data?: string; +} + + } +/** @description Faz o estorno do pagamento no adquirente do cartão de crédito +Operação válida para pedidos pagos com cartão de crédito */ + "POST /api/v2/orders/:order_code/chargeback": { + + } +/** @description Altera o status do pedido para `cancelado` */ + "POST /api/v2/orders/:order_code/cancel": { + searchParams: { + /** + * Parâmetro para incluir uma confirmação de estorno de pagamento para o cliente. + * Para pedidos com pagamento via cartão de crédito, é obrigatório que nesse campo seja incluído no parâmetro o retorno [da requisição de estorno de pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-order-code-chargeback). + */ + cancelation_data?: string; +} + + } +/** @description Retorna os itens de um pedido pelo código do pedido */ + "GET /api/v2/orders/:order_code/items": { + + } +/** @description Lista as personalizações de um item do pedido pelos códigos do item e do pedido */ + "GET /api/v2/orders/:order_code/items/:item_id/customizations": { + + } +/** @description Retorna os pedidos de um cliente pelo seu `id_client` */ + "GET /api/v2/clients/:id_client/orders": { + + } +/** @description Retorna as notas fisicais de um pacote do pedido */ + "GET /api/v2/orders/:order_code/packages/:package_code/invoices": { + + } +/** @description Inclui nota fiscal no pacote de um pedido */ + "POST /api/v2/orders/:order_code/packages/:package_code/invoices": { + searchParams: /** + * Modelo que representa uma nota fiscal na API + */ +export interface Invoice { + /** + * Número da nota fiscal + */ + number?: number; + /** + * Número de série da nota fiscal + */ + series?: number; + /** + * Data e horário da criação da nota fiscal + */ + issued_at?: string; + /** + * Chave da nota fiscal + */ + key?: string; + volumes?: number; +} + + } +/** @description Remove uma nota fiscal */ + "DELETE /api/v2/orders/:order_code/packages/:package_code/invoices/:number": { + + } +/** @description Atualiza uma nota fiscal */ + "PATCH /api/v2/orders/:order_code/packages/:package_code/invoices/:number": { + searchParams: /** + * Modelo que representa uma nota fiscal na API + */ +export interface Invoice { + /** + * Número da nota fiscal + */ + number?: number; + /** + * Número de série da nota fiscal + */ + series?: number; + /** + * Data e horário da criação da nota fiscal + */ + issued_at?: string; + /** + * Chave da nota fiscal + */ + key?: string; + volumes?: number; +} + + } +/** @description Permite listar os pedidos pendentes do feed */ + "GET /api/feed/orders": { + + } +/** @description Permite marcar os pedidos para que eles sejam filtrados da listagem do feed */ + "POST /api/feed/orders": { + searchParams: { + orders?: { + /** + * Código do pedido + */ + code?: string; + }[]; +} + + } +} \ No newline at end of file diff --git a/vnda/utils/openapi/vnda.openapi.json b/vnda/utils/openapi/vnda.openapi.json new file mode 100644 index 000000000..d58be1017 --- /dev/null +++ b/vnda/utils/openapi/vnda.openapi.json @@ -0,0 +1,19372 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "API", + "version": "v2", + "contact": { + "name": "Dúvidas e suporte para API, envie um e-mail para", + "email": "produto@vnda.com.br" + }, + "description": "API versão 2 da Vnda E-commerce.\nSaiba mais no nosso [Guia de API](https://developers.vnda.com.br/docs/chave-de-acesso-e-requisicoes)", + "license": { + "name": "API Vnda", + "url": "https://www.vnda.com.br/" + } + }, + "servers": [ + { + "url": "https://api.vnda.com.br", + "description": "Servidor do ambiente de produção" + }, + { + "url": "https://api.sandbox.vnda.com.br", + "description": "Servidor do ambiente de testes" + } + ], + "paths": { + "/api/v2/users/authorize": { + "post": { + "summary": "User authorize", + "responses": { + "200": { + "description": "Retornado quando o access token do usuário ainda é válido e a senha está correta" + }, + "401": { + "description": "Retornado quando o access_token não é mais válido e/ou a senha está incorreta" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "type": "string" + }, + "password": { + "type": "string" + } + }, + "type": "object", + "required": [ + "access_token", + "password" + ] + } + } + }, + "description": "" + }, + "description": "Permite autorizar operações usando o access_token e a senha do usuário", + "parameters": [], + "operationId": "post-api-v2-users-authorize", + "tags": [ + "Usuários" + ] + } + }, + "/api/v2/users/login": { + "post": { + "summary": "Faz o login do usuário", + "responses": { + "200": { + "description": "Quando o usuário e a senha são válidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User.v1" + } + } + } + }, + "401": { + "description": "Quando o usuário e/ou a senha não são válidos ou não foram passados" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "email": { + "type": "string", + "format": "email" + }, + "password": { + "type": "string" + } + }, + "type": "object", + "required": [ + "email", + "password" + ] + } + } + }, + "description": "" + }, + "description": "Realiza o login do usuário a partir do email e da senha", + "parameters": [], + "operationId": "post-api-v2-users-login", + "tags": [ + "Usuários" + ] + } + }, + "/api/v2/users/logout": { + "post": { + "summary": "Faz o logout do usuário", + "responses": { + "200": { + "description": "Quando o usuário atual existe" + }, + "404": { + "description": "Quando o usuário atual não existe" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "access_token": { + "type": "string", + "description": "Token de validação de usuário logado\n\nO `access_token` é gerado quando o usuário loga no Admin " + } + }, + "type": "object" + } + } + }, + "description": "" + }, + "description": "Realiza o logout do usuário a partir do access_token do mesmo", + "parameters": [], + "operationId": "post-api-v2-users-logout", + "tags": [ + "Usuários" + ] + } + }, + "/api/v2/users/{id}": { + "get": { + "summary": "User", + "responses": { + "200": { + "description": "Retorna os dados do usuário", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User.v1" + }, + "examples": { + "Usuário": { + "value": { + "id": 1, + "email": "foo@vnda.com.br", + "name": null, + "admin": false, + "renew_password": false, + "role": 1, + "access_token": "706a99d0706a99d070006a99d0706a99d0706a99d0706a99d0706a99d0706a99d0", + "tags": [], + "external_code": null, + "created_at": "2019-11-06T08:50:37.130-03:00", + "updated_at": "2020-03-26T10:40:33.730-03:00" + } + } + } + } + } + } + }, + "parameters": [], + "tags": [ + "Usuários" + ], + "operationId": "get-api-v2-users-id", + "description": "Retorna os dados de um usuário pelo seu ID" + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "put": { + "summary": "Atualiza um usuário", + "operationId": "put-api-v2-users-id", + "responses": { + "204": { + "description": "Quando o usuário é atualizado" + }, + "404": { + "description": "Quando o usuário não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Usuários" + ], + "description": "Atualiza um usuário", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "role_name": { + "type": "string", + "enum": [ + "Agente", + "Gestor", + "Local" + ] + }, + "password": { + "type": "string" + }, + "password_confirmation": { + "type": "string" + }, + "external_code": { + "type": "string" + }, + "phone_area": { + "type": "string", + "maxLength": 2 + }, + "phone": { + "type": "string", + "maxLength": 9 + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/api/v2/credits/rules/versions": { + "get": { + "summary": "Lista as versões da regra de bônus", + "tags": [ + "Créditos" + ], + "responses": { + "200": { + "description": "Quando as versões da regra são retornadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "event": { + "type": "string" + }, + "author": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "ip": { + "type": "string" + }, + "user_agent": { + "type": "string" + }, + "cart_id": { + "type": "string" + }, + "object_changes": { + "type": "string" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-credits-rules-versions", + "parameters": [], + "description": "Retorna as versões da regra de bônus cadastrada" + } + }, + "/api/v2/credits/rules": { + "get": { + "summary": "Regras de bônus", + "tags": [ + "Créditos" + ], + "responses": { + "200": { + "description": "Quando as regras são retornadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "active": { + "type": "boolean" + }, + "minimum_subtotal": { + "type": "number", + "minimum": 0 + }, + "bonus": { + "type": "number", + "minimum": 1 + }, + "delayed_for": { + "type": "number", + "minimum": 0 + }, + "valid_for": { + "type": "number", + "minimum": 1, + "exclusiveMinimum": false + }, + "maximum_usage_factor": { + "type": "number", + "minimum": 0, + "maximum": 1, + "exclusiveMaximum": false, + "exclusiveMinimum": true + } + }, + "required": [ + "active", + "minimum_subtotal", + "bonus", + "delayed_for", + "valid_for", + "maximum_usage_factor" + ] + }, + "examples": { + "example-1": { + "value": { + "active": true, + "minimum_subtotal": 100, + "bonus": 10, + "delayed_for": 5, + "valid_for": 30, + "maximum_usage_factor": 0.3 + } + } + } + } + } + } + }, + "operationId": "get-api-v2-credits-rules", + "parameters": [], + "description": "Retorna as regras de bônus cadastradas" + }, + "put": { + "summary": "Atualiza a regras de bônus", + "operationId": "put-api-v2-credits-rules", + "responses": { + "204": { + "description": "Quando a regra é atualizada" + } + }, + "description": "Permite atualizar as regras de bônus", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "bonus": { + "type": "number", + "format": "float", + "minimum": 1, + "exclusiveMinimum": false, + "description": "Percentual em cima do total do pedido que vai ser dado de bônus para o cliente" + }, + "valid_in": { + "type": "integer", + "description": "Número de dias em que o crédito começa a valer", + "minimum": 0 + }, + "valid_for": { + "type": "integer", + "description": "Número de dias para a expiração do crédito", + "minimum": 1 + }, + "minimum_subtotal": { + "type": "number", + "description": "Valor mínimo do pedido para que o bônus possa ser transferido para o cliente", + "format": "float", + "minimum": 1, + "exclusiveMinimum": false + }, + "maximum_usage_factor": { + "type": "number", + "default": 1, + "minimum": 0, + "exclusiveMinimum": true, + "maximum": 1, + "description": "Percentual do subtotal do pedido que pode ser pago com o bônus" + } + }, + "required": [ + "bonus", + "valid_in", + "valid_for" + ] + } + } + }, + "description": "Parâmetros" + }, + "parameters": [], + "tags": [ + "Créditos" + ] + }, + "delete": { + "summary": "Remove as regras de bônus", + "operationId": "delete-api-v2-credits-rules", + "responses": { + "204": { + "description": "Quando o bônus é removido" + } + }, + "tags": [ + "Créditos" + ], + "description": "Permite remover as regras de bônus, desativando o recurso" + } + }, + "/api/v2/orders/{code}": { + "parameters": [ + { + "schema": { + "type": "string", + "minLength": 10, + "maxLength": 64 + }, + "name": "code", + "in": "path", + "required": true, + "description": "O \"code\" do pedido ou o \"token\"" + }, + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_customizations_in_total", + "description": "Inclui o preço dos produtos customizados no total do pedido" + } + ], + "get": { + "summary": "Retorna um pedido", + "tags": [ + "Pedidos" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + } + }, + "operationId": "get-api-v2-orders-code", + "description": "Retorna os dados de um pedido usando o `code` ou `token`", + "parameters": [ + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_shipping_address", + "description": "Retorna as formas de entrega do pedido" + } + ] + } + }, + "/api/v2/orders": { + "get": { + "summary": "Lista os pedidos", + "tags": [ + "Pedidos" + ], + "responses": { + "200": { + "description": "Quando os pedidos são retornados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + } + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-orders", + "description": "Retorna uma lista de pedidos", + "parameters": [ + { + "$ref": "#/components/parameters/start" + }, + { + "$ref": "#/components/parameters/finish" + }, + { + "$ref": "#/components/parameters/invoiced" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/coupon_codes" + }, + { + "$ref": "#/components/parameters/include_customizations_in_total" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/start" + }, + { + "$ref": "#/components/parameters/finish" + }, + { + "$ref": "#/components/parameters/invoiced" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/coupon_codes" + }, + { + "$ref": "#/components/parameters/include_customizations_in_total" + } + ] + }, + "/api/v2/orders/{code}/capture": { + "post": { + "summary": "Captura", + "operationId": "post-api-v2-orders-capture", + "responses": { + "200": { + "description": "Quando a captura foi realizada com sucesso", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {} + }, + "examples": { + "Pagar.me": { + "value": { + "object": "transaction", + "status": "paid", + "refuse_reason": null, + "status_reason": "acquirer", + "acquirer_response_code": "0000", + "acquirer_name": "pagarme", + "acquirer_id": "5eab10915eab10915eab1091", + "authorization_code": "123456", + "soft_descriptor": "", + "tid": 1234567, + "nsu": 1234567, + "date_created": "2020-05-14T19:14:50.322Z", + "date_updated": "2020-05-15T14:19:34.699Z", + "amount": 1400, + "authorized_amount": 1400, + "paid_amount": 1400, + "refunded_amount": 0, + "installments": 1, + "id": 1234567, + "cost": 120, + "card_holder_name": "John Doe", + "card_last_digits": "6565", + "card_first_digits": "470373", + "card_brand": "visa", + "card_pin_mode": null, + "card_magstripe_fallback": false, + "cvm_pin": false, + "postback_url": "https://demo.vnda.com.br/api/v2/payments/pagarme/notifications", + "payment_method": "credit_card", + "capture_method": "ecommerce", + "antifraud_score": null, + "boleto_url": null, + "boleto_barcode": null, + "boleto_expiration_date": null, + "referer": "api_key", + "ip": "127.0.0.1", + "subscription_id": null, + "phone": null, + "address": null, + "customer": { + "object": "customer", + "id": 2954669, + "external_id": "example@vnda.com.br", + "type": "individual", + "country": "br", + "document_number": null, + "document_type": "cpf", + "name": "John Doe", + "email": "example@vnda.com.br", + "phone_numbers": [ + "+5511111111111" + ], + "born_at": null, + "birthday": null, + "gender": null, + "date_created": "2020-05-14T19:14:50.248Z", + "documents": [ + { + "object": "document", + "id": "doc_cka75cka75cka75cka75cka75", + "type": "cpf", + "number": 191 + } + ] + }, + "billing": { + "object": "billing", + "id": 1255695, + "name": "John Doe", + "address": { + "object": "address", + "street": "Rua João Neves da Fontoura", + "complementary": null, + "street_number": "1", + "neighborhood": "Azenha", + "city": "Porto Alegre", + "state": "RS", + "zipcode": "90050030", + "country": "br", + "id": 2808888 + } + }, + "shipping": null, + "items": [ + { + "object": "item", + "id": "05.01.4.1.006", + "title": "Aceto Balsâmico Di Modena IGP 500ml Aceto Balsamico Di Modena IGP 500ml", + "unit_price": 1400, + "quantity": 1, + "category": null, + "tangible": true, + "venue": null, + "date": null + } + ], + "card": { + "object": "card", + "id": "card_cka75cka75cka75cka75cka75", + "date_created": "2020-05-14T19:14:50.307Z", + "date_updated": "2020-05-14T19:14:50.717Z", + "brand": "visa", + "holder_name": "f dc", + "first_digits": "470373", + "last_digits": "6565", + "country": "RUSSIA", + "fingerprint": "cka75cka75cka75cka75cka75", + "valid": true, + "expiration_date": "0423" + }, + "split_rules": null, + "metadata": { + "order": "7A4F490570", + "seller-1": { + "name": "default", + "package": "7A4F490570-01" + } + }, + "antifraud_metadata": {}, + "reference_key": null, + "device": null, + "local_transaction_id": null, + "local_time": null, + "fraud_covered": false, + "fraud_reimbursed": null, + "order_id": null, + "risk_level": "very_low", + "receipt_url": null, + "payment": null, + "addition": null, + "discount": null, + "private_label": null + } + } + } + } + } + }, + "422": { + "description": "Quando não foi possível realizar a captura junto ao adquirente", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "failure": { + "value": { + "error": "Capture was unsuccessful" + } + } + } + } + } + } + }, + "description": "Faz a captura do pagamento no adquirente\nApenas para pedidos pagos com cartão de crédito", + "tags": [ + "Pedidos" + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ] + }, + "/api/v2/orders/{code}/confirm": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Confirma", + "operationId": "post-api-v2-orders-code-confirm", + "responses": { + "200": { + "description": "OK" + } + }, + "description": "Altera o status do pedido para \"confirmado\"", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "confirmation_data": { + "type": "string", + "description": "Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para \"/api/v2/orders/{code}/capture\"" + } + } + }, + "examples": { + "Depósito": { + "value": { + "banco": "Banco do Brasil", + "data_credito": "2020-03-26", + "conferido_por": "Nome do usuário do financeiro" + } + }, + "Cartão de crédito via Pagar.me": { + "value": { + "object": "transaction", + "status": "paid", + "refuse_reason": null, + "status_reason": "acquirer", + "acquirer_response_code": "0000", + "acquirer_name": "pagarme", + "acquirer_id": "5eab10915eab10915eab1091", + "authorization_code": "123456", + "soft_descriptor": "", + "tid": 1234567, + "nsu": 1234567, + "date_created": "2020-05-14T19:14:50.322Z", + "date_updated": "2020-05-15T14:19:34.699Z", + "amount": 1400, + "authorized_amount": 1400, + "paid_amount": 1400, + "refunded_amount": 0, + "installments": 1, + "id": 1234567, + "cost": 120, + "card_holder_name": "John Doe", + "card_last_digits": "6565", + "card_first_digits": "470373", + "card_brand": "visa", + "card_pin_mode": null, + "card_magstripe_fallback": false, + "cvm_pin": false, + "postback_url": "https://demo.vnda.com.br/api/v2/payments/pagarme/notifications", + "payment_method": "credit_card", + "capture_method": "ecommerce", + "antifraud_score": null, + "boleto_url": null, + "boleto_barcode": null, + "boleto_expiration_date": null, + "referer": "api_key", + "ip": "127.0.0.1", + "subscription_id": null, + "phone": null, + "address": null, + "customer": { + "object": "customer", + "id": 2954669, + "external_id": "example@vnda.com.br", + "type": "individual", + "country": "br", + "document_number": null, + "document_type": "cpf", + "name": "John Doe", + "email": "example@vnda.com.br", + "phone_numbers": [ + "+5511111111111" + ], + "born_at": null, + "birthday": null, + "gender": null, + "date_created": "2020-05-14T19:14:50.248Z", + "documents": [ + { + "object": "document", + "id": "doc_cka75cka75cka75cka75cka75", + "type": "cpf", + "number": 191 + } + ] + }, + "billing": { + "object": "billing", + "id": 1255695, + "name": "John Doe", + "address": { + "object": "address", + "street": "Rua João Neves da Fontoura", + "complementary": null, + "street_number": "1", + "neighborhood": "Azenha", + "city": "Porto Alegre", + "state": "RS", + "zipcode": "90050030", + "country": "br", + "id": 2808888 + } + }, + "shipping": null, + "items": [ + { + "object": "item", + "id": "05.01.4.1.006", + "title": "Aceto Balsâmico Di Modena IGP 500ml Aceto Balsamico Di Modena IGP 500ml", + "unit_price": 1400, + "quantity": 1, + "category": null, + "tangible": true, + "venue": null, + "date": null + } + ], + "card": { + "object": "card", + "id": "card_cka75cka75cka75cka75cka75", + "date_created": "2020-05-14T19:14:50.307Z", + "date_updated": "2020-05-14T19:14:50.717Z", + "brand": "visa", + "holder_name": "f dc", + "first_digits": "470373", + "last_digits": "6565", + "country": "RUSSIA", + "fingerprint": "cka75cka75cka75cka75cka75", + "valid": true, + "expiration_date": "0423" + }, + "split_rules": null, + "metadata": { + "order": "7A4F490570", + "seller-1": { + "name": "default", + "package": "7A4F490570-01" + } + }, + "antifraud_metadata": {}, + "reference_key": null, + "device": null, + "local_transaction_id": null, + "local_time": null, + "fraud_covered": false, + "fraud_reimbursed": null, + "order_id": null, + "risk_level": "very_low", + "receipt_url": null, + "payment": null, + "addition": null, + "discount": null, + "private_label": null + } + } + } + } + }, + "description": "" + }, + "tags": [ + "Pedidos" + ] + } + }, + "/api/v2/orders/{code}/chargeback": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Estorna", + "operationId": "post-api-v2-orders-code-chargeback", + "responses": { + "200": { + "description": "OK" + }, + "422": { + "description": "Unprocessable Entity" + } + }, + "description": "Faz o estorno do pagamento no adquirente\nApenas para pedidos pagos com cartão de crédito", + "tags": [ + "Pedidos" + ] + } + }, + "/api/v2/orders/{code}/cancel": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Cancela", + "operationId": "post-api-v2-orders-code-cancel", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "description": "Altera o status do pedido para \"cancelado\"", + "tags": [ + "Pedidos" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cancelation_data": { + "type": "string", + "description": "Deve ser enviado algo que comprove que o pagamento foi devolvido.\nPara cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para \"/api/v2/orders/{code}/chargeback\"" + } + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/ship": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Altera para enviado", + "operationId": "patch-api-v2-orders-code-packages-code-ship", + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Pedido ou rastreio não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Altera o status do pacote para \"enviado\"", + "tags": [ + "Pacotes" + ], + "parameters": [] + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/deliver": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Altera para entregue", + "operationId": "patch-api-v2-orders-code-packages-code-deliver", + "responses": { + "200": { + "description": "OK" + }, + "404": { + "description": "Pedido ou rastreio não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Altera o pacote para \"entregue\"", + "tags": [ + "Pacotes" + ] + } + }, + "/api/v2/variants/quantity": { + "post": { + "summary": "Atualiza em lote", + "operationId": "post-api-v2-variants-quantity", + "responses": { + "200": { + "description": "OK" + } + }, + "tags": [ + "Estoque" + ], + "description": "Recebe uma lista JSON com os SKUs que devem ser atualizados. A atualização será executada em segundo plano em aproximadamente 1 minuto ", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "place_id": { + "type": "integer", + "description": "Informe somente para atualizar o estoque de um local específico" + } + }, + "required": [ + "sku", + "quantity" + ] + } + }, + "examples": { + "Exemplo": { + "value": [ + { + "sku": "21390", + "quantity": 12, + "place_id": 1 + }, + { + "sku": "21827", + "quantity": 12 + } + ] + } + } + } + }, + "description": "" + } + } + }, + "/api/v2/variants/{sku}/quantity": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "sku", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Atualiza", + "operationId": "post-api-v2-variants-sku-quantity", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "examples": { + "Exemplo": { + "value": { + "status": "ok" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "examples": { + "Exemplo": { + "value": { + "status": "error", + "message": "A quantity must be provided to update stock" + } + } + } + } + } + } + }, + "tags": [ + "Estoque" + ], + "description": "Atualiza o estoque de uma variante de um produto", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "quantity", + "required": true + } + ] + } + }, + "/api/v2/variants/{sku}/inventories/{place_id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "sku", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "place_id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um local", + "operationId": "patch-api-v2-variants-sku-inventories-place_id", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + } + } + }, + "examples": { + "Exemplo": { + "value": { + "status": "ok" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "examples": { + "Exemplo": { + "value": { + "status": "error", + "message": "Quantity or price must be provided to update stock" + } + } + } + } + } + } + }, + "tags": [ + "Estoque" + ], + "description": "Atualiza o estoque específico de um local", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "quantity" + } + ] + } + }, + "/api/v2/products/{product_id}/variants": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "product_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as variantes", + "tags": [ + "Variantes" + ], + "responses": { + "200": { + "description": "Quando as variantes são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variant" + } + }, + "examples": { + "example-1": { + "value": [ + { + "id": 95, + "main": true, + "available": true, + "sku": "123", + "name": "Variation", + "slug": "variation", + "min_quantity": 1, + "quantity": 1, + "quantity_sold": 0, + "stock": 1, + "custom_attributes": {}, + "properties": {}, + "updated_at": "2020-10-27T11:54:32.018-03:00", + "price": 10, + "installments": [ + 10 + ], + "available_quantity": 1, + "weight": 0.001, + "width": 1, + "height": 1, + "length": 1, + "handling_days": 0, + "inventories": [], + "sale_price": 10, + "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/variation.jpg", + "product_id": 6, + "barcode": null, + "norder": 1 + }, + { + "id": 27, + "main": false, + "available": true, + "sku": "13001", + "name": "Tamanho: PP | Cor: Branca", + "slug": "camiseta", + "min_quantity": 1, + "quantity": 85, + "stock": 83, + "custom_attributes": { + "size": "PP", + "color": "#FFFFFF" + }, + "properties": {}, + "updated_at": "2019-08-01T18:36:52.718-03:00", + "price": 169.9, + "installments": [ + 169.9 + ], + "available_quantity": 83, + "weight": 0.1, + "width": 11, + "height": 2, + "length": 16, + "handling_days": 0, + "inventories": [], + "sale_price": 169.9, + "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/camiseta.jpg", + "product_id": 6, + "barcode": null, + "norder": 1 + } + ] + } + } + } + } + }, + "400": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "error": "invalid rate value" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-products-product_id-variants", + "description": "Permite listar as variantes de um produto" + }, + "post": { + "summary": "Cria uma variante", + "operationId": "post-api-v2-products-product_id-variants", + "responses": { + "201": { + "description": "Quando a variante é criada", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "min_quantity": { + "type": "integer" + }, + "quantity": { + "type": "integer" + }, + "stock": { + "type": "integer", + "description": "Quantidade de itens disponíveis" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "properties": { + "type": "object" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização" + }, + "price": { + "type": "integer" + }, + "installments": { + "type": "array", + "items": { + "type": "integer" + } + }, + "available_quantity": { + "type": "integer" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "handling_days": { + "type": "number", + "description": "Dias de manuseio da variante" + }, + "inventories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variant_inventory.v1" + } + }, + "sale_price": { + "type": "number" + }, + "image_url": { + "type": "string" + }, + "product_id": { + "type": "integer" + }, + "norder": { + "type": "integer" + } + } + }, + "examples": { + "example-1": { + "value": { + "id": 95, + "main": false, + "available": true, + "sku": "SHOP0001", + "name": "Variation", + "slug": "variation", + "min_quantity": 1, + "quantity": 1, + "stock": 1, + "custom_attributes": {}, + "properties": {}, + "updated_at": "2020-10-27T11:54:32.018-03:00", + "price": 10, + "installments": [ + 10 + ], + "available_quantity": 1, + "weight": 0.001, + "width": 1, + "height": 1, + "length": 1, + "handling_days": 0, + "inventories": [], + "sale_price": 10, + "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/variation.jpg", + "product_id": 6, + "norder": 1 + } + } + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Variantes" + ], + "description": "Permite criar uma variante", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "price": { + "type": "number" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "min_quantity": { + "type": "integer" + }, + "norder": { + "type": "integer" + }, + "property1": { + "type": "string", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "property2": { + "type": "string", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "property3": { + "type": "string", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "barcode": { + "type": "string" + } + }, + "required": [ + "sku", + "quantity", + "price" + ] + } + } + } + } + } + }, + "/api/v2/products/{product_id}/variants/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "product_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza uma variante", + "operationId": "patch-api-v2-products-product_id-variants-id", + "responses": { + "204": { + "description": "Quando a variante é atualizada" + }, + "404": { + "description": "Quando a variante não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Variantes" + ], + "description": "Permite atualizar uma variante", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "width": { + "type": "number" + }, + "height": { + "type": "number" + }, + "length": { + "type": "number" + }, + "weight": { + "type": "number" + }, + "handling_days": { + "type": "integer" + }, + "price": { + "type": "number" + }, + "custom_attributes": { + "type": "object" + }, + "min_quantity": { + "type": "integer" + }, + "norder": { + "type": "integer" + }, + "property1": { + "type": "string" + }, + "property2": { + "type": "string" + }, + "property3": { + "type": "string" + }, + "barcode": { + "type": "string" + }, + "quantity_sold": { + "type": "integer" + } + }, + "required": [ + "sku", + "quantity", + "price" + ] + } + } + } + }, + "deprecated": true + }, + "delete": { + "summary": "Remove uma variante", + "operationId": "delete-api-v2-products-product_id-variants-id", + "responses": { + "204": { + "description": "Quando a variante é removida" + }, + "404": { + "description": "Quando a variante não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Variantes" + ], + "description": "Permite remover uma variante" + } + }, + "/api/v2/variants/reorder": { + "post": { + "summary": "Reordena as variantes", + "operationId": "post-api-v2-variants-reorder", + "responses": { + "200": { + "description": "Quando as variantes são reordenadas" + } + }, + "tags": [ + "Variantes" + ], + "description": "Permite determinar a ordem das variantes dentro de cada produto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "description": "A ordem dos elementos será replicada para as variantes", + "items": { + "type": "integer" + } + } + }, + "required": [ + "ids" + ] + }, + "examples": { + "example-1": { + "value": { + "ids": [ + 32, + 29, + 28, + 31, + 30, + 27 + ] + } + } + } + } + } + } + } + }, + "/api/v2/templates/{path}": { + "get": { + "summary": "Retorna um template", + "tags": [ + "Templates" + ], + "responses": { + "200": { + "description": "Quando um template é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Template.v1" + }, + "examples": { + "Template": { + "value": { + "path": "home.liquid", + "body": "

shop site!

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + }, + "Partial": { + "value": { + "path": "partials/components/product_block/_images_by_gender.liquid", + "body": "

partial template

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + } + } + } + } + }, + "404": { + "description": "Quando um template não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-templates-path", + "description": "Retorna um template usando o path dele", + "parameters": [] + }, + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "[0-9A-Za-z_\\.\\/]+" + }, + "name": "path", + "in": "path", + "required": true, + "description": "Caminho relativo do template" + } + ], + "patch": { + "summary": "Atualiza um template", + "operationId": "patch-api-v2-templates-path", + "responses": { + "204": { + "description": "Quando um template é atualizado com sucesso" + }, + "404": { + "description": "Quando um template não é contrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "tags": [ + "Templates" + ], + "parameters": [], + "description": "Atualiza o conteúdo de um template usando o path dele", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string" + } + } + }, + "examples": { + "Template": { + "value": { + "body": "

shop site!

" + } + }, + "Partial": { + "value": { + "body": "

partial template

" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove um template", + "operationId": "delete-api-v2-templates-path", + "responses": { + "204": { + "description": "Quando um template é excluído com sucesso" + }, + "404": { + "description": "Quando um template não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "description": "Remove um template usando o path dele", + "tags": [ + "Templates" + ], + "parameters": [] + } + }, + "/api/v2/templates": { + "post": { + "summary": "Cria um template", + "operationId": "post-api-v2-templates", + "responses": { + "201": { + "description": "Quando um template é criado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Template.v1" + }, + "examples": { + "Template": { + "value": { + "path": "home.liquid", + "body": "

shop site!

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + }, + "Partial": { + "value": { + "path": "partials/components/product_block/_images_by_gender.liquid", + "body": "

partial template

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + } + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + }, + "examples": { + "Parâmetro `path` em branco": { + "value": { + "errors": { + "path": [ + "não pode ficar em branco" + ] + } + } + } + } + } + } + } + }, + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "body": { + "type": "string" + } + }, + "required": [ + "path" + ] + }, + "examples": { + "Template": { + "value": { + "path": "home.liquid", + "body": "

shop site!

" + } + }, + "Partial": { + "value": { + "path": "partials/components/product_block/_images_by_gender.liquid", + "body": "

partial template

" + } + } + } + } + } + }, + "tags": [ + "Templates" + ], + "description": "Cria um novo template" + }, + "get": { + "summary": "Lista os templates", + "operationId": "get-api-v2-templates", + "responses": { + "200": { + "description": "Quando os templates são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Template.v1" + } + }, + "examples": { + "Template": { + "value": [ + { + "path": "home.liquid", + "body": "

shop site!

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + ] + }, + "Partial": { + "value": [ + { + "path": "partials/components/product_block/_images_by_gender.liquid", + "body": "

partial template

", + "updated_at": "2020-05-17T21:37:38.000-03:00" + } + ] + }, + "Sem templates": { + "value": [] + } + } + } + } + } + }, + "description": "Retorna uma lista de templates", + "parameters": [], + "tags": [ + "Templates" + ] + } + }, + "/api/v2/users/{id}/activate": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Ativar", + "operationId": "post-api-v2-users-id-activate", + "responses": { + "200": { + "description": "Quando a ativação foi realizada com sucesso" + }, + "404": { + "description": "Quando o usuário não é encontrado" + } + }, + "description": "Reativa um usuário que estiver desativado", + "tags": [ + "Usuários" + ] + } + }, + "/api/v2/users/{id}/deactivate": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Desativar", + "operationId": "post-api-v2-users-id-deactivate", + "responses": { + "200": { + "description": "Quando a desativação foi realizada com sucesso" + }, + "404": { + "description": "Quando o usuário não é encontrado" + } + }, + "tags": [ + "Usuários" + ], + "description": "Desativa um usuário" + } + }, + "/api/v2/users": { + "get": { + "summary": "Lista os usuários", + "operationId": "get-api-v2-users", + "responses": { + "200": { + "description": "Quando os usuários são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User.v1", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador do usuário" + }, + "email": { + "type": "string", + "format": "email", + "description": "Email do usuário" + }, + "access_token": { + "type": "string", + "description": "Token de validação de usuário logado (`access_token`)\n \nO `access_token` é gerado quando o usuário loga no Admin" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Nome do usuário" + }, + "admin": { + "type": "boolean", + "description": "Identificador de usuários administradores\n\nEsse atributo retorna `true` para um usuário administrador do ambiente de loja" + }, + "renew_password": { + "type": "boolean", + "description": "Identificador de usuários que atualizaram a senha inicial\n\nEsse atributo retorna `true` para um usuário que já redefiniu sua senha pelo menos uma vez" + }, + "role": { + "type": "integer", + "description": "Código da função do usuário na loja:\n\n - Agente: `0`;\n - Gestor: `1`;\n - Local: `2`;\n - Agente Social Selling: `3`." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tags para agrupamento de usuários\nAs tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão" + }, + "external_code": { + "type": "string", + "nullable": true, + "description": "Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema." + }, + "phone_area": { + "type": "string", + "maxLength": 2, + "minLength": 2, + "description": "Código de Discagem Direta a Distância (DDD) do telefone do usuário" + }, + "phone": { + "type": "string", + "maxLength": 9, + "minLength": 8, + "description": "Número de telefone do usuário" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Data de inclusão do usuário no Admin" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data de atualização das informações do usuário" + } + } + } + }, + "examples": { + "Usuários": { + "value": [ + { + "id": 1, + "email": "foo@vnda.com.br", + "name": null, + "admin": false, + "renew_password": false, + "role": 1, + "access_token": "706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0706a99d0", + "tags": [], + "external_code": null, + "created_at": "2019-11-06T08:50:37.130-03:00", + "updated_at": "2020-03-26T10:40:33.730-03:00" + } + ] + } + }, + "example": [ + { + "id": 1, + "email": "foo@vnda.com.br", + "name": "User 1", + "admin": true, + "renew_password": true, + "role": 1, + "access_token": "706a99d0706a99d070006a99d0706a99d0706a99d0706a99d0706a99d0706a99d0", + "tags": [], + "external_code": null, + "created_at": "2019-11-06T08:50:37.130-03:00", + "updated_at": "2020-03-26T10:40:33.730-03:00" + }, + { + "id": 1, + "email": "test@vnda.com.br", + "name": "User 2", + "admin": false, + "renew_password": false, + "role": 2, + "access_token": "706a99d0706a99dhgs070006a99d0706a99d0706a99d0706a99d0706a99d0706a99d0", + "tags": [], + "external_code": null, + "created_at": "2019-12-06T08:50:37.130-03:00", + "updated_at": "2020-04-26T10:40:33.730-03:00" + } + ] + } + } + }, + "401": { + "description": "Token de acesso inválido" + }, + "404": { + "description": "Domínio da loja inválido", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Usuários" + ], + "description": "Lista os usuários", + "parameters": [ + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_inactive", + "description": "Incluir usuários desativados?" + }, + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_images", + "description": "Incluir todas as imagens dos produtos?" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "external_code", + "description": "Exibe somente os usuários com o código externo indicado" + }, + { + "schema": { + "type": "string", + "enum": [ + "Agente", + "Gestor", + "Local" + ] + }, + "in": "query", + "name": "role_name", + "description": "Exibe somente os usuários com a função indicada" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "term", + "description": "Filtra usuários que contenham o valor indicado no nome, telefone, email ou código externo" + } + ] + }, + "post": { + "summary": "Cria um usuário", + "operationId": "post-api-v2-users", + "responses": { + "200": { + "description": "Quando o usuário é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User.v1" + } + } + } + }, + "201": { + "description": "Usuário criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Usuários" + ], + "description": "Cria um usuário", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "name": { + "type": "string" + }, + "role_name": { + "type": "string", + "enum": [ + "Agente", + "Gestor", + "Local" + ] + }, + "password": { + "type": "string" + }, + "password_confirmation": { + "type": "string" + }, + "external_code": { + "type": "string" + }, + "phone_area": { + "type": "string", + "maxLength": 2 + }, + "phone": { + "type": "string", + "maxLength": 9 + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/api/v2/users/tags": { + "get": { + "summary": "Lista as tags dos usuários a partir das funções", + "operationId": "get-api-v2-users-tags", + "responses": { + "200": { + "description": "Quando as tags são retornadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "tags": [ + "Usuários" + ], + "description": "Lista os usuários", + "parameters": [ + { + "schema": { + "type": "string", + "enum": [ + "Agente", + "Gestor", + "Local", + "Agente Social Selling" + ] + }, + "in": "query", + "name": "role_names", + "description": "Exibe somente os usuários com a função indicada" + } + ] + } + }, + "/api/v2/carts": { + "get": { + "summary": "Lista os carrinhos", + "operationId": "get-api-v2-carts", + "responses": { + "200": { + "$ref": "#/components/responses/Carts" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "tags": [ + "Carrinhos" + ], + "description": "Retorna a lista de carrinhos ativos nos últimos 60 dias", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Quantidade de produtos por página" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "without_phones", + "description": "Inclui os carrinhos sem telefone (não enviar o campo para não incluir)" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "with_payments", + "description": "Filtra os carrinhos que possuem tentativa de pagamento" + } + ] + }, + "post": { + "summary": "Cria um carrinho", + "operationId": "post-api-v2-carts", + "description": "Permite criar um carrinho", + "tags": [ + "Carrinhos da loja" + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "ipv4" + }, + "in": "header", + "name": "X-Browser-Ip", + "description": "Internet Protocol (IP) da máquina de onde é criado o carrinho", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "header", + "name": "X-User-Agent", + "description": "Identificador da origem do carrinho na loja (como navegador ou dispositivo)", + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.simple" + } + } + }, + "description": "" + }, + "responses": { + "201": { + "description": "Carrinho criado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/carts/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true, + "description": "Pode ser o id ou o token do carrinho" + } + ], + "patch": { + "summary": "Atualiza um carrinho", + "operationId": "patch-api-v2-carts-id", + "responses": { + "204": { + "description": "Quando o carrinho é atualizado com sucesso" + }, + "404": { + "description": "Quando o carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + }, + "examples": { + "Com um email inválido": { + "value": { + "errors": { + "client": [ + "não é válido" + ] + } + } + } + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "agent": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "client_id": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "email": { + "type": "string", + "description": "DEPRECATED: enviar o `client_id`", + "format": "email" + }, + "rebate_token": { + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Carrinhos" + ], + "description": "Permite atualizar os atributos de um carrinho", + "parameters": [] + }, + "delete": { + "summary": "Exclui um carrinho", + "operationId": "delete-api-v2-carts-id", + "responses": { + "204": { + "description": "Quando um carrinho é excluído com sucesso" + }, + "404": { + "description": "Quando um carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "tags": [ + "Carrinhos" + ], + "description": "Permite excluir um carrinho", + "parameters": [] + }, + "get": { + "summary": "Retorna um carrinho", + "operationId": "get-api-v2-carts-id", + "responses": { + "200": { + "description": "Quando o carrinho é encontrado", + "headers": { + "X-Attempt-Count": { + "schema": { + "type": "integer" + }, + "description": "O número de tentativas de pagamento" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "404": { + "description": "Quando um carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "tags": [ + "Carrinhos" + ], + "description": "Permite retornar um carrinho", + "parameters": [] + }, + "post": { + "summary": "Cria um carrinho", + "operationId": "post-api-v2-carts-id", + "responses": { + "201": { + "description": "Quando um carrinho é criado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + }, + "examples": { + "Sem os parâmetros obrigatórios": { + "value": { + "errors": { + "browser_ip": [ + "não pode ficar em branco" + ], + "user_agent": [ + "não pode ficar em branco" + ] + } + } + } + } + } + } + } + }, + "description": "Permite criar um carrinho", + "tags": [ + "Carrinhos" + ], + "parameters": [ + { + "schema": { + "type": "string", + "format": "ipv4" + }, + "in": "header", + "name": "X-Browser-Ip", + "description": "IP do usuário que está criando o carrinho na loja", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "header", + "name": "X-User-Agent", + "description": "User-Agent do navegador do usuário criando o carrinho na loja", + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "agent": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "client_id": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "coupon_code": { + "type": "string" + }, + "email": { + "type": "string", + "description": "DEPRECATED: enviar o `client_id`", + "format": "email" + }, + "rebate_token": { + "type": "string" + } + } + } + } + }, + "description": "" + } + } + }, + "/api/v2/carts/{id}/installments": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna as parcelas do total de um carrinho", + "tags": [ + "Carrinhos" + ], + "responses": { + "200": { + "description": "Quando o carrinho é encontrado", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart_installment.v1" + } + } + } + } + }, + "404": { + "description": "Quando um carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "Não encontrado": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-carts-id-installments", + "description": "Permite calcular as parcelas referentes ao total do carrinho", + "parameters": [] + } + }, + "/api/v2/places": { + "get": { + "summary": "Lista os locais", + "tags": [ + "Locais" + ], + "responses": { + "200": { + "description": "Quando os locais são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Place.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-places", + "description": "Lista os locais", + "parameters": [ + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "names", + "description": "Filtra os locais for nome" + }, + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "warehouse", + "description": "Filtra os locais que são/não são warehouse" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "category", + "description": "Filtra os locais que contenham determinada categoria" + }, + { + "schema": { + "type": "string", + "example": "-30.1087957,-51.3172282" + }, + "in": "query", + "name": "coordinates", + "description": "As lojas mais próximas da coordenada informada serão exibidas primeiro" + }, + { + "schema": { + "type": "string", + "pattern": "^[0-9]{8}$" + }, + "in": "query", + "name": "origin_zip_code", + "description": "As lojas mais próximas do CEP informado serão exibidas primeiro" + } + ] + }, + "post": { + "summary": "Cria um local", + "operationId": "post-api-v2-places", + "responses": { + "201": { + "description": "Quando o local é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Place.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos" + } + }, + "tags": [ + "Locais" + ], + "description": "Cria um local", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "address_line_1": { + "type": "string", + "maxLength": 80 + }, + "address_line_2": { + "type": "string", + "maxLength": 80 + }, + "city": { + "type": "string", + "maxLength": 80 + }, + "neighborhood": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "home_page": { + "type": "string" + }, + "latitude": { + "type": "number" + }, + "longitude": { + "type": "number" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string", + "maxLength": 200 + }, + "email": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "mobile_phone": { + "type": "string", + "default": "false" + }, + "only_cash": { + "type": "boolean" + }, + "categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "marker_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "opening_hours": { + "type": "string" + }, + "warehouse": { + "type": "boolean" + }, + "legal_name": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + }, + "required": [ + "name", + "address_line_1", + "city", + "email" + ] + } + } + } + } + } + }, + "/api/v2/places/{id}": { + "parameters": [ + { + "schema": { + "type": "integer" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um local", + "operationId": "patch-api-v2-places-id", + "responses": { + "204": { + "description": "Quando o local é atualizado" + }, + "404": { + "description": "Quando o local não é encontrado" + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Locais" + ], + "description": "Atualiza um local", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "address_line_1": { + "type": "string", + "maxLength": 80 + }, + "address_line_2": { + "type": "string", + "maxLength": 80 + }, + "city": { + "type": "string", + "maxLength": 80 + }, + "neighborhood": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "home_page": { + "type": "string" + }, + "latitude": { + "type": "number" + }, + "longitude": { + "type": "number" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string", + "maxLength": 200 + }, + "email": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "mobile_phone": { + "type": "string", + "default": "false" + }, + "only_cash": { + "type": "boolean" + }, + "categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "marker_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "opening_hours": { + "type": "string" + }, + "warehouse": { + "type": "boolean" + }, + "legal_name": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + }, + "required": [ + "name", + "address_line_1", + "city", + "email" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove um local", + "operationId": "delete-api-v2-places-id", + "responses": { + "204": { + "description": "Quando o local é removido" + }, + "404": { + "description": "Quando o local não é encontrado" + } + }, + "tags": [ + "Locais" + ], + "description": "Remove um local" + } + }, + "/api/v2/orders/{code}/packages/{package_code}/invoices": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as notas fiscais", + "tags": [ + "Notas fiscais" + ], + "responses": { + "200": { + "description": "Quando as notas fiscais são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-orders-code-packages-package_code-invoices", + "description": "Lista as notas fiscais" + }, + "post": { + "summary": "Cria uma nota fiscal", + "operationId": "post-api-v2-orders-code-packages-package_code-invoices", + "responses": { + "201": { + "description": "Quando a nota fiscal é criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos" + } + }, + "tags": [ + "Notas fiscais" + ], + "description": "Cria uma nota fiscal", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "number" + }, + "series": { + "type": "number" + }, + "issued_at": { + "type": "string", + "format": "date-time" + }, + "key": { + "type": "string" + }, + "volumes": { + "type": "integer" + } + }, + "required": [ + "number" + ] + } + } + } + } + } + }, + "/api/v2/orders/{code}/packages/{package_code}/invoices/{number}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "number", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza uma nota fiscal", + "operationId": "patch-api-v2-orders-code-packages-package_code-invoices-number", + "responses": { + "204": { + "description": "Quando a nota fiscal é atualizada" + }, + "404": { + "description": "Quando a nota fiscal não é encontrada" + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Notas fiscais" + ], + "description": "Atualiza uma nota fiscal", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "number" + }, + "series": { + "type": "number" + }, + "issued_at": { + "type": "string", + "format": "date-time" + }, + "key": { + "type": "string" + }, + "volumes": { + "type": "integer" + } + }, + "required": [ + "number" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove uma nota fiscal", + "operationId": "delete-api-v2-orders-code-packages-package_code-invoices-number", + "responses": { + "204": { + "description": "Quando a nota fiscal é removida" + }, + "404": { + "description": "Quando a nota fiscal não é encontrada" + } + }, + "tags": [ + "Notas fiscais" + ], + "description": "Remove uma nota fiscal" + } + }, + "/api/v2/users/reset_password": { + "post": { + "summary": "Solicita renovação da senha", + "operationId": "post-api-v2-users-reset_password", + "responses": { + "200": { + "description": "Quando o email foi enviado" + }, + "404": { + "description": "Quando o usuário não existe" + } + }, + "tags": [ + "Usuários" + ], + "description": "Será enviado por email um link para o cadastro da nova senha\nO link tem validade de 24 horas", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + } + }, + "required": [ + "email" + ] + } + } + } + } + }, + "patch": { + "summary": "Cadastra a nova senha", + "operationId": "patch-api-v2-users-reset_password", + "responses": { + "200": { + "description": "Quando a senha foi alterada" + }, + "400": { + "description": "Quando o token é inválido ou expirou" + }, + "404": { + "description": "Quando não foi encontrado um usuário com o token informado" + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Usuários" + ], + "description": "Cadastra a nova senha", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "token": { + "type": "string", + "description": "Token pare renovação de senha enviado por email" + }, + "password": { + "type": "string", + "description": "Nova senha para o usuário" + }, + "password_confirmation": { + "type": "string", + "description": "Confirmação da nova senha do usuário" + } + }, + "required": [ + "token", + "password", + "password_confirmation" + ] + } + } + } + } + } + }, + "/api/v2/orders/{code}/shipping_address": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Endereço de entrega", + "tags": [ + "Pedidos" + ], + "responses": { + "200": { + "description": "Quando o endereço é retornado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "documents": { + "type": "object", + "description": "Serão retornados apenas os campos preenchidos", + "properties": { + "cpf": { + "type": "string" + }, + "cnpj": { + "type": "string" + }, + "ie": { + "type": "string" + } + } + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string", + "example": "188A" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "first_phone_area": { + "type": "string", + "description": "Somente números", + "example": "11" + }, + "first_phone": { + "type": "string", + "description": "Somente números", + "example": "984453322" + }, + "second_phone_area": { + "type": "string", + "description": "Somente números" + }, + "second_phone": { + "type": "string", + "description": "Somente números" + }, + "reference": { + "type": "string" + }, + "zip": { + "type": "string", + "description": "Somente números", + "example": "90050000" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string", + "example": "RS", + "minLength": 2, + "maxLength": 2 + }, + "recipient_name": { + "type": "string" + } + }, + "required": [ + "first_name", + "last_name", + "email", + "street_name", + "street_number", + "neighborhood", + "first_phone_area", + "first_phone", + "zip", + "city", + "state" + ] + } + } + } + } + }, + "operationId": "get-api-v2-orders-code-shipping_address", + "description": "Retorna o endereço de entrega" + } + }, + "/api/v2/payment_recipients": { + "get": { + "summary": "Lista os recebedores", + "tags": [ + "Recebedores" + ], + "responses": { + "200": { + "description": "Quando os recebedores são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Payment_recipient.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-payment_recipients", + "description": "Lista os recebedores" + }, + "post": { + "summary": "Cria um recebedor", + "operationId": "post-api-v2-payment_recipients", + "responses": { + "200": { + "description": "Quando o recebedor foi criado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Payment_recipient.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + }, + "examples": { + "Parâmetro `percentage` em branco": { + "value": { + "errors": { + "percentage": [ + "não pode ficar em branco" + ] + } + } + } + } + } + } + } + }, + "tags": [ + "Recebedores" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_id": { + "type": "integer" + }, + "recipient_id": { + "type": "integer" + }, + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "active": { + "type": "boolean", + "default": true + }, + "charge_processing_fee": { + "type": "boolean", + "default": false + }, + "liable": { + "type": "boolean", + "default": false + }, + "code": { + "type": "string" + }, + "place_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "include_shipping": { + "type": "boolean", + "default": true, + "description": "Indica se o frete deve ser incluído no split do pagamento" + } + }, + "required": [ + "percentage" + ] + } + } + } + }, + "description": "Cria um recebedor" + } + }, + "/api/v2/payment_recipients/{id}": { + "get": { + "summary": "Retorna um recebedor", + "tags": [ + "Recebedores" + ], + "responses": { + "200": { + "description": "Quando o recebedor é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Payment_recipient.v1" + } + } + } + }, + "404": { + "description": "Quando o recebedor não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-payment_recipients-id", + "description": "Retorna um recebedor" + }, + "patch": { + "summary": "Atualiza um recebedor", + "operationId": "patch-api-v2-payment_recipients-id", + "responses": { + "204": { + "description": "Quando o recebedor é atualizado" + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Recebedores" + ], + "description": "Atualiza um recebedor", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_id": { + "type": "integer" + }, + "recipient_id": { + "type": "integer" + }, + "percentage": { + "type": "number", + "maximum": 100 + }, + "active": { + "type": "boolean", + "default": true + }, + "charge_processing_fee": { + "type": "boolean", + "default": false + }, + "liable": { + "type": "boolean", + "default": false + }, + "code": { + "type": "string" + }, + "place_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "include_shipping": { + "type": "boolean", + "default": true, + "description": "Indica se o frete deve ser incluído no split do pagamento" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove um recebedor", + "operationId": "delete-api-v2-payment_recipients-id", + "responses": { + "204": { + "description": "Quando o recebedor é removido" + }, + "404": { + "description": "Quando o recebedor não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "description": "Remove um recebedor", + "tags": [ + "Recebedores" + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ] + }, + "/api/v2/users/{user_id}/payables": { + "get": { + "summary": "Lista os recebíveis do usuário", + "responses": { + "200": { + "description": "Retorna a lista de recebíveis do usuário", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Payables.v1" + } + } + } + } + }, + "404": { + "description": "Quando o usuário não está cadastrado como recebedor", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Permite a listagem de recebíveis do usuário", + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "user_id", + "in": "path", + "required": true + } + ], + "operationId": "get-api-v2-users-user_id-payables", + "tags": [ + "Usuários" + ] + } + }, + "/api/v2/audience_members": { + "get": { + "summary": "Retorna os membros da audiência", + "responses": { + "200": { + "description": "Quando os membros da audiência são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Audience_member.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-audience_members", + "description": "Lista os membros da audiência", + "tags": [ + "Público" + ] + }, + "post": { + "summary": "Cria uma membro da audiência", + "operationId": "post-api-v2-audience_members", + "responses": { + "201": { + "description": "Quando o membro da audiência é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Audience_member.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Permite criar um membro da audiência", + "tags": [ + "Público" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "first_name": { + "type": "string", + "nullable": true + }, + "last_name": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string" + }, + "phone_area": { + "type": "string", + "nullable": true + }, + "phone": { + "type": "string", + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "email" + ] + } + } + }, + "description": "" + } + }, + "parameters": [] + }, + "/api/v2/audience_members/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Remove um membro da audiência", + "operationId": "delete-api-v2-audience-members-id", + "responses": { + "204": { + "description": "Quando o membro da audiência é removido" + }, + "404": { + "description": "Quando a audiência não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Público" + ], + "description": "Permite remover um membro da audiência" + }, + "patch": { + "summary": "Altera um membro da audiência", + "operationId": "patch-api-v2-audience-members-id", + "responses": { + "204": { + "description": "Quando o membro da audiência é alterado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Audience_member.v1" + } + } + } + }, + "404": { + "description": "Quando o membro da audiência não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Permite alterar um membro da audiência", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "phone_area": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "tags": [ + "Público" + ] + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/trackings": { + "post": { + "summary": "Adiciona um rastreio", + "operationId": "post-api-v2-orders-order_code-packages-package_code-trackings", + "responses": { + "200": { + "description": "Quando o rastreio é criado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Código de rastreio do pacote" + }, + "company": { + "type": "string", + "description": "Transportadora" + }, + "url": { + "type": "string", + "description": "URL para rastreio do pacote na transportadora" + } + }, + "required": [ + "code" + ] + }, + "examples": { + "200": { + "value": { + "code": "PL123456789", + "url": "https://examble.com/tracking", + "company": "Correios" + } + } + } + } + } + }, + "404": { + "description": "Quando o pedido ou o pacote não existem", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "tags": [ + "Rastreios" + ], + "description": "Adiciona um rastreio para um pacote de um pedido", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Código de rastreio" + }, + "company": { + "type": "string", + "description": "Transportadora" + }, + "url": { + "type": "string", + "format": "uri", + "description": "Link de rastreamento" + } + }, + "required": [ + "code" + ] + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os rastreios", + "operationId": "get-api-v2-orders-order_code-packages-package_code-trackings", + "responses": { + "200": { + "description": "Quando os rastreios são listados", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "tracking_code": { + "type": "string", + "description": "Código de rastreio do pacote" + }, + "tracked_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização do código de rastreio do pacote" + }, + "url": { + "type": "string", + "format": "uri", + "description": "URL para rastreio do pedido com a transportadora" + }, + "company": { + "type": "string", + "description": "Transportadora do pacote" + } + }, + "required": [ + "tracking_code" + ] + }, + "examples": { + "Rastreio": { + "value": { + "id": 15, + "tracking_code": "codigo-rastreio", + "tracked_at": "2022-12-23T15:20:18.893-03:00", + "url": "rastreiocorreios.com.br", + "company": "Correios" + } + } + } + } + } + }, + "404": { + "description": "Quando o pedido ou o pacote não existem", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "tags": [ + "Rastreios" + ], + "description": "Lista os rastreios de um pacote de um pedido" + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/trackings/{id}": { + "delete": { + "summary": "Remove um rastreio", + "operationId": "delete-api-v2-orders-order_code-packages-package_code-trackings-id", + "responses": { + "204": { + "description": "Quando o rastreio é removido" + }, + "404": { + "description": "Quando o pedido ou o pacote não existem", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Rastreios" + ], + "description": "Remove um rastreio" + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "package_code", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ] + }, + "/api/v2/carts/{cart_id}/items": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os itens de um carrinho", + "operationId": "get-api-v2-carts-cart_id-items", + "responses": { + "200": { + "description": "Quando os itens do carrinho são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart_item.v1" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Lista os itens de um carrinho", + "tags": [ + "Itens do carrinho" + ] + }, + "post": { + "summary": "Cria um item do carrinho", + "operationId": "post-api-v2-carts-cart_id-items", + "responses": { + "201": { + "description": "Quando um item do carrinho é criado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart_item.v1" + } + } + } + }, + "400": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + }, + "examples": { + "Sem os parâmetros obrigatórios": { + "value": { + "errors": { + "sku": [ + "precisa ser informado" + ], + "quantity": [ + "não pode ficar em branco" + ] + } + } + } + } + } + } + }, + "404": { + "description": "Quando um carrinho ou variante não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "Registro não encontrado": { + "value": { + "error": "not found" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Permite criar um item do carrinho", + "tags": [ + "Itens do carrinho" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "quantity": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "extra": { + "type": "object" + }, + "place_id": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "store_coupon_code": { + "type": "string" + }, + "customizations": { + "type": "array" + } + }, + "required": [ + "sku", + "quantity" + ], + "$ref": "#/components/schemas/Product.v0" + } + } + }, + "description": "Cria um item do carrinho" + } + } + }, + "/api/v2/carts/{cart_id}/items/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um item do carrinho", + "operationId": "patch-api-v2-carts-cart_id-items-id", + "responses": { + "204": { + "description": "Quando o item do carrinho é alterado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Audience_member.v1" + } + } + } + }, + "404": { + "description": "Quando o item do carrinho ou o carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Atualiza um item do carrinho", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "quantity": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "place_id": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "extra": { + "type": "object" + }, + "store_coupon_code": { + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Itens do carrinho" + ] + }, + "delete": { + "summary": "Remove um item do carrinho", + "operationId": "delete-api-v2-carts-cart_id-items-id", + "responses": { + "204": { + "description": "Quando o item do carrinho é removido" + }, + "404": { + "description": "Quando o item do carrinho ou o carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Itens do carrinho" + ], + "description": "Remove um item do carrinho" + } + }, + "/api/v2/carts/{cart_id}/items/bulk": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Adiciona itens ao carrinho", + "operationId": "post-api-v2-carts-cart_id-items-bulk", + "responses": { + "201": { + "description": "Quando os itens são adicionados com sucesso", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart_item.v1" + } + } + } + } + }, + "400": { + "description": "Quando os parâmetros são inválidos", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "errors": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "0": { + "type": "object", + "properties": { + "quantity": { + "type": "array", + "items": { + "type": "string" + } + }, + "sku": { + "type": "array", + "items": { + "type": "string" + } + }, + "place_id": { + "type": "array", + "items": { + "type": "string" + } + }, + "": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "examples": { + "Erros de validação": { + "value": { + "errors": { + "items": { + "0": { + "sku": [ + "deve ser preenchido" + ] + }, + "1": { + "quantity": [ + "deve ser maior que 0" + ] + }, + "2": { + "place_id": [ + "deve ser maior que 0" + ] + }, + "3": { + "extra": [ + "precisa ser um hash" + ], + "quantity": [ + "precisa ser um inteiro" + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Quando um carrinho ou variante não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "Registro não encontrado": { + "value": { + "error": "not found" + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "tags": [ + "Carrinhos" + ], + "description": "Permite adicionar itens em bulk ao carrinho", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "quantity": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "extra": { + "type": "object" + }, + "place_id": { + "type": "integer", + "minimum": 0, + "exclusiveMinimum": true + }, + "items": { + "type": "array", + "description": "Itens do carrinho", + "items": { + "type": "array", + "properties": { + "sku": { + "type": "string", + "description": "Código SKU da variante do produto" + }, + "quantity": { + "type": "integer", + "description": "Unidades do produto" + }, + "customizations": { + "type": "array", + "description": "[Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto", + "items": { + "properties": { + "Customization": { + "type": "string", + "description": "Adicione a customização de acordo com a [personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. \nSe por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. \nSaiba mais sobre como utilizar esse parâmetro pelo exemplo de requsição localizado na seção de **Request Example** (ao lado do código da requisição)." + } + } + } + } + }, + "required": [ + "sku", + "quantity" + ] + }, + "example": { + "itemcustomizado": { + "items": { + "value": [ + { + "sku": "variante.sku1", + "quantity": 1, + "customizations": [ + { + "Color": "Black" + } + ] + }, + { + "sku": "variante.sku2", + "quantity": 10, + "customizations": [ + { + "Color": "Red" + } + ] + } + ] + } + } + } + } + }, + "required": [ + "sku", + "quantity" + ] + } + } + } + } + } + }, + "/api/v2/discounts": { + "post": { + "summary": "Cria uma promoção", + "operationId": "post-api-v2-discounts", + "responses": { + "201": { + "description": "Quando a promoção é criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Discount.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Promoções" + ], + "description": "Cria uma promoção", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "start_at": { + "type": "string", + "format": "date-time" + }, + "end_at": { + "type": "string", + "format": "date-time" + }, + "valid_to": { + "type": "string", + "enum": [ + "store", + "cart" + ] + }, + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "email": { + "type": "string", + "format": "email" + }, + "cpf": { + "type": "string", + "pattern": "[0-9]{11}" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "name", + "start_at" + ] + } + } + } + } + } + }, + "/api/v2/discounts/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna uma promoção", + "tags": [ + "Promoções" + ], + "responses": { + "200": { + "description": "Quando a promoção é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Discount.v1" + } + } + } + }, + "404": { + "description": "Quando a promoção não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-discounts-id", + "description": "Retorna uma promoção" + }, + "patch": { + "summary": "Altera uma promoção", + "tags": [ + "Promoções" + ], + "responses": { + "204": { + "description": "Quando a promoção é alterada" + }, + "404": { + "description": "Quando a promoção não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "operationId": "patch-api-v2-discounts-id", + "description": "Altera uma promoção", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "start_at": { + "type": "string", + "format": "date-time" + }, + "end_at": { + "type": "string", + "format": "date-time" + }, + "valid_to": { + "type": "string", + "enum": [ + "store", + "cart" + ] + }, + "description": { + "type": "string" + }, + "enabled": { + "type": "boolean", + "default": true + }, + "email": { + "type": "string", + "format": "email" + }, + "cpf": { + "type": "string", + "pattern": "[0-9]{11}" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "name", + "start_at" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove uma promoção", + "operationId": "delete-api-v2-discounts-id", + "responses": { + "204": { + "description": "Quando a promoção é removida" + }, + "400": { + "description": "Quando a promoção não pode ser removida", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "with-coupons": { + "value": { + "error": "Essa promoção não pode ser excluída pois possui cupons utilizados" + } + } + } + } + } + }, + "404": { + "description": "Quando a promoção não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Promoções" + ], + "description": "Remove uma promoção" + } + }, + "/api/v2/discounts/{discount_id}/rules": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "discount_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as regras", + "tags": [ + "Regras de desconto" + ], + "responses": { + "200": { + "description": "Quando as regras de desconto são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Discount_rule.v1" + } + } + } + } + } + }, + "description": "Lista as regras de desconto de uma promoção", + "operationId": "get-api-v2-discounts-discount_id-rules" + }, + "post": { + "summary": "Cria uma regra", + "operationId": "post-api-v2-discounts-discount_id-rules", + "responses": { + "200": { + "description": "Quando a regra de desconto é criada", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "amount": { + "type": "number" + }, + "apply_to": { + "type": "string", + "enum": [ + "product", + "tag", + "subtotal", + "total", + "shipping" + ] + }, + "min_quantity": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "channel": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Regras de desconto" + ], + "description": "Cria uma regra de desconto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apply_to": { + "type": "string", + "enum": [ + "product", + "tag", + "subtotal", + "total", + "shipping" + ] + }, + "amount_type": { + "type": "string", + "enum": [ + "R$", + "%" + ] + }, + "amount": { + "type": "number", + "minimum": 0 + }, + "product_id": { + "type": "integer" + }, + "tag_name": { + "type": "string" + }, + "min_quantity": { + "type": "integer" + }, + "shipping_method": { + "type": "string" + }, + "min_subtotal": { + "type": "number", + "minimum": 0 + }, + "gift": { + "type": "boolean", + "default": false + }, + "combinated_product_id": { + "type": "integer" + }, + "client_tag": { + "type": "string" + }, + "shipping_rule": { + "type": "string" + }, + "gift_quantity": { + "type": "integer", + "minimum": 1 + }, + "agent_tag": { + "type": "string" + }, + "regions": { + "type": "array", + "items": { + "type": "string" + } + }, + "channel": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/api/v2/discounts/{discount_id}/rules/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "discount_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Remove uma regra", + "operationId": "delete-api-v2-discounts-discount_id-rules-id", + "responses": { + "200": { + "description": "Quando a regra de desconto é removida" + } + }, + "tags": [ + "Regras de desconto" + ], + "description": "Remove uma regra de desconto" + }, + "patch": { + "summary": "Altera uma regra", + "operationId": "patch-api-v2-discounts-discount_id-rules-id", + "responses": { + "204": { + "description": "Quandoa regra de desconto é alterada" + }, + "404": { + "description": "Quando a regra de desconto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Altera uma regra de desconto", + "tags": [ + "Regras de desconto" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apply_to": { + "type": "string", + "enum": [ + "product", + "tag", + "subtotal", + "total", + "shipping" + ] + }, + "amount_type": { + "type": "string", + "enum": [ + "R$", + "%" + ] + }, + "amount": { + "type": "number", + "minimum": 0 + }, + "product_id": { + "type": "integer" + }, + "tag_id": { + "type": "integer" + }, + "min_quantity": { + "type": "integer" + }, + "shipping_method": { + "type": "string" + }, + "min_subtotal": { + "type": "number", + "minimum": 0 + }, + "gift": { + "type": "boolean", + "default": false + }, + "combinated_product_id": { + "type": "integer" + }, + "client_tag": { + "type": "string" + }, + "shipping_rule": { + "type": "string" + }, + "gift_quantity": { + "type": "integer", + "minimum": 1 + }, + "agent_tag": { + "type": "string" + }, + "regions": { + "type": "array", + "items": { + "type": "string" + } + }, + "channel": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "/api/v2/discounts/{discount_id}/coupons": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "discount_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os cupons", + "tags": [ + "Cupons de desconto" + ], + "responses": { + "200": { + "description": "Quando os cupons são retornados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Coupon.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-discounts-discount_id-coupons", + "description": "Permite listar os cupons de desconto de uma promoção", + "parameters": [ + { + "schema": { + "type": "number" + }, + "in": "query", + "name": "uses_per_code", + "description": "Filtra os cupons pelo campo uses_per_code" + } + ] + }, + "post": { + "summary": "Cria um cupom", + "operationId": "post-api-v2-discounts-discount_id-coupons", + "responses": { + "201": { + "description": "Quando o cupom é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Coupon.v1" + } + } + } + }, + "404": { + "description": "Quando o desconto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Cupons de desconto" + ], + "description": "Cria um cupom de desconto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "uses_per_code": { + "type": "integer" + }, + "uses_per_user": { + "type": "integer" + }, + "referrer_email": { + "type": "string", + "format": "email" + }, + "quantity": { + "type": "integer" + }, + "user_id": { + "type": "integer" + } + } + } + } + } + } + } + }, + "/api/v2/discounts/{discount_id}/coupons{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "discount_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um cupom", + "operationId": "patch-api-v2-discounts-discount_id-coupons-coupons_id", + "responses": { + "204": { + "description": "Quando o cupom é atualizado" + }, + "404": { + "description": "Quando o coupom não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Cupons de desconto" + ], + "description": "Atualiza um cupom de desconto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "uses_per_code": { + "type": "integer", + "description": "Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0" + }, + "uses_per_user": { + "type": "integer", + "description": "Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove um cupom", + "operationId": "delete-api-v2-discounts-discount_id-coupons-id", + "responses": { + "204": { + "description": "Quando o cupom é removido" + }, + "404": { + "description": "Quando o cupom não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando o cupom estiver utilizado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Cupons de desconto" + ], + "description": "Remove um cupom de desconto" + } + }, + "/api/v2/products": { + "get": { + "summary": "Lista os produtos", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando os produtos são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product.v1" + } + }, + "examples": { + "example-1": { + "value": [ + { + "id": 0, + "active": true, + "available": true, + "category_tags": [ + { + "tag_type": "string", + "name": "string", + "title": "string" + } + ], + "description": "string", + "discount_id": 0, + "html_description": "string", + "image_url": "string", + "installments": [ + 0 + ], + "min_quantity": "string", + "name": "string", + "on_sale": true, + "plain_description": "string", + "price": 0, + "rating": { + "rating": 0, + "votes": 0 + }, + "reference": "string", + "sale_price": 0, + "slug": "string", + "tag_names": [ + "string" + ], + "updated_at": "string", + "url": "string", + "variants": [ + { + "{id}": { + "available": true, + "available_quantity": 0, + "custom_attributes": {}, + "handling_days": 0, + "height": 0, + "id": 1, + "image_url": "string", + "installments": [ + 0 + ], + "inventories": [ + { + "created_at": "2019-08-24T14:15:22Z", + "id": 0, + "name": null, + "place_id": 0, + "price": 0, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "slug": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_id": 0 + } + ], + "length": 0, + "main": true, + "min_quantity": 0, + "name": "string", + "norder": 0, + "price": 0, + "product_id": 0, + "properties": { + "property1": { + "defining": true, + "name": "string", + "value": "string" + }, + "property2": { + "defining": true, + "name": "string", + "value": "string" + }, + "property3": { + "defining": true, + "name": "string", + "value": "string" + } + }, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "sku": "string", + "slug": "string", + "stock": 0, + "updated_at": "2019-08-24T14:15:22Z", + "weight": 0, + "width": 0 + } + } + ], + "discount_rule": null, + "images": [ + { + "id": 0, + "url": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_ids": [ + 0 + ] + } + ] + } + ] + } + } + } + } + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-products", + "description": "Lista os produtos", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "limit", + "description": "Delimita a quantidade de itens retornados" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Quantidade de produtos por página" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "reference", + "description": "Filtra pela referência" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "ids", + "description": "Filtra pelo ID dos produtos " + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "tag", + "description": "Filtra produtos que coném a tag" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "updated_after", + "description": "Filtra produtos alterados depois da data" + }, + { + "schema": { + "type": "string", + "enum": [ + "newest" + ] + }, + "in": "query", + "name": "sort", + "description": "Exibe os produtos cadastrados recentemente primeiro" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "include_inactive", + "description": "Inclui os produtos inativos na listagem" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "include_images", + "description": "Inclui na requisição se deseja que venham todas as imagens do produto" + } + ] + }, + "post": { + "summary": "Cria um produto", + "operationId": "post-api-v2-products", + "responses": { + "201": { + "description": "Quando o produto é criado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "active": { + "type": "string", + "description": "Indica se o produto está ativo (`true`) ou inativo (`false`)", + "default": true + }, + "reference": { + "type": "string", + "description": "Código de Referência do produto" + }, + "name": { + "type": "string", + "description": "Nome do produto" + }, + "description": { + "type": "string", + "description": "Descrição do produto" + }, + "tag_list": { + "type": "array", + "items": { + "type": "string" + }, + "example": "tag1, tag2", + "description": "Lista de tags associadas ao produto" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "product_type": { + "description": "Tipo de produto, entre:\n - `sample`: amostra\n - `subscription`: assinatura\n - `product`: produto em geral", + "type": "string", + "enum": [ + "product", + "sample", + "subscription" + ], + "default": "product" + } + }, + "required": [ + "reference", + "name" + ] + } + } + } + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Produtos" + ], + "description": "Cria um produto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "reference": { + "type": "string" + }, + "tag_list": { + "type": "string", + "example": "tag1, tag2" + } + }, + "required": [ + "name", + "reference" + ], + "$ref": "#/components/schemas/SimpleProduct" + } + } + } + } + } + }, + "/api/v2/products/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna um produto", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando o produto é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product.v1" + }, + "examples": { + "example-1": { + "value": { + "id": 0, + "active": true, + "available": true, + "category_tags": [ + { + "tag_type": "string", + "name": "string", + "title": "string" + } + ], + "description": "string", + "discount_id": 0, + "html_description": "string", + "image_url": "string", + "installments": [ + 0 + ], + "min_quantity": "string", + "name": "string", + "on_sale": true, + "plain_description": "string", + "price": 0, + "rating": { + "rating": 0, + "votes": 0 + }, + "reference": "string", + "sale_price": 0, + "slug": "string", + "tag_names": [ + "string" + ], + "updated_at": "string", + "url": "string", + "variants": [ + { + "{id}": { + "available": true, + "available_quantity": 0, + "custom_attributes": {}, + "handling_days": 0, + "height": 0, + "id": 1, + "image_url": "string", + "installments": [ + 0 + ], + "inventories": [ + { + "created_at": "2019-08-24T14:15:22Z", + "id": 0, + "name": null, + "place_id": 0, + "price": 0, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "slug": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_id": 0, + "place_name": "string" + } + ], + "length": 0, + "main": true, + "min_quantity": 0, + "name": "string", + "norder": 0, + "price": 0, + "product_id": 0, + "properties": { + "property1": { + "defining": true, + "name": "string", + "value": "string" + }, + "property2": { + "defining": true, + "name": "string", + "value": "string" + }, + "property3": { + "defining": true, + "name": "string", + "value": "string" + } + }, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "sku": "string", + "slug": "string", + "stock": 0, + "updated_at": "2019-08-24T14:15:22Z", + "weight": 0, + "width": 0 + } + } + ], + "discount_rule": null, + "images": [ + { + "id": 0, + "url": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_ids": [ + 0 + ] + } + ] + } + } + } + } + } + }, + "404": { + "description": "Quando o produto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product.v1" + } + } + } + } + }, + "operationId": "get-api-v2-products-id", + "description": "Retorna um produto", + "parameters": [ + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "coupon_codes", + "description": "Lista de cupons para calcular o desconto do produto" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "include_inventory_place", + "description": "Se \"true\", inclui o nome do local nos inventários das variantes" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "include_images", + "description": "Se \"true\", inclui todas as imagens do produto" + } + ] + }, + "patch": { + "summary": "Atualiza um produto", + "operationId": "patch-api-v2-products-id", + "responses": { + "204": { + "description": "Quando o produto é atualizado" + }, + "404": { + "description": "Quando o produto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviado são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Produtos" + ], + "description": "Atualiza um produto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "reference": { + "type": "string" + }, + "tag_list": { + "type": "string", + "example": "tag1, tag2" + } + }, + "required": [ + "name", + "reference" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove um produto", + "operationId": "delete-api-v2-products-id", + "responses": { + "204": { + "description": "Quando o produto é removido" + }, + "404": { + "description": "Quando o produto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Produtos" + ], + "description": "Remove um produto" + } + }, + "/api/v2/products/reference/{reference}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "reference", + "in": "path", + "required": true, + "description": "Referência do produto" + } + ], + "patch": { + "summary": "Atualiza um produto pela referência", + "operationId": "patch-api-v2-products-reference-reference", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Permite atualizar um produto pela referência", + "requestBody": { + "$ref": "#/components/requestBodies/Product", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SimpleProduct", + "type": "object", + "properties": { + "reference": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean", + "default": true + }, + "product_type": { + "type": "string", + "enum": [ + "product", + "sample", + "subscription" + ], + "default": "product" + } + }, + "required": [ + "reference", + "name" + ] + } + } + }, + "description": "" + }, + "tags": [ + "Produtos" + ] + } + }, + "/api/v2/products/{id}/rate": { + "post": { + "summary": "Avalia um produto", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando a avaliação é recebida", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "rating": { + "type": "string" + }, + "votes": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "rating": "0.9", + "votes": "2" + } + } + } + } + } + }, + "400": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "error": "invalid rate value" + } + } + } + } + } + }, + "404": { + "description": "Quando o produto não tem variantes", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "error": "product without variants" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-products-id-rate", + "description": "Recebe uma avaliação e recalcula a pontuação atual", + "parameters": [ + { + "schema": { + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + "in": "query", + "name": "rate", + "description": "Avaliação" + } + ] + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ] + }, + "/api/v2/products/search": { + "get": { + "summary": "Busca os produtos", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando os produtos são encontrados", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearch" + } + }, + "aggregations": { + "type": "object", + "properties": { + "min_price": { + "type": "number" + }, + "max_price": { + "type": "number" + }, + "types": { + "type": "object" + }, + "properties": { + "type": "object", + "properties": { + "property1": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "count": { + "type": "number" + } + } + } + }, + "property2": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "count": { + "type": "number" + } + } + } + }, + "property3": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "count": { + "type": "number" + } + } + } + } + } + } + } + } + } + }, + "examples": { + "example-1": { + "value": { + "results": [ + { + "id": 0, + "active": true, + "available": true, + "subscription": true, + "slug": "string", + "reference": "string", + "reference_lowercase": "string", + "name": "string", + "description": "string", + "image_url": "string", + "url": "string", + "tags": [ + { + "name": "string", + "title": "string", + "subtitle": "string", + "description": "string", + "importance": 0, + "type": "string", + "image_url": "string" + } + ], + "price": 0, + "on_sale": true, + "sale_price": 0, + "intl_price": 0, + "discount_id": 0, + "discount_rule": { + "type": "fixed", + "amount": 0 + }, + "discount": { + "name": "string", + "description": "string", + "facebook": true, + "valid_to": "string" + }, + "images": [ + { + "sku": "string", + "url": "string" + } + ], + "variants": [ + { + "id": 1, + "sku": "string", + "sku_lowercase": "string", + "name": "string", + "full_name": "string", + "main": true, + "available": true, + "image_url": "string", + "price": 0, + "sale_price": 0, + "intl_price": 0, + "installments": [ + { + "number": 1, + "price": 10, + "interest": false, + "interest_rate": 0, + "total": 10 + } + ], + "stock": 0, + "quantity": 0, + "quantity_sold": 0, + "min_quantity": 0, + "available_quantity": 0, + "custom_attributes": {}, + "properties": { + "property1": { + "defining": true, + "name": "string", + "value": "string" + }, + "property2": { + "defining": true, + "name": "string", + "value": "string" + }, + "property3": { + "defining": true, + "name": "string", + "value": "string" + } + }, + "inventories": [ + { + "name": null, + "slug": "string", + "available": true, + "price": 0, + "sale_price": 0, + "quantity": 0, + "quantity_sold": 0, + "place": { + "id": 0, + "name": "string" + } + } + ], + "handling_days": 0, + "barcode": "string", + "weight": 0, + "width": 0, + "height": 0, + "length": 0 + } + ], + "installments": [ + { + "number": 1, + "price": 10, + "interest": false, + "interest_rate": 0, + "total": 10 + } + ], + "created_at": "2019-08-24T14:15:22Z", + "updated_at": "2019-08-24T14:15:22Z" + } + ], + "aggregations": { + "min_price": 0, + "max_price": 0, + "types": { + "tag_0": [ + { + "name": "string", + "title": "string", + "count": 0 + }, + { + "name": "string", + "title": "string", + "count": 0 + } + ], + "tag_1": [ + { + "name": "string", + "title": "string", + "count": 0 + } + ] + }, + "properties": { + "property1": [ + { + "value": "string", + "count": 0 + } + ], + "property2": [ + { + "value": "string", + "count": 0 + } + ], + "property3": [ + { + "value": "string", + "count": 0 + } + ] + } + } + } + } + } + } + } + } + }, + "operationId": "get-api-v2-products-search", + "description": "Busca os produtos de acordo com os parâmetros definidos", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Quantidade de produtos por página" + }, + { + "schema": { + "type": "array", + "items": { + "type": "integer" + } + }, + "in": "query", + "name": "ids[]", + "description": "Filtra pelo ID dos produtos" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "term", + "description": "Filtra produtos que contenham o termo" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "wildcard", + "description": "Permite que o filtro 'term' realize filtragem de produtos por termo parcial" + }, + { + "schema": { + "type": "object" + }, + "in": "query", + "name": "type_tags", + "description": "Filtra pelo nome da tag dentro de um tipo de tag. Exemplo, type_tags[cor]=verde" + }, + { + "schema": { + "type": "string", + "enum": [ + "and", + "or" + ] + }, + "in": "query", + "name": "type_tags_operator", + "description": "Operador lógico para o filtro de tag" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "property1_values", + "description": "Filtra pelo valor da propriedade 1" + }, + { + "schema": { + "type": "string", + "enum": [ + "and", + "or" + ] + }, + "in": "query", + "name": "property1_operator", + "description": "Operador lógico para o filtro de valor da propriedade 1" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "property2_values", + "description": "Filtra pelo valor da propriedade 2" + }, + { + "schema": { + "type": "string", + "enum": [ + "and", + "or" + ] + }, + "in": "query", + "name": "property2_operator", + "description": "Operador lógico para o filtro de valor da propriedade 2" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "property3_values", + "description": "Filtra pelo valor da propriedade 3" + }, + { + "schema": { + "type": "string", + "enum": [ + "and", + "or" + ] + }, + "in": "query", + "name": "property3_operator", + "description": "Operador lógico para o filtro de valor da propriedade 3" + }, + { + "schema": { + "type": "number" + }, + "in": "query", + "name": "min_price", + "description": "Filtra pelo preço de venda mínimo do produto" + }, + { + "schema": { + "type": "number" + }, + "in": "query", + "name": "max_price", + "description": "Filtra pelo preço de venda máximo do produto" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "tags", + "description": "Filtra pelo nome das tags, independente do tipo" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "parent_tags", + "description": "Filtra pelo nome das tags, independente do tipo" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "show_only_available", + "description": "Filtra por produtos disponíveis" + }, + { + "schema": { + "type": "string", + "enum": [ + "newest", + "oldest", + "lowest_price", + "highest_price" + ] + }, + "in": "query", + "name": "sort", + "description": "Ordena o resultado da busca de produtos conforme a opção escolhida" + } + ] + } + }, + "/api/v2/variants/{sku}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "sku", + "in": "path", + "required": true, + "description": "SKU da variante" + } + ], + "get": { + "summary": "Retorna uma variante", + "tags": [ + "Variantes" + ], + "responses": { + "201": { + "description": "Quando a variante é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Variant" + }, + "examples": { + "example-1": { + "value": { + "id": 95, + "main": false, + "available": true, + "sku": "SHOP0001", + "name": "Variation", + "slug": "variation", + "min_quantity": 1, + "quantity": 1, + "quantity_sold": 0, + "stock": 1, + "custom_attributes": {}, + "properties": {}, + "updated_at": "2020-10-27T11:54:32.018-03:00", + "price": 10, + "installments": [ + 10 + ], + "available_quantity": 1, + "weight": 0.001, + "width": 1, + "height": 1, + "length": 1, + "handling_days": 0, + "inventories": [], + "sale_price": 10, + "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/variation.jpg", + "product_id": 6, + "norder": 1 + } + } + } + } + } + }, + "404": { + "description": "Quando a variante não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-variants-sku", + "description": "Retorna uma variante pelo SKU" + }, + "patch": { + "summary": "Atualiza uma variante", + "operationId": "patch-api-v2-variants-sku", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Permite atualizar uma variante pelo SKU", + "tags": [ + "Variantes" + ], + "requestBody": { + "$ref": "#/components/requestBodies/Variant", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "min_quantity": { + "type": "integer" + }, + "norder": { + "type": "integer" + }, + "property1": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property2": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property3": { + "$ref": "#/components/schemas/VariantProperty" + }, + "barcode": { + "type": "string" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + } + }, + "required": [ + "sku", + "quantity", + "price" + ] + } + } + } + } + } + }, + "/api/v2/products/{product_id}/variants/{sku}/images": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "$ref": "#/components/parameters/sku" + } + ], + "get": { + "summary": "Lista as imagens da variante com SKU na URL", + "tags": [ + "Variantes" + ], + "responses": { + "200": { + "$ref": "#/components/responses/VariantImages" + } + }, + "operationId": "get-api-v2-products-product_id-variants-sku-images", + "description": "Lista as imagens de uma variante passando o SKU da mesma na URL" + } + }, + "/api/v2/products/{product_id}/variants/images": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "sku", + "description": "SKU da variante" + } + ], + "get": { + "summary": "Lista as imagens da variante com SKU nos parâmetros", + "tags": [ + "Variantes" + ], + "responses": { + "200": { + "$ref": "#/components/responses/VariantImages" + } + }, + "operationId": "get-api-v2-products-product_id-variants-images", + "description": "Lista as imagens de uma variante passando o SKU da mesma nos parâmetros" + } + }, + "/api/v2/variants/{sku}/shipping_methods": { + "get": { + "parameters": [ + { + "$ref": "#/components/parameters/sku" + } + ], + "summary": "Calcula frete", + "tags": [ + "Variantes" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "quantity": { + "type": "integer" + }, + "zip": { + "type": "string" + } + }, + "required": [ + "quantity", + "zip" + ] + } + } + } + }, + "operationId": "get-api-v2-variants-variant_sku-shipping_methods", + "responses": { + "200": { + "$ref": "#/components/responses/VariantShippings" + }, + "404": { + "description": "Quando a variante não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Calcula o frete para uma determinada variante" + } + }, + "/api/v2/tags": { + "get": { + "summary": "Lista as tags", + "tags": [ + "Tags" + ], + "responses": { + "200": { + "description": "Quando as tags são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag.v1" + } + }, + "examples": { + "example-1": { + "value": [ + { + "products_count": 1, + "name": "camiseta", + "image_url": null, + "type": "", + "title": "Camisetas Legais", + "updated_at": "2015-03-10T04:33:08.699-03:00", + "subtitle": "Adulto e infantil", + "description": "

A loja oferece Camisetas para adultos e crianças

\n" + }, + { + "updated_at": "2017-11-05T13:23:50.107-02:00", + "products_count": 0, + "image_url": "//a0.vnda.com.br/loja/2017/03/14/15_49_52_10_Flag.png?1509895430", + "name": "promo-camiseta", + "title": "promo-camiseta", + "subtitle": null, + "description": null, + "type": "flag" + } + ] + } + } + } + } + } + }, + "operationId": "get-api-v2-tags", + "description": "Permite listar as tags", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "limit", + "description": "Indica a quantidade de tags que devem ser listadas (page será ignorado)", + "deprecated": true + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Quantidade de resultados por página" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "type", + "description": "Exibe somente as tags com o tipo indicado" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "types", + "description": "Exibe somente as tags com um dos tipos indicados" + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "names", + "description": "Exibe somente as tags com um dos nomes indicados" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "images", + "description": "Quando passado qualquer valor filtra as tags que contenham imagens" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "show_in_carts", + "description": "Quando passado qualquer valor filtra as tags marcadas para serem exibidas no carrinho" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "product_id", + "description": "Exibe somente as tags do produto indicado" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "name", + "description": "Texto livre que permite filtrar as tags pelo nome" + }, + { + "schema": { + "type": "string", + "default": "name,asc", + "enum": [ + "name,asc", + "name,desc", + "type,asc", + "type,desc", + "title,asc", + "title,desc", + "products_count,asc", + "products_count,desc" + ] + }, + "in": "query", + "name": "sort", + "description": "String no formato , que determina o campo a ser ordenado e qual a ordem (asc,desc)" + } + ] + }, + "post": { + "summary": "Cria uma tag", + "operationId": "post-api-v2-tags", + "responses": { + "201": { + "description": "Quando a tag é criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetos enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Tags" + ], + "description": "Cria uma tag", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "blurb": { + "type": "string", + "description": "Equivalente ao subtítulo" + }, + "description": { + "type": "string" + }, + "tag_type": { + "type": "string" + }, + "show_in_carts": { + "type": "boolean" + } + }, + "required": [ + "name" + ] + } + } + } + } + } + }, + "/api/v2/tags/types": { + "get": { + "summary": "Lista os tipos de tags", + "tags": [ + "Tags" + ], + "responses": { + "200": { + "description": "Quanto os tipos são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "operationId": "get-api-v2-tags-types", + "description": "Lista os tipos de tags usados em alguma tag", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Quantidade de resultados por página" + } + ] + } + }, + "/api/v2/tags/{name}": { + "parameters": [ + { + "schema": { + "type": "string", + "pattern": "[a-z0-9\\-_]+" + }, + "name": "name", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna uma tag", + "tags": [ + "Tags" + ], + "responses": { + "200": { + "description": "Quando a tag é retornada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag.v1" + } + } + } + }, + "404": { + "description": "Quando a tag não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-tags-name", + "description": "Retorna uma tag" + }, + "patch": { + "summary": "Atualiza uma tag", + "operationId": "patch-api-v2-tags-name", + "responses": { + "204": { + "description": "Quando a tag é atualizada" + }, + "404": { + "description": "Quando a tag não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Tags" + ], + "description": "Permite atualizar uma tag" + }, + "delete": { + "summary": "Remove uma tag", + "operationId": "delete-api-v2-tags-name", + "responses": { + "204": { + "description": "Quando a tag é removida" + }, + "404": { + "description": "Quando a tag não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Tags" + ], + "description": "Remove uma tag" + } + }, + "/api/v2/coupon_codes/{code}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna um cupom", + "tags": [ + "Cupons de desconto" + ], + "responses": { + "200": { + "description": "Quando o cupom é encontrado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "code": { + "type": "string" + }, + "discount_id": { + "type": "number" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "code", + "discount_id", + "updated_at" + ] + }, + "examples": { + "example-1": { + "value": { + "code": "98008F", + "discount_id": 1, + "id": 1231, + "updated_at": "2020-10-27T19:12:51.858-03:00" + } + } + } + } + } + }, + "404": { + "description": "Quando o cupom não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-coupon_codes-code", + "description": "Retorna os dados de um cupom usando o seu código" + } + }, + "/api/v2/carts/{cart_id}/payment/paypal": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Cria um pedido no Paypal", + "operationId": "post-api-v2-carts-cart_id-payments-paypal", + "responses": { + "200": { + "description": "Quando o pedido é criado no Paypal", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "id": { + "type": "string" + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "rel": { + "type": "string" + }, + "method": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "example-1": { + "value": { + "id": "31G50456P87181405", + "status": "CREATED", + "links": [ + { + "href": "https://api.sandbox.paypal.com/v2/checkout/orders/31G50456P87181405", + "rel": "self", + "method": "GET" + }, + { + "href": "https://www.sandbox.paypal.com/checkoutnow?token=31G50456P87181405", + "rel": "approve", + "method": "GET" + }, + { + "href": "https://api.sandbox.paypal.com/v2/checkout/orders/31G50456P87181405", + "rel": "update", + "method": "PATCH" + }, + { + "href": "https://api.sandbox.paypal.com/v2/checkout/orders/31G50456P87181405/capture", + "rel": "capture", + "method": "POST" + } + ] + } + } + } + } + } + }, + "400": { + "description": "Quando o pedido não é criado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + } + } + } + } + }, + "tags": [ + "Pagamentos" + ], + "description": "Cria um pedido no Paypal para que posteriormente possa receber um pagamento" + } + }, + "/api/v2/clients": { + "get": { + "summary": "Lista os clientes", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando os clientes são encontrados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Client.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-clients", + "description": "Retorna uma lista de clientes. Caso seja informado o parâmetro \"email\", então apenas o cliente com esse email será retornado", + "parameters": [ + { + "schema": { + "type": "string", + "format": "email" + }, + "in": "query", + "name": "email", + "description": "Retorna somente o cliente com o email informado", + "deprecated": true + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "per_page", + "description": "Registros por página" + }, + { + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "query", + "name": "min_updated_at", + "description": "Filtra os clientes pela menor data de atualização" + }, + { + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "query", + "name": "max_updated_at", + "description": "Filtra os clientes pela maior data de atualização" + }, + { + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "query", + "name": "birthday_start", + "description": "Data de inicío da filtragem de clientes pela data de aniversário" + }, + { + "schema": { + "type": "string", + "format": "date-time" + }, + "in": "query", + "name": "birthday_end", + "description": "Data final da filtragem de clientes pela data de aniversário" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "has_phone", + "description": "Filtra os clientes que possuem telefone" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "has_first_name", + "description": "Filtra os clientes que possuem first name" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "user_id", + "description": "Filtra os clientes por vendedor" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "term", + "description": "Filtra os clientes que possuem o termo em alguns dos campos" + }, + { + "schema": { + "type": "string", + "enum": [ + "name", + "birthdate" + ] + }, + "in": "query", + "name": "sort", + "description": "Ordena o resultado da busca de clientes conforme a opção escolhida" + } + ], + "security": [ + { + "Token": [] + } + ] + }, + "post": { + "summary": "Cria um cliente", + "operationId": "post-api-v2-clients", + "responses": { + "201": { + "description": "Quando o cliente é criado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "gender": { + "type": "string" + }, + "phone_area": { + "type": "string", + "pattern": "[0-9]+" + }, + "phone": { + "type": "string", + "pattern": "[0-9]+" + }, + "cpf": { + "type": "string", + "pattern": "[0-9]+" + }, + "cnpj": { + "type": "string", + "pattern": "[0-9]+" + }, + "ie": { + "type": "string" + }, + "tags": { + "type": "string" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + } + }, + "facebook_uid": { + "type": "string" + }, + "liked_facebook_page": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "birthdate": { + "type": "string", + "format": "date" + }, + "recent_address": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "first_phone_area": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone_area": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "email": { + "type": "string" + }, + "documents": { + "type": "object", + "properties": { + "cpf": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Permite criar um cliente", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "birthdate": { + "type": "string", + "format": "date" + }, + "gender": { + "type": "string", + "enum": [ + "M", + "F" + ] + }, + "tags": { + "type": "string", + "description": "separado por vírgula", + "example": "foo,bar" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + } + }, + "password": { + "type": "string" + }, + "password_confirmation": { + "type": "string" + }, + "terms": { + "type": "boolean" + } + } + } + } + } + } + } + }, + "/api/v2/clients/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true, + "description": "" + } + ], + "get": { + "summary": "Retorna um cliente", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando o cliente é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Client.v1" + } + } + } + }, + "404": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-clients-id", + "description": "Permite retornar as informações do cliente\nO auth_token do cliente pode ser informado no lugar do ID na URL" + }, + "patch": { + "summary": "Atualiza um cliente", + "operationId": "patch-api-v2-clients-id", + "responses": { + "204": { + "description": "Quando o cliente é atualizado" + }, + "404": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados estão incorretos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Permite atualizar as informações do cliente", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "birthdate": { + "type": "string", + "format": "date" + }, + "gender": { + "type": "string", + "enum": [ + "M", + "F" + ] + }, + "tags": { + "type": "string", + "description": "separado por vírgula", + "example": "foo,bar" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + } + }, + "password": { + "type": "string" + }, + "password_confirmation": { + "type": "string" + }, + "terms": { + "type": "boolean" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove um cliente", + "operationId": "delete-api-v2-clients-id", + "responses": { + "204": { + "description": "Quando o cliente é removido" + }, + "404": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Permite remover um cliente" + } + }, + "/api/v2/clients/{id}/orders": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os pedidos", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando os pedidos são retornados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-clients-id-orders", + "description": "Retorna a lista de pedidos do cliente" + } + }, + "/api/v2/clients/{id}/addresses": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os endereços", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando os endereços são listados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Address.v1" + } + } + } + } + }, + "operationId": "get-api-v2-clients-id-addresses", + "description": "Lista os endereços do cliente utilizados nos pedidos que foram confirmados", + "parameters": [ + { + "$ref": "#/components/parameters/status" + } + ] + } + }, + "/api/v2/clients/{client_id}/registered_addresses": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "client_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista os endereços cadastrados pelo cliente", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando os endereços são listados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientAddress.v1" + } + } + } + } + }, + "operationId": "get-api-v2-clients-id-regitered-addresses", + "description": "Lista os endereços cadastrados pelo cliente" + }, + "post": { + "summary": "Cria um endereço do cliente", + "operationId": "post-api-v2-clients-id-regitered-addresses", + "responses": { + "201": { + "description": "Quando o endereço do cliente é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientAddress.v1" + } + } + } + }, + "404": { + "description": "Quando o cliente não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Permite criar um endereço do cliente", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "label": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "reference": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/v2/clients/{client_id}/registered_addresses/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "client_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um endereço do cliente", + "operationId": "patch-api-v2-clients-id-regitered-addresses-id", + "responses": { + "200": { + "description": "Quando o endereço do cliente é atualizado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientAddress.v1" + } + } + } + }, + "404": { + "description": "Quando o cliente ou endereço não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Permite atualizar um endereço do cliente", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "label": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "reference": { + "type": "string" + } + } + } + } + } + } + }, + "delete": { + "summary": "Deleta o endereço cadastrados pelo cliente", + "tags": [ + "Clientes" + ], + "responses": { + "204": { + "description": "Quando o endereço é deletado" + }, + "404": { + "description": "Quando o endereço não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "delete-api-v2-clients-id-regitered-addresses-id", + "description": "Delete o endereço cadastrado pelo cliente" + } + }, + "/api/v2/clients/recover_password": { + "parameters": [], + "post": { + "summary": "Reseta a senha", + "operationId": "post-api-v2-clients-recover_password", + "responses": { + "200": { + "description": "Quando a senha for criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Client.v1" + } + } + } + }, + "404": { + "description": "Quando um cliente não é encontrado com o email informado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Cria uma senha para o cliente e envia por email", + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "email", + "description": "Email do cliente", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "no_send", + "description": "Preencher para pular o envio do email de senha para o cliente" + } + ] + } + }, + "/api/v2/clients/{id}/credits": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Saldo de créditos", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando o saldo é retornado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "balance": { + "type": "number" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-clients-client_id-credits", + "description": "Retorna o saldo de crétitos do cliente" + } + }, + "/api/v2/clients/{id}/credits/transfers": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Extrato de créditos", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando as transferências são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "account": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + }, + "to": { + "type": "object", + "properties": { + "account": { + "type": "string" + }, + "amount": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-clients-id-credits-transfers", + "description": "Retorna as transfertências de crétidos realizadas" + } + }, + "/api/v2/clients/{id}/bonuses": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true, + "description": "Código do cliente" + } + ], + "get": { + "summary": "Lista os bônus", + "tags": [ + "Clientes" + ], + "responses": { + "200": { + "description": "Quando os bônus são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Bonus.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-clients-id-bonuses", + "description": "Lista os bônus do cliente que ainda não foram utilizados", + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "page", + "description": "Número da página" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "per_page", + "description": "Registros por página" + } + ] + } + }, + "/api/v2/clients/{id}/remove_personal_data": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true, + "description": "" + } + ], + "patch": { + "summary": "Solicitação de esquecimento", + "operationId": "patch-api-v2-clients-id-remove-personal-data", + "responses": { + "204": { + "description": "Quando o cliente é marcado para ter seus dados pessoais removidos" + }, + "404": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Solicita a remoção (esquecimento) dos dados pessoais de um cliente, de acordo com a LGPD" + } + }, + "/api/v2/auth/email/{token}": { + "get": { + "summary": "Faz login do cliente por token", + "operationId": "get-api-v2-auth-email-token", + "responses": { + "200": { + "description": "Quanto o login é feito com sucesso", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "token": { + "type": "string" + } + }, + "required": [ + "id", + "token" + ] + } + } + } + }, + "401": { + "description": "Quando o token do email é inválido ou expirou" + } + }, + "tags": [ + "Clientes" + ], + "description": "Faz o login do cliente pelo token salvo no campo auth_token", + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "token", + "in": "path", + "required": true + } + ] + } + }, + "/api/v2/auth/client": { + "post": { + "summary": "Faz login do cliente", + "operationId": "post-api-v2-auth-client", + "responses": { + "200": { + "description": "Quanto o login é feito com sucesso", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "auth_token": { + "type": "string" + } + }, + "required": [ + "id", + "auth_token" + ] + } + } + } + }, + "400": { + "description": "Quando o email e/ou a senha estão vazios", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "enum": [ + "'email' is mandatory", + "'password' is mandatory" + ] + } + }, + "required": [ + "error" + ] + } + } + } + }, + "422": { + "description": "Quando o cliente não é encontrado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string", + "enum": [ + "email and/or password invalid" + ] + } + }, + "required": [ + "error" + ] + } + } + } + } + }, + "tags": [ + "Clientes" + ], + "description": "Faz o login do cliente por usuário e senha", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "email": { + "type": "string", + "format": "email" + }, + "password": { + "type": "string" + } + }, + "required": [ + "email", + "password" + ] + } + } + } + } + } + }, + "/api/v2/carts/{cart_id}/payment": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Faz o pagamento do carrinho", + "operationId": "post-api-v2-carts-cart-payment_id-payment", + "responses": { + "301": { + "description": "Quando o pagamento é processado corretamente", + "headers": { + "X-Attempt-Count": { + "schema": { + "type": "number" + }, + "description": "Número de tentativas de pagamento feitas para o carrinho" + }, + "Location": { + "schema": { + "type": "string" + }, + "description": "URL do pedido na API" + } + } + }, + "400": { + "description": "Quando o carrinho não pode ser pago", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + }, + "required": [ + "error" + ] + }, + "examples": { + "Itens indisponíveis": { + "value": { + "error": "Os itens do carrinho não estão mais disponíveis" + } + }, + "Alteração nos preços dos itens": { + "value": { + "error": "Houve uma alteração nos valores do carrinho" + } + } + } + } + } + }, + "404": { + "description": "Quando o carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "example-1": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "description": "Faz o pagamento do carrinho usando a forma de pagamento informada", + "tags": [ + "Pagamentos" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "payment_method": { + "type": "string", + "enum": [ + "pix" + ], + "description": "Meio de pagamento" + }, + "channel": { + "type": "string", + "default": "ecommerce", + "enum": [ + "ecommerce", + "direct" + ], + "description": "Canal de venda do carrinho" + } + }, + "required": [ + "payment_method" + ] + } + } + }, + "description": "" + } + } + }, + "/api/v2/menus": { + "get": { + "summary": "Lista os menus", + "operationId": "get-api-v2-menus", + "tags": [ + "Menus" + ], + "responses": { + "200": { + "description": "Quando os menus são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Menu.v1" + } + } + } + } + } + }, + "description": "Lista os menus", + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "parent_id" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "position" + } + ] + }, + "post": { + "summary": "Cria um menu", + "operationId": "post-api-v2-menus", + "tags": [ + "Menus" + ], + "responses": { + "201": { + "description": "Quando o menu é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Menu.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Cria um menu", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "tooltip": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "page_id": { + "type": "integer" + }, + "parent_id": { + "type": "integer" + }, + "position": { + "type": "string" + }, + "new_position": { + "type": "string" + }, + "external": { + "type": "boolean" + }, + "tag_id": { + "type": "integer" + } + }, + "required": [ + "label", + "position", + "type" + ] + } + } + } + } + } + }, + "/api/v2/menus/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna um menu", + "tags": [ + "Menus" + ], + "responses": { + "200": { + "description": "Quando o menu é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Menu.v1" + } + } + } + }, + "404": { + "description": "Quando o menu não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-menus-id", + "description": "Retorna um menu" + }, + "patch": { + "summary": "Atualiza um menu", + "operationId": "patch-api-v2-menus-id", + "responses": { + "204": { + "description": "Quando o menu é atualizado" + }, + "404": { + "description": "Quando o menu não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Menus" + ], + "description": "Atualiza um menu", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "tooltip": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "page_id": { + "type": "integer" + }, + "parent_id": { + "type": "integer" + }, + "position": { + "type": "string" + }, + "new_position": { + "type": "string" + }, + "external": { + "type": "boolean" + }, + "tag_id": { + "type": "integer" + } + }, + "required": [ + "label", + "position", + "type" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove um menu", + "operationId": "delete-api-v2-menus-id", + "responses": { + "204": { + "description": "Quando o menu é removido" + }, + "404": { + "description": "Quando o menu não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Menus" + ], + "description": "Remove um menu" + } + }, + "/api/v2/menus/positions": { + "get": { + "summary": "Lista as posições dos menus", + "operationId": "get-api-v2-menus-positions", + "tags": [ + "Menus" + ], + "responses": { + "200": { + "description": "Quando as posições são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "example-1": { + "value": [ + "principal", + "submenu" + ] + } + } + } + } + } + }, + "description": "Lista as posições dos menus" + } + }, + "/api/v2/menus/reorder": { + "post": { + "summary": "Reordena os menus", + "operationId": "post-api-v2-menus-reorder", + "tags": [ + "Menus" + ], + "responses": { + "200": { + "description": "Quando os menus são reordenados" + } + }, + "description": "Reordena os menus na ordem em que seus ids são listados no request", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "description": "A ordem dos elementos será replicada para os menus", + "items": { + "type": "integer" + } + } + }, + "required": [ + "ids" + ] + }, + "examples": { + "example-1": { + "value": { + "ids": [ + 32, + 29, + 28, + 31, + 30, + 27 + ] + } + } + } + } + } + } + } + }, + "/api/v2/menus/tree": { + "get": { + "summary": "Retorna os menus em árvore", + "operationId": "get-api-v2-menus-trees", + "tags": [ + "Menus" + ], + "responses": { + "200": { + "description": "Quando os menus são listados", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "description": "Posição", + "items": { + "$ref": "#/components/schemas/Menu_in_tree.v1" + } + } + } + } + } + } + }, + "description": "Retorna os menus em árvore, organizados pela posição" + } + }, + "/api/v2/site_message": { + "get": { + "summary": "Retorna uma mensagem do site", + "tags": [ + "Mensagens do site" + ], + "responses": { + "200": { + "description": "Quando a mensagem do site existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Site_message.v1" + } + } + } + }, + "404": { + "description": "Quando a mensagem do site não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-site-message", + "description": "Retorna uma mensagem do site" + }, + "patch": { + "summary": "Cria ou atualiza uma mensagem do site", + "operationId": "post-api-v2-site-message", + "tags": [ + "Mensagens do site" + ], + "responses": { + "204": { + "description": "Quando a mensagem é criada ou atualizada" + } + }, + "description": "Cria ou atualiza uma mensagem do site", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "call_to_action": { + "type": "string" + } + } + } + } + } + } + }, + "delete": { + "summary": "Remove uma mensagem do site", + "operationId": "delete-api-v2-site-message", + "responses": { + "204": { + "description": "Quando a mensagem é ou não removida" + }, + "404": { + "description": "Quando o menu não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Mensagens do site" + ], + "description": "Remove uma mensagem do site" + } + }, + "/api/v2/shop/images": { + "get": { + "summary": "Lista as images", + "tags": [ + "Loja" + ], + "responses": { + "200": { + "description": "Quando as imagens são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Shop_asset.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-shop-images", + "description": "Lista as imagens associadas a loja", + "parameters": [ + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/sort" + } + ] + }, + "post": { + "summary": "Cria uma imagem", + "operationId": "post-api-v2-shop-images", + "responses": { + "201": { + "description": "Quando a imagem é criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shop_asset.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviado são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Loja" + ], + "description": "Permite cadastrar uma imagem", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "position": { + "type": "string" + }, + "file_uid": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/v2/shop/images/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Remove uma imagem", + "operationId": "delete-api-v2-shop-images-id", + "responses": { + "204": { + "description": "Quando a imagem é removida" + }, + "404": { + "description": "Quando a imagem não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Permite remover uma imagem da loja", + "tags": [ + "Loja" + ] + } + }, + "/api/v2/shop/product_attributes": { + "post": { + "summary": "Cria um atributo customizado de produto", + "operationId": "post-api-v2-shop-product-attributes", + "responses": { + "201": { + "description": "Quando o atributo customizado de produto é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Products_attributes.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Permite adicionar um atributo customizado de produto", + "tags": [ + "Loja" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index": { + "type": "number" + }, + "name": { + "type": "string" + }, + "mandatory": { + "type": "boolean" + } + }, + "required": [ + "index", + "name", + "mandatory" + ] + } + } + }, + "description": "Quando o atributo customizado é criado" + } + }, + "parameters": [] + }, + "/api/v2/customizations": { + "get": { + "summary": "Lista as personalizações", + "responses": { + "200": { + "description": "Quando as personalizações são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customization.v1" + } + } + } + } + } + }, + "operationId": "get-api-v2-customizations", + "description": "Permite listar as personalizações", + "tags": [ + "Personalizações" + ], + "parameters": [ + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "product_id", + "description": "Filtra por produto" + } + ] + }, + "post": { + "summary": "Cria uma personalização", + "operationId": "post-api-v2-customizations", + "responses": { + "201": { + "description": "Quando a personalização é criada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customization.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Permite criar uma personalização", + "tags": [ + "Personalizações" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group_name": { + "type": "string" + }, + "group_type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "image_uid": { + "type": "string" + }, + "image_name": { + "type": "string" + }, + "price": { + "type": "number", + "default": 0 + }, + "quantity": { + "type": "integer", + "default": 0 + }, + "handling_days": { + "type": "integer", + "default": 0 + }, + "tag_id": { + "type": "integer" + }, + "sku": { + "type": "string" + }, + "pattern": { + "type": "string" + } + }, + "required": [ + "group_name", + "group_type", + "name", + "tag_id" + ] + } + } + }, + "description": "" + } + }, + "parameters": [] + }, + "/api/v2/customizations/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Remove uma personalização", + "operationId": "delete-api-v2-customizations-id", + "responses": { + "204": { + "description": "Quando a personalização é removida" + }, + "404": { + "description": "Quando a personalização não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Personalizações" + ], + "description": "Permite remover uma personalização" + }, + "patch": { + "summary": "Altera uma personalização", + "operationId": "patch-api-v2-customizations-id", + "responses": { + "204": { + "description": "Quando a personalização é alterada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customization.v1" + } + } + } + }, + "404": { + "description": "Quando a personalização não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "description": "Permite alterar uma personalização", + "parameters": [], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "group_name": { + "type": "string" + }, + "group_type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "image_uid": { + "type": "string" + }, + "image_name": { + "type": "string" + }, + "price": { + "type": "string" + }, + "quantity": { + "type": "string" + }, + "handling_days": { + "type": "string" + }, + "tag_id": { + "type": "string" + }, + "sku": { + "type": "string" + }, + "pattern": { + "type": "string" + } + } + } + } + } + }, + "tags": [ + "Personalizações" + ] + }, + "get": { + "summary": "Retorna uma personalização", + "operationId": "get-api-v2-customizations-id", + "responses": { + "200": { + "description": "Quando a personalização é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customization.v1" + } + } + } + }, + "404": { + "description": "Quando a personalização não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Personalizações" + ], + "description": "Permite retornar uma personalização" + } + }, + "/api/v2/orders/{order_id}/items": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_customizations_in_total", + "description": "Inclui o preço dos produtos customizados no total do pedido" + } + ], + "get": { + "summary": "Lista os itens do pedido", + "responses": { + "200": { + "description": "Quando os itens do pedido são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order_items.v1" + } + } + } + } + }, + "404": { + "description": "Quando a lista de itens do pedido não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-orders-order_id-items", + "tags": [ + "Pedidos" + ], + "description": "Permite listar os itens do pedido" + } + }, + "/api/v2/orders/{order_id}/items/{item_id}/customizations": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "order_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "item_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as personalizações do item do pedido", + "responses": { + "200": { + "description": "Quando as personalizações são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order_item_customization.v1" + } + }, + "examples": { + "Com pesonalizações": { + "value": [ + { + "id": 1, + "number": 1, + "group_name": "Color", + "sku": "A1", + "name": "Red", + "price": 0, + "intl_price": 0, + "handling_days": 0 + } + ] + }, + "Sem personalizações": { + "value": [] + } + } + } + } + }, + "404": { + "description": "Quando o item não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-orders-order_id-items-item_id-customizations", + "tags": [ + "Pedidos" + ], + "description": "Permite listar as personalizações de cada item do pedido" + } + }, + "/api/v2/carts/{cart_id}/items/{item_id}/customizations": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + }, + { + "schema": { + "type": "string" + }, + "name": "item_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as personalizações do item do carrinho", + "responses": { + "200": { + "$ref": "#/components/responses/CartItemCustomizationList" + }, + "404": { + "description": "Quando o item não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-carts-cart_id-items-item_id-customizations", + "tags": [ + "Carrinhos" + ], + "description": "Permite listar as personalizações de cada item do carrinho" + }, + "delete": { + "summary": "Remove uma personalização do item do carrinho", + "operationId": "delete-api-v2-carts-cart_id-items-item_id-customizations", + "responses": { + "204": { + "description": "Quando a personalização é removida" + }, + "404": { + "description": "Quando a personalização não é encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Permite remover uma customização do item do carrinho", + "tags": [ + "Carrinhos" + ] + } + }, + "/api/v2/mappings": { + "get": { + "summary": "Lista os mapeamentos", + "tags": [ + "Mapeamentos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Mappings" + } + }, + "operationId": "get-api-v2-mappings", + "description": "Lista os mapeamentos", + "parameters": [ + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + } + ] + }, + "post": { + "summary": "Cria um mapeamento", + "operationId": "post-api-v2-mappings", + "responses": { + "201": { + "$ref": "#/components/responses/MappingCreate" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "tags": [ + "Mapeamentos" + ], + "description": "Cria um mapeamento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "from": { + "type": "array", + "items": { + "type": "string" + } + }, + "to": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + } + } + } + } + }, + "/api/v2/mappings/{id}": { + "parameters": [ + { + "schema": { + "type": "integer" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna um mapeamento", + "tags": [ + "Mapeamentos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Mapping" + }, + "404": { + "$ref": "#/components/responses/404" + } + }, + "operationId": "get-api-v2-mappings-id", + "description": "Retorna os dados de um mapeamento" + }, + "patch": { + "summary": "Atualiza um mapeamento", + "operationId": "patch-api-v2-mappings-id", + "responses": { + "204": { + "description": "Quando o mapeamento é atualizado" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "tags": [ + "Mapeamentos" + ], + "description": "Atualiza um mapeamento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "from": { + "type": "array", + "items": { + "type": "string" + } + }, + "to": { + "type": "string" + } + }, + "required": [ + "key" + ] + } + } + } + } + }, + "delete": { + "summary": "Remove um mapeamento", + "operationId": "delete-api-v2-mappings-id", + "responses": { + "204": { + "description": "Quando o mapeamento é removido" + }, + "404": { + "$ref": "#/components/responses/404" + } + }, + "tags": [ + "Mapeamentos" + ], + "description": "Remove um mapeamento" + } + }, + "/api/v2/banners": { + "get": { + "summary": "Lista os banners", + "responses": { + "200": { + "$ref": "#/components/responses/Banners" + } + }, + "operationId": "get-api-v2-banners", + "description": "Retorna a lista de banners", + "tags": [ + "Mídias" + ], + "parameters": [ + { + "$ref": "#/components/parameters/only_valid" + }, + { + "$ref": "#/components/parameters/only_expired" + }, + { + "$ref": "#/components/parameters/only_scheduled" + }, + { + "$ref": "#/components/parameters/tag" + }, + { + "$ref": "#/components/parameters/title" + }, + { + "$ref": "#/components/parameters/no_paginate" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + } + ] + } + }, + "/api/v2/banners/{id}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Retorna um banner", + "tags": [ + "Mídias" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Banner" + }, + "404": { + "$ref": "#/components/responses/404" + } + }, + "operationId": "get-api-v2-banners-id", + "description": "Retorna os dados de um banner" + } + }, + "/api/v2/banners/all": { + "get": { + "summary": "Retorna os banners agrupados por tag", + "tags": [ + "Mídias" + ], + "responses": { + "200": { + "$ref": "#/components/responses/AllBanners" + } + }, + "operationId": "get-api-v2-banners-all", + "parameters": [], + "description": "Retorna todos os banners disponíveis agrupados por tag" + }, + "parameters": [] + }, + "/api/v2/carts/{cart_id}/shipping_methods/intl": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Cálculo de frete internacional", + "tags": [ + "Carrinhos" + ], + "responses": { + "200": { + "description": "Quando as formas de entrega são retornadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "{package_label}": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Shipping_methods.v1" + } + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "operationId": "get-api-v2-carts-cart_id-shipping_methods-intl", + "description": "Permite calcular o frete para pedidos internacionais", + "parameters": [ + { + "schema": { + "type": "string", + "example": "BRA", + "pattern": "^[A-Z]{3}$" + }, + "in": "query", + "name": "country", + "description": "Código do país de destino", + "required": true + } + ] + } + }, + "/api/v2/carts/{cart_id}/samples": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "cart_id", + "in": "path", + "required": true + } + ], + "get": { + "summary": "Lista as amostras", + "tags": [ + "Carrinhos" + ], + "responses": { + "200": { + "description": "Quando as amostras são listadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "image_url": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string" + }, + "variants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "image_url": { + "type": "string", + "nullable": true + }, + "product_id": { + "type": "integer" + }, + "norder": { + "type": "integer" + } + }, + "required": [ + "id", + "main", + "sku", + "name", + "updated_at", + "image_url", + "product_id", + "norder" + ] + } + } + }, + "required": [ + "id", + "image_url", + "name", + "reference", + "updated_at", + "url", + "variants" + ] + } + } + } + }, + "404": { + "description": "Quando um carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-carts-cart-id-samples", + "description": "Lista as amostras disponíveis para determinado carrinho" + } + }, + "/api/v2/carts/{cart_id}/shipping_address": { + "parameters": [ + { + "$ref": "#/components/parameters/cart_id" + } + ], + "get": { + "summary": "Endereço de entrega", + "tags": [ + "Carrinhos" + ], + "responses": { + "200": { + "description": "Quando o endereço é retornado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "documents": { + "type": "object", + "description": "Serão retornados apenas os campos preenchidos", + "properties": { + "cpf": { + "type": "string" + }, + "cnpj": { + "type": "string" + }, + "ie": { + "type": "string" + } + } + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string", + "example": "188A" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "first_phone_area": { + "type": "string", + "description": "Somente números", + "example": "11" + }, + "first_phone": { + "type": "string", + "description": "Somente números", + "example": "984453322" + }, + "second_phone_area": { + "type": "string", + "description": "Somente números" + }, + "second_phone": { + "type": "string", + "description": "Somente números" + }, + "reference": { + "type": "string" + }, + "zip": { + "type": "string", + "description": "Somente números", + "example": "90050000" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string", + "example": "RS", + "minLength": 2, + "maxLength": 2 + }, + "recipient_name": { + "type": "string" + } + }, + "required": [ + "first_name", + "last_name", + "email", + "street_name", + "street_number", + "neighborhood", + "first_phone_area", + "first_phone", + "zip", + "city", + "state" + ], + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "404": { + "description": "Quando o carrinho não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-carts-cart_id-shipping_address", + "description": "Retorna o endereço de entrega" + }, + "post": { + "summary": "Adiciona um endereço de entrega", + "description": "Adiciona um endereço de entrega no carrinho", + "tags": [ + "Envio do carrinho" + ], + "operationId": "post-api-v2-carts-cart_id-shipping_address", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "responses": { + "201": { + "description": "Endereço adicionado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart_item.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/carts/{cart_id}/coupon_code": { + "parameters": [ + { + "$ref": "#/components/parameters/cart_id" + } + ], + "post": { + "summary": "Associa código de cupom ao carrinho", + "tags": [ + "Carrinhos" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Código do cupom" + } + }, + "required": [ + "code" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Quando o cupom é associado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Código do cupom" + }, + "discount": { + "type": "number" + }, + "rebate_token": { + "type": "string" + }, + "rebate_discount": { + "type": "number" + } + }, + "required": [ + "code", + "discount", + "rebate_token", + "rebate_discount" + ] + } + } + } + }, + "404": { + "description": "Quando o carrinho ou o desconto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "post-api-v2-carts-cart_id-coupon_code", + "description": "Associa um código de cupom ao carrinho" + } + }, + "/api/v2/orders/channels": { + "get": { + "summary": "Lista os canais dos pedidos", + "tags": [ + "Pedidos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Channels" + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "operationId": "get-api-v2-orders-channels", + "description": "Lista todos os channels usados nos pedidos criados" + } + }, + "/api/v2/orders/states": { + "get": { + "summary": "Lista os estados dos pedidos", + "tags": [ + "Pedidos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/States" + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "get-api-v2-orders-states", + "description": "Lista todos os estados usados nos pedidos criados", + "security": [ + { + "Token": [] + } + ] + } + }, + "/api/v2/products/{product_id}/price": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "product_id", + "in": "path", + "required": true, + "description": "ID do produto" + } + ], + "get": { + "summary": "Lista os preços do produto", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ProductPrice" + } + }, + "operationId": "get-api-v2-products-product_id-price", + "description": "Retorna o preço do produto e das variantes", + "security": [ + { + "Token": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/coupon_codes" + } + ] + } + }, + "/api/v2/products/{product_id}/images": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + } + ], + "get": { + "summary": "Lista as imagens do produto", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ProductImages" + } + }, + "operationId": "get-api-v2-products-product_id-images", + "description": "Lista as imagens do produto" + }, + "post": { + "summary": "Cria uma imagem do produto", + "tags": [ + "Produtos" + ], + "responses": { + "201": { + "$ref": "#/components/responses/ProductImage" + }, + "404": { + "description": "Quando o produto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "file_url": { + "type": "string", + "format": "uri" + }, + "variant_ids": { + "type": "array", + "description": "IDs da variantes associadas a imagem", + "items": { + "type": "integer" + } + } + }, + "required": [ + "file_url" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images", + "description": "Cria uma imagem do produto" + } + }, + "/api/v2/products/{product_id}/images/{id}": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "delete": { + "summary": "Deleta uma imagem do produto", + "tags": [ + "Produtos" + ], + "responses": { + "204": { + "description": "Quando a imagem é deletada" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "delete-api-v2-products-product_id-images-id", + "description": "Deleta uma imagem do produto" + } + }, + "/api/v2/products/{product_id}/images/reorder": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + } + ], + "post": { + "summary": "Reordena imagens do produto", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando as imagens são reordenadas" + }, + "404": { + "description": "Quando o produto não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "integer" + } + } + }, + "required": [ + "ids" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images-reorder", + "description": "Reordena as imagens do produto" + } + }, + "/api/v2/products/{product_id}/images/{id}/add_variant": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Associa imagem com variante", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando a imagem é associada com a variante" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variant_id": { + "type": "integer" + } + }, + "required": [ + "variant_id" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images-id-add_variant", + "description": "Associa a imagem com uma variante" + } + }, + "/api/v2/products/{product_id}/images/{id}/remove_variant": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true + } + ], + "post": { + "summary": "Desassocia imagem da variante", + "tags": [ + "Produtos" + ], + "responses": { + "200": { + "description": "Quando a imagem é desassociada da variante" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variant_id": { + "type": "integer" + } + }, + "required": [ + "variant_id" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images-id-remove_variant", + "description": "Remove a associação da imagem com uma variante" + } + }, + "/api/v2/orders/{order_code}/packages": { + "parameters": [ + { + "$ref": "#/components/parameters/order_code" + } + ], + "get": { + "summary": "Lista os pacotes de um pedido", + "tags": [ + "Pacotes" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Packages" + }, + "404": { + "description": "Pedido ou pacote não encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-orders-order_code-packages", + "description": "Retorna uma lista de pacotes de um pedido", + "security": [ + { + "Token": [] + } + ] + } + }, + "/api/v2/events": { + "post": { + "summary": "Dispara eventos", + "operationId": "post-api-v2-events", + "responses": { + "204": { + "description": "Quando o evento é recebido" + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Eventos" + ], + "description": "Indica para a API que dererminado evento aconteceu e que ela deve disparar as ações relacionadas", + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "event_type", + "required": true, + "description": "Evento que ocorreu" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "id", + "description": "ID do recurso selacionado ao evento", + "required": true + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "browser_ip", + "description": "IP do usuário" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "user_agent", + "description": "User agent do usuário" + } + ] + } + }, + "/api/v2/users/{id}/payables": { + "get": { + "tags": [ + "Recebíveis de usuários" + ], + "summary": "Lista os recebíveis de um usuário pelo ID", + "responses": { + "200": { + "description": "Lista de recebíveis do usuário", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Payables.v1" + } + } + } + } + }, + "404": { + "description": "Quando o usuário não está cadastrado como recebedor", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Permite a listagem de recebíveis (comissão) de um usuário vendedor da loja, quando ocorre split de pagamentos via Pagarme ", + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id", + "in": "path", + "required": true, + "description": "Código idenficador de usuário" + } + ], + "operationId": "get-api-v2-users-id-payables" + } + }, + "/api/v2/products/{product_id}": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + } + ], + "get": { + "summary": "Retorna um produto", + "tags": [ + "Produto" + ], + "responses": { + "200": { + "description": "Produto encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product.v1" + }, + "examples": { + "example-1": { + "value": { + "id": 0, + "active": true, + "available": true, + "category_tags": [ + { + "tag_type": "string", + "name": "string", + "title": "string" + } + ], + "description": "string", + "discount_id": 0, + "html_description": "string", + "image_url": "string", + "installments": [ + 0 + ], + "min_quantity": "string", + "name": "string", + "on_sale": true, + "plain_description": "string", + "price": 0, + "rating": { + "rating": 0, + "votes": 0 + }, + "reference": "string", + "sale_price": 0, + "slug": "string", + "tag_names": [ + "string" + ], + "updated_at": "string", + "url": "string", + "variants": [ + { + "{id}": { + "available": true, + "available_quantity": 0, + "custom_attributes": {}, + "handling_days": 0, + "height": 0, + "id": 1, + "image_url": "string", + "installments": [ + 0 + ], + "inventories": [ + { + "created_at": "2019-08-24T14:15:22Z", + "id": 0, + "name": null, + "place_id": 0, + "price": 0, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "slug": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_id": 0, + "place_name": "string" + } + ], + "length": 0, + "main": true, + "min_quantity": 0, + "name": "string", + "norder": 0, + "price": 0, + "product_id": 0, + "properties": { + "property1": { + "defining": true, + "name": "string", + "value": "string" + }, + "property2": { + "defining": true, + "name": "string", + "value": "string" + }, + "property3": { + "defining": true, + "name": "string", + "value": "string" + } + }, + "quantity": 0, + "quantity_sold": 0, + "sale_price": 0, + "sku": "string", + "slug": "string", + "stock": 0, + "updated_at": "2019-08-24T14:15:22Z", + "weight": 0, + "width": 0 + } + } + ], + "discount_rule": null, + "images": [ + { + "id": 0, + "url": "string", + "updated_at": "2019-08-24T14:15:22Z", + "variant_ids": [ + 0 + ] + } + ] + } + } + } + } + } + }, + "404": { + "description": "Produto não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product.v1" + } + } + } + } + }, + "operationId": "get-api-v2-products-id", + "description": "Retorna um produto pelo código identificador (`product_id`)", + "parameters": [ + { + "$ref": "#/components/parameters/coupon_codes", + "description": "Cupons para calcular o desconto no produto consultado" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "include_inventory_place", + "description": "Selecione `true` para incluir o nome do local de armazenamento no retorno da requisição" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "include_images", + "description": "Selecione `true` para incluir todas as imagens do produto" + } + ] + }, + "patch": { + "summary": "Atualiza um produto", + "operationId": "patch-api-v2-products-id", + "responses": { + "204": { + "description": "Produto atualizado" + }, + "404": { + "description": "Produto não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Produto" + ], + "description": "Atualiza informações de um produto no catálogo pelo código identificador (`product_id`)", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SimpleProduct" + } + } + } + } + }, + "delete": { + "summary": "Remove um produto", + "operationId": "delete-api-v2-products-id", + "responses": { + "204": { + "description": "Produto removido" + }, + "404": { + "description": "Produto não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Produto" + ], + "description": "Remove um produto do catálogo pelo código indentificador (`product_id`)" + } + }, + "/api/v2/products/{product_id}/rate": { + "post": { + "summary": "Avalia um produto", + "tags": [ + "Produto" + ], + "responses": { + "200": { + "description": "Avaliação enviada", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "rating": { + "type": "string", + "description": "Média das avaliações" + }, + "votes": { + "type": "string", + "description": "Número de avaliações recebidas" + } + } + }, + "examples": { + "example-1": { + "value": { + "rating": "0.9", + "votes": "2" + } + } + } + } + } + }, + "400": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "error": "invalid rate value" + } + } + } + } + } + }, + "404": { + "description": "Produto não possui variantes", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "example-1": { + "value": { + "error": "product without variants" + } + } + } + } + } + } + }, + "operationId": "get-api-v2-products-id-rate", + "description": "Recebe uma avaliação e recalcula a pontuação atual", + "parameters": [ + { + "schema": { + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + "in": "query", + "name": "rate", + "description": "Avaliação" + } + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + } + ] + }, + "/api/v2/products/{product_id}/variants/{variant_id}": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "schema": { + "type": "string" + }, + "name": "variant_id", + "in": "path", + "required": true, + "description": "Código identificador da variante" + } + ], + "patch": { + "summary": "Atualiza uma variante", + "operationId": "patch-api-v2-products-product_id-variants-id", + "responses": { + "204": { + "description": "Variante atualizada" + }, + "404": { + "description": "Variante não existente", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Variante de produto" + ], + "description": "Atualiza as informações de um variante", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "price": { + "type": "number" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "min_quantity": { + "type": "integer" + }, + "norder": { + "type": "integer" + }, + "property1": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "property2": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "property3": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "barcode": { + "type": "string" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + } + }, + "required": [ + "sku", + "quantity", + "price" + ] + } + } + } + }, + "deprecated": true + }, + "delete": { + "summary": "Remove uma variante", + "operationId": "delete-api-v2-products-product_id-variants-id", + "responses": { + "204": { + "description": "Quando a variante é removida" + }, + "404": { + "description": "Quando a variante não existe", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Variante de produto" + ], + "description": "Permite remover uma variante" + } + }, + "/api/v2/products/{product_id}/images/{image_id}": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "$ref": "#/components/parameters/image_id" + } + ], + "delete": { + "summary": "Deleta uma imagem do produto", + "tags": [ + "Imagens de produtos e variantes" + ], + "responses": { + "204": { + "description": "Quando a imagem é deletada" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "operationId": "delete-api-v2-products-product_id-images-id", + "description": "Deleta uma imagem do produto" + } + }, + "/api/v2/products/{product_id}/images/{image_id}/add_variant": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "$ref": "#/components/parameters/image_id" + } + ], + "post": { + "summary": "Associa imagem com variante", + "tags": [ + "Imagens de produtos e variantes" + ], + "responses": { + "200": { + "description": "Quando a imagem é associada com a variante" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variant_id": { + "type": "integer" + } + }, + "required": [ + "variant_id" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images-id-add_variant", + "description": "Associa a imagem com uma variante" + } + }, + "/api/v2/products/{product_id}/images/{image_id}/remove_variant": { + "parameters": [ + { + "$ref": "#/components/parameters/product_id" + }, + { + "$ref": "#/components/parameters/image_id" + } + ], + "post": { + "summary": "Desassocia imagem da variante", + "tags": [ + "Imagens de produtos e variantes" + ], + "responses": { + "200": { + "description": "Quando a imagem é desassociada da variante" + }, + "404": { + "description": "Quando o produto ou a imagem não são encontrados", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "variant_id": { + "type": "integer" + } + }, + "required": [ + "variant_id" + ] + } + } + } + }, + "operationId": "post-api-v2-products-product_id-images-id-remove_variant", + "description": "Remove a associação da imagem com uma variante" + } + }, + "/api/v2/carts/{cart_id}": { + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + } + ], + "get": { + "summary": "Retorna um carrinho", + "operationId": "get-api-v2-carts-id", + "tags": [ + "Carrinhos da loja" + ], + "description": "Retorna as informações de um carrinho pelo seu `id` ou `token`", + "responses": { + "200": { + "description": "Carrinho encontrado", + "headers": { + "X-Attempt-Count": { + "schema": { + "type": "integer" + }, + "description": "O número de tentativas de pagamento" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "404": { + "description": "Carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Atualiza um carrinho", + "operationId": "patch-api-v2-carts-id", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.simple" + } + } + } + }, + "tags": [ + "Carrinhos da loja" + ], + "description": "Permite atualizar os atributos de um carrinho", + "responses": { + "204": { + "description": "Carrinho atualizado com sucesso", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "404": { + "description": "Carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + }, + "delete": { + "summary": "Exclui um carrinho", + "operationId": "delete-api-v2-carts-id", + "tags": [ + "Carrinhos da loja" + ], + "description": "Permite excluir um carrinho", + "responses": { + "204": { + "description": "Carrinho excluído com sucesso" + }, + "404": { + "description": "Carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "404": { + "value": { + "error": "not found" + } + } + } + } + } + } + } + } + }, + "/api/v2/carts/{cart_id}/items/{item_id}": { + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + }, + { + "schema": { + "type": "string" + }, + "name": "item_id", + "in": "path", + "required": true + } + ], + "patch": { + "summary": "Atualiza um item do carrinho", + "operationId": "patch-api-v2-carts-cart_id-items-id", + "responses": { + "204": { + "description": "Item do carrinho alterado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart.v1" + } + } + } + }, + "404": { + "description": "Item ou o carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "description": "Atualiza um item do carrinho", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "$ref": "#/components/schemas/Product.v0" + } + } + } + }, + "tags": [ + "Itens do carrinho" + ] + }, + "delete": { + "summary": "Remove um item do carrinho", + "operationId": "delete-api-v2-carts-cart_id-items-id", + "responses": { + "204": { + "description": "Item do carrinho removido" + }, + "404": { + "description": "Item ou o carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Itens do carrinho" + ], + "description": "Remove um item do carrinho" + } + }, + "/api/v2/carts/{cart_id}/shipping_methods/{value_method}": { + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + }, + { + "schema": { + "type": "string" + }, + "name": "value_method", + "in": "path", + "required": true, + "description": "Tipo de envio (`value`)" + } + ], + "patch": { + "summary": "Atualiza o método de envio de um carrinho", + "operationId": "patch-api-v2-carts-cart_id-shipping_methods-value_method", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_methods.v1" + } + } + } + }, + "tags": [ + "Envio do carrinho" + ], + "description": "Atualiza o método para o envio dos itens do carrinho", + "responses": { + "204": { + "description": "Carrinho atualizado com sucesso" + }, + "404": { + "description": "Carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/carts/{cart_id}/shipping_methods": { + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + } + ], + "get": { + "summary": "Cálculo de frete", + "tags": [ + "Envio do carrinho" + ], + "operationId": "get-api-v2-carts-cart_id-shipping_methods", + "description": "Calculo os método de envio disponíveis para o carrinho", + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + } + ], + "responses": { + "200": { + "description": "Formas de envio disponíveis retornadas", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "{package_label}": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Shipping_methods.v1" + } + } + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/carts/{cart_id}/installments": { + "parameters": [ + { + "$ref": "#/components/parameters/Cart.id" + } + ], + "get": { + "summary": "Calcula as parcelas de pagamento", + "tags": [ + "Pagamento" + ], + "operationId": "get-api-v2-carts-cart_id-installments", + "description": "Calcula as parcelas de pagamento para valor total do carrinho", + "responses": { + "200": { + "description": "Carrinho encontrado", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart_installment.v1" + } + } + } + } + }, + "404": { + "description": "Carrinho não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + }, + "examples": { + "Não encontrado": { + "value": { + "error": "not found" + } + } + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + }, + { + "$ref": "#/components/parameters/include_customizations_in_total" + } + ], + "get": { + "summary": "Retorna um pedido", + "tags": [ + "Pedidos" + ], + "operationId": "get-api-v2-orders-order-code", + "description": "Retorna os dados de um pedido pelo `code` ou `token` do pedido", + "parameters": [ + { + "schema": { + "type": "boolean", + "default": false + }, + "in": "query", + "name": "include_shipping_address", + "description": "Inclui as formas de entrega do pedido" + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + }, + "patch": { + "summary": "Atualiza dados extras de um pedido", + "operationId": "patch-api-v2-orders-order_code", + "description": "Atualiza o campo de dados extras de um pedido pelo `code` do pedido", + "tags": [ + "Pedidos" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "extra": { + "type": "object", + "description": "Campo para registro de observações, chave ou valores necessários" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Dado extra alterado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/orders/{order_code}/events": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "get": { + "summary": "Retorna os eventos ocorridos em um pedido", + "tags": [ + "Pedidos" + ], + "operationId": "get-api-v2-orders-order-code-events", + "description": "Retorna a *timeline* de eventos ocorridos em um pedido", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + }, + "examples": { + "events": { + "value": [ + { + "occurred_at": "2022-12-26T11:53:12.401-03:00", + "name": "Pedido enviado", + "user": "Jessica", + "ip": "172.29.33.150", + "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36", + "created_at": "2022-12-26T11:53:12.402-03:00", + "updated_at": "2022-12-26T11:53:12.402-03:00" + }, + { + "occurred_at": "2022-12-26T11:53:28.136-03:00", + "name": "Pedido entregue", + "user": "Jessica", + "ip": "178.29.79.40", + "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36", + "created_at": "2022-12-26T11:53:28.136-03:00", + "updated_at": "2022-12-26T11:53:28.136-03:00" + } + ] + } + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/reviews": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "get": { + "summary": "Retorna a avaliação de um pedido", + "tags": [ + "Pedidos" + ], + "operationId": "get-api-v2-orders-order-code-reviews", + "description": "Retorna a avaliação que o cliente fez em um pedido", + "responses": { + "200": { + "description": "Resenhas retornadas" + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/discounts": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "get": { + "summary": "Retorna os descontos de um pedido", + "tags": [ + "Pedidos" + ], + "operationId": "get-api-v2-orders-order-code-discounts", + "description": "Retorna os descontos de um pedido pelo `code` ou `token` do pedido", + "responses": { + "200": { + "description": "Descontos retornados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": {} + } + }, + "example": { + "Desconto": { + "value": [ + { + "name": "Pagamento via slip", + "valid_to": "payment", + "apply_to": "cart", + "type": "%", + "value": "10,", + "package": null, + "sku": null, + "created_at": "2022-12-02T12:00:03.651-03:00", + "updated_at": "2022-12-02T12:00:03.651-03:00" + } + ] + } + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/shipping_address": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "get": { + "summary": "Retorna o endereço de envio", + "description": "Retorna o endereço de envio pelo `code` do pedido", + "tags": [ + "Envio de pedido" + ], + "operationId": "get-api-v2-orders-order-code-shipping_address", + "responses": { + "200": { + "description": "Endereço do pedido retornado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + }, + "patch": { + "summary": "Atualiza endereço do pedido", + "operationId": "patch-api-v2-orders-order-code-shipping-address", + "description": "Atualiza dados de endereço do pedido", + "tags": [ + "Envio de pedido" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "responses": { + "204": { + "description": "Endereço do pedido alterado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Shipping_address" + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/orders/{order_code}/capture": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "post": { + "summary": "Captura um pedido", + "operationId": "post-api-v2-orders-capture", + "description": "Captura o pagamento no adquirente para pedidos com pagamento por cartão de crédito.", + "tags": [ + "Fluxo e andamento" + ], + "responses": { + "200": { + "description": "Captura realizada com sucesso", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": {} + }, + "examples": { + "Pagar.me": { + "value": { + "object": "transaction", + "status": "paid", + "refuse_reason": null, + "status_reason": "acquirer", + "acquirer_response_code": "0000", + "acquirer_name": "pagarme", + "acquirer_id": "5eab10915eab10915eab1091", + "authorization_code": "123456", + "soft_descriptor": "", + "tid": 1234567, + "nsu": 1234567, + "date_created": "2020-05-14T19:14:50.322Z", + "date_updated": "2020-05-15T14:19:34.699Z", + "amount": 1400, + "authorized_amount": 1400, + "paid_amount": 1400, + "refunded_amount": 0, + "installments": 1, + "id": 1234567, + "cost": 120, + "card_holder_name": "John Doe", + "card_last_digits": "6565", + "card_first_digits": "470373", + "card_brand": "visa", + "card_pin_mode": null, + "card_magstripe_fallback": false, + "cvm_pin": false, + "postback_url": "https://demo.vnda.com.br/api/v2/payments/pagarme/notifications", + "payment_method": "credit_card", + "capture_method": "ecommerce", + "antifraud_score": null, + "boleto_url": null, + "boleto_barcode": null, + "boleto_expiration_date": null, + "referer": "api_key", + "ip": "127.0.0.1", + "subscription_id": null, + "phone": null, + "address": null, + "customer": { + "object": "customer", + "id": 2954669, + "external_id": "example@vnda.com.br", + "type": "individual", + "country": "br", + "document_number": null, + "document_type": "cpf", + "name": "John Doe", + "email": "example@vnda.com.br", + "phone_numbers": [ + "+5511111111111" + ], + "born_at": null, + "birthday": null, + "gender": null, + "date_created": "2020-05-14T19:14:50.248Z", + "documents": [ + { + "object": "document", + "id": "doc_cka75cka75cka75cka75cka75", + "type": "cpf", + "number": 191 + } + ] + }, + "billing": { + "object": "billing", + "id": 1255695, + "name": "John Doe", + "address": { + "object": "address", + "street": "Rua João Neves da Fontoura", + "complementary": null, + "street_number": "1", + "neighborhood": "Azenha", + "city": "Porto Alegre", + "state": "RS", + "zipcode": "90050030", + "country": "br", + "id": 2808888 + } + }, + "shipping": null, + "items": [ + { + "object": "item", + "id": "05.01.4.1.006", + "title": "Aceto Balsâmico Di Modena IGP 500ml Aceto Balsamico Di Modena IGP 500ml", + "unit_price": 1400, + "quantity": 1, + "category": null, + "tangible": true, + "venue": null, + "date": null + } + ], + "card": { + "object": "card", + "id": "card_cka75cka75cka75cka75cka75", + "date_created": "2020-05-14T19:14:50.307Z", + "date_updated": "2020-05-14T19:14:50.717Z", + "brand": "visa", + "holder_name": "f dc", + "first_digits": "470373", + "last_digits": "6565", + "country": "RUSSIA", + "fingerprint": "cka75cka75cka75cka75cka75", + "valid": true, + "expiration_date": "0423" + }, + "split_rules": null, + "metadata": { + "order": "7A4F490570", + "seller-1": { + "name": "default", + "package": "7A4F490570-01" + } + }, + "antifraud_metadata": {}, + "reference_key": null, + "device": null, + "local_transaction_id": null, + "local_time": null, + "fraud_covered": false, + "fraud_reimbursed": null, + "order_id": null, + "risk_level": "very_low", + "receipt_url": null, + "payment": null, + "addition": null, + "discount": null, + "private_label": null + } + } + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Captura não efetuada junto ao adquirente", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + } + }, + "examples": { + "failure": { + "value": { + "error": "Capture was unsuccessful" + } + } + } + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/confirm": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "post": { + "summary": "Confirma um pedido", + "operationId": "post-api-v2-orders-order-code-confirm", + "description": "Confirma um pedido", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "confirmation_data": { + "type": "string", + "description": "Parâmetro para incluir o retorno [da requisição de captura do pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-capture).\nEsse parâmetro é **obrigatório** para pedidos com pagamento por cartão de crédito. " + } + } + }, + "examples": { + "Depósito": { + "value": { + "banco": "Banco do Brasil", + "data_credito": "2020-03-26", + "conferido_por": "Nome do usuário do financeiro" + } + }, + "Cartão de crédito via Pagar.me": { + "value": { + "object": "transaction", + "status": "paid", + "refuse_reason": null, + "status_reason": "acquirer", + "acquirer_response_code": "0000", + "acquirer_name": "pagarme", + "acquirer_id": "5eab10915eab10915eab1091", + "authorization_code": "123456", + "soft_descriptor": "", + "tid": 1234567, + "nsu": 1234567, + "date_created": "2020-05-14T19:14:50.322Z", + "date_updated": "2020-05-15T14:19:34.699Z", + "amount": 1400, + "authorized_amount": 1400, + "paid_amount": 1400, + "refunded_amount": 0, + "installments": 1, + "id": 1234567, + "cost": 120, + "card_holder_name": "John Doe", + "card_last_digits": "6565", + "card_first_digits": "470373", + "card_brand": "visa", + "card_pin_mode": null, + "card_magstripe_fallback": false, + "cvm_pin": false, + "postback_url": "https://demo.vnda.com.br/api/v2/payments/pagarme/notifications", + "payment_method": "credit_card", + "capture_method": "ecommerce", + "antifraud_score": null, + "boleto_url": null, + "boleto_barcode": null, + "boleto_expiration_date": null, + "referer": "api_key", + "ip": "127.0.0.1", + "subscription_id": null, + "phone": null, + "address": null, + "customer": { + "object": "customer", + "id": 2954669, + "external_id": "example@vnda.com.br", + "type": "individual", + "country": "br", + "document_number": null, + "document_type": "cpf", + "name": "John Doe", + "email": "example@vnda.com.br", + "phone_numbers": [ + "+5511111111111" + ], + "born_at": null, + "birthday": null, + "gender": null, + "date_created": "2020-05-14T19:14:50.248Z", + "documents": [ + { + "object": "document", + "id": "doc_cka75cka75cka75cka75cka75", + "type": "cpf", + "number": 191 + } + ] + }, + "billing": { + "object": "billing", + "id": 1255695, + "name": "John Doe", + "address": { + "object": "address", + "street": "Rua João Neves da Fontoura", + "complementary": null, + "street_number": "1", + "neighborhood": "Azenha", + "city": "Porto Alegre", + "state": "RS", + "zipcode": "90050030", + "country": "br", + "id": 2808888 + } + }, + "shipping": null, + "items": [ + { + "object": "item", + "id": "05.01.4.1.006", + "title": "Aceto Balsâmico Di Modena IGP 500ml Aceto Balsamico Di Modena IGP 500ml", + "unit_price": 1400, + "quantity": 1, + "category": null, + "tangible": true, + "venue": null, + "date": null + } + ], + "card": { + "object": "card", + "id": "card_cka75cka75cka75cka75cka75", + "date_created": "2020-05-14T19:14:50.307Z", + "date_updated": "2020-05-14T19:14:50.717Z", + "brand": "visa", + "holder_name": "f dc", + "first_digits": "470373", + "last_digits": "6565", + "country": "RUSSIA", + "fingerprint": "cka75cka75cka75cka75cka75", + "valid": true, + "expiration_date": "0423" + }, + "split_rules": null, + "metadata": { + "order": "7A4F490570", + "seller-1": { + "name": "default", + "package": "7A4F490570-01" + } + }, + "antifraud_metadata": {}, + "reference_key": null, + "device": null, + "local_transaction_id": null, + "local_time": null, + "fraud_covered": false, + "fraud_reimbursed": null, + "order_id": null, + "risk_level": "very_low", + "receipt_url": null, + "payment": null, + "addition": null, + "discount": null, + "private_label": null + } + } + } + } + }, + "description": "Confirma um pedido" + }, + "tags": [ + "Fluxo e andamento" + ], + "responses": { + "200": { + "description": "Pedido confirmado" + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/orders/{order_code}/chargeback": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "post": { + "summary": "Estorna pagamento por cartão de crédito", + "operationId": "post-api-v2-orders-order-code-chargeback", + "description": "Faz o estorno do pagamento no adquirente do cartão de crédito\nOperação válida para pedidos pagos com cartão de crédito", + "tags": [ + "Fluxo e andamento" + ], + "responses": { + "200": { + "description": "OK" + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/orders/{order_code}/cancel": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + } + ], + "post": { + "summary": "Cancela um pedido", + "operationId": "post-api-v2-orders-order-code-cancel", + "description": "Altera o status do pedido para `cancelado`", + "tags": [ + "Fluxo e andamento" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cancelation_data": { + "type": "string", + "description": "Parâmetro para incluir uma confirmação de estorno de pagamento para o cliente.\nPara pedidos com pagamento via cartão de crédito, é obrigatório que nesse campo seja incluído no parâmetro o retorno [da requisição de estorno de pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-order-code-chargeback). " + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Pedido cancelado", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + } + } + }, + "/api/v2/orders/{order_code}/items": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + }, + { + "$ref": "#/components/parameters/include_customizations_in_total" + } + ], + "get": { + "summary": "Lista os itens de um pedido", + "tags": [ + "Itens de pedido" + ], + "operationId": "get-api-v2-orders-items", + "responses": { + "200": { + "description": "Itens retornados", + "content": { + "application/json": { + "schema": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product.order" + } + } + } + } + } + }, + "404": { + "description": "Pedido não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Retorna os itens de um pedido pelo código do pedido" + } + }, + "/api/v2/orders/{order_code}/items/{item_id}/customizations": { + "parameters": [ + { + "schema": null, + "$ref": "#/components/parameters/Order.code" + }, + { + "schema": { + "type": "string" + }, + "name": "item_id", + "in": "path", + "description": "Código identificador do item", + "required": true + } + ], + "get": { + "summary": "Retorna personalizações de um item", + "operationId": "get-api-v2-orders-order_id-items-item_id-customizations", + "tags": [ + "Itens de pedido" + ], + "description": "Lista as personalizações de um item do pedido pelos códigos do item e do pedido", + "responses": { + "200": { + "description": "Personalizações listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order_item_customization.v1" + } + }, + "examples": { + "Com pesonalizações": { + "value": [ + { + "id": 1, + "number": 1, + "group_name": "Color", + "sku": "A1", + "name": "Red", + "price": 0, + "intl_price": 0, + "handling_days": 0 + } + ] + }, + "Sem personalizações": { + "value": [] + } + } + } + } + }, + "404": { + "description": "Quando o item não é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + } + }, + "/api/v2/clients/{id_client}/orders": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "id_client", + "in": "path", + "required": true, + "description": "Código identificador do cliente" + } + ], + "get": { + "summary": "Lista os pedidos de um cliente", + "tags": [ + "Clientes" + ], + "operationId": "get-api-v2-clients-id-orders", + "responses": { + "200": { + "description": "Pedidos retornados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + } + }, + "404": { + "description": "Cliente não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "description": "Retorna os pedidos de um cliente pelo seu `id_client`" + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/invoices": { + "parameters": [ + { + "$ref": "#/components/parameters/Order.code" + }, + { + "$ref": "#/components/parameters/Package.code" + } + ], + "get": { + "summary": "Retorna notas fiscais de um pacote", + "tags": [ + "Notas fiscais de pedidos" + ], + "responses": { + "200": { + "description": "Notas fiscais listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + } + }, + "404": { + "description": "Pedido ou pacote não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "$ref": "#/components/responses/422" + } + }, + "operationId": "get-api-v2-orders-order-code-packages-package_code-invoices", + "description": "Retorna as notas fisicais de um pacote do pedido" + }, + "post": { + "summary": "Inclui nota fiscal em um pedido", + "operationId": "post-api-v2-orders-order-code-packages-package_code-invoices", + "responses": { + "201": { + "description": "Nota fiscal adicionada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + }, + "422": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Notas fiscais de pedidos" + ], + "description": "Inclui nota fiscal no pacote de um pedido", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + } + } + }, + "/api/v2/orders/{order_code}/packages/{package_code}/invoices/{number}": { + "parameters": [ + { + "schema": null, + "$ref": "#/components/parameters/Order.code" + }, + { + "schema": null, + "$ref": "#/components/parameters/Package.code" + }, + { + "schema": { + "type": "string" + }, + "name": "number", + "in": "path", + "required": true, + "description": "Número da nota fiscal" + } + ], + "patch": { + "summary": "Atualiza uma nota fiscal", + "operationId": "patch-api-v2-orders-order-code-packages-package_code-invoices-number", + "responses": { + "204": { + "description": "Nota fiscal atualizada" + }, + "404": { + "description": "Pedido ou nota fiscal não encontrada", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + }, + "422": { + "description": "Parâmetros enviados inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + } + } + }, + "tags": [ + "Notas fiscais de pedidos" + ], + "description": "Atualiza uma nota fiscal", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invoice.v1" + } + } + } + } + }, + "delete": { + "summary": "Remove uma nota fiscal", + "operationId": "delete-api-v2-orders-order-code-packages-package_code-invoices-number", + "responses": { + "204": { + "description": "Nota fiscal removida" + }, + "404": { + "description": "Nota fiscal não encontrada" + } + }, + "tags": [ + "Notas fiscais de pedidos" + ], + "description": "Remove uma nota fiscal" + } + }, + "/api/feed/orders": { + "parameters": [], + "get": { + "summary": "Lista os pedidos do feed", + "tags": [ + "Order Feed" + ], + "operationId": "get-feed-orders", + "description": "Permite listar os pedidos pendentes do feed", + "parameters": [ + { + "schema": { + "type": "boolean", + "enum": [ + true + ] + }, + "in": "query", + "name": "include_shipping_address", + "allowEmptyValue": true, + "description": "Selecione `true` para incluir o endereço na resposta" + }, + { + "schema": { + "type": "string", + "enum": [ + "received", + "confirmed", + "canceled" + ] + }, + "in": "query", + "name": "status", + "description": "Filtra os pedidos por status" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/Orders" + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + } + }, + "post": { + "summary": "Marca os pedidos do feed", + "operationId": "post-api-feed-orders", + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Domínio de loja não encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/404.v1" + } + } + } + } + }, + "tags": [ + "Order Feed" + ], + "description": "Permite marcar os pedidos para que eles sejam filtrados da listagem do feed", + "requestBody": { + "$ref": "#/components/requestBodies/Orders" + } + } + } + }, + "components": { + "schemas": { + "Banner": { + "title": "Banner", + "type": "object", + "description": "Modelo que representa um banner na API", + "properties": { + "big_thumb": { + "type": "string" + }, + "color": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "end_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "external": { + "type": "boolean" + }, + "file_name": { + "type": "string" + }, + "file_uid": { + "type": "string" + }, + "html_description": { + "type": "string", + "nullable": true + }, + "id": { + "type": "integer" + }, + "norder": { + "type": "integer", + "nullable": true + }, + "plain_description": { + "type": "string", + "nullable": true + }, + "small_thumb": { + "type": "string" + }, + "start_at": { + "type": "string", + "format": "date-time" + }, + "subtitle": { + "type": "string", + "nullable": true + }, + "tag": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri" + } + }, + "required": [ + "big_thumb", + "color", + "description", + "end_at", + "external", + "file_name", + "file_uid", + "html_description", + "id", + "norder", + "plain_description", + "small_thumb", + "start_at", + "subtitle", + "tag", + "title", + "updated_at", + "url" + ] + }, + "SlimBanner": { + "title": "SlimBanner", + "type": "object", + "description": "Modelo que representa um banner simplificado na API", + "properties": { + "id": { + "type": "integer" + }, + "tag": { + "type": "string" + }, + "title": { + "type": "string" + }, + "subtitle": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "nullable": true + }, + "external": { + "type": "boolean" + }, + "start_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "end_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "file_url": { + "type": "string", + "nullable": true + }, + "norder": { + "type": "integer", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "tag", + "title", + "subtitle", + "description", + "url", + "external", + "start_at", + "end_at", + "file_url", + "norder", + "color", + "updated_at" + ] + }, + "Variant": { + "title": "Variant", + "type": "object", + "description": "Modelo que representa uma variante na API", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador da variante" + }, + "main": { + "type": "boolean", + "description": "Identifica se é a variante principal do produto. Para `true` a variante é principal e `false` a variante é secundária" + }, + "available": { + "type": "boolean", + "description": "Identifica se a variante está ativa em `true` e desativa em `false`" + }, + "sku": { + "type": "string", + "description": "Código SKU da variante" + }, + "name": { + "type": "string", + "description": "Nome da variante" + }, + "slug": { + "type": "string", + "description": "Slug da URL da variante" + }, + "min_quantity": { + "type": "integer", + "description": "Quantidade mínima para venda" + }, + "quantity": { + "type": "integer", + "description": "Quantidade física" + }, + "quantity_sold": { + "type": "integer", + "description": "" + }, + "stock": { + "type": "integer", + "description": "Quantidade disponível" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "properties": { + "type": "object", + "properties": { + "property1": { + "$ref": "#/components/schemas/Variant_property.v1" + }, + "property2": { + "$ref": "#/components/schemas/Variant_property.v1" + }, + "property3": { + "$ref": "#/components/schemas/Variant_property.v1" + } + }, + "description": "[Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização da variante" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "installments": { + "type": "array", + "items": { + "type": "number" + }, + "description": "Relação das parcelas para pagamento do item parcelado" + }, + "available_quantity": { + "type": "integer", + "description": "Unidades reservadas e não reservadas do item" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "inventories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Variant_inventory.v1" + }, + "description": "Relação de itens por estoque (armazém)" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "intl_price": { + "type": "number", + "description": "Preço internacional" + }, + "image_url": { + "type": "string", + "description": "URL da imagem da variante" + }, + "product_id": { + "type": "integer", + "description": "Código identificador `ID` do produto" + }, + "barcode": { + "type": "string", + "nullable": true, + "description": "Código de barra da variante" + }, + "norder": { + "type": "integer" + } + }, + "x-examples": { + "example-1": { + "id": 27, + "main": false, + "available": true, + "sku": "13001", + "name": "Tamanho: PP | Cor: Branca", + "slug": "camiseta", + "min_quantity": 1, + "quantity": 85, + "stock": 83, + "custom_attributes": { + "size": "PP", + "color": "#FFFFFF" + }, + "properties": {}, + "updated_at": "2019-08-01T18:36:52.718-03:00", + "price": 169.9, + "installments": [ + 169.9 + ], + "available_quantity": 83, + "weight": 0.1, + "width": 11, + "height": 2, + "length": 16, + "handling_days": 0, + "inventories": [], + "sale_price": 169.9, + "intl_price": 33.98, + "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/camiseta.jpg", + "product_id": 6, + "barcode": null, + "norder": 1 + } + } + }, + "ProductImage": { + "title": "ProductImage", + "type": "object", + "description": "Modelo que representa uma imagem de um produto", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador `ID` da imagem" + }, + "url": { + "type": "string", + "description": "URL da imagem" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização da imagem do produto" + }, + "variant_ids": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Códigos das variantes que utilizam a imagem" + } + }, + "required": [ + "id", + "url", + "updated_at", + "variant_ids" + ] + }, + "ProductSearch": { + "title": "ProductSearch", + "type": "object", + "description": "Modelo que representa um produto retornado via busca no Elasticsearch", + "properties": { + "id": { + "type": "integer" + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "subscription": { + "type": "boolean" + }, + "slug": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "reference_lowercase": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "image_url": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "title", + "subtitle", + "description", + "importance", + "type", + "image_url" + ], + "properties": { + "name": { + "type": "string", + "pattern": "[a-z0-9\\-_]+" + }, + "title": { + "type": "string" + }, + "subtitle": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "importance": { + "type": "number", + "nullable": true + }, + "type": { + "type": "string" + }, + "image_url": { + "type": "string", + "nullable": true + } + } + } + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "on_sale": { + "type": "boolean" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "intl_price": { + "type": "number" + }, + "discount_id": { + "type": "integer" + }, + "discount_rule": { + "type": "object", + "nullable": true, + "required": [ + "type", + "amount" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "fixed", + "percentage" + ] + }, + "amount": { + "type": "number" + } + } + }, + "discount": { + "type": "object", + "nullable": true, + "required": [ + "name", + "description", + "facebook", + "valid_to" + ], + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "facebook": { + "type": "boolean", + "description": "Em desuso", + "default": false + }, + "valid_to": { + "type": "string" + } + } + }, + "images": { + "type": "array", + "items": { + "type": "object", + "required": [ + "sku", + "url" + ], + "properties": { + "sku": { + "type": "string" + }, + "url": { + "nullable": true, + "type": "string" + } + } + } + }, + "variants": { + "type": "array", + "items": { + "$ref": "#/components/schemas/VariantProductSearch" + } + }, + "installments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductInstallment" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização do produto" + } + }, + "required": [ + "id", + "active", + "available", + "subscription", + "slug", + "reference", + "reference_lowercase", + "name", + "description", + "image_url", + "url", + "tags", + "price", + "on_sale", + "sale_price", + "intl_price", + "discount_id", + "discount_rule", + "discount", + "images", + "variants", + "installments", + "created_at", + "updated_at" + ] + }, + "VariantProductSearch": { + "title": "VariantProductSearch", + "type": "object", + "description": "Modelo que representa uma variante retornada via busca no Elasticsearch", + "properties": { + "id": { + "type": "integer", + "minimum": 1 + }, + "sku": { + "type": "string", + "minLength": 1 + }, + "sku_lowercase": { + "type": "string", + "minLength": 1 + }, + "name": { + "type": "string", + "nullable": true + }, + "full_name": { + "type": "string", + "minLength": 1 + }, + "main": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "image_url": { + "type": "string", + "nullable": true + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "intl_price": { + "type": "number" + }, + "installments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductInstallment" + } + }, + "stock": { + "type": "integer", + "description": "Quantidade de itens disponíveis" + }, + "quantity": { + "type": "integer" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + }, + "min_quantity": { + "type": "integer", + "description": "Quantidade mínima para venda" + }, + "available_quantity": { + "type": "integer" + }, + "custom_attributes": { + "type": "object", + "nullable": true, + "description": "Customização da variante" + }, + "properties": { + "type": "object", + "properties": { + "property1": { + "$ref": "#/components/schemas/VariantPropertyProductSearch" + }, + "property2": { + "$ref": "#/components/schemas/VariantPropertyProductSearch" + }, + "property3": { + "$ref": "#/components/schemas/VariantPropertyProductSearch" + } + }, + "description": "[Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante" + }, + "inventories": { + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "slug", + "available", + "price", + "sale_price", + "quantity", + "quantity_sold", + "place" + ], + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "slug": { + "type": "string", + "minLength": 1 + }, + "available": { + "type": "boolean" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "quantity": { + "type": "number", + "nullable": true + }, + "quantity_sold": { + "type": "number", + "description": "Quantidade de itens vendidos" + }, + "place": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + } + } + } + } + } + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "barcode": { + "type": "string", + "nullable": true + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + } + }, + "required": [ + "id", + "sku", + "sku_lowercase", + "name", + "full_name", + "main", + "available", + "image_url", + "price", + "sale_price", + "intl_price", + "installments", + "stock", + "quantity", + "quantity_sold", + "min_quantity", + "available_quantity", + "custom_attributes", + "properties", + "inventories", + "handling_days", + "barcode", + "weight", + "width", + "height", + "length" + ] + }, + "VariantPropertyProductSearch": { + "title": "VariantPropertyProductSearch", + "type": "object", + "description": "Modelo que representa uma propriedade de uma variante quando retornada via Elasticsearch", + "nullable": true, + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + }, + "required": [ + "name", + "value", + "defining" + ] + }, + "Cart": { + "type": "object", + "title": "Cart", + "description": "Modelo que representa um carrinho na API", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer" + }, + "email": { + "type": "string", + "nullable": true + }, + "shipping_method": { + "type": "string", + "nullable": true + }, + "items_count": { + "type": "integer" + }, + "quotation_responses_count": { + "type": "integer" + }, + "payment_responses_count": { + "type": "integer" + }, + "has_payment_responses": { + "type": "boolean" + }, + "has_phone": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "email", + "shipping_method", + "items_count", + "quotation_responses_count", + "payment_responses_count", + "has_payment_responses", + "has_phone", + "updated_at" + ] + }, + "CartItemCustomization": { + "type": "object", + "title": "CartItemCustomization", + "description": "Modelo que representa uma personalização de item do carrinho na API", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Código identificador do produto" + }, + "group_name": { + "type": "string" + }, + "name": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "price": { + "type": "number", + "description": "Preço unitário" + }, + "intl_price": { + "type": "number", + "description": "Preço internacional" + }, + "handling_days": { + "type": "integer", + "description": "Número de dias para manuseio" + }, + "sku": { + "type": "string", + "nullable": true, + "description": "Código SKU do produto" + } + }, + "required": [ + "id", + "group_name", + "name", + "number", + "price", + "intl_price", + "handling_days", + "sku" + ] + }, + "ProductInstallment": { + "title": "ProductInstallment", + "type": "object", + "properties": { + "number": { + "type": "integer" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "interest": { + "type": "boolean" + }, + "interest_rate": { + "type": "number" + }, + "total": { + "type": "number" + } + }, + "required": [ + "number", + "price", + "interest", + "interest_rate", + "total" + ], + "description": "Modelo que representa uma parcela", + "x-internal": false + }, + "VariantProperty": { + "title": "VariantProperty", + "type": "object", + "description": "Modelo que representa uma propriedade de uma variante", + "properties": { + "name": { + "type": "string", + "description": "Nome da propriedade" + }, + "value": { + "type": "string", + "description": "Valor da propriedade" + }, + "defining": { + "type": "boolean", + "description": "Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`)" + } + }, + "required": [ + "name", + "value", + "defining" + ], + "example": { + "example-property1": { + "name": "Tamanho", + "value": "G", + "defining": true + }, + "example-property2": { + "name": "Cor", + "value": "Amarelo", + "defining": true + } + } + }, + "ProductPriceVariant": { + "title": "ProductPriceVariant", + "type": "object", + "description": "Modelo que representa os preços de uma variante", + "properties": { + "main": { + "type": "boolean", + "description": "Define se a variante do produto é a principal" + }, + "sku": { + "type": "string", + "description": "Código SKU da variante" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "on_sale": { + "type": "boolean" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "intl_price": { + "type": "number" + }, + "available": { + "type": "boolean" + }, + "properties": { + "type": "object", + "properties": { + "property1": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property2": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property3": { + "$ref": "#/components/schemas/VariantProperty" + } + }, + "description": "[Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante" + }, + "stock": { + "type": "number", + "description": "Quantidade de itens disponíveis" + }, + "installments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductInstallment" + } + } + }, + "required": [ + "main", + "sku", + "price", + "on_sale", + "sale_price", + "intl_price", + "available", + "properties", + "stock", + "installments" + ], + "x-internal": false + }, + "Mapping": { + "type": "object", + "description": "Modelo que representa um mapeamento na API", + "properties": { + "id": { + "type": "integer" + }, + "key": { + "type": "string" + }, + "from": { + "type": "array", + "items": { + "type": "string" + } + }, + "to": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key" + ] + }, + "Package": { + "title": "Package", + "type": "object", + "description": "Modelo que representa um pacote na API", + "properties": { + "actual_shipping_method": { + "type": "string", + "nullable": true + }, + "code": { + "type": "string", + "minLength": 1, + "description": "Código identificador do pacote" + }, + "delivered_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Data de entrega do pacote" + }, + "delivered_email_sent_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "delivery_days": { + "type": "integer", + "minimum": 0, + "description": "Número de dias para entrega" + }, + "delivery_type": { + "type": "string", + "minLength": 1, + "description": "Tipo de envio do pacote" + }, + "delivery_work_days": { + "type": "integer", + "minimum": 0, + "description": "Quantidade de dias úteis para entrega" + }, + "fulfillment_company": { + "type": "string", + "nullable": true, + "description": "Transportadora" + }, + "fulfillment_status": { + "type": "string", + "minLength": 1, + "enum": [ + "waiting", + "shipped", + "delivered" + ], + "description": "Status de envio" + }, + "integrated": { + "type": "boolean", + "default": false + }, + "invoiced": { + "type": "boolean", + "default": false + }, + "label": { + "type": "string", + "minLength": 1 + }, + "properties": { + "type": "object" + }, + "quoted_shipping_price": { + "type": "number", + "minimum": 0 + }, + "shipped_at": { + "type": "string", + "format": "date-time" + }, + "shipped_email_sent_at": { + "type": "string", + "format": "date-time" + }, + "shipping_label": { + "type": "string" + }, + "shipping_name": { + "type": "string" + }, + "shipping_price": { + "type": "number" + }, + "total": { + "type": "number", + "minimum": 0 + }, + "tracked_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "Data e horário da última atualização do código de rastreio do pacote" + }, + "tracking_code": { + "type": "string", + "nullable": true, + "description": "Código de rastreio do pacote" + } + }, + "required": [ + "actual_shipping_method", + "code", + "delivered_at", + "delivered_email_sent_at", + "delivery_days", + "delivery_type", + "delivery_work_days", + "fulfillment_company", + "fulfillment_status", + "integrated", + "invoiced", + "label", + "properties", + "quoted_shipping_price", + "shipped_at", + "shipped_email_sent_at", + "shipping_label", + "shipping_name", + "shipping_price", + "total", + "tracked_at", + "tracking_code" + ] + }, + "404.v1": { + "title": "404", + "type": "object", + "x-examples": { + "Not found": { + "error": "not found" + } + }, + "description": "Modelo que representa uma mensagem de erro 404", + "properties": { + "error": { + "type": "string", + "enum": [ + "not found" + ] + } + }, + "required": [ + "error" + ] + }, + "422.v1": { + "title": "422", + "type": "object", + "properties": { + "errors": { + "type": "object", + "properties": { + "{field}": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "description": "Modelo que representa um erro de validação na criação e atualização de registros" + }, + "Address.v1": { + "title": "Address", + "type": "object", + "description": "Modelo que representa um endereço na API", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "documents": { + "type": "object", + "properties": { + "cpf": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + } + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "first_phone_area": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone_area": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "recipient_name": { + "type": "string" + } + } + }, + "Audience_member.v1": { + "title": "Audience Member", + "type": "object", + "description": "Modelo que representa um membro do público", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string", + "nullable": true + }, + "last_name": { + "type": "string", + "nullable": true + }, + "email": { + "type": "string", + "format": "email" + }, + "phone_area": { + "type": "string", + "nullable": true + }, + "phone": { + "type": "string", + "nullable": true + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "email" + ] + }, + "Bonus.v1": { + "title": "Bonus", + "type": "object", + "description": "Modelo que representa um bônus na API", + "properties": { + "amount": { + "type": "number" + }, + "token": { + "type": "string" + }, + "valid_from": { + "type": "string", + "format": "date-time" + }, + "valid_thru": { + "type": "string", + "format": "date-time" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "Cart.v1": { + "title": "Cart", + "type": "object", + "description": "Modelo que representa um carrinho na API", + "properties": { + "agent": { + "type": "string", + "nullable": true, + "description": "Agente que criou o carrinho" + }, + "billing_address_id": { + "type": "integer", + "nullable": true, + "description": "Código identificador `ID` do endereço de cobrança do carrinho" + }, + "channel": { + "type": "string", + "nullable": true, + "description": "Canal de venda que originou o carrinho" + }, + "client_id": { + "type": "integer", + "nullable": true, + "description": "Código identificador `ID` do cliente" + }, + "code": { + "type": "string", + "description": "Código identificador `ID` do carrinho" + }, + "coupon_code": { + "type": "string", + "nullable": true, + "description": "Código de cupom de desconto utilizado no carrinho" + }, + "discount": { + "type": "object", + "nullable": true, + "required": [ + "id", + "name", + "description", + "facebook", + "valid_to", + "seal_uid", + "seal_url", + "start_at", + "end_at", + "email", + "cpf", + "tags" + ], + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "facebook": { + "type": "boolean", + "default": false + }, + "valid_to": { + "type": "string", + "enum": [ + "store", + "cart" + ] + }, + "seal_uid": { + "type": "string", + "description": "DEPRECATED" + }, + "seal_url": { + "type": "string", + "description": "DEPRECATED" + }, + "start_at": { + "type": "string", + "format": "date-time" + }, + "end_at": { + "type": "string", + "nullable": true, + "format": "date-time" + }, + "email": { + "type": "string", + "nullable": true + }, + "cpf": { + "type": "string", + "nullable": true + }, + "tags": { + "type": "string", + "nullable": true + } + }, + "$ref": "#/components/schemas/Discount.v1", + "description": "Promoção aplicada no carrinho" + }, + "discount_price": { + "type": "number", + "deprecated": true, + "description": "Valor do desconto" + }, + "extra": { + "type": "object", + "description": "Campo para registro de observações, chave ou valores necessários" + }, + "id": { + "type": "integer", + "description": "Código identificador `ID` do carrinho" + }, + "items": { + "type": "string", + "description": "Itens do carrinho", + "items": { + "$ref": "#/components/schemas/Cart_item.v1" + } + }, + "items_count": { + "type": "integer", + "description": "Unidades do item no carrinho" + }, + "shipping_address_id": { + "type": "integer", + "nullable": true, + "description": "Código identificador `ID` do endereço de entrega do carrinho" + }, + "shipping_method": { + "type": "string", + "nullable": true, + "description": "Método de envio selecionado para o carrinho, como por exemplo: normal, expressa e agendada." + }, + "shipping_methods": { + "type": "array", + "items": { + "type": "object", + "properties": { + "package": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "price": { + "type": "string" + }, + "delivery_days": { + "type": "string" + }, + "delivery_type": { + "type": "string" + }, + "description": { + "type": "string" + }, + "short_description": { + "type": "string" + }, + "fulfillment_company": { + "type": "string", + "nullable": true + } + }, + "required": [ + "package", + "name", + "label", + "price", + "delivery_days", + "delivery_type", + "description", + "short_description", + "fulfillment_company" + ], + "$ref": "#/components/schemas/Shipping_methods.v1" + }, + "description": "Lista com as entregas disponíveis para os itens do carrinho de acordo com o endereço de envio" + }, + "shipping_price": { + "type": "number", + "nullable": true, + "description": "Preço de envio" + }, + "subtotal": { + "type": "number", + "description": "Valor da soma dos itens do carrinho, sem considerar descontos de cupom, carrinho e frete." + }, + "token": { + "type": "string", + "description": "Token do carrinho" + }, + "total": { + "type": "number", + "description": "Valor final do carrinho" + }, + "total_for_deposit": { + "type": "number", + "description": "Valor total do carrinho para pagamento por depósito" + }, + "total_for_slip": { + "type": "number", + "description": "Valor total do carrinho para pagamento por boleto" + }, + "total_for_pix": { + "type": "number", + "description": "Valor do carrinho para pagamento por PIX" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data da última atualização do carrinho" + }, + "rebate_token": { + "type": "string", + "nullable": true, + "description": "Código identificador `ID` do desconto por bônus" + }, + "rebate_discount": { + "type": "number", + "description": "Desconto por bônus do cliente" + }, + "handling_days": { + "type": "number", + "description": "Número de dias para manuseio dos itens" + }, + "subtotal_discount": { + "type": "number", + "description": "Valor de desconto de promoções aplicadas ao subtotal do carrinho" + }, + "total_discount": { + "type": "number", + "description": "Valor de desconto de promoções aplicadas ao valor total do carrinho" + }, + "installments": { + "$ref": "#/components/schemas/Cart_installment.v1", + "description": "Parcelas para pagamento parcelado" + }, + "user_id": { + "type": "string", + "description": "Código identificador `ID` do cliente" + } + }, + "required": [ + "agent", + "billing_address_id", + "channel", + "client_id", + "code", + "coupon_code", + "discount", + "discount_price", + "extra", + "id", + "items", + "items_count", + "shipping_address_id", + "shipping_method", + "shipping_methods", + "shipping_price", + "subtotal", + "token", + "total", + "total_for_deposit", + "total_for_slip", + "total_for_pix", + "updated_at", + "rebate_token", + "rebate_discount", + "handling_days", + "subtotal_discount", + "total_discount" + ] + }, + "Cart_installment.v1": { + "title": "Cart Installment", + "type": "object", + "description": "Modelo que representa uma parcela do total de um carrinho", + "properties": { + "interest": { + "type": "boolean", + "description": "Identifica se há (`true`) ou não (`false`) juros no parcelamento" + }, + "interest_rate": { + "type": "number", + "description": "Taxa de juros do parcelamento" + }, + "number": { + "type": "integer", + "description": "Número de parcelas" + }, + "price": { + "type": "number", + "description": "Valor de cada parcela" + }, + "total": { + "type": "number", + "description": "Valor total das parcelas" + } + }, + "required": [ + "interest", + "interest_rate", + "number", + "price", + "total" + ], + "x-examples": { + "Primeira parcela": { + "interest": false, + "interest_rate": 0, + "number": 1, + "price": 837, + "total": 837 + }, + "Segunda parcela": { + "interest": false, + "interest_rate": 0, + "number": 2, + "price": 418.5, + "total": 837 + } + } + }, + "Cart_item.v1": { + "title": "Cart Item", + "type": "object", + "description": "Modelo que representa um item no carrinho na API", + "x-tags": [ + "Carrinhos" + ], + "properties": { + "available_quantity": { + "type": "integer", + "description": "Unidades disponíveis do produto" + }, + "delivery_days": { + "type": "integer", + "description": "Número de dias para a entrega" + }, + "extra": { + "type": "object", + "description": "Campo para registro de observações, chave ou valores necessários" + }, + "place_id": { + "type": "integer", + "nullable": true, + "description": "Código identificador do local do produto" + }, + "price": { + "type": "number", + "description": "Preço do produto" + }, + "intl_price": { + "type": "number", + "description": "Preço internacional" + }, + "product_id": { + "type": "integer", + "description": "Código identificador `ID` do produto" + }, + "product_name": { + "type": "string", + "description": "Nome do produto" + }, + "product_reference": { + "type": "string", + "description": "Código de referência do produto" + }, + "product_url": { + "type": "string", + "description": "URL do produto no e-commerce" + }, + "quantity": { + "type": "integer", + "description": "Unidades do produto no carrinho" + }, + "seller": { + "type": "string", + "nullable": true, + "description": "Identificador do seller" + }, + "seller_name": { + "type": "string", + "nullable": true, + "description": "Nome do seller" + }, + "subtotal": { + "type": "number", + "description": "Valor do produto sem descontos e promoções" + }, + "total": { + "type": "number", + "description": "Valor total do produto" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data da última atualização do carrinho" + }, + "variant_attributes": { + "type": "object", + "description": "Atributos da variante" + }, + "variant_min_quantity": { + "type": "integer", + "description": "Quantidade miníma de variantes para compra" + }, + "variant_name": { + "type": "string", + "description": "Nome da variante" + }, + "variant_price": { + "type": "number", + "description": "Preço da variante" + }, + "variant_intl_price": { + "type": "number", + "description": "Preço internacional da variante" + }, + "variant_properties": { + "type": "object", + "$ref": "#/components/schemas/Variant" + }, + "variant_sku": { + "type": "string", + "description": "Código SKU da [Variante](https://developers.vnda.com.br/docs/cat%C3%A1logo-de-produtos#produto-atributo-e-variante)" + }, + "id": { + "type": "string", + "description": "Código identificador do item no carrinho" + }, + "product_type": { + "type": "string", + "description": "Tipo de produto" + }, + "image_url": { + "type": "string", + "nullable": true, + "description": "URL da imagem da variante" + } + }, + "required": [ + "available_quantity", + "delivery_days", + "extra", + "place_id", + "price", + "intl_price", + "product_id", + "product_name", + "product_reference", + "product_url", + "quantity", + "seller", + "seller_name", + "subtotal", + "total", + "updated_at", + "variant_attributes", + "variant_min_quantity", + "variant_name", + "variant_price", + "variant_intl_price", + "variant_properties", + "variant_sku" + ] + }, + "Client.v1": { + "title": "Client", + "type": "object", + "description": "Modelo que representa um cliente na API", + "properties": { + "id": { + "type": "integer" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "email": { + "type": "string", + "format": "email" + }, + "gender": { + "type": "string" + }, + "phone_area": { + "type": "string", + "pattern": "[0-9]+" + }, + "phone": { + "type": "string", + "pattern": "[0-9]+" + }, + "document_type": { + "type": "string", + "enum": [ + "CPF", + "CNPJ" + ] + }, + "document_number": { + "type": "string", + "description": "Número de documento cadastrado pelo cliente" + }, + "cpf": { + "type": "string", + "pattern": "[0-9]+" + }, + "cnpj": { + "type": "string", + "pattern": "[0-9]+" + }, + "ie": { + "type": "string" + }, + "tags": { + "type": "string" + }, + "lists": { + "type": "array", + "items": { + "type": "string" + } + }, + "facebook_uid": { + "type": "string" + }, + "liked_facebook_page": { + "type": "boolean" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "birthdate": { + "type": "string", + "format": "date" + }, + "recent_address": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "first_name": { + "type": "string" + }, + "last_name": { + "type": "string" + }, + "company_name": { + "type": "string" + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "first_phone_area": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone_area": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "email": { + "type": "string" + }, + "documents": { + "type": "object", + "properties": { + "cpf": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + } + } + } + } + }, + "auth_token": { + "type": "string" + }, + "last_confirmed_order_at": { + "type": "string", + "format": "date-time" + }, + "received_orders_count": { + "type": "integer" + }, + "confirmed_orders_count": { + "type": "integer" + }, + "canceled_orders_count": { + "type": "integer" + }, + "renew_password": { + "type": "boolean", + "default": false + } + } + }, + "ClientAddress.v1": { + "title": "Client", + "type": "object", + "description": "Modelo que representa os endereços cadastrados pelo cliente na API", + "properties": { + "id": { + "type": "integer" + }, + "street_name": { + "type": "string" + }, + "street_number": { + "type": "string" + }, + "complement": { + "type": "string" + }, + "neighborhood": { + "type": "string" + }, + "label": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "city": { + "type": "string" + }, + "state": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "client_id": { + "type": "integer" + } + } + }, + "Coupon.v1": { + "title": "Coupon", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "code": { + "type": "string" + }, + "uses_per_code": { + "type": "integer" + }, + "uses_per_user": { + "type": "integer" + }, + "referrer_email": { + "type": "string", + "format": "email" + }, + "user_id": { + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "orders_count": { + "type": "integer" + } + }, + "description": "Modelo que representa um cupom de desconto" + }, + "Customization.v1": { + "title": "Customization", + "type": "object", + "description": "Modelo que representa uma customização", + "properties": { + "id": { + "type": "integer" + }, + "group_name": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "image_uid": { + "type": "string" + }, + "image_name": { + "type": "string" + }, + "price": { + "type": "number" + }, + "intl_price": { + "type": "number" + }, + "quantity": { + "type": "integer" + }, + "handling_days": { + "type": "integer" + }, + "tag_id": { + "type": "integer" + }, + "sku": { + "type": "string" + }, + "pattern": { + "type": "string", + "nullable": true + } + } + }, + "Products_attributes.v1": { + "title": "Products Attributes", + "type": "object", + "description": "Modelo que representa um atributo customizado de produto", + "properties": { + "index": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "mandatory": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + } + } + }, + "Discount.v1": { + "title": "Discount", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador `ID` do desconto" + }, + "name": { + "type": "string", + "description": "Nome do desconto ou promoção" + }, + "description": { + "type": "string", + "description": "Descrição do desconto" + }, + "start_at": { + "type": "string", + "format": "date-time", + "description": "Data de início da regra do desconto" + }, + "end_at": { + "type": "string", + "format": "date-time", + "description": "Data de fim da regra do desconto" + }, + "enabled": { + "type": "boolean", + "default": true, + "description": "Indica se o desconto está habilitado (`true`) ou desabilitado (`false`)" + }, + "facebook": { + "type": "boolean", + "description": "Em desuso", + "default": false + }, + "valid_to": { + "type": "string", + "description": "Indica a regra da promoção: se o desconto é aplicado na vitrine ou no carrinho da loja " + }, + "email": { + "type": "string", + "format": "email", + "description": "Email do cliente, no caso de promoções direcionadas para clientes específicos" + }, + "cpf": { + "type": "string", + "pattern": "[0-9]{11}", + "description": "Cadastro de Pessoa Física (CPF) do cliente, no caso de promoções direcionadas para clientes específicos" + }, + "tags": { + "type": "string", + "description": "Tag de agrupamento de promoção" + } + }, + "required": [ + "name", + "start_at", + "enabled" + ], + "description": "Modelo que representa uma promoção na API" + }, + "Discount_rule.v1": { + "title": "Discount Rule", + "type": "object", + "description": "Modelo que representa uma regra de desconto na API", + "properties": { + "id": { + "type": "integer" + }, + "amount": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": false, + "exclusiveMaximum": false + }, + "type": { + "type": "string", + "enum": [ + "fixed", + "percentage" + ] + }, + "apply_to": { + "type": "string" + }, + "min_quantity": { + "type": "integer", + "default": 0 + }, + "product": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "reference": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "tag": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "combined_product": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "reference": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "min_subtotal": { + "type": "number" + }, + "shipping_method": { + "type": "string" + }, + "shipping_rule": { + "type": "string", + "enum": [ + "any", + "all" + ] + }, + "regions": { + "type": "array", + "items": { + "type": "string" + } + }, + "agent_tag": { + "type": "string" + }, + "channel": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "amount", + "type", + "apply_to", + "min_quantity", + "min_subtotal" + ] + }, + "Invoice.v1": { + "title": "Invoice", + "type": "object", + "description": "Modelo que representa uma nota fiscal na API", + "properties": { + "number": { + "type": "integer", + "description": "Número da nota fiscal" + }, + "series": { + "type": "integer", + "description": "Número de série da nota fiscal" + }, + "issued_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da criação da nota fiscal" + }, + "key": { + "type": "string", + "description": "Chave da nota fiscal" + }, + "volumes": { + "type": "integer" + } + }, + "required": [ + "number" + ] + }, + "Menu.v1": { + "title": "Menu", + "type": "object", + "description": "Modelo que representa um menu na API", + "properties": { + "id": { + "type": "integer" + }, + "label": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "url": { + "type": "string" + }, + "external": { + "type": "boolean" + }, + "parent_id": { + "type": "integer" + }, + "tag_id": { + "type": "integer" + }, + "tag_name": { + "type": "string" + }, + "page_id": { + "type": "integer" + }, + "page_slug": { + "type": "string" + }, + "items_count": { + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date" + }, + "tooltip": { + "type": "string" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Menu.v1" + } + }, + "image_url": { + "type": "string" + }, + "simple_url": { + "type": "string" + }, + "position": { + "type": "string" + }, + "norder": { + "type": "integer" + }, + "type": { + "type": "string" + } + } + }, + "Menu_in_tree.v1": { + "title": "Menu (Tree)", + "type": "object", + "description": "Modelo que representa um menu na API quando retornado pela ação de menu em árvore", + "properties": { + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "tag_id": { + "type": "integer" + }, + "page_id": { + "type": "integer" + }, + "items_count": { + "type": "integer" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Menu_in_tree.v1" + } + }, + "updated_at": { + "type": "string", + "format": "date" + }, + "tooltip": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "simple_url": { + "type": "string" + }, + "norder": { + "type": "integer" + } + } + }, + "Order.v1": { + "title": "Order", + "type": "object", + "description": "Modelo que representa um pedido na API", + "properties": { + "rebate_discount": { + "type": "number", + "minimum": 0, + "description": "Desconto por bônus do cliente" + }, + "rebate_token": { + "type": "string", + "nullable": true, + "description": "Código identificador `ID` do desconto por bônus" + }, + "user_id": { + "type": "integer", + "description": "Código identificador `ID` do cliente" + }, + "updated_at": { + "type": "string", + "description": "Data da última atualização do pedido" + }, + "tracking_code_list": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Lista com os códigos de rastreio dos pacotes do pedido" + }, + "tracking_code": { + "type": "string", + "description": "Código de rastreio do pacote" + }, + "total": { + "type": "number", + "minimum": 0, + "description": "Valor final do pedido" + }, + "token": { + "type": "string" + }, + "taxes": { + "type": "number", + "minimum": 0 + }, + "subtotal": { + "type": "number", + "minimum": 0, + "exclusiveMinimum": true, + "description": "Valor da soma dos itens do pedido, desconsiderando descontos e frete." + }, + "status": { + "type": "string", + "enum": [ + "received", + "confirmed", + "canceled" + ], + "description": "Status do pedido" + }, + "payment_due_date": { + "type": "string", + "format": "date" + }, + "slip_url": { + "type": "string" + }, + "slip_token": { + "type": "string" + }, + "slip_due_date": { + "type": "string", + "format": "date" + }, + "slip": { + "type": "boolean" + }, + "shipping_tracked_at": { + "type": "string", + "format": "date-time" + }, + "shipping_price": { + "type": "number" + }, + "shipping_label": { + "type": "string" + }, + "shipped_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data e horário de envio do pedido" + }, + "received_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data e horário de recebimento do pedido" + }, + "payment_tid": { + "type": "string", + "nullable": true + }, + "payment_method": { + "type": "string", + "description": "Método de pagamento do pedido" + }, + "payment_gateway": { + "type": "string", + "nullable": true + }, + "payment_authorization": { + "type": "string", + "nullable": true + }, + "paid_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data e horário do pagamento do pedido" + }, + "items": { + "type": "array", + "items": { + "type": "object", + "properties": { + "extra": { + "type": "object" + }, + "height": { + "type": "number" + }, + "id": { + "type": "integer" + }, + "length": { + "type": "number" + }, + "original_price": { + "type": "number" + }, + "package": { + "type": "string" + }, + "picture_url": { + "type": "string" + }, + "place_city": { + "type": "string", + "nullable": true + }, + "place_id": { + "type": "integer" + }, + "place_name": { + "type": "string", + "nullable": true + }, + "price": { + "type": "number" + }, + "product_id": { + "type": "integer" + }, + "product_name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "reference": { + "type": "string" + }, + "sku": { + "type": "string" + }, + "total": { + "type": "number", + "minimum": 0 + }, + "variant_id": { + "type": "integer" + }, + "variant_name": { + "type": "string", + "nullable": true + }, + "weight": { + "type": "number" + }, + "width": { + "type": "number" + }, + "barcode": { + "type": "string" + } + }, + "required": [ + "extra", + "product_id", + "product_name", + "quantity", + "reference", + "sku", + "total", + "variant_id", + "variant_name", + "weight", + "width" + ], + "$ref": "#/components/schemas/Product.order" + } + }, + "installments": { + "type": "number", + "minimum": 1, + "description": "Parcelas do pagamento parcelado" + }, + "id": { + "type": "integer", + "description": "Código identificador do pedido" + }, + "extra": { + "type": "object", + "description": "Campo de observações do pedido" + }, + "expected_delivery_date": { + "type": "string", + "format": "date" + }, + "email": { + "type": "string", + "description": "Email do cliente" + }, + "discount_price": { + "type": "number", + "description": "Valor do desconto aplicado no pedido" + }, + "deposit": { + "type": "boolean" + }, + "delivery_type": { + "type": "string" + }, + "delivery_message": { + "type": "string" + }, + "delivery_days": { + "type": "integer", + "description": "Dias para entrega" + }, + "delivered_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data de entrega do pedido" + }, + "coupon_code": { + "type": "string", + "nullable": true, + "description": "Código de cupom do pedido" + }, + "confirmed_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data e horário de confirmação do pedido" + }, + "code": { + "type": "string", + "description": "Código do pedido" + }, + "client_id": { + "type": "integer", + "description": "Código identificador (`ID`) do cliente" + }, + "channel": { + "type": "string", + "enum": [ + "ecommerce", + "direct" + ], + "description": "Canal de venda que originou o pedido" + }, + "cart_id": { + "type": "integer", + "description": "Código identificador do carrinho que originou o pedido" + }, + "card_validity": { + "type": "string", + "nullable": true, + "description": "Data de validade do cartão de crédito" + }, + "card_number": { + "type": "string", + "pattern": "^[*]{10,12}[0-9]{4}$", + "description": "Número do cartão de crédito" + }, + "card": { + "type": "boolean", + "description": "Retorna `true` se o método de pagamento do pedido é por cartão de crédito." + }, + "canceled_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "description": "Data e horário do cancelamento do pedido" + }, + "browser_ip": { + "type": "string", + "format": "ipv4", + "description": "Endereço IP de origem do pedido" + }, + "agent": { + "type": "string", + "nullable": true, + "description": "Agente do pedido" + }, + "affiliate_tag": { + "type": "string", + "nullable": true + }, + "pix_qr_code": { + "type": "string", + "nullable": true + }, + "payment_authorization_code": { + "type": "string", + "nullable": true, + "description": "Código de autorização do pagamento" + }, + "bonus_granted": { + "type": "boolean", + "description": "Indica se o pedido gerou bônus" + }, + "has_split": { + "type": "boolean" + }, + "pix": { + "type": "boolean", + "description": "Indica se o pedido foi pago usando o Pix" + }, + "ame_qr_code": { + "type": "string", + "nullable": true + }, + "ame": { + "type": "boolean", + "description": "Indica se o pedido foi pago usando o Ame" + }, + "antifraud_assurance": { + "type": "string", + "nullable": true + } + }, + "required": [ + "rebate_discount", + "updated_at", + "total", + "token", + "taxes", + "subtotal", + "status", + "slip", + "shipped_at", + "received_at", + "payment_method", + "payment_gateway", + "payment_authorization", + "paid_at", + "email", + "discount_price", + "deposit", + "delivered_at", + "coupon_code", + "confirmed_at", + "code", + "client_id", + "channel", + "cart_id", + "card_validity", + "card_number", + "card", + "browser_ip", + "pix", + "ame" + ] + }, + "Order_item_customization.v1": { + "title": "Order Item Customization", + "type": "object", + "description": "Modelo que representa uma personalização de item do pedido na API", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador `ID` da personalização" + }, + "number": { + "type": "integer", + "minimum": 1, + "description": "Número de tipos diferentes de personalizações em produtos do pedido" + }, + "group_name": { + "type": "string", + "description": "Grupo em que se enquadra a personalização" + }, + "name": { + "type": "string", + "description": "Nome do produto" + }, + "price": { + "type": "number", + "description": "Preço do produto" + }, + "intl_price": { + "type": "number", + "description": "Preço internacional" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio do produto" + }, + "sku": { + "type": "string", + "nullable": true, + "description": "Código SKU da variante de produto" + } + }, + "required": [ + "id", + "number", + "group_name", + "name", + "price", + "intl_price", + "handling_days", + "sku" + ] + }, + "Payables.v1": { + "title": "Recebíveis do usuário", + "description": "Valores que o usuário possui a receber", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "status": { + "type": "string" + }, + "amount": { + "type": "number" + }, + "fee": { + "type": "number" + }, + "installment": { + "type": "number" + }, + "credit_date": { + "type": "string", + "format": "date-time" + }, + "order_date": { + "type": "string", + "format": "date-time" + }, + "transaction_id": { + "type": "number" + } + } + }, + "Payment_recipient.v1": { + "title": "Payment Recipient", + "type": "object", + "description": "Modelo que representa um recebedor na API", + "properties": { + "id": { + "type": "integer" + }, + "percentage": { + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "active": { + "type": "boolean", + "default": true + }, + "charge_processing_fee": { + "type": "boolean", + "default": false + }, + "liable": { + "type": "boolean", + "default": false + }, + "code": { + "type": "string" + }, + "name": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "place_id": { + "type": "integer" + }, + "recipient_id": { + "type": "integer" + }, + "tag_id": { + "type": "integer" + }, + "user_id": { + "type": "integer" + }, + "include_shipping": { + "type": "boolean", + "default": true, + "description": "Indica se o frete deve ser incluído no split do pagamento" + } + }, + "required": [ + "id", + "percentage", + "recipient_id" + ] + }, + "Place.v1": { + "title": "Place", + "type": "object", + "description": "Modelo que representa um local na API", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "address_line_1": { + "type": "string", + "maxLength": 80 + }, + "address_line_2": { + "type": "string", + "maxLength": 80 + }, + "city": { + "type": "string", + "maxLength": 80 + }, + "neighborhood": { + "type": "string" + }, + "zip": { + "type": "string" + }, + "home_page": { + "type": "string" + }, + "latitude": { + "type": "number" + }, + "longitude": { + "type": "number" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "type": "string", + "maxLength": 200 + }, + "email": { + "type": "string" + }, + "first_phone": { + "type": "string" + }, + "second_phone": { + "type": "string" + }, + "mobile_phone": { + "type": "string" + }, + "only_cash": { + "type": "boolean", + "default": false + }, + "categories": { + "type": "array", + "items": { + "type": "string" + } + }, + "marker_url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "opening_hours": { + "type": "string" + }, + "warehouse": { + "type": "boolean", + "default": false + }, + "legal_name": { + "type": "string" + }, + "cnpj": { + "type": "string" + } + }, + "required": [ + "name", + "address_line_1", + "city", + "email" + ] + }, + "Product.v1": { + "title": "Product", + "type": "object", + "description": "Modelo que representa um produto na API", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador `ID` do priduto" + }, + "active": { + "type": "boolean", + "description": "Indica se o produto está ativo (`true`) ou invativo (`false`)" + }, + "available": { + "type": "boolean", + "description": "Indica se o produto está disponível (`true`) ou indisponível (`false`)" + }, + "category_tags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tag_type": { + "type": "string", + "description": "Tipo de tag" + }, + "name": { + "type": "string", + "description": "Nome da tag" + }, + "title": { + "type": "string", + "description": "Título da tag" + } + } + }, + "example": [ + { + "tag_type": "flag", + "name": "tag-veganos", + "title": "Veg" + }, + { + "tag_type": "flag", + "name": "liquida10", + "title": "10OFF" + } + ] + }, + "description": { + "type": "string", + "description": "Descrição do produto" + }, + "discount_id": { + "type": "integer", + "description": "Código de desconto" + }, + "html_description": { + "type": "string", + "description": "Descrição do produto em HTML" + }, + "image_url": { + "type": "string", + "description": "URL da imagem do produto" + }, + "installments": { + "type": "array", + "items": { + "type": "number" + }, + "description": "Relação das parcelas para pagamento parcelado" + }, + "min_quantity": { + "type": "string", + "description": "Quantidade mínima para venda do produto" + }, + "name": { + "type": "string", + "description": "Nome do produto" + }, + "on_sale": { + "type": "boolean", + "description": "Indica se o produto está em promoção (`true`) ou não (`false`)" + }, + "plain_description": { + "type": "string", + "description": "Descrição simplificada" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "rating": { + "type": "object", + "properties": { + "rating": { + "type": "integer" + }, + "votes": { + "type": "integer" + } + }, + "description": "Média de avaliação do produto" + }, + "reference": { + "type": "string", + "description": "Código de referência do produto" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "slug": { + "type": "string", + "description": "slug do produto" + }, + "tag_names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Lista de tags que o produto é associado" + }, + "updated_at": { + "type": "string", + "description": "Data e horário da última atualização do produto" + }, + "url": { + "type": "string", + "description": "URL do produto" + }, + "variants": { + "type": "array", + "items": { + "type": "object", + "properties": { + "{id}": { + "$ref": "#/components/schemas/Product_variant.v1" + } + } + }, + "description": "Variantes do produto" + }, + "discount_rule": { + "type": "object", + "nullable": true, + "required": [ + "type", + "amount" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "fixed", + "percentage" + ] + }, + "amount": { + "type": "number" + } + }, + "description": "Regras de desconto de uma promoção" + }, + "images": { + "type": "array", + "description": "Imagens do produto", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "id do produto" + }, + "url": { + "type": "string", + "description": "Url do produto" + }, + "updated_at": { + "type": "string", + "description": "Data e horário da última atualização do produto" + }, + "variant_ids": { + "type": "array", + "items": { + "type": "object" + } + } + } + }, + "example": [ + { + "id": 0, + "url": "https://b0.vnda.com.br/product.gif?v=1514479363", + "updated_at": "2017-12-28T14:42:43.000-02:00", + "variant_ids": [ + 0 + ] + } + ] + } + }, + "required": [ + "discount_rule" + ] + }, + "Product_variant.v1": { + "description": "Modelo que representa uma variante na API", + "type": "object", + "properties": { + "available": { + "type": "boolean" + }, + "available_quantity": { + "type": "integer" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "height": { + "type": "number" + }, + "id": { + "type": "integer", + "minimum": 1 + }, + "image_url": { + "type": "string", + "minLength": 1, + "description": "URL da imagem da variante" + }, + "installments": { + "type": "array", + "items": { + "type": "number" + } + }, + "inventories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product_variant_inventory.v1" + } + }, + "length": { + "type": "number" + }, + "main": { + "type": "boolean" + }, + "min_quantity": { + "type": "integer", + "description": "Quantidade mínima para venda" + }, + "name": { + "type": "string", + "minLength": 1, + "description": "Nome da variante" + }, + "norder": { + "type": "integer" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "product_id": { + "type": "integer" + }, + "properties": { + "type": "object", + "properties": { + "property1": { + "$ref": "#/components/schemas/Variant_property.v1" + }, + "property2": { + "$ref": "#/components/schemas/Variant_property.v1" + }, + "property3": { + "$ref": "#/components/schemas/Variant_property.v1" + } + }, + "description": "[Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante" + }, + "quantity": { + "type": "integer" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "sku": { + "type": "string", + "minLength": 1 + }, + "slug": { + "type": "string", + "minLength": 1 + }, + "stock": { + "type": "integer", + "description": "Quantidade de itens disponíveis" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização da variante" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + } + }, + "required": [ + "available", + "available_quantity", + "custom_attributes", + "handling_days", + "height", + "image_url", + "installments", + "length", + "main", + "min_quantity", + "name", + "norder", + "price", + "product_id", + "properties", + "quantity", + "sale_price", + "sku", + "slug", + "stock", + "updated_at", + "weight", + "width" + ] + }, + "Product_variant_inventory.v1": { + "description": "Modelo que representa um inventory da variante na API", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador `ID` do inventário" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Nome do inventário" + }, + "place_id": { + "type": "integer", + "description": "Código identificador do local" + }, + "place_name": { + "type": "string", + "nullable": true, + "description": "Nome do local" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "quantity": { + "type": "integer", + "description": "Quantidade de itens no inventário" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "slug": { + "type": "string", + "minLength": 1, + "description": "Slug do inventário" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização da variante no inventário" + }, + "variant_id": { + "type": "integer", + "description": "Código da variante" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Data de criação do inventário" + } + }, + "required": [ + "created_at", + "id", + "place_id", + "price", + "quantity", + "quantity_sold", + "sale_price", + "slug", + "updated_at", + "variant_id" + ], + "example": { + "inventories": { + "id": 524, + "slug": "normandia", + "price": 132, + "sale_price": 0, + "quantity": 500, + "quantity_sold": 0, + "name": null, + "variant_id": 532, + "updated_at": "2022-12-15T10:44:36.456-03:00", + "place_id": 3 + } + } + }, + "Shipping_methods.v1": { + "title": "Shipping Methods", + "type": "object", + "description": "Modelo que representa as formas de entrega na API", + "x-examples": { + "Forma de entrega": { + "name": "Normal", + "value": "pac", + "price": 1.99, + "description": "Prazo de até 7 dias corridos para a entrega do pedido", + "delivery_days": 7, + "value_needed_to_discount": null, + "shipping_method_id": 423, + "notice": null + } + }, + "properties": { + "name": { + "type": "string", + "description": "Nome do tipo de entrega, como por exemplo Normal, Expressa e Agendada" + }, + "value": { + "type": "string", + "description": "Identificador do método de envio" + }, + "price": { + "type": "number", + "description": "Preço de envio" + }, + "description": { + "type": "string", + "description": "Descrição do tipo de envio e prazo" + }, + "delivery_days": { + "type": "integer", + "description": "Número em dias do prazo de envio" + }, + "value_needed_to_discount": { + "type": "number", + "nullable": true, + "description": "Valor restante da compra para que o carrinho fique elegível para frete grátis" + }, + "shipping_method_id": { + "type": "integer", + "description": "Código identificador `ID` do tipo de envio" + }, + "notice": { + "type": "string", + "nullable": true, + "description": "Mensagem ou observação sobre a forma de envio" + }, + "fulfillment_company": { + "type": "string", + "nullable": true, + "description": "Empresa responsável pelo envio" + } + }, + "required": [ + "name", + "value", + "price", + "description", + "delivery_days", + "shipping_method_id", + "fulfillment_company" + ] + }, + "Order_items.v1": { + "title": "Order Items", + "type": "object", + "description": "Modelo que representa a lista de itens do pedido", + "properties": { + "id": { + "type": "integer" + }, + "variant_id": { + "type": "integer" + }, + "product_id": { + "type": "integer" + }, + "quantity": { + "type": "integer" + }, + "price": { + "type": "number" + }, + "weight": { + "type": "number" + }, + "width": { + "type": "number" + }, + "height": { + "type": "number" + }, + "length": { + "type": "number" + }, + "extra": { + "type": "object", + "properties": { + "customization": { + "type": "string" + } + } + }, + "picture_url": { + "type": "string" + }, + "reference": { + "type": "string" + }, + "sku": { + "type": "string" + }, + "product_name": { + "type": "string" + }, + "variant_name": { + "type": "string" + }, + "original_price": { + "type": "string" + }, + "place_id": { + "type": "string" + }, + "place_name": { + "type": "number" + }, + "place_city": { + "type": "number" + }, + "total": { + "type": "integer" + }, + "package": { + "type": "number" + }, + "has_customizations": { + "type": "integer" + }, + "barcode": { + "type": "integer" + } + } + }, + "Shop_asset.v1": { + "title": "Shop Asset", + "type": "object", + "description": "Modelo que representa as imagens da loja na API", + "properties": { + "id": { + "type": "integer" + }, + "position": { + "type": "string" + }, + "file_uid": { + "type": "string" + }, + "file_name": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "Shop_property.v1": { + "title": "Shop Property", + "type": "object", + "description": "Modelo que representa o atributo dos produtos da loja na API", + "properties": { + "name": { + "type": "string" + }, + "defining": { + "type": "boolean" + } + } + }, + "Shop_properties.v1": { + "title": "Shop Properties", + "type": "object", + "description": "Modelo que representa os atributos dos produtos da loja na API", + "properties": { + "property1": { + "$ref": "#/components/schemas/Shop_property.v1" + }, + "property2": { + "$ref": "#/components/schemas/Shop_property.v1" + }, + "property3": { + "$ref": "#/components/schemas/Shop_property.v1" + } + } + }, + "Site_message.v1": { + "title": "Site Message", + "type": "object", + "description": "Modelo que representa as mensagens do site na API", + "properties": { + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "call_to_action": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date" + }, + "updated_at": { + "type": "string", + "format": "date" + } + } + }, + "Tag.v1": { + "title": "Tag", + "type": "object", + "description": "Modelo que representa uma tag na API", + "properties": { + "name": { + "type": "string", + "pattern": "[a-z0-9\\-_]+" + }, + "title": { + "type": "string" + }, + "subtitle": { + "type": "string", + "nullable": true + }, + "description": { + "type": "string", + "nullable": true + }, + "type": { + "type": "string" + }, + "products_count": { + "type": "integer" + }, + "image_url": { + "type": "string", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name" + ] + }, + "Template.v1": { + "title": "Template", + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "body": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "path", + "updated_at" + ], + "description": "Modelo que representa um template na API" + }, + "User.v1": { + "title": "User", + "type": "object", + "description": "Modelo que representa um usuário na API", + "properties": { + "id": { + "type": "integer", + "description": "Código identificador do usuário" + }, + "email": { + "type": "string", + "format": "email", + "description": "Email do usuário" + }, + "access_token": { + "type": "string", + "description": "Token de validação de usuário logado (`access_token`)\n \nO `access_token` é gerado quando o usuário loga no Admin" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Nome do usuário" + }, + "admin": { + "type": "boolean", + "description": "Identificador de usuários administradores\n\nEsse atributo retorna `true` para um usuário administrador do ambiente de loja" + }, + "renew_password": { + "type": "boolean", + "description": "Identificador de usuários que atualizaram a senha inicial\n\nEsse atributo retorna `true` para um usuário que já redefiniu sua senha pelo menos uma vez" + }, + "role": { + "type": "integer", + "description": "Código da função do usuário na loja:\n\n - Agente: `0`;\n - Gestor: `1`;\n - Local: `2`;\n - Agente Social Selling: `3`." + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tags para agrupamento de usuários\nAs tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão" + }, + "external_code": { + "type": "string", + "nullable": true, + "description": "Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema." + }, + "phone_area": { + "type": "string", + "maxLength": 2, + "minLength": 2, + "description": "Código de Discagem Direta a Distância (DDD) do telefone do usuário" + }, + "phone": { + "type": "string", + "maxLength": 9, + "minLength": 8, + "description": "Número de telefone do usuário" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Data de inclusão do usuário no Admin" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data de atualização das informações do usuário" + } + }, + "required": [ + "email" + ] + }, + "Variant_inventory.v1": { + "description": "Model que representa um inventory da variante", + "type": "object", + "properties": { + "id": { + "type": "integer", + "minimum": 1 + }, + "name": { + "type": "string", + "minLength": 1 + }, + "place_id": { + "type": "integer" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "quantity": { + "type": "integer" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + }, + "sale_price": { + "type": "number", + "description": "Preço promocional" + }, + "slug": { + "type": "string" + } + }, + "required": [ + "id", + "name", + "place_id", + "price", + "quantity", + "quantity_sold", + "sale_price", + "slug" + ] + }, + "Variant_property.v1": { + "title": "variant_property", + "type": "object", + "properties": { + "defining": { + "type": "boolean", + "description": "Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`)" + }, + "name": { + "type": "string", + "description": "Nome da propriedade" + }, + "value": { + "type": "string", + "description": "Valor da propriedade" + } + }, + "required": [ + "defining", + "name" + ], + "description": "Modelo que representa uma propriedade customizada na API", + "example": { + "example-property1": { + "name": "Tamanho", + "value": "G", + "defining": true + }, + "example-property2": { + "name": "Cor", + "value": "Amarelo", + "defining": true + } + } + }, + "User.v0": { + "title": "Campos de cadastro de usuário", + "type": "object", + "description": "Modelo que representa o cadastro de usuário", + "properties": { + "email": { + "type": "string", + "format": "email", + "description": "Email do usuário" + }, + "name": { + "type": "string", + "nullable": true, + "description": "Nome do usuário" + }, + "role_name": { + "type": "string", + "enum": [ + "Agente", + "Gestor", + "Local", + "Agente Social Selling" + ], + "description": "Função do usuário na loja" + }, + "password": { + "type": "string", + "description": "Senha do usuário" + }, + "password_confirmation": { + "type": "string", + "description": "Confirmação de senha do usuário" + }, + "external_code": { + "type": "string", + "description": "Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema." + }, + "phone_area": { + "type": "string", + "maxLength": 2, + "minLength": 2, + "description": "Código de Discagem Direta a Distância (DDD) do telefone do usuário" + }, + "phone": { + "type": "string", + "maxLength": 9, + "minLength": 8, + "description": "Número de telefone do usuário" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Tags para agrupamento de usuários\nCom as tags o lojista pode agrupar usuários para direcionar promoções para determinados usuários, fazer uma divisão de pagamentos, definir regras de comissão, entre outras aplicações com usuários" + } + }, + "required": [ + "email" + ] + }, + "SimpleProduct": { + "title": "SimpleProduct", + "type": "object", + "description": "Modelo simplificado de um produto para atualização e criação", + "properties": { + "reference": { + "type": "string", + "description": "Código de Referência do produto" + }, + "name": { + "type": "string", + "description": "Nome do produto" + }, + "description": { + "type": "string", + "description": "Descrição do produto" + }, + "active": { + "type": "boolean", + "default": true, + "description": "Indica se o produto está ativo (`true`) ou invativo (`false`)" + }, + "tag_list": { + "type": "string", + "example": "tag1, tag2", + "description": "Tags associadas ao produto" + }, + "product_type": { + "type": "string", + "description": "Tipo de produto", + "enum": [ + "product", + "sample", + "subscription" + ], + "default": "product" + } + }, + "required": [ + "reference", + "name" + ] + }, + "Cart.simple": { + "title": "Parâmetros de carrinho resumido", + "description": "Parâmetros criação e atualização de carrinho", + "type": "object", + "properties": { + "agent": { + "type": "string", + "description": "Agente que criou o carrinho" + }, + "zip": { + "type": "string", + "description": "Código de Endereçamento Postal (CEP) do destinatário do pedido" + }, + "client_id": { + "type": "integer", + "minimum": 0, + "description": "Código identificador `ID` do cliente" + }, + "coupon_code": { + "type": "string", + "description": "Código identificador `ID` do desconto do carrinho" + }, + "email": { + "type": "string", + "deprecated": true, + "format": "email", + "description": "Email do cliente" + }, + "rebate_token": { + "type": "string", + "description": "Token do desconto" + } + } + }, + "Cart.v2": { + "title": "Lista de carrinhos", + "description": "Modelo de lista de carrinhos", + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart.v1" + } + }, + "Product.v0": { + "type": "object", + "title": "Produto", + "description": "Modelo de carcaterística de produto para item no carrinho", + "properties": { + "sku": { + "type": "string", + "description": "Código SKU da variante do produto" + }, + "quantity": { + "type": "integer", + "minimum": 0, + "description": "Unidades do produto disponíveis fisicamente" + }, + "extra": { + "type": "object", + "description": "Campo para registro de observações, chave ou valores necessários" + }, + "place_id": { + "type": "integer", + "description": "Código identificador do local do produto", + "minimum": 0 + }, + "store_coupon_code": { + "type": "string", + "description": "Código de cupom" + }, + "customizations": { + "type": "array", + "description": "[Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto", + "items": { + "properties": { + "Customization": { + "type": "string", + "description": "[Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. \nSe por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. " + } + } + }, + "required": [ + "sku", + "quantity" + ] + } + } + }, + "Shipping_address": { + "title": "Endereço de envio", + "description": "Modelo de endereço de envio para carrinho e pedido", + "type": "object", + "properties": { + "first_name": { + "type": "string", + "description": "Nome do cliente" + }, + "last_name": { + "type": "string", + "description": "Sobrenome do cliente" + }, + "company_name": { + "type": "string", + "description": "Nome da empresa (para clientes jurídicos)" + }, + "email": { + "type": "string", + "format": "email", + "description": "Email do cliente" + }, + "first_phone_area": { + "type": "string", + "description": "Código de Discagem Direta à Distância (DDD)" + }, + "first_phone": { + "type": "string", + "description": "Telefone do cliente" + }, + "second_phone_area": { + "type": "string", + "description": "Código de Discagem Direta à Distância (DDD)" + }, + "second_phone": { + "type": "string", + "description": "Telefone do cliente" + }, + "recipient_name": { + "description": "Nome do recebedor" + }, + "street_name": { + "type": "string", + "description": "Logradouro" + }, + "street_number": { + "description": "Número", + "type": "string" + }, + "complement": { + "type": "string", + "description": "Complemento" + }, + "neighborhood": { + "type": "string", + "description": "Bairro" + }, + "reference": { + "type": "string", + "description": "Ponto de referência" + }, + "zip": { + "type": "string", + "description": "Código de Endereçamento Postal (CEP)" + }, + "documents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cpf": { + "description": "Cadastro de Pessoa Física", + "type": "string" + }, + "rg": { + "description": "Registro Geral", + "type": "string" + }, + "cnpj": { + "description": "Cadastro Nacional de Pessoas Jurídicas", + "type": "string" + }, + "ie": { + "type": "string", + "description": "Inscrição Estadual" + } + } + } + } + }, + "required": [ + "zip" + ] + }, + "Product.order": { + "title": "Produto em um pedido", + "description": "Modelo de produto em um pedido", + "type": "object", + "properties": { + "extra": { + "type": "object", + "description": "Dados extra do produto" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros." + }, + "id": { + "type": "integer", + "description": "código identificador do produto" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros." + }, + "original_price": { + "type": "number", + "description": "Preço original" + }, + "package": { + "type": "string", + "description": "Pacote do produto" + }, + "picture_url": { + "type": "string", + "description": "URL da imagem do produto" + }, + "place_city": { + "type": "string", + "nullable": true, + "description": "Cidade que o produto está" + }, + "place_id": { + "type": "integer", + "description": "Código identificador do local do produto" + }, + "place_name": { + "type": "string", + "nullable": true, + "description": "Nome do local do produto" + }, + "price": { + "type": "number", + "description": "Preço do produto" + }, + "product_id": { + "type": "integer" + }, + "product_name": { + "type": "string" + }, + "quantity": { + "type": "integer", + "description": "Unidades do produto" + }, + "reference": { + "type": "string", + "description": "Código de referência do produto" + }, + "sku": { + "type": "string", + "description": "Código SKU da variante do produto" + }, + "total": { + "type": "number", + "minimum": 0, + "description": "Valor total do produto" + }, + "variant_id": { + "type": "integer", + "description": "Código identificador da variante do produto" + }, + "variant_name": { + "type": "string", + "nullable": true, + "description": "Nome da variante do produto" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "barcode": { + "type": "string", + "description": "Código de barras do produto" + }, + "has_customizations": { + "type": "boolean", + "description": "Indica se o produto possui customização." + } + }, + "required": [ + "extra", + "product_id", + "product_name", + "quantity", + "reference", + "sku", + "total", + "variant_id", + "variant_name", + "weight", + "width" + ] + } + }, + "securitySchemes": { + "Token": { + "type": "http", + "scheme": "bearer", + "description": "Token que deve ser enviado em todas as requisições. [Este token](http://ajuda.vnda.com.br/pt-BR/articles/1506726-chave-token-de-api) pode ser gerado pelo painel admin e não possui data de expiração. O Token e URLs gerados e utilizados no ambiente de produção serão diferentes dos que foram gerados no [ambiente de testes](http://ajuda.vnda.com.br/pt-BR/articles/3760960-ambiente-de-testes-staging). O valor de Authorization será 'Bearer seu_token'" + }, + "X-Shop-Host": { + "type": "apiKey", + "in": "header", + "name": "X-Shop-Host", + "description": "Domínio da loja como `www.nomedaloja.com.br`" + } + }, + "responses": { + "204": { + "description": "Quando um registro é atualizado", + "content": { + "application/json": { + "schema": { + "nullable": true + } + } + }, + "headers": { + "X-Request-Id": { + "schema": { + "type": "string" + }, + "description": "Id da requisição" + } + } + }, + "404": { + "description": "Quando o registro não é encontrado", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "error": { + "type": "string" + } + }, + "required": [ + "error" + ] + }, + "examples": { + "Não encontrado": { + "value": { + "error": "not found" + } + } + } + }, + "application/xml": { + "schema": { + "type": "object", + "properties": {} + } + } + }, + "headers": { + "X-Request-Id": { + "schema": { + "type": "string" + }, + "description": "Id da requisição" + } + } + }, + "422": { + "description": "Quando os parâmetros enviados são inválidos", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/422.v1" + } + } + }, + "headers": { + "X-Request-Id": { + "schema": { + "type": "string" + }, + "description": "Id da requisição" + } + } + }, + "Banners": { + "description": "Resposta que representa uma lista de banners", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Banner" + } + } + } + } + }, + "Banner": { + "description": "Quando um banner é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Banner" + }, + "examples": { + "example-1": { + "value": { + "big_thumb": "//b3.vnda.com.br/200x/demo%2F2019%2F02%2F25%2F19_49_32_754_home1b.jpg", + "color": "", + "description": "[COLEÇAO LA MEDINAi](https://exemplo.com/ovos-mexidos.pdf)", + "end_at": "2019-12-01T08:50:00.000-03:00", + "external": false, + "file_name": "demo%2F2019%2F02%2F25%2F19_49_32_754_home1b.jpg", + "file_uid": "demo%2F2019%2F02%2F25%2F19_49_32_754_home1b.jpg", + "html_description": "

COLEÇAO LA MEDINAi

\n", + "id": 2, + "norder": null, + "plain_description": "COLEÇAO LA MEDINAi (https://exemplo.com/ovos-mexidos.pdf)", + "small_thumb": "//b3.vnda.com.br/26x26/demo%2F2019%2F02%2F25%2F19_49_32_754_home1b.jpg", + "start_at": "2018-12-13T00:00:00.000-02:00", + "subtitle": null, + "tag": "fullbanner", + "title": "Fullbanner 2", + "updated_at": "2021-01-11T17:14:48.999-03:00", + "url": null + } + } + } + } + } + }, + "AllBanners": { + "description": "Quando existem banners dentro do período de validade", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SlimBanner" + } + } + } + } + } + }, + "Carts": { + "description": "Resposta que representa uma lista de carrinhos", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Cart" + }, + "example": [ + { + "updated_at": "2020-07-13T16:35:14.999-03:00", + "has_phone": false, + "shipping_method": null, + "items_count": 1, + "has_payment_responses": false, + "id": 23, + "email": null, + "quotation_responses_count": 0, + "payment_responses_count": 0, + "code": "799594D6EB", + "extra": {}, + "total": 12.1, + "token": "zX89SG241cST3lpzQ2nkkqJXppUJYou1jTgL" + }, + { + "shipping_method": null, + "has_phone": false, + "updated_at": "2020-07-06T22:51:17.171-03:00", + "has_payment_responses": false, + "items_count": 1, + "id": 22, + "quotation_responses_count": 0, + "payment_responses_count": 0, + "email": null, + "code": "FDF4819129", + "extra": {}, + "total": 123.1, + "token": "gt2hvYm96LNzVhcKGbR9BJnQlpaqL4kMVYAs" + } + ] + }, + "examples": { + "example-1": { + "value": [ + { + "updated_at": "2020-07-13T16:35:14.999-03:00", + "has_phone": false, + "shipping_method": null, + "items_count": 1, + "has_payment_responses": false, + "id": 23, + "email": null, + "quotation_responses_count": 0, + "payment_responses_count": 0, + "code": "799594D6EB", + "extra": {}, + "total": 12.1, + "token": "zX89SG241cST3zQ2nkkqJXUJYou1jTgL" + }, + { + "shipping_method": null, + "has_phone": false, + "updated_at": "2020-07-06T22:51:17.171-03:00", + "has_payment_responses": false, + "items_count": 1, + "id": 22, + "quotation_responses_count": 0, + "payment_responses_count": 0, + "email": null, + "code": "FDF4819129", + "extra": {}, + "total": 123.1, + "token": "gt2hvYmLNzVhcKGbR9BJnQaqL4kMVYAs" + } + ] + } + } + } + } + }, + "Channels": { + "description": "Resposta que representa uma lista de channels", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "Lista de channels": { + "value": [ + "direct", + "direct_app", + "ecommerce" + ] + } + } + } + }, + "headers": {} + }, + "CartItemCustomizationList": { + "description": "Resposta que representa uma lista de customizações de um item", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartItemCustomization" + } + }, + "items": { + "$ref": "#/components/schemas/CartItemCustomization" + } + } + } + } + }, + "States": { + "description": "Resposta que representa uma lista de estados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "examples": { + "Lista de estados": { + "value": [ + "RS", + "PE", + "MG" + ] + } + } + } + } + }, + "ProductPrice": { + "description": "Resposta que representa os dados de preços de um produto e suas variantes", + "content": { + "application/json": { + "schema": { + "description": "", + "type": "object", + "x-examples": { + "example-1": { + "available": true, + "on_sale": false, + "price": 10, + "sale_price": 10, + "intl_price": 0, + "discount_rule": null, + "installments": [ + { + "number": 1, + "price": 10, + "interest": false, + "interest_rate": 0, + "total": 10 + }, + { + "number": 2, + "price": 5.15, + "interest": true, + "interest_rate": 1.5, + "total": 10.3 + } + ], + "updated_at": "", + "variants": [ + { + "main": true, + "sku": "CSMT-1", + "price": 10, + "on_sale": false, + "sale_price": 10, + "intl_price": 0, + "available": true, + "properties": {}, + "stock": 1, + "installments": [ + { + "number": 1, + "price": 10, + "interest": false, + "interest_rate": 0, + "total": 10 + }, + { + "number": 2, + "price": 5.15, + "interest": true, + "interest_rate": 1.5, + "total": 10.3 + } + ] + }, + { + "main": false, + "sku": "CSMT-2", + "price": 10, + "on_sale": false, + "sale_price": 10, + "intl_price": 0, + "available": true, + "properties": {}, + "stock": 1, + "installments": [ + { + "number": 1, + "price": 10, + "interest": false, + "interest_rate": 0, + "total": 10 + }, + { + "number": 2, + "price": 5.15, + "interest": true, + "interest_rate": 1.5, + "total": 10.3 + } + ] + } + ] + } + }, + "properties": { + "available": { + "type": "boolean" + }, + "on_sale": { + "type": "boolean" + }, + "price": { + "type": "number" + }, + "sale_price": { + "type": "number" + }, + "intl_price": { + "type": "number" + }, + "discount_rule": {}, + "installments": { + "type": "array", + "uniqueItems": true, + "minItems": 1, + "items": { + "$ref": "#/components/schemas/ProductInstallment" + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização" + }, + "variants": { + "type": "array", + "uniqueItems": true, + "minItems": 1, + "items": { + "$ref": "#/components/schemas/ProductPriceVariant" + } + } + }, + "required": [ + "available", + "on_sale", + "price", + "sale_price", + "intl_price", + "installments", + "updated_at", + "variants" + ] + } + } + }, + "headers": {} + }, + "Mappings": { + "description": "Quando os mapeamentos são listados", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Mapping" + } + } + } + } + }, + "Mapping": { + "description": "Quando o mapeamento é encontrado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Mapping" + } + } + } + }, + "MappingCreate": { + "description": "Quando o mapeamento é criado", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Mapping" + } + } + } + }, + "Packages": { + "description": "Resposta que representa uma lista de pacotes", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Package" + } + } + } + } + }, + "ProductImage": { + "description": "Resposta que representa uma imagem de produto", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductImage" + } + } + } + } + }, + "ProductImages": { + "description": "Resposta que representa uma lista de imagens de produto", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductImage" + } + } + } + } + }, + "VariantImages": { + "description": "Quando as imagens são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Data e horário da última atualização da imagem do produto" + } + }, + "required": [ + "url", + "updated_at" + ] + } + }, + "examples": { + "Lista de imagens": { + "value": [ + { + "url": "//b1.vnda.com.br/demo/2020/01/01/001-produto-teste-01-nome-do-produto-123.jpg?v=1234567890", + "updated_at": "2020-01-01T00:00:00.000-03:00" + }, + { + "url": "//b1.vnda.com.br/demo/2020/01/01/002-produto-teste-02-nome-do-produto-456.jpg?v=1357902468", + "updated_at": "2020-01-01T01:01:01.001-03:00" + } + ] + } + } + } + } + }, + "VariantShippings": { + "description": "Quando as formas de entrega são listadas", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "price": { + "type": "number" + }, + "description": { + "type": "string" + }, + "delivery_days": { + "type": "integer" + }, + "value_needed_to_discount": { + "type": "number", + "nullable": true + }, + "shipping_method_id": { + "type": "integer", + "nullable": true + }, + "notice": { + "type": "string", + "nullable": true + }, + "fulfillment_company": { + "type": "string", + "nullable": true + }, + "countries": { + "type": "array", + "nullable": true, + "items": { + "type": "object", + "properties": { + "country": { + "type": "string" + }, + "price": { + "type": "string" + } + } + } + } + }, + "required": [ + "name", + "value", + "price", + "description", + "delivery_days", + "value_needed_to_discount", + "shipping_method_id", + "notice", + "fulfillment_company", + "countries" + ] + } + }, + "examples": { + "Lista de formas de entrega": { + "value": [ + { + "name": "Normal", + "value": "normal", + "price": 1.25, + "description": "Prazo de até 7 dias corridos para a entrega do pedido", + "delivery_days": 7, + "value_needed_to_discount": 2.2, + "shipping_method_id": 1, + "notice": "Notice 1", + "fulfillment_company": "olist_envios", + "countries": [ + { + "country": "ARG", + "price": "1.0" + }, + { + "country": "RUS", + "price": "2.0" + } + ] + }, + { + "name": "Expressa", + "value": "expressa", + "price": 2.25, + "description": "Prazo de 1 dia corrido para a entrega do pedido", + "delivery_days": 1, + "value_needed_to_discount": null, + "shipping_method_id": null, + "fulfillment_company": null, + "notice": null, + "countries": null + } + ] + } + } + } + } + }, + "Orders": { + "description": "Lista de pedidos", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order.v1" + } + } + } + }, + "headers": { + "X-Request-Id": { + "schema": { + "type": "string" + }, + "description": "ID da requisição" + }, + "X-Pagination": { + "schema": { + "type": "string" + }, + "description": "JSON com dados da paginação" + } + } + } + }, + "parameters": { + "only_valid": { + "name": "only_valid", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "true" + }, + "description": "Booleano indicando para filtrar banners fora do prazo de validade" + }, + "only_scheduled": { + "name": "only_scheduled", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "true" + }, + "description": "Booleano indicando para filtrar banners agendados" + }, + "only_expired": { + "name": "only_expired", + "in": "query", + "required": false, + "schema": { + "type": "string", + "example": "true" + }, + "description": "Booleano indicando para filtrar banners com prazo de validade expirados" + }, + "tag": { + "name": "tag", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Lista separada por vírgula com nomes de tags" + }, + "title": { + "name": "title", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Texto livre que permite filtrar os banners pelo título" + }, + "no_paginate": { + "name": "no_paginate", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "description": "Booleano indicando para não fazer paginação dos resultados" + }, + "page": { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "minimum": 1 + }, + "description": "Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação" + }, + "per_page": { + "name": "per_page", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "default": 100, + "maximum": 100 + }, + "description": "Número máximo de registros que deve ser retornado por página" + }, + "coupon_codes": { + "name": "coupon_codes", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "allowEmptyValue": true, + "description": "Array com os códigos de cupons" + }, + "start": { + "name": "start", + "in": "query", + "schema": { + "type": "string", + "format": "date" + }, + "description": "Retorna os resultados a partir desta data, no formato 'yyyy-mm-dd'" + }, + "finish": { + "name": "finish", + "in": "query", + "schema": { + "type": "string", + "format": "date" + }, + "description": "Retorna os resultados até esta data, no formato 'yyyy-mm-dd'" + }, + "status": { + "name": "status", + "in": "query", + "schema": { + "type": "string", + "example": "confirmed" + } + }, + "sort": { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "example": "updated_at,desc", + "enum": [ + "newest" + ] + }, + "description": "Ordena o resultado da busca de produtos em ordem crescente de cadastro " + }, + "order_code": { + "name": "order_code", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "Código do pedido" + }, + "invoiced": { + "name": "invoiced", + "in": "query", + "schema": { + "type": "boolean" + }, + "description": "Se \"true\" retorna somente os pedidos que tenham nota fiscal. Se \"false\" retorna somente os pedidos que não tenham nota fiscal" + }, + "product_id": { + "name": "product_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID do produto" + }, + "cart_id": { + "name": "cart_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "ID do carrinho" + }, + "sku": { + "name": "sku", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "SKU da variante" + }, + "include_customizations_in_total": { + "name": "include_customizations_in_total", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "description": "Se \"true\" inclui o preço dos produtos customizados no total do pedido. Se \"false\" retorna o total do pedido sem a somatória do preço de produtos customizados.", + "required": false, + "allowEmptyValue": true + }, + "limit": { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "limit", + "description": "Limite da quantidade de itens retornados" + }, + "reference": { + "schema": { + "type": "string" + }, + "in": "query", + "name": "reference", + "description": "Código de referência do produto" + }, + "ids": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "ids", + "description": "Filtra pelo `ID` de produtos" + }, + "updated_after": { + "schema": { + "type": "string" + }, + "in": "query", + "name": "updated_after", + "description": "Filtra produtos alterados depois da data" + }, + "include_inactive": { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "include_inactive", + "description": "Inclui na requisição os produtos inativos" + }, + "include_images": { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "include_images", + "description": "Inclui na requisição se deseja que venham todas as imagens do produto" + }, + "image_id": { + "schema": { + "type": "string" + }, + "name": "image_id", + "in": "path", + "required": true, + "description": "Código identificador `ID` da imagem" + }, + "Cart.id": { + "in": "path", + "schema": { + "type": "string" + }, + "name": "cart_id", + "required": true, + "description": "Código identificador `ID` ou `token` do carrinho" + }, + "Order.code": { + "in": "path", + "schema": { + "type": "string", + "minLength": 10, + "maxLength": 64 + }, + "name": "order_code", + "required": true, + "description": "Código identificador (`code`) ou `token` do pedido" + }, + "Package.code": { + "in": "path", + "schema": { + "type": "string", + "minLength": 1 + }, + "name": "package_code", + "required": true, + "description": "Código identificador do pacote" + } + }, + "requestBodies": { + "Product": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reference": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "active": { + "type": "boolean", + "default": true + }, + "product_type": { + "type": "string", + "enum": [ + "product", + "sample", + "subscription" + ], + "default": "product" + } + }, + "required": [ + "reference", + "name" + ] + } + } + }, + "description": "" + }, + "Variant": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sku": { + "type": "string" + }, + "name": { + "type": "string" + }, + "quantity": { + "type": "integer" + }, + "main": { + "type": "boolean" + }, + "width": { + "type": "number", + "description": "Largura do produto, em centímetros" + }, + "height": { + "type": "number", + "description": "Altura do produto, em centímetros" + }, + "length": { + "type": "number", + "description": "Comprimento do produito, em centímetros" + }, + "weight": { + "type": "number", + "description": "Massa do produto, em gramas" + }, + "handling_days": { + "type": "integer", + "description": "Dias de manuseio da variante" + }, + "price": { + "type": "number", + "description": "Preço do item" + }, + "custom_attributes": { + "type": "object", + "description": "Customização da variante" + }, + "min_quantity": { + "type": "integer" + }, + "norder": { + "type": "integer" + }, + "property1": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property2": { + "$ref": "#/components/schemas/VariantProperty" + }, + "property3": { + "$ref": "#/components/schemas/VariantProperty" + }, + "barcode": { + "type": "string" + }, + "quantity_sold": { + "type": "integer", + "description": "Quantidade de itens vendidos" + } + }, + "required": [ + "sku", + "quantity", + "price" + ] + } + } + } + }, + "Orders": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "orders": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Código do pedido" + } + }, + "required": [ + "code" + ] + } + } + } + }, + "examples": { + "example-1": { + "value": { + "orders": [ + { + "code": "A1B2C3D4E5" + }, + { + "code": "5E4D3C2B1A" + } + ] + } + } + } + } + } + } + } + }, + "tags": [ + { + "name": "Usuários" + }, + { + "name": "Créditos" + }, + { + "name": "Pedidos" + }, + { + "name": "Pacotes" + }, + { + "name": "Produtos" + }, + { + "name": "Variantes" + }, + { + "name": "Estoque" + }, + { + "name": "Tags" + }, + { + "name": "Templates" + }, + { + "name": "Carrinhos" + }, + { + "name": "Itens do carrinho" + }, + { + "name": "Locais" + }, + { + "name": "Notas fiscais" + }, + { + "name": "Recebedores" + }, + { + "name": "Pagamentos" + }, + { + "name": "Público" + }, + { + "name": "Clientes" + }, + { + "name": "Rastreios" + }, + { + "name": "Promoções" + }, + { + "name": "Regras de desconto" + }, + { + "name": "Cupons de desconto" + }, + { + "name": "Menus" + }, + { + "name": "Mensagens do site" + }, + { + "name": "Loja" + }, + { + "name": "Personalizações" + }, + { + "name": "Mapeamentos" + }, + { + "name": "Mídias" + }, + { + "name": "Eventos" + } + ], + "security": [ + { + "Token": [] + } + ], + "x-readme": { + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "_id": "6387a48156e90b009a6ce710", + "x-stoplight": { + "id": "baml4bcuaujvs" + } +} \ No newline at end of file diff --git a/wake/hooks/context.ts b/wake/hooks/context.ts index 4f7248ff9..79b62c93b 100644 --- a/wake/hooks/context.ts +++ b/wake/hooks/context.ts @@ -1,7 +1,7 @@ import { IS_BROWSER } from "$fresh/runtime.ts"; import { signal } from "@preact/signals"; import { invoke } from "../runtime.ts"; -import type { CheckoutFragment } from "../utils/graphql/graphql.gen.ts"; +import type { CheckoutFragment } from "../utils/graphql/storefront.graphql.gen.ts"; export interface Context { cart: Partial; diff --git a/wake/hooks/useCart.ts b/wake/hooks/useCart.ts index 3016a2629..4daeeb045 100644 --- a/wake/hooks/useCart.ts +++ b/wake/hooks/useCart.ts @@ -1,7 +1,7 @@ import type { AnalyticsItem } from "../../commerce/types.ts"; import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; -import { CheckoutFragment } from "../utils/graphql/graphql.gen.ts"; +import { CheckoutFragment } from "../utils/graphql/storefront.graphql.gen.ts"; import { Context, state as storeState } from "./context.ts"; const { cart, loading } = storeState; diff --git a/wake/loaders/cart.ts b/wake/loaders/cart.ts index 30610f39e..7026a43e7 100644 --- a/wake/loaders/cart.ts +++ b/wake/loaders/cart.ts @@ -8,7 +8,7 @@ import { CreateCartMutationVariables, GetCartQuery, GetCartQueryVariables, -} from "../utils/graphql/graphql.gen.ts"; +} from "../utils/graphql/storefront.graphql.gen.ts"; /** * @title VNDA Integration diff --git a/wake/loaders/productDetailsPage.ts b/wake/loaders/productDetailsPage.ts index cf8365882..28dbc2d98 100644 --- a/wake/loaders/productDetailsPage.ts +++ b/wake/loaders/productDetailsPage.ts @@ -5,7 +5,7 @@ import { AppContext } from "../mod.ts"; import { GetProductQuery, GetProductQueryVariables, -} from "../utils/graphql/graphql.gen.ts"; +} from "../utils/graphql/storefront.graphql.gen.ts"; import { parseSlug, toBreadcrumbList, toProduct } from "../utils/transform.ts"; import { fragment } from "../utils/graphql/fragments/singleProduct.ts"; diff --git a/wake/loaders/productList.ts b/wake/loaders/productList.ts index 3efcdf7fe..20f330cd7 100644 --- a/wake/loaders/productList.ts +++ b/wake/loaders/productList.ts @@ -6,7 +6,7 @@ import { GetProductsQuery, GetProductsQueryVariables, ProductFragment, -} from "../utils/graphql/graphql.gen.ts"; +} from "../utils/graphql/storefront.graphql.gen.ts"; import { toProduct } from "../utils/transform.ts"; export interface Props { diff --git a/wake/loaders/productListingPage.ts b/wake/loaders/productListingPage.ts index 22a3d5c74..515c500c7 100644 --- a/wake/loaders/productListingPage.ts +++ b/wake/loaders/productListingPage.ts @@ -9,7 +9,7 @@ import { SearchQuery, SearchQueryVariables, SortDirection, -} from "../utils/graphql/graphql.gen.ts"; +} from "../utils/graphql/storefront.graphql.gen.ts"; import { FILTER_PARAM, toFilters, toProduct } from "../utils/transform.ts"; export const SORT_OPTIONS: SortOption[] = [ diff --git a/wake/mod.ts b/wake/mod.ts index 8df5f3c5c..2e46c55f9 100644 --- a/wake/mod.ts +++ b/wake/mod.ts @@ -1,7 +1,7 @@ import type { App, FnContext } from "deco/mod.ts"; import { createHttpClient } from "../utils/http.ts"; import manifest, { Manifest } from "./manifest.gen.ts"; -import { API } from "./utils/openapi/openapi.gen.ts"; +import { API } from "./utils/openapi/wake.openapi.gen.ts"; import { fetchSafe } from "../utils/fetch.ts"; import { createGraphqlClient } from "../utils/graphql.ts"; diff --git a/wake/utils/graphql/graphql.gen.ts b/wake/utils/graphql/storefront.graphql.gen.ts similarity index 100% rename from wake/utils/graphql/graphql.gen.ts rename to wake/utils/graphql/storefront.graphql.gen.ts diff --git a/wake/utils/graphql/instropection.graphql.json b/wake/utils/graphql/storefront.graphql.json similarity index 100% rename from wake/utils/graphql/instropection.graphql.json rename to wake/utils/graphql/storefront.graphql.json diff --git a/wake/utils/openapi/adiciona-novo-produto.openapi.json b/wake/utils/openapi/adiciona-novo-produto.openapi.json deleted file mode 100644 index ab5d4f123..000000000 --- a/wake/utils/openapi/adiciona-novo-produto.openapi.json +++ /dev/null @@ -1,372 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos": { - "post": { - "summary": "Adiciona novo produto", - "description": "Método que insere um produto na base", - "operationId": "adiciona-novo-produto", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "idPaiExterno": { - "type": "string", - "description": "Representa o ProdutoId agrupador por variante (optional)" - }, - "idVinculoExterno": { - "type": "string", - "description": "Representa o ParentId agrupador por parent (optional)" - }, - "sku": { - "type": "string", - "description": "(Max Length: 50) Sku do produto" - }, - "nome": { - "type": "string", - "description": "(Max Length: 300) Nome do produto variante" - }, - "nomeProdutoPai": { - "type": "string", - "description": "Nome do produto (pai do variante) (optional)" - }, - "exibirMatrizAtributos": { - "type": "string", - "description": "Tipo de exibição da matriz de atributos (optional)", - "enum": [ - "Sim", - "Nao", - "Neutro" - ] - }, - "contraProposta": { - "type": "boolean", - "description": "Se o produto aceita contra proposta (optional)" - }, - "fabricante": { - "type": "string", - "description": "(Max Length: 100) Nome do fabricante" - }, - "autor": { - "type": "string", - "description": "(Max Length: 500) Nome do autor (optional)" - }, - "editora": { - "type": "string", - "description": "(Max Length: 100) Nome da editora (optional)" - }, - "colecao": { - "type": "string", - "description": "(Max Length: 100) Nome da coleção (optional)" - }, - "genero": { - "type": "string", - "description": "(Max Length: 100) Nome do gênero (optional)" - }, - "precoCusto": { - "type": "number", - "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", - "format": "double" - }, - "precoDe": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", - "format": "double" - }, - "fatorMultiplicadorPreco": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", - "format": "double" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega do produto variante (optional)", - "format": "int32" - }, - "valido": { - "type": "boolean", - "description": "Define se um produto variante é valido ou não" - }, - "exibirSite": { - "type": "boolean", - "description": "Define se um produto deve ser exibido no site" - }, - "freteGratis": { - "type": "string", - "description": "Define a qual regra de calculo de frete o produto vai pertencer", - "enum": [ - "Sempre", - "Nunca", - "Neutro", - "Desconsiderar_Regras" - ] - }, - "trocaGratis": { - "type": "boolean", - "description": "Define se o produto variante tem troca grátis (optional)" - }, - "peso": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g).", - "format": "double" - }, - "altura": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", - "format": "double" - }, - "comprimento": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", - "format": "double" - }, - "largura": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", - "format": "double" - }, - "garantia": { - "type": "integer", - "description": "Define se o produto variante tem garantia (optional)", - "format": "int32" - }, - "isTelevendas": { - "type": "boolean", - "description": "Define se o produto contém televendas (optional)" - }, - "ean": { - "type": "string", - "description": "(Max Length: 25) EAN do produto variante (optional)" - }, - "localizacaoEstoque": { - "type": "string", - "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" - }, - "listaAtacado": { - "type": "array", - "description": "Dados de atacado do produto variante (optional)", - "items": { - "properties": { - "precoPor": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", - "format": "double" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade para compra de atacado", - "format": "int32" - } - }, - "type": "object" - } - }, - "estoque": { - "type": "array", - "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", - "items": { - "properties": { - "estoqueFisico": { - "type": "integer", - "description": "Estoque físico do produto", - "format": "int32" - }, - "estoqueReservado": { - "type": "integer", - "description": "Estoque reservado do produto", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição do estoque do produto", - "format": "int32" - }, - "alertaEstoque": { - "type": "integer", - "description": "Quantidade para ativar o alerta de estoque", - "format": "int32" - } - }, - "type": "object" - } - }, - "listaAtributos": { - "type": "array", - "description": "Lista de atributos do produto", - "items": { - "properties": { - "nome": { - "type": "string", - "description": "(Max Length: 100) - Define o nome do atributo" - }, - "valor": { - "type": "string", - "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" - }, - "exibir": { - "type": "boolean", - "description": "Define se o atributo deverá ser exibido" - } - }, - "type": "object" - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "description": "Quantidade máxima de compra do produto variante (optional)", - "format": "int32" - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "description": "Quantidade mínima de compra do produto variante (optional)", - "format": "int32" - }, - "condicao": { - "type": "string", - "description": "Condição do produto variante (optional)", - "enum": [ - "Novo", - "Usado", - "Renovado", - "Danificado" - ] - }, - "urlVideo": { - "type": "string", - "description": "Url do vídeo do Produto (optional)" - }, - "spot": { - "type": "boolean", - "description": "Se o produto aparece no Spot (optional)" - }, - "paginaProduto": { - "type": "boolean", - "description": "Se o produto aparece na Url (optional)" - }, - "marketplace": { - "type": "boolean", - "description": "Se o produto aparece no Marketplace (optional)" - }, - "somenteParceiros": { - "type": "boolean", - "description": "Se o produto aparece somente nos Parceiros (optional)" - }, - "buyBox": { - "type": "boolean", - "description": "Se o produto deve ser agrupado pelo EAN (optional)" - }, - "prazoValidade": { - "type": "integer", - "description": "Prazo de validade ou consumo do produto (optional)", - "format": "int32" - }, - "consumo": { - "type": "object", - "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail.", - "properties": { - "quantidadeDias": { - "type": "integer", - "description": "Quantidade de Dias (optional)", - "format": "int32" - }, - "enviarEmail": { - "type": "boolean", - "description": "Enviar e-mail (optional)" - } - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do produto variante gerado": { - "value": "Id do produto variante gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c2f227aee7e0002715f279" -} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json b/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json deleted file mode 100644 index 488f07ffc..000000000 --- a/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json +++ /dev/null @@ -1,201 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/atacarejo": { - "post": { - "summary": "Adiciona novos Atacarejos", - "description": "", - "operationId": "adiciona-novos-atacarejos", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de Atacarejos (optional)", - "items": { - "properties": { - "precoAtacado": { - "type": "number", - "description": "Preço atacado", - "format": "double" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade do produto", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtacadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoAtacado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c492bb89b317004423454c" -} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json b/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json deleted file mode 100644 index 4ea266373..000000000 --- a/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/categorias": { - "post": { - "summary": "Adiciona o vínculo entre um produto e uma categoria", - "description": "Adiciona o vínculo entre um produto e uma categoria com base na lista enviada", - "operationId": "adiciona-o-vinculo-entre-um-produto-e-uma-categoria", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "categoriaPrincipalId": { - "type": "integer", - "description": "Id da Categoria Principal (optional)", - "format": "int32" - }, - "listaCategoriaId": { - "type": "array", - "description": "Id da categoria a qual o produto deverá ser vinculado (optional)", - "items": { - "type": "integer", - "format": "int32" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c44eff366cb40080f1cdc0" -} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json deleted file mode 100644 index 4b3c8e8b2..000000000 --- a/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/parceiro": { - "post": { - "summary": "Adiciona um vínculo entre usuário e parceiro", - "description": "", - "operationId": "adiciona-um-vinculo-entre-usuario-e-parceiro", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário que se deseja vincular", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "description": "Id do parceiro (optional)", - "format": "int32" - }, - "vinculoVitalicio": { - "type": "boolean", - "description": "Vinculo vitalício (optional)" - }, - "dataInicial": { - "type": "string", - "description": "Data inicial do vinculo entre usuário e parceiro (optional)", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data final do vinculo entre usuário e parceiro (optional)", - "format": "date" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Usuário vinculado com o parceiro com sucesso": { - "value": "Usuário vinculado com o parceiro com sucesso" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de920520b8a600a54dfd77" -} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json b/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json deleted file mode 100644 index c571d7545..000000000 --- a/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json +++ /dev/null @@ -1,182 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/imagens": { - "post": { - "summary": "Adiciona uma nova imagem vinculada a um produto", - "description": "", - "operationId": "adiciona-uma-nova-imagem-vinculada-a-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "tipoRetorno", - "in": "query", - "description": "Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", - "schema": { - "type": "string", - "enum": [ - "ListaIds", - "Booleano" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista com as imagens do produto no formato base 64 (optional)", - "items": { - "properties": { - "base64": { - "type": "string", - "description": "Imagem do produto em base64" - }, - "formato": { - "type": "string", - "description": "JPG ou PNG" - }, - "exibirMiniatura": { - "type": "boolean", - "description": "Se a imagem será apresentada como miniatura" - }, - "estampa": { - "type": "boolean", - "description": "Se a imagem será apresentada como estampa" - }, - "ordem": { - "type": "integer", - "description": "Ordem para apresentação da imagem", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c469681f965e03abf18962" -} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json b/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json deleted file mode 100644 index e307d5058..000000000 --- a/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/informacoes": { - "post": { - "summary": "Adiciona uma nova informação", - "description": "", - "operationId": "adiciona-uma-nova-informacao", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "tipoRetorno", - "in": "query", - "description": "Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", - "schema": { - "type": "string", - "enum": [ - "Id", - "Booleano" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "titulo": { - "type": "string", - "description": "Titulo da informação (optional)" - }, - "texto": { - "type": "string", - "description": "Texto da informação (optional)" - }, - "exibirSite": { - "type": "boolean", - "description": "Informação se o produto variante está visível no site." - }, - "tipoInformacao": { - "type": "string", - "description": "Tipo de informação do produto (optional)", - "enum": [ - "Informacoes", - "Beneficios", - "Especificacoes", - "DadosTecnicos", - "Composicao", - "ModoDeUsar", - "Cuidados", - "ItensInclusos", - "Dicas", - "Video", - "Descricao", - "ValorReferente", - "PopUpReferente", - "Prescricao", - "TabelaDeMedidas", - "Spot", - "Sinopse", - "Carrinho" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c44160fb4198002fd91e72" -} \ No newline at end of file diff --git a/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json b/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json deleted file mode 100644 index 46b8b0d04..000000000 --- a/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}/proximaRecorrencia": { - "put": { - "summary": "Altera a data de recorrência de uma assinatura", - "description": "", - "operationId": "altera-a-data-de-recorrencia-de-uma-assinatura", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Identificador da assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "proximaRecorrencia": { - "type": "string", - "description": "Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados)", - "format": "date" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:63359f8f907ca9000f334681" -} \ No newline at end of file diff --git a/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json b/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json deleted file mode 100644 index f3e25749b..000000000 --- a/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}/status": { - "put": { - "summary": "Altera o status de um portfolio", - "description": "", - "operationId": "altera-o-status-de-um-portfolio", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja atualizar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Status do portfolio: true ou false", - "properties": { - "ativo": { - "type": "boolean", - "description": "Novo status do portfolio" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef4ae0b7a1d003587bf7d" -} \ No newline at end of file diff --git a/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json b/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json deleted file mode 100644 index e957e9c42..000000000 --- a/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/autorizar": { - "put": { - "summary": "Aprova um cadastro de usuário", - "description": "Operação realizada com ou sem sucesso para os usuários", - "operationId": "aprova-um-cadastro-de-usuario", - "parameters": [ - { - "name": "tipoIdentificador", - "in": "query", - "description": "Tipo de Identificador", - "schema": { - "type": "string", - "enum": [ - "UsuarioId", - "Email" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Usuários", - "items": { - "properties": { - "identificador": { - "type": "string", - "description": "Identificador" - }, - "aprovado": { - "type": "boolean", - "description": "Status de aprovação" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuariosAtualizados": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "usuariosNaoAtualizados": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62decb9a9c6884004b017caf" -} \ No newline at end of file diff --git a/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json b/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json deleted file mode 100644 index 3acb6aa4d..000000000 --- a/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}/produtos": { - "put": { - "summary": "Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request", - "description": "", - "operationId": "atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtosVariante": { - "type": "array", - "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c46678273b800036c3ceaa" -} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json deleted file mode 100644 index 72bb197c3..000000000 --- a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/enderecos/{enderecoId}/ativar": { - "put": { - "summary": "Ativa ou desativa um endereço de um usuário com base no e-mail do usuário", - "description": "", - "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário que se deseja alterar o status do endereço", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "enderecoId", - "in": "path", - "description": "Id do endereço que se deseja alterar o status", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "Status do endereço" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de84e2ad1c94005e93c49e" -} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json deleted file mode 100644 index 30bf02f77..000000000 --- a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}/enderecos/{enderecoId}/ativar": { - "put": { - "summary": "Ativa ou desativa um endereço de um usuário com base no id do usuário", - "description": "", - "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "enderecoId", - "in": "path", - "description": "Id do endereço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "Status do endereço" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de7e88dd8ea90037b5b279" -} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json deleted file mode 100644 index 56a3b39ea..000000000 --- a/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}/Ativo": { - "put": { - "summary": "Ativa ou Desativa um frete", - "description": "Frete atualizado com sucesso", - "operationId": "ativa-ou-desativa-um-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status para atualização do contrato de frete" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d2bde9995201369a43c5" -} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json deleted file mode 100644 index 2e8912d3b..000000000 --- a/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/{resellerId}/status": { - "put": { - "summary": "Ativa ou desativa um Seller", - "description": "", - "operationId": "ativa-ou-desativa-um-seller", - "parameters": [ - { - "name": "resellerId", - "in": "path", - "description": "Valor único utilizado para identificar o seller", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status do seller (ativo / inativo)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d549c7a3038d00f877dfc6" -} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json b/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json deleted file mode 100644 index 608604555..000000000 --- a/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/inscricao/{inscricaoId}/Ativar": { - "put": { - "summary": "Ativa ou inativa uma inscrição", - "description": "", - "operationId": "ativa-ou-inativa-uma-inscricao", - "parameters": [ - { - "name": "inscricaoId", - "in": "path", - "description": "Id da inscrição", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada)" - }, - "usuario": { - "type": "string", - "description": "Usuário que está realizando a atualização" - }, - "observacao": { - "type": "string", - "description": "Observação que deseje fazer com relação a ativação/desativação da inscrição (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb53224cf363008f84f170" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json b/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json deleted file mode 100644 index d9e9091b3..000000000 --- a/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/{resellerId}/ativacaoAutomaticaProdutos": { - "put": { - "summary": "Atualiza a ativação automática de produtos de um Seller", - "description": "", - "operationId": "atualiza-a-ativacao-automatica-de-produtos-de-um-seller", - "parameters": [ - { - "name": "resellerId", - "in": "path", - "description": "Valor único utilizado para identificar o seller", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status da ativação automática de produtos" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d54a2109a9600022d27023" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json b/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json deleted file mode 100644 index 8d075480d..000000000 --- a/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/{resellerId}/autonomia": { - "put": { - "summary": "Atualiza a autonomia de um Seller", - "description": "", - "operationId": "atualiza-a-autonomia-de-um-seller", - "parameters": [ - { - "name": "resellerId", - "in": "path", - "description": "Valor único utilizado para identificar o seller", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status da autonomia do seller" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d54963a605cb00870d19be" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json b/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json deleted file mode 100644 index e2e187f22..000000000 --- a/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json +++ /dev/null @@ -1,117 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/comunicacao": { - "put": { - "summary": "Atualiza a comunicação de um usuário via newsletter", - "description": "", - "operationId": "atualiza-a-comunicacao-de-um-usuario-via-newsletter", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário cujos pedidos devem ser selecionados", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "recebimentoNewsletter": { - "type": "boolean", - "description": "Novo status da comunicação via new ajuste realisletter" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dea54e6d3de500a2e0e173" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json b/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json deleted file mode 100644 index e2b88275b..000000000 --- a/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json +++ /dev/null @@ -1,514 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/DataCadastro": { - "put": { - "summary": "Atualiza a data de cadastro de um produto", - "description": "Atualiza a data de cadastro um produto com base nos dados enviados", - "operationId": "atualiza-a-data-de-cadastro-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "dataCadastro": { - "type": "string", - "description": "Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss", - "format": "date" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "idPaiExterno": { - "type": "string", - "example": "string" - }, - "idVinculoExterno": { - "type": "string", - "example": "string" - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "nomeProdutoPai": { - "type": "string", - "example": "string" - }, - "urlProduto": { - "type": "string", - "example": "string" - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "contraProposta": { - "type": "boolean", - "example": true, - "default": true - }, - "fabricante": { - "type": "string", - "example": "string" - }, - "autor": { - "type": "string", - "example": "string" - }, - "editora": { - "type": "string", - "example": "string" - }, - "colecao": { - "type": "string", - "example": "string" - }, - "genero": { - "type": "string", - "example": "string" - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirSite": { - "type": "boolean", - "example": true, - "default": true - }, - "freteGratis": { - "type": "string", - "example": "Sempre" - }, - "trocaGratis": { - "type": "boolean", - "example": true, - "default": true - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "garantia": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isTelevendas": { - "type": "boolean", - "example": true, - "default": true - }, - "ean": { - "type": "string", - "example": "string" - }, - "localizacaoEstoque": { - "type": "string", - "example": "string" - }, - "listaAtacado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "estoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alertaEstoque": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoAtributo": { - "type": "string", - "example": "Selecao" - }, - "isFiltro": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - }, - "exibir": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "condicao": { - "type": "string", - "example": "Novo" - }, - "informacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - }, - "tabelasPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-04T11:52:02.490Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-04T11:52:02.490Z" - }, - "urlVideo": { - "type": "string", - "example": "string" - }, - "spot": { - "type": "boolean", - "example": true, - "default": true - }, - "paginaProduto": { - "type": "boolean", - "example": true, - "default": true - }, - "marketplace": { - "type": "boolean", - "example": true, - "default": true - }, - "somenteParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "reseller": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "\tProduto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c330bc1dae71001399ee9d" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json deleted file mode 100644 index ec20f8219..000000000 --- a/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento": { - "put": { - "summary": "Atualiza a data de entrega do pedido", - "description": "", - "operationId": "atualiza-a-data-de-entrega-do-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto com os dados do rastreamento", - "properties": { - "rastreamento": { - "type": "string", - "description": "Código de verificação do transporte do produto" - }, - "dataEntrega": { - "type": "string", - "description": "Data que a entrega foi realizada" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb124393006a00fd45eba5" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json b/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json deleted file mode 100644 index 28aa7de03..000000000 --- a/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/Parceiros": { - "put": { - "summary": "Atualiza a exibição do banner em parceiros, se deve ser em todos ou não", - "description": "", - "operationId": "atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve acontecer a atualização", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "exibirEmTodosParceiros": { - "type": "boolean", - "description": "Exibição do banner em parceiros" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a777db37590c02362b7353" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json b/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json deleted file mode 100644 index 14ff8becd..000000000 --- a/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/hotsites": { - "put": { - "summary": "Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não", - "description": "", - "operationId": "atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Id do banner", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "exibirEmTodosHotsites": { - "type": "boolean", - "description": "Exibição do banner nos hotsites" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a7680c2436ab012aa5657d" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json b/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json deleted file mode 100644 index a9860dc5f..000000000 --- a/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/imagens/estampa": { - "put": { - "summary": "Atualiza a imagem de estampa do produto", - "description": "", - "operationId": "atualiza-a-imagem-de-estampa-do-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "idImagem": { - "type": "integer", - "description": "Id da imagem que será marcada como estampa", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c46cbbe579280049bdc972" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json b/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json deleted file mode 100644 index 5b2ea8d2c..000000000 --- a/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/Imagem": { - "put": { - "summary": "Atualiza a imagem do banner", - "description": "", - "operationId": "atualiza-a-imagem-do-banner", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Id do banner", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "urlImagem": { - "type": "string", - "description": "URL da Imagem (optional)" - }, - "Imagem": { - "type": "object", - "description": "Informações para atualizar a imagem (optional)", - "properties": { - "base64": { - "type": "string", - "description": "string da imagem em base 64" - }, - "formato": { - "type": "string", - "description": "formato da imagem", - "enum": [ - "PNG", - "JPG", - "JPEG" - ] - }, - "nome": { - "type": "string", - "description": "nome da imagem" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a778ac0e2537080d7a0922" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json deleted file mode 100644 index cde76c427..000000000 --- a/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}": { - "put": { - "summary": "Atualiza a situação de uma assinatura específica", - "description": "", - "operationId": "atualiza-a-situacao-de-uma-assinatura-especifica", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Id da assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "enderecoId": { - "type": "integer", - "description": "Id do endereço (optional)", - "format": "int32" - }, - "usuarioCartaoCreditoId": { - "type": "integer", - "description": "Id do cartão de crédito do usuário (optional)", - "format": "int32" - }, - "periodoRecorrencia": { - "type": "string", - "description": "Período Recorrência (optional)" - }, - "situacaoAssinatura": { - "type": "string", - "description": "Situação da Assinatura (optional)", - "enum": [ - "Ativa", - "Pausada", - "Cancelada" - ] - }, - "cupom": { - "type": "string", - "description": "Cupom (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a72072e64d1e001eb41c9a" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json deleted file mode 100644 index 4cac23494..000000000 --- a/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json +++ /dev/null @@ -1,179 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/{produtoVarianteId}/status": { - "put": { - "summary": "Atualiza a situação do status de um produto do pedido", - "description": "", - "operationId": "atualiza-a-situacao-do-status-de-um-produto-do-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Id do Produto Variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Dados da situação do produto (optional)", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição do produto", - "format": "int32" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade de produtos do centro de distribuição", - "format": "int32" - }, - "situacaoPedidoProdutoId": { - "type": "integer", - "description": "Novo status da situação do produto (são os mesmo status do pedido)", - "format": "int32" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb2ee068809f00213f0330" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json deleted file mode 100644 index 75b22ed17..000000000 --- a/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/status": { - "put": { - "summary": "Atualiza a situação do status do pedido", - "description": "", - "operationId": "atualiza-a-situacao-do-status-do-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Id do Pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Id da situação do pedido", - "properties": { - "id": { - "type": "integer", - "description": "Id da situação do pedido", - "format": "int32" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb0f0892734202f646b177" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json b/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json deleted file mode 100644 index 10d3d2bb9..000000000 --- a/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json +++ /dev/null @@ -1,154 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}/produtos/recebido": { - "put": { - "summary": "Atualiza o campo Recebido de um produto vinculado a um evento", - "description": "", - "operationId": "atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Id do produto variante (optional)", - "format": "int32" - }, - "recebidoForaLista": { - "type": "boolean", - "description": "Se o produto foi recebido fora da lista (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac8eb4b341de004e8ceb0a" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json b/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json deleted file mode 100644 index 480e49719..000000000 --- a/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json +++ /dev/null @@ -1,238 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/estoques": { - "put": { - "summary": "Atualiza o estoque de vários produtos", - "description": "Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", - "operationId": "atualiza-o-estoque-de-varios-produtos", - "parameters": [ - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista com os dados da atualização do estoque (optional)", - "items": { - "properties": { - "identificador": { - "type": "string", - "description": "Valor único utilizado para identificar o produto" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega do produto", - "format": "int32" - }, - "listaEstoque": { - "type": "array", - "description": "Lista com os dados da atualização do estoque", - "items": { - "properties": { - "estoqueFisico": { - "type": "integer", - "description": "Estoque físico do produto", - "format": "int32" - }, - "estoqueReservado": { - "type": "integer", - "description": "Estoque reservado do produto", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição do estoque do produto", - "format": "int32" - }, - "produtoVarianteId": { - "type": "integer", - "description": "Id do produto variante", - "format": "int32" - }, - "alertaEstoque": { - "type": "integer", - "description": "Quantidade para ativar o alerta de estoque", - "format": "int32" - } - }, - "type": "object" - } - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtosNaoAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "produtosAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c3322231eb6900649e2013" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json b/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json deleted file mode 100644 index d2632c855..000000000 --- a/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/changeseller": { - "put": { - "summary": "Atualiza o frete de todos os produtos de um pedido", - "description": "", - "operationId": "atualiza-o-frete-de-todos-os-produtos-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Id do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto com os dados de cotação e responsável", - "properties": { - "cotacao": { - "type": "string", - "description": "ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes" - }, - "responsavel": { - "type": "string", - "description": "Responsável pela cotação" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:641b388b5760451595218ec0" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json b/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json deleted file mode 100644 index 32964d54d..000000000 --- a/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json +++ /dev/null @@ -1,209 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/precos": { - "put": { - "summary": "Atualiza o preço de vários produtos", - "description": "Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", - "operationId": "atualiza-o-preco-de-varios-produtos", - "parameters": [ - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista com os dados da atualização do preço (optional)", - "items": { - "properties": { - "identificador": { - "type": "string", - "description": "Identificador do produto (ProdutoVarianteId ou SKU)" - }, - "precoCusto": { - "type": "number", - "description": "Preço de custo do produto variante", - "format": "double" - }, - "precoDe": { - "type": "number", - "description": "\"PrecoDe\" do produto variante", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "\"PrecoPor\" do produto variante", - "format": "double" - }, - "fatorMultiplicadorPreco": { - "type": "number", - "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão)", - "format": "double" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtosNaoAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "produtosAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c43202750530009e4c1fad" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json b/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json deleted file mode 100644 index 00abc58db..000000000 --- a/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json +++ /dev/null @@ -1,154 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtoavaliacao/{produtoAvaliacaoId}/status": { - "put": { - "summary": "Atualiza o status de uma avaliação de um produto variante", - "description": "", - "operationId": "atualiza-o-status-de-uma-avaliacao-de-um-produto-variante", - "parameters": [ - { - "name": "produtoAvaliacaoId", - "in": "path", - "description": "Identificador de uma Avaliação de um produto variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status para a avaliação", - "enum": [ - "Pendente", - "NaoAprovado", - "Aprovado" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d06b923fea280086f8709e" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json b/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json deleted file mode 100644 index 76b72c2d0..000000000 --- a/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/status": { - "put": { - "summary": "Atualiza o status do banner pelo id", - "description": "", - "operationId": "atualiza-o-status-do-banner-pelo-id", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve acontecer a atualização", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "Status para qual deve ir o baner: Ativo (true) ou Inativo (false)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a73da240034e0086aee3de" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json b/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json deleted file mode 100644 index 09677179b..000000000 --- a/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/status": { - "put": { - "summary": "Atualiza o status do hotsite, sendo ativo (true) ou inativo (false)", - "description": "", - "operationId": "atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser atualizado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "ativo": { - "type": "boolean", - "description": "Status para qual o hotsite indicado deve ir" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a89b23b696e70057bec544" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json b/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json deleted file mode 100644 index dfc9c5ccc..000000000 --- a/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}/AlterarStatus": { - "put": { - "summary": "Atualiza o status do tipo de evento, ativando-o ou inativando-o", - "description": "", - "operationId": "atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62cedc03ecf222001a0b82db" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json b/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json deleted file mode 100644 index 2a364e6f5..000000000 --- a/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json +++ /dev/null @@ -1,203 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}": { - "put": { - "summary": "Atualiza o tipo evento", - "description": "", - "operationId": "atualiza-o-tipo-evento", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do Tipo de Evento" - }, - "tipoEntrega": { - "type": "string", - "description": "Tipo de entrega", - "enum": [ - "EntregaAgendada", - "EntregaConformeCompraRealizada", - "Todos", - "Nenhum" - ] - }, - "tipoDisponibilizacao": { - "type": "string", - "description": "Disponibilização do Tipo de Evento", - "enum": [ - "DisponibilizacaoDeCreditos", - "DisponibilizacaoDeProdutos", - "Todos" - ] - }, - "permitirRemocaoAutomaticaProdutos": { - "type": "boolean", - "description": "Permissão para remoção automática de produtos" - }, - "corHexTituloInformacoes": { - "type": "string", - "description": "Cor em hexadecimal para o titulo de informações" - }, - "corHexCorpoInformacoes": { - "type": "string", - "description": "Cor em hexadecimal para o corpo de informações" - }, - "numeroAbasInformacoes": { - "type": "integer", - "description": "Número de abas de informações, podendo ser de 1 a 2", - "format": "int32" - }, - "quantidadeDiasParaEventoExpirar": { - "type": "integer", - "description": "Quantidade de dias para que o evento expire", - "format": "int32" - }, - "numeroLocaisEvento": { - "type": "integer", - "description": "Quantidade de locais do evento", - "format": "int32" - }, - "ativo": { - "type": "boolean", - "description": "Informa se o evento está ativo ou inativo" - }, - "disponivel": { - "type": "boolean", - "description": "Informa a disponibilidade do evento" - }, - "tipoBeneficiarioFrete": { - "type": "string", - "description": "O beneficiário do frete", - "enum": [ - "DonodaLista", - "Convidado" - ] - }, - "imagemLogoEvento": { - "type": "string", - "description": "Imagem da logo do evento em base64" - }, - "sugestaoProdutos": { - "type": "array", - "description": "Produtos Sugeridos para este evento (optional)", - "items": { - "properties": { - "tipoEventoId": { - "type": "integer", - "description": "Id do tipo de evento", - "format": "int32" - }, - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ced1bfb6ef560e1f64f7df" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json b/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json deleted file mode 100644 index 1c98485ee..000000000 --- a/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json +++ /dev/null @@ -1,286 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}": { - "put": { - "summary": "Atualiza os dados de um hotsite existente", - "description": "", - "operationId": "atualiza-os-dados-de-um-hotsite-existente", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser atualizado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do hotsite" - }, - "dataInicio": { - "type": "string", - "description": "Data/hora em que o hotsite começará a ser exibido (optional)", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", - "format": "date" - }, - "url": { - "type": "string", - "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" - }, - "tamanhoPagina": { - "type": "integer", - "description": "Informe o número de produtos que deve ser exibido por página", - "format": "int32" - }, - "templateId": { - "type": "integer", - "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", - "format": "int32" - }, - "ordenacao": { - "type": "string", - "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", - "enum": [ - "Nenhuma", - "NomeCrescente", - "NomeDecrescente", - "Lancamento", - "MenorPreco", - "MaiorPreco", - "MaisVendidos", - "MaioresDescontos", - "Aleatorio", - "MenorEstoque", - "MaiorEstoque" - ] - }, - "listaProdutos": { - "type": "object", - "description": "Produtos que devem aparecer no hotsite", - "properties": { - "expressao": { - "type": "string", - "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" - }, - "produtos": { - "type": "array", - "description": "Id dos produtos", - "items": { - "properties": { - "produtoId": { - "type": "integer", - "description": "Identificador do produto a ser mostrado no hotsite", - "format": "int32" - }, - "ordem": { - "type": "integer", - "description": "Ordem para apresentação do produto (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - }, - "seo": { - "type": "object", - "description": "Dados de seo", - "properties": { - "titulo": { - "type": "string", - "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" - }, - "metas": { - "type": "array", - "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", - "items": { - "properties": { - "conteudo": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "nome": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "httpEquiv": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "scheme": { - "type": "string", - "description": "Informe os dados da Metatag" - } - }, - "type": "object" - } - } - } - }, - "banners": { - "type": "array", - "description": "Lista de identificadores de banners a serem vinculados ao hotsite", - "items": { - "properties": { - "bannerId": { - "type": "integer", - "description": "Identificador do banner (optional)", - "format": "int32" - } - }, - "type": "object" - } - }, - "conteudos": { - "type": "array", - "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", - "items": { - "properties": { - "conteudoId": { - "type": "integer", - "description": "Identificador do conteúdo", - "format": "int32" - } - }, - "type": "object" - } - }, - "ativo": { - "type": "boolean", - "description": "Status do hotsite (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b2051f846cfe08b0bc5625" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json b/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json deleted file mode 100644 index 8b2fa936b..000000000 --- a/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json +++ /dev/null @@ -1,128 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}/produtos": { - "put": { - "summary": "Atualiza os produtos sugeridos de um tipo de evento", - "description": "", - "operationId": "atualiza-os-produtos-sugeridos-de-um-tipo-de-evento", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtos": { - "type": "array", - "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ced07e60f1270ffa5b7ea3" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json b/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json deleted file mode 100644 index 077f754aa..000000000 --- a/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json +++ /dev/null @@ -1,195 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/precos/lote": { - "put": { - "summary": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado", - "description": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição", - "operationId": "atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista com os dados da atualização do preço por lote", - "items": { - "properties": { - "sku": { - "type": "string", - "description": "Identificador do produto (SKU)" - }, - "precoCusto": { - "type": "number", - "description": "Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional)", - "format": "double" - }, - "precoDe": { - "type": "number", - "description": "\"PrecoDe\" do produto variante", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "\"PrecoPor\" do produto variante", - "format": "double" - }, - "fatorMultiplicadorPreco": { - "type": "number", - "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", - "format": "double" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtosNaoAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "produtosAtualizados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4368c2ddf2500137b6405" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json b/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json deleted file mode 100644 index 383ed7488..000000000 --- a/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json +++ /dev/null @@ -1,197 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}": { - "put": { - "summary": "Atualiza rastreamento completo (com os dados da N.F.)", - "description": "", - "operationId": "atualiza-rastreamento-completo-com-os-dados-da-nf", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pedidoRastreamentoId", - "in": "path", - "description": "Id do Pedido Rastreamento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto Pedido Rastreamento", - "properties": { - "notaFiscal": { - "type": "string", - "description": "Número da nota fiscal" - }, - "cfop": { - "type": "integer", - "description": "Código Fiscal de Operações e Prestações", - "format": "int32" - }, - "dataEnviado": { - "type": "string", - "description": "Data Envio" - }, - "chaveAcessoNFE": { - "type": "string", - "description": "Chave de Acesso NFE" - }, - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "urlRastreamento": { - "type": "string", - "description": "URL de rastreamento (optional)" - }, - "transportadora": { - "type": "string", - "description": "Transportadora (optional)" - }, - "dataEntrega": { - "type": "string", - "description": "Data da entrega (optional)" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb138db31f30003d9e4166" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json b/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json deleted file mode 100644 index a9b293b98..000000000 --- a/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json +++ /dev/null @@ -1,200 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}": { - "put": { - "summary": "Atualiza rastreamento de produto completo (com os dados da N.F.)", - "description": "", - "operationId": "atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Id do produto variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pedidoRastreamentoProdutoId", - "in": "path", - "description": "Id do Pedido Rastreamento Produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "notaFiscal": { - "type": "string", - "description": "Nota Fiscal" - }, - "cfop": { - "type": "integer", - "description": "CFOP", - "format": "int32" - }, - "dataEnviado": { - "type": "string", - "description": "Data Enviado", - "format": "date" - }, - "chaveAcessoNFE": { - "type": "string", - "description": "Chave de acesso NFE" - }, - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "urlRastreamento": { - "type": "string", - "description": "URL de rastreamento (optional)" - }, - "transportadora": { - "type": "string", - "description": "Transportadora (optional)" - }, - "dataEntrega": { - "type": "string", - "description": "Data da entrega (optional)", - "format": "date" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bd93a23555a702b80cc676" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json deleted file mode 100644 index e44896060..000000000 --- a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json +++ /dev/null @@ -1,182 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}/parcial": { - "put": { - "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", - "description": "", - "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Id do Produto Variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pedidoRastreamentoProdutoId", - "in": "path", - "description": "Id do Pedido Rastreamento Produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto Pedido Rastreamento Produto", - "properties": { - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "urlRastreamento": { - "type": "string", - "description": "URL de Rastreamento (optional)" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb2daa0958bf004df9bb6b" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json deleted file mode 100644 index 64916ff74..000000000 --- a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}/parcial": { - "put": { - "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", - "description": "", - "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pedidoRastreamentoId", - "in": "path", - "description": "Id do Pedido Rastreamento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto Pedido Rastreamento", - "properties": { - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "urlRastreamento": { - "type": "string", - "description": "URL de Rastreamento (optional)" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb1601cbcb18001a387394" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-atacarejo.openapi.json b/wake/utils/openapi/atualiza-um-atacarejo.openapi.json deleted file mode 100644 index ec8d5dff4..000000000 --- a/wake/utils/openapi/atualiza-um-atacarejo.openapi.json +++ /dev/null @@ -1,176 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { - "put": { - "summary": "Atualiza um Atacarejo", - "description": "", - "operationId": "atualiza-um-atacarejo", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "SKU ou Id do Produto Variante", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "produtoVarianteAtacadoId", - "in": "path", - "description": "Id do Atacarejo", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "precoAtacado": { - "type": "number", - "description": "Preço atacado (optional)", - "format": "double" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade do produto (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Resultado da Atualização do Atacarejo": { - "value": "Resultado da Atualização do Atacarejo" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4972ef8681e009e2f55cf" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-atributo.openapi.json b/wake/utils/openapi/atualiza-um-atributo.openapi.json deleted file mode 100644 index 4d52c8918..000000000 --- a/wake/utils/openapi/atualiza-um-atributo.openapi.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/atributos/{nome}": { - "put": { - "summary": "Atualiza um atributo", - "description": "", - "operationId": "atualiza-um-atributo", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do atributo", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do atributo (optional)" - }, - "tipo": { - "type": "string", - "description": "Tipo do atributo (optional)", - "enum": [ - "Selecao", - "Filtro", - "Comparacao", - "Configuracao", - "ExclusivoGoogle" - ] - }, - "tipoExibicao": { - "type": "string", - "description": "Tipo de exibição (optional)", - "enum": [ - "Combo", - "Div", - "DivComCor", - "DivComFotoDoProdutoVariante", - "Javascript" - ] - }, - "prioridade": { - "type": "integer", - "description": "Prioridade do atributo (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0ef671d1a44001a416495" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-banner-existente.openapi.json b/wake/utils/openapi/atualiza-um-banner-existente.openapi.json deleted file mode 100644 index 2e804bb3b..000000000 --- a/wake/utils/openapi/atualiza-um-banner-existente.openapi.json +++ /dev/null @@ -1,348 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}": { - "put": { - "summary": "Atualiza um banner existente", - "description": "", - "operationId": "atualiza-um-banner-existente", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve acontecer a atualização", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do banner" - }, - "dataInicio": { - "type": "string", - "description": "Data de inicio de exibição do banner", - "format": "date" - }, - "dataFim": { - "type": "string", - "description": "Data de termino de exibição do banner (optional)", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Banner ativo/inativo (optional)" - }, - "detalhe": { - "type": "object", - "description": "Detalhes do banner", - "properties": { - "posicionamentoId": { - "type": "integer", - "description": "Local de posicionamento do banner", - "format": "int32" - }, - "imagemBanner": { - "type": "object", - "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", - "properties": { - "base64": { - "type": "string", - "description": "string da imagem em base 64" - }, - "formato": { - "type": "string", - "description": "formato da imagem", - "enum": [ - "PNG", - "JPG", - "JPEG" - ] - }, - "nome": { - "type": "string", - "description": "nome da imagem" - } - } - }, - "urlBanner": { - "type": "string", - "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" - }, - "ordemExibicao": { - "type": "integer", - "description": "Ordem de exibição do banner (optional)", - "format": "int32" - }, - "abrirLinkNovaAba": { - "type": "boolean", - "description": "Se o banner deve ou não abrir em nova aba (optional)" - }, - "largura": { - "type": "integer", - "description": "Largura do banner em pixels (optional)", - "format": "int32" - }, - "altura": { - "type": "integer", - "description": "Altura do banner em pixels (optional)", - "format": "int32" - }, - "title": { - "type": "string", - "description": "Title da imagem do banner (optional)" - }, - "urlClique": { - "type": "string", - "description": "Url de destino para quando o usuário clicar no Banner (optional)" - }, - "urlBannerAlternativo": { - "type": "string", - "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" - }, - "textoAlternativo": { - "type": "string", - "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" - } - } - }, - "diasExibicao": { - "type": "object", - "description": "Dias da semana que o banner deverá ser exibido (optional)", - "properties": { - "todosDias": { - "type": "boolean", - "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" - }, - "domingo": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado no domingo" - }, - "segunda": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na segunda" - }, - "terca": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na terça" - }, - "quarta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na quarta" - }, - "quinta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na quinta" - }, - "sexta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na sexta" - }, - "sabado": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado no sábado" - } - } - }, - "apresentacao": { - "type": "object", - "description": "Apresentação do banner (optional)", - "properties": { - "exibirNoSite": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todo o site" - }, - "exibirEmTodasBuscas": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todas as buscas" - }, - "naoExibirEmBuscas": { - "type": "boolean", - "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" - }, - "termosBusca": { - "type": "string", - "description": "Termos que o banner será exibido na busca" - }, - "exibirEmTodasCategorias": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" - }, - "listaHotsites": { - "type": "object", - "description": "Em quais hotsites o banner deve ser exibido", - "properties": { - "exibirEmTodosHotsites": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" - }, - "hotsites": { - "type": "array", - "description": "Lista de hotsite's que o banner será exibido", - "items": { - "properties": { - "hotSiteId": { - "type": "integer", - "description": "Id do hotsite (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - }, - "listaParceiros": { - "type": "object", - "description": "Em quais parceiros o banner deve ser exibido", - "properties": { - "exibirEmTodosParceiros": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" - }, - "parceiros": { - "type": "array", - "description": "Lista de parceiros que o banner será exibido", - "items": { - "properties": { - "parceiroId": { - "type": "integer", - "description": "Id do parceiro (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a3536c05e24b00790f0fb6" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json deleted file mode 100644 index ef633b1b2..000000000 --- a/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/camposcadastropersonalizado/{camposcadastropersonalizadoId}": { - "put": { - "summary": "Atualiza um campo de cadastro personalizado pelo id", - "description": "", - "operationId": "atualiza-um-campo-de-cadastro-personalizado-pelo-id", - "parameters": [ - { - "name": "camposcadastropersonalizadoId", - "in": "path", - "description": "Id do campo de cadastro personalizado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do campo (optional)" - }, - "obrigatorio": { - "type": "boolean", - "description": "Se o campo será obrigatório (optional)" - }, - "ordem": { - "type": "integer", - "description": "Ordem (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec928a8e5b706e1ef93b2" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-conteudo.openapi.json b/wake/utils/openapi/atualiza-um-conteudo.openapi.json deleted file mode 100644 index 2d3035e09..000000000 --- a/wake/utils/openapi/atualiza-um-conteudo.openapi.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/conteudos/{conteudoId}": { - "put": { - "summary": "Atualiza um conteúdo", - "description": "", - "operationId": "atualiza-um-conteudo", - "parameters": [ - { - "name": "conteudoId", - "in": "path", - "description": "Identificador do conteúdo", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "titulo": { - "type": "string", - "description": "Titulo do conteúdo" - }, - "ativo": { - "type": "boolean", - "description": "Conteúdo ativo/inativo" - }, - "dataInicio": { - "type": "string", - "description": "Data de inicio de exibição do conteúdo (optional)", - "format": "date" - }, - "dataFim": { - "type": "string", - "description": "Data de final de exibição do conteúdo (optional)", - "format": "date" - }, - "posicionamento": { - "type": "string", - "description": "Posicionamento do conteúdo", - "enum": [ - "Topo", - "Centro", - "Rodape", - "LateralDireita", - "LateralEsquerda", - "MobileTopo", - "MobileRodape" - ] - }, - "conteudo": { - "type": "string", - "description": "Informações do conteúdo" - }, - "termoBusca": { - "type": "string", - "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" - }, - "exibeTodasBuscas": { - "type": "boolean", - "description": "Exibição do conteúdo nas buscas" - }, - "naoExibeBuscas": { - "type": "boolean", - "description": "Não exibição do conteúdo nas buscas" - }, - "exibeTodosHotsites": { - "type": "boolean", - "description": "Exibição do conteúdo nos hotsites" - }, - "hotsiteId": { - "type": "array", - "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", - "items": { - "type": "integer", - "format": "int32" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a883279bb3eb0040242a53" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json b/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json deleted file mode 100644 index ea6269109..000000000 --- a/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json +++ /dev/null @@ -1,216 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}": { - "put": { - "summary": "Atualiza um contrato de frete", - "description": "Frete atualizado com sucesso", - "operationId": "atualiza-um-contrato-de-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do contrato de frete (optional)" - }, - "ativo": { - "type": "boolean", - "description": "Status do contrato de frete (optional)" - }, - "volumeMaximo": { - "type": "integer", - "description": "Volume máximo permitido, em metro cúbico (m³). (optional)", - "format": "int32" - }, - "pesoCubado": { - "type": "number", - "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", - "format": "double" - }, - "entregaAgendadaConfiguracaoId": { - "type": "integer", - "description": "Id da configuração entrega agendada (optional)", - "format": "int32" - }, - "linkRastreamento": { - "type": "string", - "description": "URL rastreamento (optional)" - }, - "ehAssinatura": { - "type": "boolean", - "description": "Contrato é exclusivo assinatura (optional)" - }, - "larguraMaxima": { - "type": "integer", - "description": "Informe a largura máxima, em centímetros (cm). (optional)", - "format": "int32" - }, - "alturaMaxima": { - "type": "integer", - "description": "Informe a altura máxima, em centímetros (cm). (optional)", - "format": "int32" - }, - "comprimentoMaximo": { - "type": "integer", - "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", - "format": "int32" - }, - "limiteMaximoDimensoes": { - "type": "integer", - "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", - "format": "int32" - }, - "limitePesoCubado": { - "type": "number", - "description": "Informe o limite de peso cubado, em gramas (g). (optional)", - "format": "double" - }, - "tempoMinimoDespacho": { - "type": "integer", - "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Informe o Id do centro de distribuição (optional)", - "format": "int32" - }, - "valorMinimoProdutos": { - "type": "number", - "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", - "format": "double" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d25cc22ded0014a29a91" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json deleted file mode 100644 index 2e445dc7c..000000000 --- a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/enderecos/{enderecoId}": { - "put": { - "summary": "Atualiza um endereço de um usuário pelo e-mail do usuário", - "description": "", - "operationId": "atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "enderecoId", - "in": "path", - "description": "Id do endereço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nomeEndereco": { - "type": "string", - "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" - }, - "rua": { - "type": "string", - "description": "Nome da rua (Max Length: 500)" - }, - "numero": { - "type": "string", - "description": "Número do local (Max Length: 50)" - }, - "complemento": { - "type": "string", - "description": "Complemento (Max Length: 250) (optional)" - }, - "referencia": { - "type": "string", - "description": "Referência para a localização do endereço (Max Length: 500) (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço (Max Length: 100)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que se localiza o endereço (Max Length: 100)" - }, - "estado": { - "type": "string", - "description": "O estado (Max Length: 100)" - }, - "cep": { - "type": "string", - "description": "Código do cep (Max Length: 50)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dad5c4affc630065c406fa" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json deleted file mode 100644 index c9a377b9f..000000000 --- a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}/enderecos/{enderecoId}": { - "put": { - "summary": "Atualiza um endereço de um usuário pelo id do usuário", - "description": "", - "operationId": "atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "enderecoId", - "in": "path", - "description": "Id do endereço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nomeEndereco": { - "type": "string", - "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" - }, - "rua": { - "type": "string", - "description": "Nome da rua (Max Length: 500)" - }, - "numero": { - "type": "string", - "description": "Número do local (Max Length: 50)" - }, - "complemento": { - "type": "string", - "description": "Complemento (Max Length: 250) (optional)" - }, - "referencia": { - "type": "string", - "description": "Referência para a localização do endereço (Max Length: 500) (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço (Max Length: 100)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que se localiza o endereço (Max Length: 100)" - }, - "estado": { - "type": "string", - "description": "O estado (Max Length: 100)" - }, - "cep": { - "type": "string", - "description": "Código do cep (Max Length: 50)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dad614c5f1b3008671c8d3" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-evento.openapi.json b/wake/utils/openapi/atualiza-um-evento.openapi.json deleted file mode 100644 index 93b6af23b..000000000 --- a/wake/utils/openapi/atualiza-um-evento.openapi.json +++ /dev/null @@ -1,303 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}": { - "put": { - "summary": "Atualiza um evento", - "description": "", - "operationId": "atualiza-um-evento", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "description": "Identificador do tipo de evento", - "format": "int32" - }, - "enderecoEntregaId": { - "type": "integer", - "description": "Identificador do endereço de entrega", - "format": "int32" - }, - "titulo": { - "type": "string", - "description": "Titulo do evento" - }, - "url": { - "type": "string", - "description": "Atributo obsoleto - (optional)" - }, - "data": { - "type": "string", - "description": "Data do Evento", - "format": "date" - }, - "usuarioEmail": { - "type": "string", - "description": "Email do usuário" - }, - "disponivel": { - "type": "boolean", - "description": "Disponibilidade do evento (optional)" - }, - "diasAntesEvento": { - "type": "integer", - "description": "Quantos dias antes do evento ele será exibido (optional)", - "format": "int32" - }, - "diasDepoisEvento": { - "type": "integer", - "description": "Até quantos dias depois do evento ele será exibido (optional)", - "format": "int32" - }, - "urlLogo": { - "type": "string", - "description": "Url do Logo. (Base64)" - }, - "urlCapa": { - "type": "string", - "description": "Url da Capa. (Base64)" - }, - "proprietario": { - "type": "string", - "description": "Quem é o proprietário" - }, - "abaInfo01Habilitado": { - "type": "boolean", - "description": "Se a aba de informação 01 será habilitada" - }, - "textoInfo01": { - "type": "string", - "description": "Texto para o campo informação 01 (optional)" - }, - "conteudoInfo01": { - "type": "string", - "description": "Conteúdo para o campo informação 01 (optional)" - }, - "abaInfo02Habilitado": { - "type": "boolean", - "description": "Se a aba de informação 02 será habilitada" - }, - "textoInfo02": { - "type": "string", - "description": "Texto para o campo informação 02 (optional)" - }, - "conteudoInfo02": { - "type": "string", - "description": "Conteúdo para o campo informação 02 (optional)" - }, - "abaMensagemHabilitado": { - "type": "boolean", - "description": "Se a aba de mensagem será habilitada (optional)" - }, - "enumTipoListaPresenteId": { - "type": "string", - "description": "Tipo de lista de presente", - "enum": [ - "ListaPronta", - "ListaManual" - ] - }, - "enumTipoEntregaId": { - "type": "string", - "description": "Tipo de entrega", - "enum": [ - "EntregaAgendada", - "EntregaConformeCompraRealizada", - "Todos", - "Nenhum" - ] - }, - "eventoProdutoSelecionado": { - "type": "array", - "description": "Seleção de produto no evento", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Id do produto variante", - "format": "int32" - }, - "recebidoForaLista": { - "type": "boolean", - "description": "Se produto recebido fora da lista (optional)" - }, - "removido": { - "type": "boolean", - "description": "Se produto removido (optional)" - } - }, - "type": "object" - } - }, - "enderecoEvento": { - "type": "array", - "description": "Endereço do Evento", - "items": { - "properties": { - "nome": { - "type": "string", - "description": "Nome para identificação do endereço" - }, - "endereco": { - "type": "string", - "description": "Endereço" - }, - "cep": { - "type": "string", - "description": "Cep do endereço" - }, - "numero": { - "type": "string", - "description": "Numero do endereço" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço" - }, - "cidade": { - "type": "string", - "description": "Cidade do endereço" - }, - "estado": { - "type": "string", - "description": "Estado do endereço" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62accac13dbf3400400a146c" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-fabricante.openapi.json b/wake/utils/openapi/atualiza-um-fabricante.openapi.json deleted file mode 100644 index 5719957a0..000000000 --- a/wake/utils/openapi/atualiza-um-fabricante.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes/{fabricanteId}": { - "put": { - "summary": "Atualiza um fabricante", - "description": "", - "operationId": "atualiza-um-fabricante", - "parameters": [ - { - "name": "fabricanteId", - "in": "path", - "description": "Id do fabricante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do fabricante (optional)" - }, - "urlLogoTipo": { - "type": "string", - "description": "URL tipo logo (optional)" - }, - "urlLink": { - "type": "string", - "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" - }, - "urlCarrossel": { - "type": "string", - "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0886b69241400e931a5b8" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json b/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json deleted file mode 100644 index 5771e99d7..000000000 --- a/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers": { - "put": { - "summary": "Atualiza um novo Seller no marketplace", - "description": "", - "operationId": "atualiza-um-novo-seller-no-marketplace", - "parameters": [ - { - "name": "resellerId", - "in": "query", - "description": "Valor único utilizado para identificar o seller", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "razaoSocial": { - "type": "string", - "description": "Razão Social/Nome do Reseller" - }, - "cnpj": { - "type": "string", - "description": "CNPJ do Seller" - }, - "inscricaoEstadual": { - "type": "string", - "description": "Inscrição Estadual do Seller" - }, - "isento": { - "type": "boolean", - "description": "Seller isento de inscrição estadual" - }, - "email": { - "type": "string", - "description": "Email de contato do Seller" - }, - "telefone": { - "type": "string", - "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" - }, - "tipoAutonomia": { - "type": "string", - "description": "Tipo de autonomia do vendedor", - "enum": [ - "ComAutonomia", - "SemAutonomia" - ] - }, - "ativo": { - "type": "boolean", - "description": "Seller Ativo" - }, - "split": { - "type": "boolean", - "description": "Se irá ter Split de frete boolean. Default:false" - }, - "buyBox": { - "type": "boolean", - "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," - }, - "cep": { - "type": "string", - "description": "Cep do Seller (utilizado para o calculo de frete)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d5435d9a9b65003e6c2c53" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-parceiro.openapi.json b/wake/utils/openapi/atualiza-um-parceiro.openapi.json deleted file mode 100644 index c6dfcb3f8..000000000 --- a/wake/utils/openapi/atualiza-um-parceiro.openapi.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{parceiroId}": { - "put": { - "summary": "Atualiza um parceiro", - "description": "Parceiro atualizado com sucesso", - "operationId": "atualiza-um-parceiro", - "parameters": [ - { - "name": "parceiroId", - "in": "path", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do parceiro" - }, - "tabelaPrecoId": { - "type": "integer", - "description": "Id da tabela de preço (optional)", - "format": "int32" - }, - "portfolioId": { - "type": "integer", - "description": "Id do portfolio (optional)", - "format": "int32" - }, - "tipoEscopo": { - "type": "string", - "description": "Tipo de escopo", - "enum": [ - "Aberto\"", - "Fechado", - "PorCliente" - ] - }, - "ativo": { - "type": "boolean", - "description": "Status do parceiro" - }, - "isMarketPlace": { - "type": "boolean", - "description": "Se o parceiro é marketplace (optional)" - }, - "origem": { - "type": "string", - "description": "Origem (optional)" - }, - "alias": { - "type": "string", - "description": "alias (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "[\n {\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb35b47500e0027269e3b" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-portfolio.openapi.json b/wake/utils/openapi/atualiza-um-portfolio.openapi.json deleted file mode 100644 index c438f4287..000000000 --- a/wake/utils/openapi/atualiza-um-portfolio.openapi.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}": { - "put": { - "summary": "Atualiza um portfolio", - "description": "", - "operationId": "atualiza-um-portfolio", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja atualizar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do portfolio" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef25ff3aebb0098964b27" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json b/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json deleted file mode 100644 index b6711fb9f..000000000 --- a/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/produtos/{assinaturaProdutoId}/Alterar": { - "put": { - "summary": "Atualiza um produto em uma assinatura", - "description": "", - "operationId": "atualiza-um-produto-em-uma-assinatura", - "parameters": [ - { - "name": "assinaturaProdutoId", - "in": "path", - "description": "Id do Produto dentro de uma assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "valor": { - "type": "number", - "description": "Novo valor do produto na assinatura (optional)", - "format": "double" - }, - "removido": { - "type": "boolean", - "description": "Se o produto será considerado removido ou não da assinatura (optional)" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade do produto na assinatura (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Produto foi alterado na assinatura": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0b0eeeb452400b2cc1346" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-produto.openapi.json b/wake/utils/openapi/atualiza-um-produto.openapi.json deleted file mode 100644 index 5baf9e5c9..000000000 --- a/wake/utils/openapi/atualiza-um-produto.openapi.json +++ /dev/null @@ -1,395 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}": { - "put": { - "summary": "Atualiza um produto", - "description": "Atualiza um produto com base nos dados enviados", - "operationId": "atualiza-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "idPaiExterno": { - "type": "string", - "description": "Representa o ProdutoId agrupador por variante (optional)" - }, - "idVinculoExterno": { - "type": "string", - "description": "Representa o ParentId agrupador por parent (optional)" - }, - "sku": { - "type": "string", - "description": "(Max Length: 50) Sku do produto" - }, - "nome": { - "type": "string", - "description": "(Max Length: 300) Nome do produto variante" - }, - "nomeProdutoPai": { - "type": "string", - "description": "Nome do produto (pai do variante) (optional)" - }, - "exibirMatrizAtributos": { - "type": "string", - "description": "Tipo de exibição da matriz de atributos (optional)", - "enum": [ - "Sim", - "Nao", - "Neutro" - ] - }, - "contraProposta": { - "type": "boolean", - "description": "Se o produto aceita contra proposta (optional)" - }, - "fabricante": { - "type": "string", - "description": "(Max Length: 100) Nome do fabricante" - }, - "autor": { - "type": "string", - "description": "(Max Length: 500) Nome do autor (optional)" - }, - "editora": { - "type": "string", - "description": "(Max Length: 100) Nome da editora (optional)" - }, - "colecao": { - "type": "string", - "description": "(Max Length: 100) Nome da coleção (optional)" - }, - "genero": { - "type": "string", - "description": "(Max Length: 100) Nome do gênero (optional)" - }, - "precoCusto": { - "type": "number", - "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", - "format": "double" - }, - "precoDe": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", - "format": "double" - }, - "fatorMultiplicadorPreco": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", - "format": "double" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega do produto variante (optional)", - "format": "int32" - }, - "valido": { - "type": "boolean", - "description": "Define se um produto variante é valido ou não (optional)" - }, - "exibirSite": { - "type": "boolean", - "description": "Define se um produto deve ser exibido no site (optional)" - }, - "freteGratis": { - "type": "string", - "description": "Define a qual regra de calculo de frete o produto vai pertencer", - "enum": [ - "Sempre", - "Nunca", - "Neutro", - "Desconsiderar_Regras" - ] - }, - "trocaGratis": { - "type": "boolean", - "description": "Define se o produto variante tem troca grátis (optional)" - }, - "peso": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g)", - "format": "double" - }, - "altura": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", - "format": "double" - }, - "comprimento": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", - "format": "double" - }, - "largura": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", - "format": "double" - }, - "garantia": { - "type": "integer", - "description": "Define se o produto variante tem garantia (optional)", - "format": "int32" - }, - "isTelevendas": { - "type": "boolean", - "description": "Define se o produto contém televendas (optional)" - }, - "ean": { - "type": "string", - "description": "(Max Length: 25) EAN do produto variante (optional)" - }, - "localizacaoEstoque": { - "type": "string", - "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" - }, - "listaAtacado": { - "type": "array", - "description": "Dados de atacado do produto variante (optional)", - "items": { - "properties": { - "precoPor": { - "type": "number", - "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", - "format": "double" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade para compra de atacado", - "format": "int32" - } - }, - "type": "object" - } - }, - "estoque": { - "type": "array", - "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", - "items": { - "properties": { - "estoqueFisico": { - "type": "integer", - "description": "Estoque físico do produto", - "format": "int32" - }, - "estoqueReservado": { - "type": "integer", - "description": "Estoque reservado do produto", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição do estoque do produto", - "format": "int32" - }, - "alertaEstoque": { - "type": "integer", - "description": "Quantidade para ativar o alerta de estoque", - "format": "int32" - } - }, - "type": "object" - } - }, - "listaAtributos": { - "type": "array", - "description": "Lista de atributos do produto", - "items": { - "properties": { - "nome": { - "type": "string", - "description": "(Max Length: 100) - Define o nome do atributo" - }, - "valor": { - "type": "string", - "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" - }, - "exibir": { - "type": "boolean", - "description": "Define se o atributo deverá ser exibido" - } - }, - "type": "object" - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "description": "Quantidade máxima de compra do produto variante (optional)", - "format": "int32" - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "description": "Quantidade mínima de compra do produto variante (optional)", - "format": "int32" - }, - "condicao": { - "type": "string", - "description": "Condição do produto variante (optional)", - "enum": [ - "Novo", - "Usado", - "Renovado", - "Danificado" - ] - }, - "urlVideo": { - "type": "string", - "description": "Url do vídeo do Produto (optional)" - }, - "spot": { - "type": "boolean", - "description": "Se o produto aparece no Spot (optional)" - }, - "paginaProduto": { - "type": "boolean", - "description": "Se o produto aparece na Url (optional)" - }, - "marketplace": { - "type": "boolean", - "description": "Se o produto aparece no Marketplace (optional)" - }, - "somenteParceiros": { - "type": "boolean", - "description": "Se o produto aparece somente nos Parceiros" - }, - "buyBox": { - "type": "boolean", - "description": "Se o produto deve ser agrupado pelo EAN (optional)" - }, - "prazoValidade": { - "type": "integer", - "description": "Prazo de validade ou consumo do produto (optional)", - "format": "int32" - }, - "consumo": { - "type": "object", - "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional)", - "properties": { - "quantidadeDias": { - "type": "integer", - "description": "Quantidade de Dias (optional)", - "format": "int32" - }, - "enviarEmail": { - "type": "boolean", - "description": "Enviar e-mail (optional)" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c32ea54e560b0014096ac6" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-script-existente.openapi.json b/wake/utils/openapi/atualiza-um-script-existente.openapi.json deleted file mode 100644 index 98c9acd67..000000000 --- a/wake/utils/openapi/atualiza-um-script-existente.openapi.json +++ /dev/null @@ -1,206 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts/{scriptId}": { - "put": { - "summary": "Atualiza um script existente", - "description": "", - "operationId": "atualiza-um-script-existente", - "parameters": [ - { - "name": "scriptId", - "in": "path", - "description": "Id do script", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do script" - }, - "dataInicial": { - "type": "string", - "description": "Data inicial do script", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data final do script", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Informe se o script está ativo ou não" - }, - "prioridade": { - "type": "integer", - "description": "Prioridade do script", - "format": "int32" - }, - "posicao": { - "type": "string", - "description": "Posição do script", - "enum": [ - "HeaderPrimeiraLinha", - "HeaderUltimaLinha", - "BodyPrimeiraLinha", - "BodyUltimaLinha", - "FooterPrimeiraLinha", - "FooterUltimeLinha" - ] - }, - "tipoPagina": { - "type": "string", - "description": "Tipo da página do script", - "enum": [ - "Todas", - "Home", - "Busca", - "Categoria", - "Fabricante", - "Estaticas", - "Produto", - "Carrinho" - ] - }, - "identificadorPagina": { - "type": "string", - "description": "Identificador da página" - }, - "conteudo": { - "type": "string", - "description": "Conteúdo do script" - }, - "publicado": { - "type": "boolean", - "description": "Status do script" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b465f3b2e610001aca35e7" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json deleted file mode 100644 index 113a90c54..000000000 --- a/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo": { - "put": { - "summary": "Atualiza um SEO de um produto específico", - "description": "", - "operationId": "atualiza-um-seo-de-um-produto-especifico", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tagCanonical": { - "type": "string", - "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" - }, - "title": { - "type": "string", - "description": "Informe o title da página do produto (optional)" - }, - "metaTags": { - "type": "array", - "description": "Informe os dados da Meta Tag (optional)", - "items": { - "properties": { - "content": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "httpEquiv": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "name": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "scheme": { - "type": "string", - "description": "Dados da Meta Tag" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c881000f98d4006a920d78" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json b/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json deleted file mode 100644 index 98c517753..000000000 --- a/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}": { - "put": { - "summary": "Atualiza um usuário pelo email", - "description": "", - "operationId": "atualiza-um-usuario-pelo-email", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tipoPessoa": { - "type": "string", - "description": "Tipo de pessoa", - "enum": [ - "Fisica", - "Juridica" - ] - }, - "origemContato": { - "type": "string", - "description": "Origem do contato", - "enum": [ - "Google", - "Bing", - "Jornal", - "PatrocinioEsportivo", - "RecomendacaoAlguem", - "Revista", - "SiteInternet", - "Televisao", - "Outro", - "UsuarioImportadoViaAdmin", - "PayPalExpress" - ] - }, - "tipoSexo": { - "type": "string", - "description": "Tipo Sexo (optional)", - "enum": [ - "Undefined", - "Masculino", - "Feminino" - ] - }, - "nome": { - "type": "string", - "description": "Nome do usuário (Max Length: 100)" - }, - "cpf": { - "type": "string", - "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "email": { - "type": "string", - "description": "E-mail do usuário (Max Length: 100)" - }, - "rg": { - "type": "string", - "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "telefoneResidencial": { - "type": "string", - "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" - }, - "telefoneCelular": { - "type": "string", - "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" - }, - "telefoneComercial": { - "type": "string", - "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" - }, - "dataNascimento": { - "type": "string", - "description": "Data de nascimento (optional)", - "format": "date" - }, - "razaoSocial": { - "type": "string", - "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" - }, - "cnpj": { - "type": "string", - "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "inscricaoEstadual": { - "type": "string", - "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "responsavel": { - "type": "string", - "description": "Responsável(Max Length: 100) (optional)" - }, - "dataCriacao": { - "type": "string", - "description": "Data de criação do cadastro (optional)", - "format": "date" - }, - "dataAtualizacao": { - "type": "string", - "description": "Data de atualização do cadastro (optional)", - "format": "date" - }, - "revendedor": { - "type": "boolean", - "description": "Se o usuário é revendedor (optional)" - }, - "listaInformacaoCadastral": { - "type": "array", - "description": "Informação cadastral (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave" - }, - "valor": { - "type": "string", - "description": "Valor" - } - }, - "type": "object" - } - }, - "avatar": { - "type": "string", - "description": "Avatar (Max Length: 50) (optional)" - }, - "ip": { - "type": "string", - "description": "IP do usuário (Max Length: 20) (optional)" - }, - "aprovado": { - "type": "boolean", - "description": "Seta ou retorna o valor de Aprovado (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d99364cec32f0013e7bdae" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json deleted file mode 100644 index 8744131a0..000000000 --- a/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json +++ /dev/null @@ -1,240 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}": { - "put": { - "summary": "Atualiza um usuário pelo id", - "description": "", - "operationId": "atualiza-um-usuario-pelo-id", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tipoPessoa": { - "type": "string", - "description": "Tipo de pessoa", - "enum": [ - "Fisica", - "Juridica" - ] - }, - "origemContato": { - "type": "string", - "description": "Origem do contato", - "enum": [ - "Google", - "Bing", - "Jornal", - "PatrocinioEsportivo", - "RecomendacaoAlguem", - "Revista", - "SiteInternet", - "Televisao", - "Outro", - "UsuarioImportadoViaAdmin", - "PayPalExpress" - ] - }, - "tipoSexo": { - "type": "string", - "description": "Tipo Sexo (optional)", - "enum": [ - "Undefined", - "Masculino", - "Feminino" - ] - }, - "nome": { - "type": "string", - "description": "Nome do usuário (Max Length: 100)" - }, - "cpf": { - "type": "string", - "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "email": { - "type": "string", - "description": "E-mail do usuário (Max Length: 100)" - }, - "rg": { - "type": "string", - "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "telefoneResidencial": { - "type": "string", - "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" - }, - "telefoneCelular": { - "type": "string", - "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" - }, - "telefoneComercial": { - "type": "string", - "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" - }, - "dataNascimento": { - "type": "string", - "description": "Data de nascimento (optional)", - "format": "date" - }, - "razaoSocial": { - "type": "string", - "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" - }, - "cnpj": { - "type": "string", - "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "inscricaoEstadual": { - "type": "string", - "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "responsavel": { - "type": "string", - "description": "Responsável(Max Length: 100) (optional)" - }, - "dataCriacao": { - "type": "string", - "description": "Data de criação do cadastro (optional)", - "format": "date" - }, - "dataAtualizacao": { - "type": "string", - "description": "Data de atualização do cadastro (optional)", - "format": "date" - }, - "revendedor": { - "type": "boolean", - "description": "Se o usuário é revendedor (optional)" - }, - "listaInformacaoCadastral": { - "type": "array", - "description": "Informação cadastral (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave" - }, - "valor": { - "type": "string", - "description": "Valor" - } - }, - "type": "object" - } - }, - "avatar": { - "type": "string", - "description": "Avatar (Max Length: 50) (optional)" - }, - "ip": { - "type": "string", - "description": "IP do usuário (Max Length: 20) (optional)" - }, - "aprovado": { - "type": "boolean", - "description": "Seta ou retorna o valor de Aprovado (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d99116940b47009ad96278" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json deleted file mode 100644 index 4b02f545e..000000000 --- a/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/valoresdefinidoscadastropersonalizado/{valoresDefinidosCampoGrupoInformacaoId}": { - "put": { - "summary": "Atualiza um valor pré definido pelo id", - "description": "", - "operationId": "atualiza-um-valor-pre-definido-pelo-id", - "parameters": [ - { - "name": "valoresDefinidosCampoGrupoInformacaoId", - "in": "path", - "description": "Id dos valores definidos no campo grupo informação", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "valor": { - "type": "string", - "description": "Valor para o campo (optional)" - }, - "ordem": { - "type": "integer", - "description": "Ordem (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62deca4f112bba03863d34ee" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json deleted file mode 100644 index c262b36d6..000000000 --- a/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/parceiro": { - "put": { - "summary": "Atualiza um vínculo entre usuário e parceiro", - "description": "", - "operationId": "atualiza-um-vinculo-entre-usuario-e-parceiro", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário que se deseja vincular", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "vinculoVitalicio": { - "type": "boolean", - "description": "Vinculo vitalício (optional)" - }, - "dataInicial": { - "type": "string", - "description": "Data inicial do vinculo entre usuário e parceiro (optional)", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data final do vinculo entre usuário e parceiro (optional)", - "format": "date" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de924dd176ec0022200a56" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json deleted file mode 100644 index 1b8df2310..000000000 --- a/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/erp/{id}": { - "put": { - "summary": "Atualiza uma categoria utilizando o id do erp como identificador", - "description": "", - "operationId": "atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome da categoria (optional)" - }, - "categoriaPaiId": { - "type": "integer", - "description": "Id da categoria pai (optional)", - "format": "int32" - }, - "categoriaERPId": { - "type": "string", - "description": "Id da categoria ERP (optional)" - }, - "ativo": { - "type": "boolean", - "description": "Categoria ativo/inativo (optional)" - }, - "isReseller": { - "type": "boolean", - "description": "Categoria de reseller (optional)" - }, - "exibirMatrizAtributos": { - "type": "string", - "description": "Exibir Matriz de Atributos (optional)", - "enum": [ - "Sim", - "Nao", - "Neutro" - ] - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", - "format": "int32" - }, - "valorMinimoCompra": { - "type": "number", - "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", - "format": "double" - }, - "exibeMenu": { - "type": "boolean", - "description": "Informe se será exibida no menu (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa0e377ed8eb0094e81562" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-categoria.openapi.json b/wake/utils/openapi/atualiza-uma-categoria.openapi.json deleted file mode 100644 index c12ab6572..000000000 --- a/wake/utils/openapi/atualiza-uma-categoria.openapi.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/{id}": { - "put": { - "summary": "Atualiza uma categoria", - "description": "", - "operationId": "atualiza-uma-categoria", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome da categoria (optional)" - }, - "categoriaPaiId": { - "type": "integer", - "description": "Id da categoria pai (optional)", - "format": "int32" - }, - "categoriaERPId": { - "type": "string", - "description": "Id da categoria ERP (optional)" - }, - "ativo": { - "type": "boolean", - "description": "Categoria ativo/inativo (optional)" - }, - "isReseller": { - "type": "boolean", - "description": "Categoria de reseller (optional)" - }, - "exibirMatrizAtributos": { - "type": "string", - "description": "Exibir Matriz de Atributos (optional)", - "enum": [ - "Sim", - "Nao", - "Neutro" - ] - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", - "format": "int32" - }, - "valorMinimoCompra": { - "type": "number", - "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", - "format": "double" - }, - "exibeMenu": { - "type": "boolean", - "description": "Informe se será exibida no menu (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa06a9f42f94009b1ccb1f" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json b/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json deleted file mode 100644 index 7c5edaf60..000000000 --- a/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json +++ /dev/null @@ -1,183 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/informacoes/{informacaoId}": { - "put": { - "summary": "Atualiza uma informação de um produto", - "description": "Atualiza uma informação de um produto específico", - "operationId": "atualiza-uma-informacao-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "informacaoId", - "in": "path", - "description": "Id da informação do produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "titulo": { - "type": "string", - "description": "Titulo da informação (optional)" - }, - "texto": { - "type": "string", - "description": "Texto da informação (optional)" - }, - "exibirSite": { - "type": "boolean", - "description": "Informação se o produto variante está visível no site." - }, - "tipoInformacao": { - "type": "string", - "description": "Tipo de informação do produto (optional)", - "enum": [ - "Informacoes", - "Beneficios", - "Especificacoes", - "DadosTecnicos", - "Composicao", - "ModoDeUsar", - "Cuidados", - "ItensInclusos", - "Dicas", - "Video", - "Descricao", - "ValorReferente", - "PopUpReferente", - "Prescricao", - "TabelaDeMedidas", - "Spot", - "Sinopse", - "Carrinho" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c44a6b08078700343baccb" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-inscricao.openapi.json b/wake/utils/openapi/atualiza-uma-inscricao.openapi.json deleted file mode 100644 index 40d49d4c4..000000000 --- a/wake/utils/openapi/atualiza-uma-inscricao.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/inscricao/{inscricaoId}": { - "put": { - "summary": "Atualiza uma inscrição", - "description": "", - "operationId": "atualiza-uma-inscricao", - "parameters": [ - { - "name": "inscricaoId", - "in": "path", - "description": "Id da inscrição", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "topicos" - ], - "properties": { - "nome": { - "type": "string", - "description": "Nome da inscrição" - }, - "appUrl": { - "type": "string", - "description": "Url para qual deve ser enviada as notificações" - }, - "topicos": { - "type": "array", - "description": "Tópicos em que deseja se inscrever", - "items": { - "type": "string" - } - }, - "usuario": { - "type": "string", - "description": "Usuário que está realizando a inscrição" - }, - "ativo": { - "type": "boolean", - "description": "Status da inscrição, se ativada ou desativada" - }, - "emailResponsavel": { - "type": "string", - "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" - }, - "headers": { - "type": "array", - "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave do header, por exemplo: 'Authorization'" - }, - "valor": { - "type": "string", - "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bc5f8f5f7d60003f1d1ca5" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json deleted file mode 100644 index 8da8cc3e7..000000000 --- a/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,187 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}/produtos": { - "put": { - "summary": "Atualiza uma lista de produto variantes em uma tabela de preços", - "description": "Lista com o retorno do processamento dos produtos enviados", - "operationId": "atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de produtos variantes", - "items": { - "properties": { - "sku": { - "type": "string", - "description": "SKU do produto" - }, - "precoDe": { - "type": "number", - "description": "Preço De do produto", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "Preço Por do produto", - "format": "double" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "sucesso": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "erro": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6ab3a3877de0080895f3f" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json b/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json deleted file mode 100644 index 3f3d0610e..000000000 --- a/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json +++ /dev/null @@ -1,251 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}": { - "put": { - "summary": "Atualiza uma Loja Física", - "description": "", - "operationId": "atualiza-uma-loja-fisica", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "description": "Id da loja (optional)", - "format": "int32" - }, - "nome": { - "type": "string", - "description": "Nome da loja (optional)" - }, - "ddd": { - "type": "integer", - "description": "DDD da localidade de destino da loja (optional)", - "format": "int32" - }, - "telefone": { - "type": "string", - "description": "Telefone da loja (optional)" - }, - "email": { - "type": "string", - "description": "E-mail de contato da loja (optional)" - }, - "cep": { - "type": "string", - "description": "CEP do endereço da loja (optional)" - }, - "logradouro": { - "type": "string", - "description": "Logradouro do endereço da loja (optional)" - }, - "numero": { - "type": "string", - "description": "Número de localização do endereço da loja (optional)" - }, - "complemento": { - "type": "string", - "description": "Complemento para localização da loja (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço do loja (optional)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que a loja se encontra (optional)" - }, - "estadoId": { - "type": "integer", - "description": "Id do estado em que a loja se encontra (optional)", - "format": "int32" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega (optional)", - "format": "int32" - }, - "prazoMaximoRetirada": { - "type": "integer", - "description": "Prazo máximo para retirada (optional)", - "format": "int32" - }, - "ativo": { - "type": "boolean", - "description": "Status da loja (optional)" - }, - "valido": { - "type": "boolean", - "description": "Valido (optional)" - }, - "textoComplementar": { - "type": "string", - "description": "Informações complementares da loja (optional)" - }, - "retirarNaLoja": { - "type": "boolean", - "description": "Se a retirada na loja será ativada (optional)" - }, - "latitude": { - "type": "number", - "description": "Latitude (optional)", - "format": "double" - }, - "longitude": { - "type": "number", - "description": "Longitude (optional)", - "format": "double" - }, - "centroDistribuicao": { - "type": "array", - "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", - "items": { - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição", - "format": "int32" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b9b5c006c3f8008caaa98e" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json deleted file mode 100644 index 87aed88dd..000000000 --- a/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}": { - "put": { - "summary": "Atualiza uma tabela de preços", - "description": "", - "operationId": "atualiza-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome da tabela de preço" - }, - "dataInicial": { - "type": "string", - "description": "Data que inicia a tabela de preço", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data de término da tabela de preço", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Status da tabela de preço" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a90380c565001fa1e489" -} \ No newline at end of file diff --git a/wake/utils/openapi/atualizar-autor.openapi.json b/wake/utils/openapi/atualizar-autor.openapi.json deleted file mode 100644 index cde37f660..000000000 --- a/wake/utils/openapi/atualizar-autor.openapi.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores/{autorId}": { - "put": { - "summary": "Atualizar autor", - "description": "", - "operationId": "atualizar-autor", - "parameters": [ - { - "name": "autorId", - "in": "path", - "description": "Identificador do autor", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do Autor" - }, - "ativo": { - "type": "boolean", - "description": "Status do autor" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a1dace443345001ac941c1" -} \ No newline at end of file diff --git a/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json b/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json deleted file mode 100644 index ad2b7ce5b..000000000 --- a/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/bloquear": { - "put": { - "summary": "Bloqueia ou desbloqueia usuários", - "description": "Campo atualizado com sucesso", - "operationId": "bloqueia-ou-desbloqueia-usuarios", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Usuários (optional)", - "items": { - "properties": { - "email": { - "type": "string", - "description": "E-mail do usuário" - }, - "bloqueado": { - "type": "boolean", - "description": "Status do usuário" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuariosAtualizados": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "usuariosNaoAtualizados": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62deccc387bd9a0027ff964f" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json b/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json deleted file mode 100644 index b96b8411b..000000000 --- a/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/inscricao/{inscricaoId}": { - "get": { - "summary": "Busca a inscrição por seu identificador", - "description": "Inscrição", - "operationId": "busca-a-inscricao-por-seu-identificador", - "parameters": [ - { - "name": "inscricaoId", - "in": "path", - "description": "Id da inscrição", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "inscricaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "appUrl": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "emailResponsavel": { - "type": "string", - "example": "string" - }, - "topico": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "usuario": { - "type": "string", - "example": "string" - }, - "header": { - "type": "array", - "items": { - "type": "object", - "properties": { - "headerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb5238fd766d00203ed45f" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json b/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json deleted file mode 100644 index f5a5747d8..000000000 --- a/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts/{scriptId}/versao/{versaoId}/conteudo": { - "get": { - "summary": "Busca o conteúdo de uma versão", - "description": "Lista o conteúdo de uma versão", - "operationId": "busca-o-conteudo-de-uma-versao", - "parameters": [ - { - "name": "scriptId", - "in": "path", - "description": "Id do script", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "versaoId", - "in": "path", - "description": "Id da versão", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"scriptId\": 0,\n \"versaoId\": 0,\n \"conteudo\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "scriptId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "versaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "conteudo": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b4672b44ceb9007b673297" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json b/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json deleted file mode 100644 index 3f1001f08..000000000 --- a/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/conteudos/{conteudoId}": { - "get": { - "summary": "Busca o conteúdo pelo seu id", - "description": "Conteúdo encontrado", - "operationId": "busca-o-conteudo-pelo-seu-id", - "parameters": [ - { - "name": "conteudoId", - "in": "path", - "description": "Identificador do conteúdo", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a882bceeff6c0303ab0d80" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json deleted file mode 100644 index 7c96f163c..000000000 --- a/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo": { - "get": { - "summary": "Busca o SEO de um produto específico", - "description": "SEO do produto informado", - "operationId": "busca-o-seo-de-um-produto-especifico", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tagCanonical\": \"string\",\n \"title\": \"string\",\n \"metatags\": [\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tagCanonical": { - "type": "string", - "example": "string" - }, - "title": { - "type": "string", - "example": "string" - }, - "metatags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metatagId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "content": { - "type": "string", - "example": "string" - }, - "httpEquiv": { - "type": "string", - "example": "string" - }, - "name": { - "type": "string", - "example": "string" - }, - "scheme": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c49ae47aa2fa00aadf0d41" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json deleted file mode 100644 index 8c5762013..000000000 --- a/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/banners": { - "get": { - "summary": "Busca os banners vinculados a um hotsite específico", - "description": "Lista de identificadores de banners vinculados ao hotsite", - "operationId": "busca-os-banners-vinculados-a-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser buscado os banners", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"bannerId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bannerId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a89d61050cb2044569d479" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json deleted file mode 100644 index 749cc7492..000000000 --- a/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/conteudos": { - "get": { - "summary": "Busca os conteúdos vinculados a um hotsite específico", - "description": "Lista de identificadores de conteúdos vinculados ao hotsite", - "operationId": "busca-os-conteudos-vinculados-a-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser buscados os conteúdos", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"conteudoId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a8e59fcc1f8e003c4203a5" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-estados.openapi.json b/wake/utils/openapi/busca-os-estados.openapi.json deleted file mode 100644 index 689c737fc..000000000 --- a/wake/utils/openapi/busca-os-estados.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/estados": { - "get": { - "summary": "Busca os estados", - "description": "Lista dos estados", - "operationId": "busca-os-estados", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"estadoId\": 0,\n \"nome\": \"string\",\n \"sigla\": \"string\",\n \"regiao\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "sigla": { - "type": "string", - "example": "string" - }, - "regiao": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "400": { - "description": "400", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b9baa85f463904e9443138" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json b/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json deleted file mode 100644 index a32aa31cb..000000000 --- a/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/hotsites": { - "get": { - "summary": "Busca os hotsites vinculados de um banner específico", - "description": "Lista de hotsites vinculados ao banner", - "operationId": "busca-os-hotsites-vinculados-de-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve buscar os hotsites vinculados.", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "exibirEmTodosHotSites": { - "type": "boolean", - "example": true, - "default": true - }, - "hotSites": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hotSiteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a7485c784ec80041ceb41e" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json b/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json deleted file mode 100644 index 56149fe17..000000000 --- a/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo/metaTag": { - "get": { - "summary": "Busca os metatags de um produto específico", - "description": "Lista de Metatags do produto informado", - "operationId": "busca-os-metatags-de-um-produto-especifico", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Identificador do produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metatagId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "content": { - "type": "string", - "example": "string" - }, - "httpEquiv": { - "type": "string", - "example": "string" - }, - "name": { - "type": "string", - "example": "string" - }, - "scheme": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c5781eaec04f0084b9fb43" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json b/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json deleted file mode 100644 index b70790fe9..000000000 --- a/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/parceiros": { - "get": { - "summary": "Busca os parceiros vinculados de um banner específico", - "description": "Lista de parceiros vinculados ao banner", - "operationId": "busca-os-parceiros-vinculados-de-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve buscar os parceiros vinculados", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a7729a44dd7e03c9874a9a" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json b/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json deleted file mode 100644 index 889097d1d..000000000 --- a/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json +++ /dev/null @@ -1,139 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/posicionamentos": { - "get": { - "summary": "Busca os possíveis posicionamentos para o banner", - "description": "Lista de posicionamentos do banner", - "operationId": "busca-os-possiveis-posicionamentos-para-o-banner", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"posicionamentoId\": 0,\n \"descricao\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "posicionamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a775da9c36f70050eafda8" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json b/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json deleted file mode 100644 index fc77da5e1..000000000 --- a/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json +++ /dev/null @@ -1,154 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/relacionados": { - "get": { - "summary": "Busca os produtos relacionados", - "description": "Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado", - "operationId": "busca-os-produtos-relacionados", - "parameters": [ - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - }, - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoId\": 0,\n \"parentId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "parentId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c32f9aaa3da40421de580b" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json b/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json deleted file mode 100644 index 0162ad0a8..000000000 --- a/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json +++ /dev/null @@ -1,121 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}/produtos": { - "get": { - "summary": "Busca os produtos sugeridos para a lista de evento", - "description": "Lista de produtos variantes vinculados aos tipo de evento", - "operationId": "busca-os-produtos-sugeridos-para-a-lista-de-evento", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"tipoEventoId\": 0,\n \"produtoVariantePrincipalId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVariantePrincipalId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ceb2333a7de2026c4611e4" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json b/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json deleted file mode 100644 index d53d02ba0..000000000 --- a/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/Topicos": { - "get": { - "summary": "Busca os tópicos disponíveis para inscrição", - "description": "Lista de Tópicos", - "operationId": "busca-os-topicos-disponiveis-para-inscricao", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"payload\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "descricao": { - "type": "string", - "example": "string" - }, - "payload": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb6481fa3fdf003be8bed4" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json b/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json deleted file mode 100644 index ca6d2180a..000000000 --- a/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/naoIntegrados": { - "get": { - "summary": "Busca pedidos que ainda não foram setado o complete", - "description": "Lista de números de pedidos ainda não integrados", - "operationId": "busca-pedidos-que-ainda-nao-foram-setado-o-complete", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"pedidoId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb3896237430004df21cf0" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json b/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json deleted file mode 100644 index 2b509d8ba..000000000 --- a/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}/produtos": { - "get": { - "summary": "Busca produtos vinculados a um evento", - "description": "Lista de produtos variantes vinculados aos tipo de evento", - "operationId": "busca-produtos-vinculados-a-um-evento", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "recebidoForaLista": { - "type": "boolean", - "example": true, - "default": true - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac88ce1ccd8700422c2db2" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json b/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json deleted file mode 100644 index 23507fa7b..000000000 --- a/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json +++ /dev/null @@ -1,153 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/inscricao": { - "get": { - "summary": "Busca todas as inscrições inseridas", - "description": "Lista de inscrições", - "operationId": "busca-todas-as-inscricoes-inseridas", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "inscricaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "appUrl": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "emailResponsavel": { - "type": "string", - "example": "string" - }, - "topico": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "usuario": { - "type": "string", - "example": "string" - }, - "header": { - "type": "array", - "items": { - "type": "object", - "properties": { - "headerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a34bf489dc890013d79075" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json b/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json deleted file mode 100644 index 8b1200f09..000000000 --- a/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/contascorrentes/{email}/extrato": { - "get": { - "summary": "Busca todas as movimentações de conta corrente de um usuário", - "description": "Extrato retornado com sucesso", - "operationId": "busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "dataInicial", - "in": "query", - "description": "Data Inicial para verificar extrato", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data Final para verificar extrato", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"data\": \"2022-06-15T13:26:37.748Z\",\n \"historico\": \"string\",\n \"valor\": 0,\n \"tipoLancamento\": \"Credito\",\n \"observacao\": \"string\",\n \"visivelParaCliente\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "example": "2022-06-15T13:26:37.748Z" - }, - "historico": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoLancamento": { - "type": "string", - "example": "Credito" - }, - "observacao": { - "type": "string", - "example": "string" - }, - "visivelParaCliente": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa2dba0522f500488ccbd1" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json b/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json deleted file mode 100644 index f2cbcb4d8..000000000 --- a/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json +++ /dev/null @@ -1,169 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts/{scriptId}/versoes": { - "get": { - "summary": "Busca todas as versões de um script", - "description": "Lista de versões", - "operationId": "busca-todas-as-versoes-de-um-script", - "parameters": [ - { - "name": "scriptId", - "in": "path", - "description": "Id do script", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"versaoId\": 0,\n \"scriptId\": 0,\n \"dataCadastro\": \"2022-06-23T11:17:57.658Z\",\n \"identificadorPagina\": \"string\",\n \"publicado\": true,\n \"usuario\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "versaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "scriptId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataCadastro": { - "type": "string", - "example": "2022-06-23T11:17:57.658Z" - }, - "identificadorPagina": { - "type": "string", - "example": "string" - }, - "publicado": { - "type": "boolean", - "example": true, - "default": true - }, - "usuario": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b46847f1a5f5006cf745bc" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-banners.openapi.json b/wake/utils/openapi/busca-todos-banners.openapi.json deleted file mode 100644 index aa2c1fb08..000000000 --- a/wake/utils/openapi/busca-todos-banners.openapi.json +++ /dev/null @@ -1,363 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners": { - "get": { - "summary": "Busca todos banners", - "description": "Lista de banners", - "operationId": "busca-todos-banners", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadePorPagina", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-13T11:13:55.299Z\",\n \"dataFim\": \"2022-06-13T11:13:55.299Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dataInicio": { - "type": "string", - "example": "2022-06-13T11:13:55.299Z" - }, - "dataFim": { - "type": "string", - "example": "2022-06-13T11:13:55.299Z" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhe": { - "type": "object", - "properties": { - "posicionamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "urlBanner": { - "type": "string", - "example": "string" - }, - "imagemBanner": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "base64": { - "type": "string", - "example": "string" - }, - "formato": { - "type": "string", - "example": "PNG" - } - } - }, - "ordemExibicao": { - "type": "integer", - "example": 0, - "default": 0 - }, - "abrirBannerNovaAba": { - "type": "boolean", - "example": true, - "default": true - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "title": { - "type": "string", - "example": "string" - }, - "urlClique": { - "type": "string", - "example": "string" - }, - "urlBannerAlternativo": { - "type": "string", - "example": "string" - }, - "titleAlternativo": { - "type": "string", - "example": "string" - }, - "diasExibicao": { - "type": "object", - "properties": { - "todosDias": { - "type": "boolean", - "example": true, - "default": true - }, - "domingo": { - "type": "boolean", - "example": true, - "default": true - }, - "segunda": { - "type": "boolean", - "example": true, - "default": true - }, - "terca": { - "type": "boolean", - "example": true, - "default": true - }, - "quarta": { - "type": "boolean", - "example": true, - "default": true - }, - "quinta": { - "type": "boolean", - "example": true, - "default": true - }, - "sexta": { - "type": "boolean", - "example": true, - "default": true - }, - "sabado": { - "type": "boolean", - "example": true, - "default": true - } - } - }, - "textoAlternativo": { - "type": "string", - "example": "string" - } - } - }, - "apresentacao": { - "type": "object", - "properties": { - "exibirNoSite": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirEmTodasBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "naoExibirEmBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "termosBusca": { - "type": "string", - "example": "string" - }, - "listaHotsites": { - "type": "object", - "properties": { - "exibirEmTodosHotSites": { - "type": "boolean", - "example": true, - "default": true - }, - "hotSites": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hotSiteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "exibirEmTodasCategorias": { - "type": "boolean", - "example": true, - "default": true - }, - "listaParceiros": { - "type": "object", - "properties": { - "exibirEmTodosParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "parceiros": { - "type": "array", - "items": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a73b9f57855a01175e0f3e" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-conteudos.openapi.json b/wake/utils/openapi/busca-todos-os-conteudos.openapi.json deleted file mode 100644 index 89cfec522..000000000 --- a/wake/utils/openapi/busca-todos-os-conteudos.openapi.json +++ /dev/null @@ -1,192 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/conteudos": { - "get": { - "summary": "Busca todos os conteúdos", - "description": "Conteúdos encontrados", - "operationId": "busca-todos-os-conteudos", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadePorPagina", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"conteudoId\": 0,\n \"titulo\": \"string\",\n \"ativo\": true,\n \"dataInicio\": \"2022-06-13T11:13:55.432Z\",\n \"dataFim\": \"2022-06-13T11:13:55.432Z\",\n \"posicionamento\": \"Topo\",\n \"codigoFonte\": \"string\",\n \"termoBusca\": \"string\",\n \"exibeTodasBuscas\": true,\n \"naoExibeBuscas\": true,\n \"exibeTodosHotsites\": true,\n \"hotsitesId\": [\n 0\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "dataInicio": { - "type": "string", - "example": "2022-06-13T11:13:55.432Z" - }, - "dataFim": { - "type": "string", - "example": "2022-06-13T11:13:55.432Z" - }, - "posicionamento": { - "type": "string", - "example": "Topo" - }, - "codigoFonte": { - "type": "string", - "example": "string" - }, - "termoBusca": { - "type": "string", - "example": "string" - }, - "exibeTodasBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "naoExibeBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "exibeTodosHotsites": { - "type": "boolean", - "example": true, - "default": true - }, - "hotsitesId": { - "type": "array", - "items": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{}" - } - }, - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a795f0a9696c00b6665d44" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json b/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json deleted file mode 100644 index 1eef28022..000000000 --- a/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json +++ /dev/null @@ -1,279 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites": { - "get": { - "summary": "Busca todos os hotsites inseridos", - "description": "Lista de hotsites", - "operationId": "busca-todos-os-hotsites-inseridos", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadePorPagina", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.198Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.198Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.198Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "template": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-14T11:07:54.198Z" - }, - "dataInicio": { - "type": "string", - "example": "2022-06-14T11:07:54.198Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-06-14T11:07:54.198Z" - }, - "url": { - "type": "string", - "example": "string" - }, - "tamanhoPagina": { - "type": "integer", - "example": 0, - "default": 0 - }, - "templateId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ordenacao": { - "type": "string", - "example": "Nenhuma" - }, - "listaProdutos": { - "type": "object", - "properties": { - "expressao": { - "type": "string", - "example": "string" - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ordem": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "seo": { - "type": "object", - "properties": { - "seoHotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "hotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "metas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "httpEquiv": { - "type": "string", - "example": "string" - }, - "scheme": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "banners": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bannerId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "conteudos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{}" - } - }, - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a886f80a083f009b233919" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json b/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json deleted file mode 100644 index 39469b406..000000000 --- a/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts": { - "get": { - "summary": "Busca todos os scripts inseridos", - "description": "Lista de scripts", - "operationId": "busca-todos-os-scripts-inseridos", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"scriptId\": 0,\n \"nome\": \"string\",\n \"posicao\": \"HeaderPrimeiraLinha\",\n \"tipoPagina\": \"Todas\",\n \"dataInicial\": \"2022-06-23T11:17:57.626Z\",\n \"datafinal\": \"2022-06-23T11:17:57.626Z\",\n \"ativo\": true,\n \"prioridade\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "scriptId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "posicao": { - "type": "string", - "example": "HeaderPrimeiraLinha" - }, - "tipoPagina": { - "type": "string", - "example": "Todas" - }, - "dataInicial": { - "type": "string", - "example": "2022-06-23T11:17:57.626Z" - }, - "datafinal": { - "type": "string", - "example": "2022-06-23T11:17:57.626Z" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "prioridade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b1cd784fb14d006f388284" -} \ No newline at end of file diff --git a/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json deleted file mode 100644 index 689d0cc64..000000000 --- a/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,283 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}": { - "get": { - "summary": "Busca um hotsite específico", - "description": "Objeto do hotsite", - "operationId": "busca-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser buscado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.213Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.213Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.213Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "hotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "template": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-14T11:07:54.213Z" - }, - "dataInicio": { - "type": "string", - "example": "2022-06-14T11:07:54.213Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-06-14T11:07:54.213Z" - }, - "url": { - "type": "string", - "example": "string" - }, - "tamanhoPagina": { - "type": "integer", - "example": 0, - "default": 0 - }, - "templateId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ordenacao": { - "type": "string", - "example": "Nenhuma" - }, - "listaProdutos": { - "type": "object", - "properties": { - "expressao": { - "type": "string", - "example": "string" - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ordem": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "seo": { - "type": "object", - "properties": { - "seoHotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "hotsiteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "metas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "httpEquiv": { - "type": "string", - "example": "string" - }, - "scheme": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "banners": { - "type": "array", - "items": { - "type": "object", - "properties": { - "bannerId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "conteudos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "conteudoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a899e59f542f002f2f9894" -} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json b/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json deleted file mode 100644 index 0fe1dd623..000000000 --- a/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores/{nomeAutor}": { - "get": { - "summary": "Buscar autor pelo nome", - "description": "", - "operationId": "buscar-autor-pelo-nome", - "parameters": [ - { - "name": "nomeAutor", - "in": "path", - "description": "Nome do autor", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a1dc027abf93008b11f4a2" -} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-autor-por-id.openapi.json b/wake/utils/openapi/buscar-autor-por-id.openapi.json deleted file mode 100644 index e9c044921..000000000 --- a/wake/utils/openapi/buscar-autor-por-id.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores/{autorId}": { - "get": { - "summary": "Buscar autor por id", - "description": "", - "operationId": "buscar-autor-por-id", - "parameters": [ - { - "name": "autorId", - "in": "path", - "description": "Identificador do autor", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a1da72e40b2500337971fc" -} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-banner-por-id.openapi.json b/wake/utils/openapi/buscar-banner-por-id.openapi.json deleted file mode 100644 index b8ae9ca47..000000000 --- a/wake/utils/openapi/buscar-banner-por-id.openapi.json +++ /dev/null @@ -1,337 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}": { - "get": { - "summary": "Buscar banner por Id", - "description": "Objeto do banner", - "operationId": "buscar-banner-por-id", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve ser buscado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-10T13:20:59.150Z\",\n \"dataFim\": \"2022-06-10T13:20:59.150Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dataInicio": { - "type": "string", - "example": "2022-06-10T13:20:59.150Z" - }, - "dataFim": { - "type": "string", - "example": "2022-06-10T13:20:59.150Z" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhe": { - "type": "object", - "properties": { - "posicionamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "urlBanner": { - "type": "string", - "example": "string" - }, - "imagemBanner": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "base64": { - "type": "string", - "example": "string" - }, - "formato": { - "type": "string", - "example": "PNG" - } - } - }, - "ordemExibicao": { - "type": "integer", - "example": 0, - "default": 0 - }, - "abrirBannerNovaAba": { - "type": "boolean", - "example": true, - "default": true - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "title": { - "type": "string", - "example": "string" - }, - "urlClique": { - "type": "string", - "example": "string" - }, - "urlBannerAlternativo": { - "type": "string", - "example": "string" - }, - "titleAlternativo": { - "type": "string", - "example": "string" - }, - "diasExibicao": { - "type": "object", - "properties": { - "todosDias": { - "type": "boolean", - "example": true, - "default": true - }, - "domingo": { - "type": "boolean", - "example": true, - "default": true - }, - "segunda": { - "type": "boolean", - "example": true, - "default": true - }, - "terca": { - "type": "boolean", - "example": true, - "default": true - }, - "quarta": { - "type": "boolean", - "example": true, - "default": true - }, - "quinta": { - "type": "boolean", - "example": true, - "default": true - }, - "sexta": { - "type": "boolean", - "example": true, - "default": true - }, - "sabado": { - "type": "boolean", - "example": true, - "default": true - } - } - }, - "textoAlternativo": { - "type": "string", - "example": "string" - } - } - }, - "apresentacao": { - "type": "object", - "properties": { - "exibirNoSite": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirEmTodasBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "naoExibirEmBuscas": { - "type": "boolean", - "example": true, - "default": true - }, - "termosBusca": { - "type": "string", - "example": "string" - }, - "listaHotsites": { - "type": "object", - "properties": { - "exibirEmTodosHotSites": { - "type": "boolean", - "example": true, - "default": true - }, - "hotSites": { - "type": "array", - "items": { - "type": "object", - "properties": { - "hotSiteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "exibirEmTodasCategorias": { - "type": "boolean", - "example": true, - "default": true - }, - "listaParceiros": { - "type": "object", - "properties": { - "exibirEmTodosParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "parceiros": { - "type": "array", - "items": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{}" - } - }, - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a35336a70b19004482f095" -} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-todos-os-autores.openapi.json b/wake/utils/openapi/buscar-todos-os-autores.openapi.json deleted file mode 100644 index 32d1efa80..000000000 --- a/wake/utils/openapi/buscar-todos-os-autores.openapi.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores": { - "get": { - "summary": "Buscar todos os autores", - "description": "", - "operationId": "buscar-todos-os-autores", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "" - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0fd79f0f787009eb49416" -} \ No newline at end of file diff --git a/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json b/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json deleted file mode 100644 index 038668bec..000000000 --- a/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/grupoassinatura/assinatura": { - "post": { - "summary": "Cria assinatura com base em uma lista de pedidos", - "description": "Pedidos que terão vínculo com o grupo de assinatura informado.", - "operationId": "cria-assinatura-com-base-em-uma-lista-de-pedidos", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pedidos": { - "type": "array", - "description": "Lista de pedidos a serem vinculados a assinatura", - "items": { - "properties": { - "pedidoId": { - "type": "integer", - "description": "Id do pedido", - "format": "int32" - } - }, - "type": "object" - } - }, - "recorrenciaId": { - "type": "integer", - "description": "ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura", - "format": "int32" - }, - "grupoAssinaturaId": { - "type": "integer", - "description": "ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "text/plain": { - "examples": { - "Erro no processamento da operação": { - "value": "" - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:63adc9f79b51fc00122338f6" -} \ No newline at end of file diff --git a/wake/utils/openapi/cria-um-novo-evento.openapi.json b/wake/utils/openapi/cria-um-novo-evento.openapi.json deleted file mode 100644 index bbc5b3d16..000000000 --- a/wake/utils/openapi/cria-um-novo-evento.openapi.json +++ /dev/null @@ -1,291 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos": { - "post": { - "summary": "Cria um Novo Evento", - "description": "", - "operationId": "cria-um-novo-evento", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "description": "Identificador do tipo de evento", - "format": "int32" - }, - "enderecoEntregaId": { - "type": "integer", - "description": "Identificador do endereço de entrega", - "format": "int32" - }, - "titulo": { - "type": "string", - "description": "Titulo do evento" - }, - "url": { - "type": "string", - "description": "URL do evento" - }, - "data": { - "type": "string", - "description": "Data do Evento", - "format": "date" - }, - "usuarioEmail": { - "type": "string", - "description": "Email do usuário" - }, - "disponivel": { - "type": "boolean", - "description": "Disponibilidade do evento (optional)" - }, - "diasAntesEvento": { - "type": "integer", - "description": "Quantos dias antes do evento ele será exibido (optional)", - "format": "int32" - }, - "diasDepoisEvento": { - "type": "integer", - "description": "Até quantos dias depois do evento ele será exibido (optional)", - "format": "int32" - }, - "urlLogo": { - "type": "string", - "description": "Url do Logo. (Base64)" - }, - "urlCapa": { - "type": "string", - "description": "Url da Capa. (Base64)" - }, - "proprietario": { - "type": "string", - "description": "Quem é o proprietário" - }, - "abaInfo01Habilitado": { - "type": "boolean", - "description": "Se a aba de informação 01 será habilitada" - }, - "textoInfo01": { - "type": "string", - "description": "Texto para o campo informação 01 (optional)" - }, - "conteudoInfo01": { - "type": "string", - "description": "Conteúdo para o campo informação 01 (optional)" - }, - "abaInfo02Habilitado": { - "type": "boolean", - "description": "Se a aba de informação 02 será habilitada" - }, - "textoInfo02": { - "type": "string", - "description": "Texto para o campo informação 02 (optional)" - }, - "conteudoInfo02": { - "type": "string", - "description": "Conteúdo para o campo informação 02 (optional)" - }, - "abaMensagemHabilitado": { - "type": "boolean", - "description": "Se a aba de mensagem será habilitada (optional)" - }, - "enumTipoListaPresenteId": { - "type": "string", - "description": "Tipo de lista de presente", - "enum": [ - "ListaPronta", - "ListaManual" - ] - }, - "enumTipoEntregaId": { - "type": "string", - "description": "Tipo de entrega", - "enum": [ - "EntregaAgendada", - "EntregaConformeCompraRealizada", - "Todos", - "Nenhum" - ] - }, - "eventoProdutoSelecionado": { - "type": "array", - "description": "Seleção de produto no evento", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Id do produto variante", - "format": "int32" - }, - "recebidoForaLista": { - "type": "boolean", - "description": "Se produto recebido fora da lista (optional)" - }, - "removido": { - "type": "boolean", - "description": "Se produto removido (optional)" - } - }, - "type": "object" - } - }, - "enderecoEvento": { - "type": "array", - "description": "Endereço do Evento", - "items": { - "properties": { - "nome": { - "type": "string", - "description": "Nome para identificação do endereço" - }, - "endereco": { - "type": "string", - "description": "Endereço" - }, - "cep": { - "type": "string", - "description": "Cep do endereço" - }, - "numero": { - "type": "string", - "description": "Numero do endereço" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço" - }, - "cidade": { - "type": "string", - "description": "Cidade do endereço" - }, - "estado": { - "type": "string", - "description": "Estado do endereço" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac815a9efce0039082096a" -} \ No newline at end of file diff --git a/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json b/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json deleted file mode 100644 index c36202129..000000000 --- a/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/categoriaPrincipal": { - "put": { - "summary": "Define uma categoria de um produto como principal", - "description": "", - "operationId": "define-uma-categoria-de-um-produto-como-principal", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "categoriaId": { - "type": "integer", - "description": "Id da categoria", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c467f517331b00b6c6396b" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json deleted file mode 100644 index a8aee2246..000000000 --- a/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo": { - "delete": { - "summary": "Deleta o SEO de um produto específico", - "description": "", - "operationId": "deleta-o-seo-de-um-produto-especifico", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c49a83317888003b3a6129" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json deleted file mode 100644 index 21fbdfbaf..000000000 --- a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/hotsites": { - "delete": { - "summary": "Deleta o vinculo de um ou mais hotsites com um banner específico", - "description": "", - "operationId": "deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve desvincular os hotsites desejados", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "listaHotsites": { - "type": "object", - "description": "Lista de identificadores de hotsites para desvincular do banner (optional)", - "properties": { - "hotSiteId": { - "type": "array", - "description": "Id do hotsite para vinculo com banner", - "items": { - "properties": { - "hotSiteId": { - "type": "array", - "description": "Id do hotsite para vinculo com banner", - "default": [] - } - }, - "type": "object" - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a747f036263e0027566bfb" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json deleted file mode 100644 index 4ce51e40b..000000000 --- a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/parceiros": { - "delete": { - "summary": "Deleta o vinculo de um ou mais parceiros com um banner específico", - "description": "", - "operationId": "deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve desvincular os parceiros desejados", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "listaParceiros": { - "type": "array", - "description": "Lista de identificadores de parceiros para desvincular do banner", - "items": { - "properties": { - "parceiroId": { - "type": "integer", - "description": "Id do parceiro (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a7691a93536400345f5633" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json deleted file mode 100644 index 786607c53..000000000 --- a/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json +++ /dev/null @@ -1,148 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}/produto/{produtoVarianteId}": { - "delete": { - "summary": "Deleta o vinculo de um produto a um evento", - "description": "", - "operationId": "deleta-o-vinculo-de-um-produto-a-um-evento", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Identificador do variante do produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "\"Produto desvinculado com sucesso!\"": { - "value": "\"Produto desvinculado com sucesso!\"" - } - }, - "schema": { - "type": "string", - "example": "Produto desvinculado com sucesso!" - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac8e39e66b3800148635e3" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-atributo.openapi.json b/wake/utils/openapi/deleta-um-atributo.openapi.json deleted file mode 100644 index 7693a9c76..000000000 --- a/wake/utils/openapi/deleta-um-atributo.openapi.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/atributos/{nome}": { - "delete": { - "summary": "Deleta um atributo", - "description": "", - "operationId": "deleta-um-atributo", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do atributo", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0ee0071a9a9003ad8bb79" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json b/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json deleted file mode 100644 index 5ad616e37..000000000 --- a/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/avatar": { - "delete": { - "summary": "Deleta um avatar de um usuário", - "description": "", - "operationId": "deleta-um-avatar-de-um-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec25dfb1b9902beda6b44" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-banner-existente.openapi.json b/wake/utils/openapi/deleta-um-banner-existente.openapi.json deleted file mode 100644 index 95a648aa0..000000000 --- a/wake/utils/openapi/deleta-um-banner-existente.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}": { - "delete": { - "summary": "Deleta um banner existente", - "description": "", - "operationId": "deleta-um-banner-existente", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve ser deletado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a34cd384de520013cdef50" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json b/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json deleted file mode 100644 index 176dffacd..000000000 --- a/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}": { - "delete": { - "summary": "Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados", - "description": "", - "operationId": "deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser deletado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a89922544600001d879d98" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json b/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json deleted file mode 100644 index 5e8b7cc69..000000000 --- a/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json +++ /dev/null @@ -1,140 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo/metaTag": { - "delete": { - "summary": "Deleta um ou mais Metatags de produto", - "description": "", - "operationId": "deleta-um-ou-mais-metatags-de-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Identificador do produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metatags": { - "type": "array", - "description": "Lista de identificadores de metatags (optional)", - "items": { - "properties": { - "metatagId": { - "type": "integer", - "description": "Identificador do MetaTag", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c57651bf9a8f077c21747d" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-portfolio.openapi.json b/wake/utils/openapi/deleta-um-portfolio.openapi.json deleted file mode 100644 index c3d9c4fca..000000000 --- a/wake/utils/openapi/deleta-um-portfolio.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}": { - "delete": { - "summary": "Deleta um portfolio", - "description": "", - "operationId": "deleta-um-portfolio", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja excluir", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef1802129b700693025c0" -} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json b/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json deleted file mode 100644 index 2902bdd63..000000000 --- a/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json +++ /dev/null @@ -1,113 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}/produto/{produtoVarianteId}": { - "delete": { - "summary": "Deleta um produto da lista de sugestões de produtos de um tipo de evento", - "description": "", - "operationId": "deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Identificador do variante do produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ced108313480037cbf7038" -} \ No newline at end of file diff --git a/wake/utils/openapi/deletar-autor.openapi.json b/wake/utils/openapi/deletar-autor.openapi.json deleted file mode 100644 index b4982411d..000000000 --- a/wake/utils/openapi/deletar-autor.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores/{autorId}": { - "delete": { - "summary": "Deletar autor", - "description": "", - "operationId": "deletar-autor", - "parameters": [ - { - "name": "autorId", - "in": "path", - "description": "Identificador do autor", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a1067e55e8290036bc96c3" -} \ No newline at end of file diff --git a/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json b/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json deleted file mode 100644 index 52fd84d12..000000000 --- a/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/banners": { - "delete": { - "summary": "Desvincula um ou mais banners de um hotsite específico", - "description": "", - "operationId": "desvincula-um-ou-mais-banners-de-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser desvinculado os banners", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "banners": { - "type": "array", - "description": "Lista de identificadores de banners a serem desvinculados", - "items": { - "properties": { - "bannerId": { - "type": "integer", - "description": "Identificador do banner (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a89c86f39f1007ccd51a18" -} \ No newline at end of file diff --git a/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json b/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json deleted file mode 100644 index 66e74c394..000000000 --- a/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/conteudos": { - "delete": { - "summary": "Desvincula um ou mais conteúdos de um hotsite específico", - "description": "", - "operationId": "desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser desvinculado os conteúdos", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "conteudos": { - "type": "array", - "description": "Lista de identificadores de conteúdos a serem desvinculados", - "items": { - "properties": { - "conteudoId": { - "type": "integer", - "description": "Identificador do conteúdo", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a8dc7781fdca00562277c5" -} \ No newline at end of file diff --git a/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json b/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json deleted file mode 100644 index 67b5623ce..000000000 --- a/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/estorno/{pedidoId}": { - "post": { - "summary": "Estorna total ou parcial de um pedido", - "description": "Estorna um valor menor ou igual ao total do pedido \"Pago\"", - "operationId": "estorna-total-ou-parcial-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Id do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "Valor": { - "type": "number", - "description": "Valor a ser estornado do pedido. Total ou parcial.", - "default": null, - "format": "float" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "400": { - "description": "400", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:648a233482a9bc000a9d91f0" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json b/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json deleted file mode 100644 index 3d5450e7d..000000000 --- a/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/categorias/{id}": { - "delete": { - "summary": "Exclui o vínculo entre uma categoria e um produto", - "description": "", - "operationId": "exclui-o-vinculo-entre-uma-categoria-e-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "id", - "in": "path", - "description": "Id da categoria a qual o produto deverá ser desvinculado", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4525d69aab3006b814790" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json b/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json deleted file mode 100644 index c890f85c3..000000000 --- a/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}/detalhes": { - "delete": { - "summary": "Exclui os detalhes de um contrato de frete", - "description": "", - "operationId": "exclui-os-detalhes-de-um-contrato-de-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d3726b567b00ae9c7d66" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-fabricante.openapi.json b/wake/utils/openapi/exclui-um-fabricante.openapi.json deleted file mode 100644 index 9d9b661b4..000000000 --- a/wake/utils/openapi/exclui-um-fabricante.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes/{fabricanteId}": { - "delete": { - "summary": "Exclui um fabricante", - "description": "", - "operationId": "exclui-um-fabricante", - "parameters": [ - { - "name": "fabricanteId", - "in": "path", - "description": "Id do fabricante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0837883dd8c00404e4c66" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-parceiro.openapi.json b/wake/utils/openapi/exclui-um-parceiro.openapi.json deleted file mode 100644 index fe3599e65..000000000 --- a/wake/utils/openapi/exclui-um-parceiro.openapi.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{parceiroId}": { - "delete": { - "summary": "Exclui um parceiro", - "description": "Parceiro excluído com sucesso", - "operationId": "exclui-um-parceiro", - "parameters": [ - { - "name": "parceiroId", - "in": "path", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb2c519a3d800464c2464" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-script.openapi.json b/wake/utils/openapi/exclui-um-script.openapi.json deleted file mode 100644 index 3838b107e..000000000 --- a/wake/utils/openapi/exclui-um-script.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts/{scriptId}": { - "delete": { - "summary": "Exclui um Script", - "description": "", - "operationId": "exclui-um-script", - "parameters": [ - { - "name": "scriptId", - "in": "path", - "description": "Id do script", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b4522a9f03910096195e76" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json deleted file mode 100644 index 0d275ea1e..000000000 --- a/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/erp/{id}": { - "delete": { - "summary": "Exclui uma categoria utilizando o id do erp como identificador", - "description": "Categoria excluída com sucesso", - "operationId": "exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa0a6aad28090027004824" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-categoria.openapi.json b/wake/utils/openapi/exclui-uma-categoria.openapi.json deleted file mode 100644 index c00ece4d8..000000000 --- a/wake/utils/openapi/exclui-uma-categoria.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/{id}": { - "delete": { - "summary": "Exclui uma categoria", - "description": "", - "operationId": "exclui-uma-categoria", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a9f29c4caa3800382a6f51" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json b/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json deleted file mode 100644 index df9941b0e..000000000 --- a/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json +++ /dev/null @@ -1,136 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/imagens/{id}": { - "delete": { - "summary": "Exclui uma imagem de um produto", - "description": "", - "operationId": "exclui-uma-imagem-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "id", - "in": "path", - "description": "Id da imagem do produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c46d4db2f76f00aa944392" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json b/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json deleted file mode 100644 index 3f11e5720..000000000 --- a/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/informacoes/{informacaoId}": { - "delete": { - "summary": "Exclui uma informação de um produto", - "description": "", - "operationId": "exclui-uma-informacao-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "informacaoId", - "in": "path", - "description": "Id da informação do produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c448a7873944006eb782d0" -} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json deleted file mode 100644 index f769cd830..000000000 --- a/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}": { - "delete": { - "summary": "Exclui uma tabela de preços", - "description": "", - "operationId": "exclui-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a7f9b0c9350027e96a00" -} \ No newline at end of file diff --git a/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json b/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json deleted file mode 100644 index 435ecb50b..000000000 --- a/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/centrosdistribuicao/{centroDistribuicaoId}/prioridade": { - "put": { - "summary": "Executa uma atualizacao da prioridade do centro de distribuicao", - "description": "Atualiza a prioridade de um centro de distribuição", - "operationId": "executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1", - "parameters": [ - { - "name": "centroDistribuicaoId", - "in": "path", - "description": "Id do centro de distribuição", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "incrementoOrdem": { - "type": "integer", - "description": "(optional)", - "format": "int32" - }, - "desativarPriorizacao": { - "type": "boolean", - "description": "(optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{}" - } - }, - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no Processamento da Operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no Processamento da Operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:64be95e5b78c82006347bf61" -} \ No newline at end of file diff --git a/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json b/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json deleted file mode 100644 index 81e03d90a..000000000 --- a/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autenticacao/refresh": { - "post": { - "summary": "Gera um novo access token baseado em um access token expirado por data", - "description": "Access token atualizado com sucesso", - "operationId": "gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.420Z\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "lojas": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "accessToken": { - "type": "string", - "example": "string" - }, - "dataExpiracaoAccessTokenUTC": { - "type": "string", - "example": "2022-06-09T11:21:37.420Z" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a226cab72af600215e6b78" -} \ No newline at end of file diff --git a/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json b/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json deleted file mode 100644 index 1ad5e6786..000000000 --- a/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}/pedido": { - "post": { - "summary": "Gera um novo pedido para a assinatura", - "description": "", - "operationId": "gera-um-novo-pedido-para-a-assinatura", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Identificador da assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a723a3b41b840051dffa8e" -} \ No newline at end of file diff --git a/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json b/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json deleted file mode 100644 index 8c17ff2a4..000000000 --- a/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/carrinhoabandonado": { - "get": { - "summary": "Indicador do Carrinho Abandonado", - "description": "Indicador do Carrinho Abandonado", - "operationId": "indicador-do-carrinho-abandonado", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"indicadorCarrinhoAbandonado\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "indicadorCarrinhoAbandonado": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4130800ea80090d9ee0b" -} \ No newline at end of file diff --git a/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json b/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json deleted file mode 100644 index b79f09c53..000000000 --- a/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/novoscompradores": { - "get": { - "summary": "Indicador dos Novos Compradores", - "description": "Indicador dos Novos Compradores", - "operationId": "indicador-dos-novos-compradores", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos novos compradores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"indicadorComprador\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "indicadorComprador": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa3fa86afe2b0086c77851" -} \ No newline at end of file diff --git a/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json b/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json deleted file mode 100644 index 2d71dd143..000000000 --- a/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/produtoestoque": { - "get": { - "summary": "Indicadores dos Produtos no Estoque", - "description": "Indicadores dos Produtos no Estoque", - "operationId": "indicadores-dos-produtos-no-estoque", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"indicadorProdutoComEstoque\": \"string\",\n \"indicadorProdutoSemEstoque\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "indicadorProdutoComEstoque": { - "type": "string", - "example": "string" - }, - "indicadorProdutoSemEstoque": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4078cbd4e30014d40c44" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json b/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json deleted file mode 100644 index 3710afa42..000000000 --- a/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/limiteCredito/{usuarioId}": { - "put": { - "summary": "Atualiza o limite de crédito para um usuário", - "description": "", - "operationId": "insere-limite-de-credito-para-um-usuario", - "parameters": [ - { - "name": "cpf_cnpj", - "in": "query", - "description": "CPF ou CNPJ do usuário", - "schema": { - "type": "string" - } - }, - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "valor", - "in": "query", - "description": "Valor do limite de crédito", - "schema": { - "type": "number", - "format": "double" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de9462609d1c006fd1e913" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json deleted file mode 100644 index 60da46408..000000000 --- a/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}/enderecos": { - "post": { - "summary": "Insere um endereço para um usuário pelo id do usuário", - "description": "", - "operationId": "insere-um-endereco-para-um-usuario-pelo-id-do-usuario", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nomeEndereco": { - "type": "string", - "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" - }, - "rua": { - "type": "string", - "description": "Nome da rua (Max Length: 500)" - }, - "numero": { - "type": "string", - "description": "Número do local (Max Length: 50)" - }, - "complemento": { - "type": "string", - "description": "Complemento (Max Length: 250) (optional)" - }, - "referencia": { - "type": "string", - "description": "Referência para a localização do endereço (Max Length: 500) (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço (Max Length: 100)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que se localiza o endereço (Max Length: 100)" - }, - "estado": { - "type": "string", - "description": "O estado (Max Length: 100)" - }, - "cep": { - "type": "string", - "description": "Código do cep (Max Length: 50)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dad570ff4a61001a38ebf3" -} \ No newline at end of file diff --git "a/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" "b/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" deleted file mode 100644 index fedfaa8b7..000000000 --- "a/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/enderecos": { - "post": { - "summary": "Insere um endereço para um usuário pelo e-mail", - "description": "", - "operationId": "insere-um-endereço-para-um-usuario-pelo-e-mail", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nomeEndereco": { - "type": "string", - "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" - }, - "rua": { - "type": "string", - "description": "Nome da rua (Max Length: 500)" - }, - "numero": { - "type": "string", - "description": "Número do local (Max Length: 50)" - }, - "complemento": { - "type": "string", - "description": "Complemento (Max Length: 250) (optional)" - }, - "referencia": { - "type": "string", - "description": "Referência para a localização do endereço (Max Length: 500) (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço (Max Length: 100)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que se localiza o endereço (Max Length: 100)" - }, - "estado": { - "type": "string", - "description": "O estado (Max Length: 100)" - }, - "cep": { - "type": "string", - "description": "Código do cep (Max Length: 50)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62daad403871a90037c1d87e" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-atributo.openapi.json b/wake/utils/openapi/insere-um-novo-atributo.openapi.json deleted file mode 100644 index 3029df96f..000000000 --- a/wake/utils/openapi/insere-um-novo-atributo.openapi.json +++ /dev/null @@ -1,164 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/atributos": { - "post": { - "summary": "Insere um novo atributo", - "description": "", - "operationId": "insere-um-novo-atributo", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do atributo (optional)" - }, - "tipo": { - "type": "string", - "description": "Tipo do atributo (optional)", - "enum": [ - "Selecao", - "Filtro", - "Comparacao", - "Configuracao", - "ExclusivoGoogle" - ] - }, - "tipoExibicao": { - "type": "string", - "description": "Tipo de exibição (optional)", - "enum": [ - "Combo", - "Div", - "DivComCor", - "DivComFotoDoProdutoVariante", - "Javascript" - ] - }, - "prioridade": { - "type": "integer", - "description": "Prioridade do atributo (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "501": { - "description": "501", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0e8bcf02cdd004907a1c4" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json b/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json deleted file mode 100644 index b400a4936..000000000 --- a/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/avatar": { - "post": { - "summary": "Insere um novo avatar para o usuário", - "description": "", - "operationId": "insere-um-novo-avatar-para-o-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "base64": { - "type": "string", - "description": "Imagem do avatar em base64 (optional)" - }, - "formato": { - "type": "string", - "description": "Formato da imagem (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Nome do arquivo gerado": { - "value": "{\n \"urlAvatar\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "urlAvatar": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec2dcc9cecb012fb4e625" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-banner.openapi.json b/wake/utils/openapi/insere-um-novo-banner.openapi.json deleted file mode 100644 index 990528a68..000000000 --- a/wake/utils/openapi/insere-um-novo-banner.openapi.json +++ /dev/null @@ -1,336 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners": { - "post": { - "summary": "Insere um novo banner", - "description": "", - "operationId": "insere-um-novo-banner", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do banner" - }, - "dataInicio": { - "type": "string", - "description": "Data de inicio de exibição do banner", - "format": "date" - }, - "dataFim": { - "type": "string", - "description": "Data de termino de exibição do banner (optional)", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Banner ativo/inativo (optional)" - }, - "detalhe": { - "type": "object", - "description": "Detalhes do banner", - "properties": { - "posicionamentoId": { - "type": "integer", - "description": "Local de posicionamento do banner", - "format": "int32" - }, - "imagemBanner": { - "type": "object", - "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", - "properties": { - "base64": { - "type": "string", - "description": "string da imagem em base 64" - }, - "formato": { - "type": "string", - "description": "formato da imagem", - "enum": [ - "PNG", - "JPG", - "JPEG" - ] - }, - "nome": { - "type": "string", - "description": "nome da imagem" - } - } - }, - "urlBanner": { - "type": "string", - "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" - }, - "ordemExibicao": { - "type": "integer", - "description": "Ordem de exibição do banner (optional)", - "format": "int32" - }, - "abrirLinkNovaAba": { - "type": "boolean", - "description": "Se o banner deve ou não abrir em nova aba (optional)" - }, - "largura": { - "type": "integer", - "description": "Largura do banner em pixels (optional)", - "format": "int32" - }, - "altura": { - "type": "integer", - "description": "Altura do banner em pixels (optional)", - "format": "int32" - }, - "title": { - "type": "string", - "description": "Title da imagem do banner (optional)" - }, - "urlClique": { - "type": "string", - "description": "Url de destino para quando o usuário clicar no Banner (optional)" - }, - "urlBannerAlternativo": { - "type": "string", - "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" - }, - "textoAlternativo": { - "type": "string", - "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" - } - } - }, - "diasExibicao": { - "type": "object", - "description": "Dias da semana que o banner deverá ser exibido (optional)", - "properties": { - "todosDias": { - "type": "boolean", - "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" - }, - "domingo": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado no domingo" - }, - "segunda": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na segunda" - }, - "terca": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na terça" - }, - "quarta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na quarta" - }, - "quinta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na quinta" - }, - "sexta": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado na sexta" - }, - "sabado": { - "type": "boolean", - "description": "Se o banner deverá ser apresentado no sábado" - } - } - }, - "apresentacao": { - "type": "object", - "description": "Detalhes de apresentação do banner (optional)", - "properties": { - "exibirNoSite": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todo o site" - }, - "exibirEmTodasBuscas": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todas as buscas" - }, - "naoExibirEmBuscas": { - "type": "boolean", - "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" - }, - "termosBusca": { - "type": "string", - "description": "Termos que o banner será exibido na busca" - }, - "exibirEmTodasCategorias": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" - }, - "listaHotsites": { - "type": "object", - "description": "Em quais hotsites o banner deve ser exibido", - "properties": { - "exibirEmTodosHotsites": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" - }, - "hotsites": { - "type": "array", - "description": "Lista de hotsite's que o banner será exibido", - "items": { - "properties": { - "hotSiteId": { - "type": "integer", - "description": "Id do hotsite (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - }, - "listaParceiros": { - "type": "object", - "description": "Em quais parceiros o banner deve ser exibido", - "properties": { - "exibirEmTodosParceiros": { - "type": "boolean", - "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" - }, - "parceiros": { - "type": "array", - "description": "Lista de parceiros que o banner será exibido", - "items": { - "properties": { - "parceiroId": { - "type": "integer", - "description": "Id do parceiro (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a73d79fc8d2200f3244bc0" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json b/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json deleted file mode 100644 index 0ba261157..000000000 --- a/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json +++ /dev/null @@ -1,142 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/CadastroPersonalizado": { - "post": { - "summary": "Insere um novo campo de cadastro personalizado", - "description": "", - "operationId": "insere-um-novo-campo-de-cadastro-personalizado", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do campo" - }, - "tipo": { - "type": "string", - "description": "Tipo do campo", - "enum": [ - "TextoLivre", - "ValoresPredefinidos", - "RadioButton" - ] - }, - "obrigatorio": { - "type": "boolean", - "description": "Se o campo será obrigatório" - }, - "ordem": { - "type": "integer", - "description": "Ordem", - "format": "int32" - }, - "valorPreDefinido": { - "type": "array", - "description": "Informação para os campos (optional)", - "items": { - "properties": { - "valor": { - "type": "string", - "description": "Valor" - }, - "ordem": { - "type": "integer", - "description": "Ordem", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do campo de cadastro personalizado gerado": { - "value": "Id do campo de cadastro personalizado gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec4fbe00703012ad1342f" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json b/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json deleted file mode 100644 index 7ab745dca..000000000 --- a/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json +++ /dev/null @@ -1,192 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/conteudos": { - "post": { - "summary": "Insere um novo conteúdo na loja", - "description": "", - "operationId": "insere-um-novo-conteudo-na-loja", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "titulo": { - "type": "string", - "description": "Titulo do conteúdo" - }, - "ativo": { - "type": "boolean", - "description": "Conteúdo ativo/inativo" - }, - "dataInicio": { - "type": "string", - "description": "Data de inicio de exibição do conteúdo (optional)", - "format": "date" - }, - "dataFim": { - "type": "string", - "description": "Data final de exibição do conteúdo (optional)", - "format": "date" - }, - "posicionamento": { - "type": "string", - "description": "Posicionamento do conteúdo", - "enum": [ - "Topo", - "Centro", - "Rodape", - "LateralDireita", - "LateralEsquerda", - "MobileTopo", - "MobileRodape" - ] - }, - "conteudo": { - "type": "string", - "description": "Informações do conteúdo" - }, - "termoBusca": { - "type": "string", - "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" - }, - "exibeTodasBuscas": { - "type": "boolean", - "description": "Exibição do conteúdo nas buscas" - }, - "naoExibeBuscas": { - "type": "boolean", - "description": "Não exibição do conteúdo nas buscas" - }, - "exibeTodosHotsites": { - "type": "boolean", - "description": "Exibição do conteúdo nos hotsites" - }, - "hotsitesId": { - "type": "array", - "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", - "items": { - "type": "integer", - "format": "int32" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a8723026857d003565d195" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json b/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json deleted file mode 100644 index 6fad6e2ec..000000000 --- a/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes": { - "post": { - "summary": "Insere um novo contrato de frete", - "description": "", - "operationId": "insere-um-novo-contrato-de-frete", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do contrato de frete (optional)" - }, - "ativo": { - "type": "boolean", - "description": "Status do contrato de frete (optional)" - }, - "volumeMaximo": { - "type": "integer", - "description": "Volume máximo permitido , em metro cúbico (m³). (optional)", - "format": "int32" - }, - "pesoCubado": { - "type": "number", - "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", - "format": "double" - }, - "entregaAgendadaConfiguracaoId": { - "type": "integer", - "description": "Id da configuração entrega agendada (optional)", - "format": "int32" - }, - "linkRastreamento": { - "type": "string", - "description": "URL rastreamento (optional)" - }, - "ehAssinatura": { - "type": "boolean", - "description": "Contrato é exclusivo assinatura (optional)" - }, - "larguraMaxima": { - "type": "integer", - "description": "Informe a largura máxima, em centímetros (cm). (optional)", - "format": "int32" - }, - "alturaMaxima": { - "type": "integer", - "description": "Informe a altura máxima, em centímetros (cm). (optional)", - "format": "int32" - }, - "comprimentoMaximo": { - "type": "integer", - "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", - "format": "int32" - }, - "limiteMaximoDimensoes": { - "type": "integer", - "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", - "format": "int32" - }, - "limitePesoCubado": { - "type": "number", - "description": "Informe o limite de peso cubado, em gramas (g). (optional)", - "format": "double" - }, - "tempoMinimoDespacho": { - "type": "integer", - "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Informe o Id do centro de distribuição (optional)", - "format": "int32" - }, - "valorMinimoProdutos": { - "type": "number", - "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", - "format": "double" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do frete gerado": { - "value": "Id do frete gerado" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0a6af7953870133270d58" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json b/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json deleted file mode 100644 index 462251bb9..000000000 --- a/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json +++ /dev/null @@ -1,194 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}/detalhes": { - "post": { - "summary": "Insere um novo detalhe de frete vinculado a um contrato de frete", - "description": "", - "operationId": "insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "cepInicial": { - "type": "integer", - "description": "Informe o cep inicial (optional)", - "format": "int32" - }, - "cepFinal": { - "type": "integer", - "description": "Informe o cep final (optional)", - "format": "int32" - }, - "variacoesFreteDetalhe": { - "type": "array", - "description": "Variações de detalhe do frete (optional)", - "items": { - "properties": { - "pesoInicial": { - "type": "number", - "description": "Informe o peso inicial", - "format": "double" - }, - "pesoFinal": { - "type": "number", - "description": "Informe o peso final", - "format": "double" - }, - "valorFrete": { - "type": "number", - "description": "Informe o valor do frete", - "format": "double" - }, - "prazoEntrega": { - "type": "number", - "description": "Informe o prazo de entrega", - "format": "double" - }, - "valorPreco": { - "type": "number", - "description": "Informe o valor preço", - "format": "double" - }, - "valorPeso": { - "type": "number", - "description": "Informe o valor peso", - "format": "double" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Detalhes de frete inserido com sucesso": { - "value": "Detalhes de frete inserido com sucesso" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d42276643100982d7acb" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-fabricante.openapi.json b/wake/utils/openapi/insere-um-novo-fabricante.openapi.json deleted file mode 100644 index 27f4ce2fb..000000000 --- a/wake/utils/openapi/insere-um-novo-fabricante.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes": { - "post": { - "summary": "Insere um novo fabricante", - "description": "", - "operationId": "insere-um-novo-fabricante", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do fabricante (optional)" - }, - "urlLogoTipo": { - "type": "string", - "description": "URL tipo logo (optional)" - }, - "urlLink": { - "type": "string", - "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" - }, - "urlCarrossel": { - "type": "string", - "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do fabricante gerado": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b05fffd74efd002f605f51" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-hotsite.openapi.json b/wake/utils/openapi/insere-um-novo-hotsite.openapi.json deleted file mode 100644 index a7c801215..000000000 --- a/wake/utils/openapi/insere-um-novo-hotsite.openapi.json +++ /dev/null @@ -1,274 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites": { - "post": { - "summary": "Insere um novo hotsite", - "description": "A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos.", - "operationId": "insere-um-novo-hotsite", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do hotsite" - }, - "dataInicio": { - "type": "string", - "description": "Data/hora em que o hotsite começará a ser exibido (optional)", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", - "format": "date" - }, - "url": { - "type": "string", - "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" - }, - "tamanhoPagina": { - "type": "integer", - "description": "Informe o número de produtos que deve ser exibido por página", - "format": "int32" - }, - "templateId": { - "type": "integer", - "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", - "format": "int32" - }, - "ordenacao": { - "type": "string", - "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", - "enum": [ - "Nenhuma", - "NomeCrescente", - "NomeDecrescente", - "Lancamento", - "MenorPreco", - "MaiorPreco", - "MaisVendidos", - "MaioresDescontos", - "Aleatorio", - "MenorEstoque", - "MaiorEstoque" - ] - }, - "listaProdutos": { - "type": "object", - "description": "Produtos que devem aparecer no hotsite", - "properties": { - "expressao": { - "type": "string", - "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" - }, - "produtos": { - "type": "array", - "description": "Id dos produtos", - "items": { - "properties": { - "produtoId": { - "type": "integer", - "description": "Identificador do produto a ser mostrado no hotsite", - "format": "int32" - }, - "ordem": { - "type": "integer", - "description": "Ordem para apresentação do produto (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - }, - "seo": { - "type": "object", - "description": "Dados de seo (optional)", - "properties": { - "titulo": { - "type": "string", - "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" - }, - "metas": { - "type": "array", - "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", - "items": { - "properties": { - "conteudo": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "nome": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "httpEquiv": { - "type": "string", - "description": "Informe os dados da Metatag" - }, - "scheme": { - "type": "string", - "description": "Informe os dados da Metatag" - } - }, - "type": "object" - } - } - } - }, - "banners": { - "type": "array", - "description": "Lista de identificadores de banners a serem vinculados ao hotsite (optional)", - "items": { - "properties": { - "bannerId": { - "type": "integer", - "description": "Identificador do banner (optional)", - "format": "int32" - } - }, - "type": "object" - } - }, - "conteudos": { - "type": "array", - "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", - "items": { - "properties": { - "conteudoId": { - "type": "integer", - "description": "Identificador do conteúdo", - "format": "int32" - } - }, - "type": "object" - } - }, - "ativo": { - "type": "boolean", - "description": "Status do hotsite (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a88c6540fc1d074a0e9fb2" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-parceiro.openapi.json b/wake/utils/openapi/insere-um-novo-parceiro.openapi.json deleted file mode 100644 index 565235414..000000000 --- a/wake/utils/openapi/insere-um-novo-parceiro.openapi.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros": { - "post": { - "summary": "Insere um novo parceiro", - "description": "", - "operationId": "insere-um-novo-parceiro", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do parceiro" - }, - "tabelaPrecoId": { - "type": "integer", - "description": "Id da tabela de preço (optional)", - "format": "int32" - }, - "portfolioId": { - "type": "integer", - "description": "Id do portfolio (optional)", - "format": "int32" - }, - "tipoEscopo": { - "type": "string", - "description": "Tipo de escopo", - "enum": [ - "Aberto\"", - "Fechado", - "PorCliente" - ] - }, - "ativo": { - "type": "boolean", - "description": "Status do parceiro" - }, - "isMarketPlace": { - "type": "boolean", - "description": "Se o parceiro é marketplace (optional)" - }, - "origem": { - "type": "string", - "description": "Origem (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do parceiro gerado": { - "value": "\tId do parceiro gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdabae2efc110028adb899" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-pedido.openapi.json b/wake/utils/openapi/insere-um-novo-pedido.openapi.json deleted file mode 100644 index 5a60a887c..000000000 --- a/wake/utils/openapi/insere-um-novo-pedido.openapi.json +++ /dev/null @@ -1,442 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos": { - "post": { - "summary": "Insere um novo pedido", - "description": "Caso a loja utilize as formas de pagamento do gateway o campo \"formaPagamentoId\" do objeto \"pagamento\" deverá conter o valor \"200\".", - "operationId": "insere-um-novo-pedido", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "description": "Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional)", - "format": "int32" - }, - "carrinhoId": { - "type": "string", - "description": "Id do carrinho que foi utilizado no pedido (optional)" - }, - "situacaoPedidoId": { - "type": "integer", - "description": "Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido", - "format": "int32" - }, - "data": { - "type": "string", - "description": "Data em que o pedido foi realizado", - "format": "date" - }, - "valorTotal": { - "type": "number", - "description": "Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional)", - "format": "double" - }, - "valorJuros": { - "type": "number", - "description": "Informação do juros do pedido", - "format": "double" - }, - "valorDesconto": { - "type": "number", - "description": "Informação de desconto do pedido", - "format": "double" - }, - "usuarioId": { - "type": "integer", - "description": "Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios", - "format": "int32" - }, - "enderecoId": { - "type": "integer", - "description": "Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos", - "format": "int32" - }, - "isMobile": { - "type": "boolean", - "description": "Define se o pedido foi feito através de um dispositivo móvel ou não" - }, - "eventoId": { - "type": "integer", - "description": "Id do evento ao qual o pedido está vinculado (opcional)", - "format": "int32" - }, - "produtos": { - "type": "array", - "description": "Lista contendo os produtos do pedido", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Id do produto variante que está vinculado a esse pedido.", - "format": "int32" - }, - "quantidade": { - "type": "object", - "description": "Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição", - "properties": { - "quantidadeTotal": { - "type": "integer", - "description": "Quantidade por centro de distribuição", - "format": "int32" - }, - "quantidadePorCentroDeDistribuicao": { - "type": "array", - "description": "Quantidade (optional)", - "items": { - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição", - "format": "int32" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade", - "format": "int32" - } - }, - "type": "object" - } - } - } - }, - "precoVenda": { - "type": "number", - "description": "Preço de venda do produto, sem adição ou subtração de valores.", - "format": "double" - }, - "isBrinde": { - "type": "boolean", - "description": "Define se esse produto é um brinde ou não" - }, - "ajustes": { - "type": "array", - "description": "Lista contendo todos os ajustes de preço do produto", - "items": { - "properties": { - "tipo": { - "type": "string", - "description": "Define o tipo do ajuste de valor de um produto contido em um pedido. = ['Frete', 'Pricing', 'Atacarejo', 'Personalizacao', 'Embalagem', 'Promocao', 'PromocaoFrete', 'ContaCorrente', 'FormaPagamento', 'PromocaoProduto', 'TipoFreteProduto', 'Formula']stringEnum:\"Frete\", \"Pricing\", \"Atacarejo\", \"Personalizacao\", \"Embalagem\", \"Promocao\", \"PromocaoFrete\", \"ContaCorrente\", \"FormaPagamento\", \"PromocaoProduto\", \"TipoFreteProduto\", \"Formula\"" - }, - "valor": { - "type": "number", - "description": "Define o valor do ajuste a ser aplicado no produto. O valor pode ser positivo ou negativo", - "format": "double" - }, - "observacao": { - "type": "string", - "description": "Observação (optional)" - }, - "nome": { - "type": "string", - "description": "Nome (optional)" - } - }, - "type": "object" - } - } - }, - "type": "object" - } - }, - "fretes": { - "type": "array", - "description": "Informações de frete do pedido", - "items": { - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "description": "Identificador do centro de distribuição de origem", - "format": "int32" - }, - "freteContratoId": { - "type": "integer", - "description": "Identificador do contrato de frete (optional)", - "format": "int32" - }, - "peso": { - "type": "number", - "description": "Peso em gramas (g) do frete calculado (optional)", - "format": "double" - }, - "pesoCobrado": { - "type": "number", - "description": "Peso em gramas cobrado do cliente (optional)", - "format": "double" - }, - "volume": { - "type": "number", - "description": "Volume em metro cúbico (m³) calculado (optional)", - "format": "double" - }, - "volumeCobrado": { - "type": "number", - "description": "Volume em metro cúbico (m³) cobrado do cliente (optional)", - "format": "double" - }, - "prazoEnvio": { - "type": "integer", - "description": "Prazo do envio do frete em dias úteis", - "format": "int32" - }, - "valorFreteEmpresa": { - "type": "number", - "description": "Valor do frete (optional)", - "format": "double" - }, - "valorFreteCliente": { - "type": "number", - "description": "Valor do frete cobrado do cliente", - "format": "double" - }, - "dataEntrega": { - "type": "string", - "description": "Data estimada da entrega do produto (optional)", - "format": "date" - }, - "informacoesAdicionais": { - "type": "array", - "description": "Informações adicionais do frete", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave" - }, - "valor": { - "type": "string", - "description": "Valor" - } - }, - "type": "object" - } - } - }, - "type": "object" - } - }, - "pagamento": { - "type": "object", - "description": "Informações de pagamento do pedido", - "properties": { - "formaPagamentoId": { - "type": "integer", - "description": "Id da forma de pagamento", - "format": "int32" - }, - "numeroParcelas": { - "type": "integer", - "description": "Número parcelas", - "format": "int32" - }, - "valorParcela": { - "type": "number", - "description": "Valor da parcela", - "format": "double" - }, - "informacaoAdicional": { - "type": "array", - "description": "Informações adicionais de pagamento (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave" - }, - "valor": { - "type": "string", - "description": "Valor" - } - }, - "type": "object" - } - } - } - }, - "canalId": { - "type": "integer", - "description": "ParceiroId vinculado ao pedido (optional)", - "format": "int32" - }, - "omniChannel": { - "type": "object", - "description": "Dados do pedido no marketplace (optional)", - "properties": { - "pedidoIdPublico": { - "type": "string", - "description": "Id do pedido que o cliente vê no momento que fecha a compra" - }, - "pedidoIdPrivado": { - "type": "string", - "description": "Id interno do marketplace" - }, - "integrador": { - "type": "object", - "description": "Dados do pedido no integrador", - "properties": { - "nome": { - "type": "string", - "description": "Nome do parceiro integrador" - }, - "pedidoId": { - "type": "string", - "description": "Numero do pedido dentro do integrador" - }, - "pedidoUrl": { - "type": "string", - "description": "Url do pedido dentro painel do integrador" - } - } - } - } - }, - "transacaoId": { - "type": "integer", - "description": "Id da transação (optional)", - "format": "int32" - }, - "observacao": { - "type": "string", - "description": "Observação do pedido (optional)" - }, - "valido": { - "type": "boolean", - "description": "Se um pedido é valido (optional)" - }, - "cupomDesconto": { - "type": "string", - "description": "Cupom de desconto (optional)" - }, - "ip": { - "type": "string", - "description": "IP da criação do pedido (optional)" - }, - "usuarioMaster": { - "type": "integer", - "description": "ID do usuário master que realizou o pedido, se houver (optional)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do pedido gerado": { - "value": "Id do pedido gerado" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb0a7b8210890054b5b7a9" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-portfolio.openapi.json b/wake/utils/openapi/insere-um-novo-portfolio.openapi.json deleted file mode 100644 index ba8c84601..000000000 --- a/wake/utils/openapi/insere-um-novo-portfolio.openapi.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios": { - "post": { - "summary": "Insere um novo portfolio", - "description": "", - "operationId": "insere-um-novo-portfolio", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do portfolio" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do portfolio gerado": { - "value": "Id do portfolio gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bedcaaafb3b100e88d7fc5" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json b/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json deleted file mode 100644 index 732ddf078..000000000 --- a/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}/produtos": { - "post": { - "summary": "Insere um novo produto na assinatura", - "description": "", - "operationId": "insere-um-novo-produto-na-assinatura", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Id de uma assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Produto Variante que será incluído na assinatura", - "format": "int32" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade do produto que será inserido na assinatura", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Produto foi adicionado na assinatura": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a722139588e9027c7da95f" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-script.openapi.json b/wake/utils/openapi/insere-um-novo-script.openapi.json deleted file mode 100644 index b3b9cff5a..000000000 --- a/wake/utils/openapi/insere-um-novo-script.openapi.json +++ /dev/null @@ -1,194 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts": { - "post": { - "summary": "Insere um novo script", - "description": "", - "operationId": "insere-um-novo-script", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do script" - }, - "dataInicial": { - "type": "string", - "description": "Data inicial do script", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data final do script", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Informe se o script está ativo ou não" - }, - "prioridade": { - "type": "integer", - "description": "Prioridade do script", - "format": "int32" - }, - "posicao": { - "type": "string", - "description": "Posição do script", - "enum": [ - "HeaderPrimeiraLinha", - "HeaderUltimaLinha", - "BodyPrimeiraLinha", - "BodyUltimaLinha", - "FooterPrimeiraLinha", - "FooterUltimeLinha" - ] - }, - "tipoPagina": { - "type": "string", - "description": "Tipo da página do script", - "enum": [ - "Todas", - "Home", - "Busca", - "Categoria", - "Fabricante", - "Estaticas", - "Produto", - "Carrinho" - ] - }, - "identificadorPagina": { - "type": "string", - "description": "Identificador da página" - }, - "conteudo": { - "type": "string", - "description": "Conteúdo do script" - }, - "publicado": { - "type": "boolean", - "description": "Status do script" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b44f64c35c270014666e56" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json b/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json deleted file mode 100644 index ad7bffef9..000000000 --- a/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json +++ /dev/null @@ -1,154 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers": { - "post": { - "summary": "Insere um novo Seller no marketplace", - "description": "", - "operationId": "insere-um-novo-seller-no-marketplace", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "razaoSocial": { - "type": "string", - "description": "Razão Social/Nome do Reseller" - }, - "cnpj": { - "type": "string", - "description": "CNPJ do Seller" - }, - "inscricaoEstadual": { - "type": "string", - "description": "Inscrição Estadual do Seller" - }, - "isento": { - "type": "boolean", - "description": "Seller isento de inscrição estadual" - }, - "email": { - "type": "string", - "description": "Email de contato do Seller" - }, - "telefone": { - "type": "string", - "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" - }, - "tipoAutonomia": { - "type": "string", - "description": "Tipo de autonomia do vendedor", - "enum": [ - "ComAutonomia", - "SemAutonomia" - ] - }, - "ativo": { - "type": "boolean", - "description": "Seller Ativo" - }, - "split": { - "type": "boolean", - "description": "Se irá ter Split de frete boolean. Default:false" - }, - "buyBox": { - "type": "boolean", - "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," - }, - "cep": { - "type": "string", - "description": "Cep do Seller (utilizado para o calculo de frete)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d1bf29766c65003571b218" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json b/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json deleted file mode 100644 index f4c5fa6d5..000000000 --- a/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json +++ /dev/null @@ -1,191 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento": { - "post": { - "summary": "Insere um novo tipo de evento", - "description": "", - "operationId": "insere-um-novo-tipo-de-evento", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do Tipo de Evento" - }, - "tipoEntrega": { - "type": "string", - "description": "Tipo de entrega", - "enum": [ - "EntregaAgendada", - "EntregaConformeCompraRealizada", - "Todos", - "Nenhum" - ] - }, - "tipoDisponibilizacao": { - "type": "string", - "description": "Disponibilização do Tipo de Evento", - "enum": [ - "DisponibilizacaoDeCreditos", - "DisponibilizacaoDeProdutos", - "Todos" - ] - }, - "permitirRemocaoAutomaticaProdutos": { - "type": "boolean", - "description": "Permissão para remoção automática de produtos" - }, - "corHexTituloInformacoes": { - "type": "string", - "description": "Cor em hexadecimal para o titulo de informações" - }, - "corHexCorpoInformacoes": { - "type": "string", - "description": "Cor em hexadecimal para o corpo de informações" - }, - "numeroAbasInformacoes": { - "type": "integer", - "description": "Número de abas de informações, podendo ser de 1 a 2", - "format": "int32" - }, - "quantidadeDiasParaEventoExpirar": { - "type": "integer", - "description": "Quantidade de dias para que o evento expire", - "format": "int32" - }, - "numeroLocaisEvento": { - "type": "integer", - "description": "Quantidade de locais do evento", - "format": "int32" - }, - "ativo": { - "type": "boolean", - "description": "Informa se o evento está ativo ou inativo" - }, - "disponivel": { - "type": "boolean", - "description": "Informa a disponibilidade do evento" - }, - "tipoBeneficiarioFrete": { - "type": "string", - "description": "O beneficiário do frete", - "enum": [ - "DonodaLista", - "Convidado" - ] - }, - "imagemLogoEvento": { - "type": "string", - "description": "Imagem da logo do evento em base64" - }, - "sugestaoProdutos": { - "type": "array", - "description": "Produtos Sugeridos para este evento (optional)", - "items": { - "properties": { - "tipoEventoId": { - "type": "integer", - "description": "Id do tipo de evento", - "format": "int32" - }, - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62cedb444f456f02b7fbbc5e" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-usuario.openapi.json b/wake/utils/openapi/insere-um-novo-usuario.openapi.json deleted file mode 100644 index b0dc5e53a..000000000 --- a/wake/utils/openapi/insere-um-novo-usuario.openapi.json +++ /dev/null @@ -1,228 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios": { - "post": { - "summary": "Insere um novo usuário", - "description": "", - "operationId": "insere-um-novo-usuario", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tipoPessoa": { - "type": "string", - "description": "Tipo de pessoa", - "enum": [ - "Fisica", - "Juridica" - ] - }, - "origemContato": { - "type": "string", - "description": "Origem do contato", - "enum": [ - "Google", - "Bing", - "Jornal", - "PatrocinioEsportivo", - "RecomendacaoAlguem", - "Revista", - "SiteInternet", - "Televisao", - "Outro", - "UsuarioImportadoViaAdmin", - "PayPalExpress" - ] - }, - "tipoSexo": { - "type": "string", - "description": "Tipo Sexo (optional)", - "enum": [ - "Undefined", - "Masculino", - "Feminino" - ] - }, - "nome": { - "type": "string", - "description": "Nome do usuário (Max Length: 100)" - }, - "cpf": { - "type": "string", - "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "email": { - "type": "string", - "description": "E-mail do usuário (Max Length: 100)" - }, - "rg": { - "type": "string", - "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" - }, - "telefoneResidencial": { - "type": "string", - "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" - }, - "telefoneCelular": { - "type": "string", - "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" - }, - "telefoneComercial": { - "type": "string", - "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" - }, - "dataNascimento": { - "type": "string", - "description": "Data de nascimento (optional)", - "format": "date" - }, - "razaoSocial": { - "type": "string", - "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" - }, - "cnpj": { - "type": "string", - "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "inscricaoEstadual": { - "type": "string", - "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" - }, - "responsavel": { - "type": "string", - "description": "Responsável(Max Length: 100) (optional)" - }, - "dataCriacao": { - "type": "string", - "description": "Data de criação do cadastro (optional)", - "format": "date" - }, - "dataAtualizacao": { - "type": "string", - "description": "Data de atualização do cadastro (optional)", - "format": "date" - }, - "revendedor": { - "type": "boolean", - "description": "Se o usuário é revendedor (optional)" - }, - "listaInformacaoCadastral": { - "type": "array", - "description": "Informação cadastral (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave" - }, - "valor": { - "type": "string", - "description": "Valor" - } - }, - "type": "object" - } - }, - "avatar": { - "type": "string", - "description": "Avatar (Max Length: 50) (optional)" - }, - "ip": { - "type": "string", - "description": "IP do usuário (Max Length: 20) (optional)" - }, - "aprovado": { - "type": "boolean", - "description": "Seta ou retorna o valor de Aprovado (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id do usuário gerado": { - "value": "Id do usuário gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d84176895f5d001468e6a4" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json b/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json deleted file mode 100644 index 28264aded..000000000 --- a/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json +++ /dev/null @@ -1,180 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo/metaTag": { - "post": { - "summary": "Insere um ou mais metatags para um produto", - "description": "", - "operationId": "insere-um-ou-mais-metatags-para-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Identificador do produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno da fstore", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "metas": { - "type": "array", - "description": "Lista de metatags (optional)", - "items": { - "properties": { - "content": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "httpEquiv": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "name": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "scheme": { - "type": "string", - "description": "Dados da Meta Tag" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "metatagId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "content": { - "type": "string", - "example": "string" - }, - "httpEquiv": { - "type": "string", - "example": "string" - }, - "name": { - "type": "string", - "example": "string" - }, - "scheme": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c5787bf8681e009e301a83" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json b/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json deleted file mode 100644 index ff8a64fa8..000000000 --- a/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}/rangeCep": { - "post": { - "summary": "Insere um range de cep em uma Loja Física", - "description": "", - "operationId": "insere-um-range-de-cep-em-uma-loja-fisica", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do range de cep" - }, - "cepInicial": { - "type": "string", - "description": "Cep inicial do range. Formato: 00.000-000" - }, - "cepFinal": { - "type": "string", - "description": "Cep final do range. Formato: 00.000-000" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b9b945ae523a00681ad134" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json deleted file mode 100644 index 879e8f9a9..000000000 --- a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento": { - "post": { - "summary": "Insere um rastreamento e status a um pedido", - "description": "", - "operationId": "insere-um-rastreamento-e-status-a-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Id do Pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "situacaoPedidoId": { - "type": "integer", - "description": "Id da situação do pedido", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição", - "format": "int32" - }, - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "dataEvento": { - "type": "string", - "description": "Data do pedido (optional)", - "format": "date" - }, - "numeroNotaFiscal": { - "type": "string", - "description": "Número da nota fiscal (optional)" - }, - "chaveAcessoNFE": { - "type": "string", - "description": "Chave acesso NFE (optional)" - }, - "urlNFE": { - "type": "string", - "description": "URL NFE (optional)" - }, - "serieNFE": { - "type": "string", - "description": "Serie NFE (optional)" - }, - "cfop": { - "type": "string", - "description": "CFOP (optional)" - }, - "urlRastreamento": { - "type": "string", - "description": "URL Rastreamento (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb11b77b19e300fd2d9070" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json deleted file mode 100644 index e584357ae..000000000 --- a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento": { - "post": { - "summary": "Insere um rastreamento e status a um produto variante", - "description": "", - "operationId": "insere-um-rastreamento-e-status-a-um-produto-variante", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Id do produto variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "situacaoPedidoId": { - "type": "integer", - "description": "Id da situação do pedido", - "format": "int32" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade (optional)", - "format": "int32" - }, - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição", - "format": "int32" - }, - "rastreamento": { - "type": "string", - "description": "Rastreamento (optional)" - }, - "dataEvento": { - "type": "string", - "description": "Data (optional)", - "format": "date" - }, - "numeroNotaFiscal": { - "type": "string", - "description": "Número da nota fiscal (optional)" - }, - "chaveAcessoNFE": { - "type": "string", - "description": "Chave de acesso NFE (optional)" - }, - "urlNFE": { - "type": "string", - "description": "URL NFE (optional)" - }, - "serieNFE": { - "type": "string", - "description": "Serie NFE (optional)" - }, - "cfop": { - "type": "integer", - "description": "CFOP (optional)", - "format": "int32" - }, - "urlRastreamento": { - "type": "string", - "description": "URL de rastreamento (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bd8a130b1de500144fc9db" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json b/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json deleted file mode 100644 index f22406160..000000000 --- a/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/seo": { - "post": { - "summary": "Insere um SEO para um produto específico", - "description": "", - "operationId": "insere-um-seo-para-um-produto-especifico", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoId", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "tagCanonical": { - "type": "string", - "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" - }, - "title": { - "type": "string", - "description": "Informe o title da página do produto (optional)" - }, - "metaTags": { - "type": "array", - "description": "Informe os dados da Meta Tag (optional)", - "items": { - "properties": { - "content": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "httpEquiv": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "name": { - "type": "string", - "description": "Dados da Meta Tag" - }, - "scheme": { - "type": "string", - "description": "Dados da Meta Tag" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c49b1d38e2fb0031bb3c8d" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json b/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json deleted file mode 100644 index a1b6fad23..000000000 --- a/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json +++ /dev/null @@ -1,192 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtoavaliacao/{identificador}": { - "post": { - "summary": "Insere uma avaliação para um produto variante", - "description": "", - "operationId": "insere-uma-avaliacao-para-um-produto-variante", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno da fstore", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "comentario": { - "type": "string", - "description": "Texto referente a avaliação do produto" - }, - "avaliacao": { - "type": "integer", - "description": "Escala de 1 a 5 para avaliar o produto", - "format": "int32" - }, - "usuarioId": { - "type": "integer", - "description": "Identificado do usuário", - "format": "int32" - }, - "dataAvaliacao": { - "type": "string", - "description": "Referente a data que a avaliação foi criada", - "format": "date" - }, - "nome": { - "type": "string", - "description": "Nome do usuário que avaliou" - }, - "email": { - "type": "string", - "description": "Email do usuário que avaliou" - }, - "status": { - "type": "string", - "description": "Referente ao status que libera a visualização da avaliação no site", - "enum": [ - "Pendente", - "NaoAprovado", - "Aprovado" - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d06c986bf8eb00583fef1d" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-inscricao.openapi.json b/wake/utils/openapi/insere-uma-inscricao.openapi.json deleted file mode 100644 index 01c312544..000000000 --- a/wake/utils/openapi/insere-uma-inscricao.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/webhook/inscricao": { - "post": { - "summary": "Insere uma inscrição", - "description": "", - "operationId": "insere-uma-inscricao", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "topicos" - ], - "properties": { - "nome": { - "type": "string", - "description": "Nome da inscrição" - }, - "appUrl": { - "type": "string", - "description": "Url para qual deve ser enviada as notificações" - }, - "topicos": { - "type": "array", - "description": "Tópicos em que deseja se inscrever", - "items": { - "type": "string" - } - }, - "usuario": { - "type": "string", - "description": "Usuário que está realizando a inscrição" - }, - "ativo": { - "type": "boolean", - "description": "Status da inscrição, se ativada ou desativada" - }, - "emailResponsavel": { - "type": "string", - "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" - }, - "headers": { - "type": "array", - "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", - "items": { - "properties": { - "chave": { - "type": "string", - "description": "Chave do header, por exemplo: 'Authorization'" - }, - "valor": { - "type": "string", - "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb51dbfe13b702bcabb9e0" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-loja-fisica.openapi.json b/wake/utils/openapi/insere-uma-loja-fisica.openapi.json deleted file mode 100644 index e296fe2e0..000000000 --- a/wake/utils/openapi/insere-uma-loja-fisica.openapi.json +++ /dev/null @@ -1,239 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas": { - "post": { - "summary": "Insere uma Loja Física", - "description": "", - "operationId": "insere-uma-loja-fisica", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "description": "Id da loja (optional)", - "format": "int32" - }, - "nome": { - "type": "string", - "description": "Nome da loja (optional)" - }, - "ddd": { - "type": "integer", - "description": "DDD da localidade de destino da loja (optional)", - "format": "int32" - }, - "telefone": { - "type": "string", - "description": "Telefone da loja (optional)" - }, - "email": { - "type": "string", - "description": "E-mail de contato da loja (optional)" - }, - "cep": { - "type": "string", - "description": "CEP do endereço da loja (optional)" - }, - "logradouro": { - "type": "string", - "description": "Logradouro do endereço da loja (optional)" - }, - "numero": { - "type": "string", - "description": "Número de localização do endereço da loja (optional)" - }, - "complemento": { - "type": "string", - "description": "Complemento para localização da loja (optional)" - }, - "bairro": { - "type": "string", - "description": "Bairro do endereço do loja (optional)" - }, - "cidade": { - "type": "string", - "description": "Cidade em que a loja se encontra (optional)" - }, - "estadoId": { - "type": "integer", - "description": "Id do estado em que a loja se encontra (optional)", - "format": "int32" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega (optional)", - "format": "int32" - }, - "prazoMaximoRetirada": { - "type": "integer", - "description": "Prazo máximo para retirada (optional)", - "format": "int32" - }, - "ativo": { - "type": "boolean", - "description": "Status da loja (optional)" - }, - "valido": { - "type": "boolean", - "description": "Valido (optional)" - }, - "textoComplementar": { - "type": "string", - "description": "Informações complementares da loja (optional)" - }, - "retirarNaLoja": { - "type": "boolean", - "description": "Se a retirada na loja será ativada (optional)" - }, - "latitude": { - "type": "number", - "description": "Latitude (optional)", - "format": "double" - }, - "longitude": { - "type": "number", - "description": "Longitude (optional)", - "format": "double" - }, - "centroDistribuicao": { - "type": "array", - "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", - "items": { - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "description": "Id do centro de distribuição", - "format": "int32" - }, - "prazoEntrega": { - "type": "integer", - "description": "Prazo de entrega", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5f0cf26899305a6f7ea96" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-nova-categoria.openapi.json b/wake/utils/openapi/insere-uma-nova-categoria.openapi.json deleted file mode 100644 index 735beadad..000000000 --- a/wake/utils/openapi/insere-uma-nova-categoria.openapi.json +++ /dev/null @@ -1,177 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias": { - "post": { - "summary": "Insere uma nova categoria", - "description": "", - "operationId": "insere-uma-nova-categoria", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome da categoria (optional)" - }, - "categoriaPaiId": { - "type": "integer", - "description": "Id da categoria pai (optional)", - "format": "int32" - }, - "categoriaERPId": { - "type": "string", - "description": "Id da categoria ERP (optional)" - }, - "ativo": { - "type": "boolean", - "description": "Categoria ativo/inativo (optional)" - }, - "isReseller": { - "type": "boolean", - "description": "Categoria de reseller (optional)" - }, - "exibirMatrizAtributos": { - "type": "string", - "description": "Exibir Matriz de Atributos (optional)", - "enum": [ - "Sim", - "Nao", - "Neutro" - ] - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", - "format": "int32" - }, - "valorMinimoCompra": { - "type": "number", - "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", - "format": "double" - }, - "exibeMenu": { - "type": "boolean", - "description": "Informe se será exibida no menu (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id da categoria gerada": { - "value": "\tId da categoria gerada" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a9e9ff320058003cb2c812" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json b/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json deleted file mode 100644 index 1ccb7e22b..000000000 --- a/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json +++ /dev/null @@ -1,120 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos": { - "post": { - "summary": "Insere uma nova tabela de preços", - "description": "", - "operationId": "insere-uma-nova-tabela-de-precos", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome da tabela de preço" - }, - "dataInicial": { - "type": "string", - "description": "Data que inicia a tabela de preço", - "format": "date" - }, - "dataFinal": { - "type": "string", - "description": "Data de término da tabela de preço", - "format": "date" - }, - "ativo": { - "type": "boolean", - "description": "Status da tabela de preço" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id da tabela de preços gerado": { - "value": "Id da tabela de preços gerado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a74857fb2e00a66e7ab3" -} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json b/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json deleted file mode 100644 index a469799ea..000000000 --- a/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/gestorscripts/scripts/{scriptId}/versoes": { - "post": { - "summary": "Insere uma versão para um script existente", - "description": "", - "operationId": "insere-uma-versao-para-um-script-existente", - "parameters": [ - { - "name": "scriptId", - "in": "path", - "description": "Id do script", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "identificadorPagina": { - "type": "string", - "description": "Identificador da página" - }, - "conteudo": { - "type": "string", - "description": "Conteúdo do script" - }, - "publicado": { - "type": "boolean", - "description": "Status do script" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b46898ef4727006dee2c10" -} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json deleted file mode 100644 index 92671a6bd..000000000 --- a/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,187 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}/produtos": { - "post": { - "summary": "Inseri uma lista de produto variantes em uma tabela de preços", - "description": "", - "operationId": "inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de produtos variantes", - "items": { - "properties": { - "sku": { - "type": "string", - "description": "SKU do produto" - }, - "precoDe": { - "type": "number", - "description": "Preço De do produto", - "format": "double" - }, - "precoPor": { - "type": "number", - "description": "Preço Por do produto", - "format": "double" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Lista com o retorno do processamento dos produtos enviados": { - "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "sucesso": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "erro": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sku": { - "type": "string", - "example": "string" - }, - "resultado": { - "type": "boolean", - "example": true, - "default": true - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a9fe4960ff007e2e25d5" -} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json deleted file mode 100644 index 010e2b271..000000000 --- a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/observacao": { - "post": { - "summary": "Insere uma observação a um pedido", - "description": "", - "operationId": "inseri-uma-observacao-a-um-pedido-1", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Objeto com os dados da observação (optional)", - "properties": { - "observacao": { - "type": "string", - "description": "Texto da observação" - }, - "usuario": { - "type": "string", - "description": "Nome do usuário que está inserindo a observação" - }, - "publica": { - "type": "boolean", - "description": "Se a observação é publica ou privada" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb3bc41fe5a9003e92271a" -} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json deleted file mode 100644 index 9c4e48545..000000000 --- a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/observacao": { - "get": { - "summary": "Retorna a observação de um pedido", - "description": "Lista de observações de um pedido", - "operationId": "inseri-uma-observacao-a-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"publica\": true,\n \"data\": \"2022-06-28T11:18:19.263Z\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "observacao": { - "type": "string", - "example": "string" - }, - "usuario": { - "type": "string", - "example": "string" - }, - "publica": { - "type": "boolean", - "example": true, - "default": true - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.263Z" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb3a3b0a861a04b9dd482b" -} \ No newline at end of file diff --git a/wake/utils/openapi/inserir-autor.openapi.json b/wake/utils/openapi/inserir-autor.openapi.json deleted file mode 100644 index 4c4fcda8a..000000000 --- a/wake/utils/openapi/inserir-autor.openapi.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autores": { - "post": { - "summary": "Inserir autor", - "description": "", - "operationId": "inserir-autor", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "description": "Nome do Autor" - }, - "ativo": { - "type": "boolean", - "description": "Status do autor" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0fedceb452400b2cca404" -} \ No newline at end of file diff --git a/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json b/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json deleted file mode 100644 index 29787fc65..000000000 --- a/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/liberarReservas": { - "post": { - "summary": "Liberar reservas de pedidos", - "description": "", - "operationId": "liberar-reservas-de-pedidos", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Números dos pedidos que se deseja buscar", - "items": { - "type": "integer", - "format": "int64" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb3420b31f30003d9e5990" -} \ No newline at end of file diff --git a/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json b/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json deleted file mode 100644 index 293b5abe4..000000000 --- a/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autenticacao/login": { - "post": { - "summary": "Realiza a autenticação de usuário no IDM (Identity Manager)", - "description": "Autenticação realizada com sucesso", - "operationId": "realiza-a-autenticacao-de-usuario-no-idm-identity-manager", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "login": { - "type": "string", - "description": "Login do usuário (optional)" - }, - "senha": { - "type": "string", - "description": "Senha do usuário (optional)" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "401": { - "description": "401", - "content": { - "application/json": { - "examples": { - "Usuário não autorizado": { - "value": "" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a224cf02d3d104ac570a4f" -} \ No newline at end of file diff --git a/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json b/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json deleted file mode 100644 index 4fd654d1a..000000000 --- a/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/contascorrentes/{email}": { - "post": { - "summary": "Realiza um novo lançamento na conta corrente do cliente", - "description": "", - "operationId": "realiza-um-novo-lancamento-na-conta-corrente-do-cliente", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "valor": { - "type": "number", - "description": "Valor da conta corrente (optional)", - "format": "double" - }, - "tipoLancamento": { - "type": "string", - "description": "Tipo de Lançamento (optional)", - "enum": [ - "Credito", - "Debito" - ] - }, - "observacao": { - "type": "string", - "description": "Observação (optional)" - }, - "visivelParaCliente": { - "type": "boolean", - "description": "Se será visível para o cliente (optional)" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Id da conta corrente gerada": { - "value": "\tId da conta corrente gerada" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa28db2ce54d00f9ba1799" -} \ No newline at end of file diff --git a/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json b/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json deleted file mode 100644 index 79f36ef94..000000000 --- a/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json +++ /dev/null @@ -1,238 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/cotacoes": { - "post": { - "summary": "Realiza uma cotação de frete", - "description": "Método que realiza uma cotação de frete", - "operationId": "realiza-uma-cotacao-de-frete", - "parameters": [ - { - "name": "cep", - "in": "query", - "description": "Cep de entrega", - "schema": { - "type": "string" - } - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno da fstore", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "retiradaLoja", - "in": "query", - "description": "Define se deve retornar as opções de retirada em loja (\"False\" por padrão) (optional)", - "schema": { - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "valorTotal": { - "type": "number", - "description": "Valor total do pedido (optional)", - "format": "double" - }, - "produtos": { - "type": "array", - "description": "Lista de produtos da cotação", - "items": { - "properties": { - "identificador": { - "type": "string", - "description": "Id do produto variante" - }, - "quantidade": { - "type": "integer", - "description": "Quantidade do produto", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tabelaFreteId": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d58a11a77e00940d9613" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json deleted file mode 100644 index c069c2052..000000000 --- a/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { - "delete": { - "summary": "Remove o vinculo de produtos de um Grupo de Personalização", - "description": "", - "operationId": "remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao", - "parameters": [ - { - "name": "grupoPersonalizacaoId", - "in": "path", - "description": "Id do grupo de personalização", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de Id dos produtos", - "items": { - "properties": { - "produtoId": { - "type": "integer", - "description": "Id do produto", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5bc15d737210013d9c741" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json deleted file mode 100644 index 428cd25c1..000000000 --- a/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/parceiro": { - "delete": { - "summary": "Remove o vínculo entre usuário e parceiro", - "description": "", - "operationId": "remove-o-vinculo-entre-usuario-e-parceiro", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "description": "Número identificador do parceiro (Max Length: 4)", - "format": "int32" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de90af7f1a57005c9d9eb3" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-atacarejo.openapi.json b/wake/utils/openapi/remove-um-atacarejo.openapi.json deleted file mode 100644 index e267df3ec..000000000 --- a/wake/utils/openapi/remove-um-atacarejo.openapi.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { - "delete": { - "summary": "Remove um Atacarejo", - "description": "", - "operationId": "remove-um-atacarejo", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "produtoVarianteAtacadoId", - "in": "path", - "description": "Id do Atacarejo", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c494d0b10de9008e230508" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json b/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json deleted file mode 100644 index 2aae960fe..000000000 --- a/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/camposcadastropersonalizado/{camposcadastropersonalizadoId}": { - "delete": { - "summary": "Remove um campo de cadastro personalizado", - "description": "", - "operationId": "remove-um-campo-de-cadastro-personalizado", - "parameters": [ - { - "name": "camposcadastropersonalizadoId", - "in": "path", - "description": "Id do campo de cadastro personalizado", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec8a330c41d03ec86195a" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json b/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json deleted file mode 100644 index 2d50ad2fe..000000000 --- a/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}/{sku}": { - "delete": { - "summary": "Remove um produto de uma tabela de preço", - "description": "", - "operationId": "remove-um-produto-de-uma-tabela-de-preco", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "sku", - "in": "path", - "description": "SKU do produto", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6aba558d7ad0277606612" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json b/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json deleted file mode 100644 index 06991844a..000000000 --- a/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/valoresdefinidoscadastropersonalizado/{valoresDefinidosCampoGrupoInformacaoId}": { - "delete": { - "summary": "Remove um valor pré definido", - "description": "", - "operationId": "remove-um-valor-pre-definido", - "parameters": [ - { - "name": "valoresDefinidosCampoGrupoInformacaoId", - "in": "path", - "description": "Id dos valores definidos no campo grupo informação", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec9cb22add500fbf7fa8c" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json b/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json deleted file mode 100644 index bc45ef886..000000000 --- a/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}/rangeCep": { - "delete": { - "summary": "Remove uma lista de range de cep de uma Loja Física", - "description": "", - "operationId": "remove-uma-lista-de-range-de-cep-de-uma-loja-fisica", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de range de cep a serem excluídos da loja física", - "items": { - "properties": { - "rangeCepId": { - "type": "integer", - "description": "Id da faixa de cep a ser deletado", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b9b784d123d90044a22b2c" -} \ No newline at end of file diff --git a/wake/utils/openapi/remove-uma-loja-fisica.openapi.json b/wake/utils/openapi/remove-uma-loja-fisica.openapi.json deleted file mode 100644 index c0bf23255..000000000 --- a/wake/utils/openapi/remove-uma-loja-fisica.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}": { - "delete": { - "summary": "Remove uma Loja Física", - "description": "", - "operationId": "remove-uma-loja-fisica", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b99952fca2be0056fd9b64" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json b/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json deleted file mode 100644 index afa346e49..000000000 --- a/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}/produtos": { - "get": { - "summary": "Retorna a lista de produtos de um portfolio", - "description": "Retorna a lista de produtos de um portfolio", - "operationId": "retorna-a-lista-de-produtos-de-um-portfolio", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja buscar os produtos", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef325f0a9ef006b096d11" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json b/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json deleted file mode 100644 index 899c50215..000000000 --- a/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/situacaoReseller": { - "get": { - "summary": "Retorna a situação reseller de um produto", - "description": "", - "operationId": "retorna-a-situacao-reseller-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c43f8a273b800036c3a336" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json deleted file mode 100644 index a3fe648c1..000000000 --- a/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/avatar": { - "get": { - "summary": "Retorna a url do avatar de um usuário", - "description": "Avatar do usuário encontrado", - "operationId": "retorna-a-url-do-avatar-de-um-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"urlAvatar\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "urlAvatar": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec2a6a17bb80165cf956e" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json b/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json deleted file mode 100644 index 78a38bee2..000000000 --- a/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/erros": { - "get": { - "summary": "Retorna as assinaturas com erros", - "description": "Assinaturas com erro na loja", - "operationId": "retorna-as-assinaturas-com-erros", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "resolvidos", - "in": "query", - "description": "Erros já resolvidos ou não", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.560Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0b2e0d9f32a0562852efd" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json b/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json deleted file mode 100644 index a616fd918..000000000 --- a/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json +++ /dev/null @@ -1,228 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{email}": { - "get": { - "summary": "Retorna as assinaturas de um determinado usuário", - "description": "Produtos de uma assinatura", - "operationId": "retorna-as-assinaturas-de-um-determinado-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "e-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.170Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.170Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataProximoPedido": { - "type": "string", - "example": "2022-06-13T11:13:55.170Z" - }, - "periodoRecorrencia": { - "type": "string", - "example": "string" - }, - "situacaoAssinatura": { - "type": "string", - "example": "Ativa" - }, - "dataAssinatura": { - "type": "string", - "example": "2022-06-13T11:13:55.170Z" - }, - "grupoAssinatura": { - "type": "string", - "example": "string" - }, - "enderecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioCartaoCreditoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupom": { - "type": "string", - "example": "string" - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a720b61558d3003f1f3f21" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json b/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json deleted file mode 100644 index cf1927fd9..000000000 --- a/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/recorrencias": { - "get": { - "summary": "Retorna as recorrências cadastradas na loja", - "description": "Recorrências cadastradas na loja", - "operationId": "retorna-as-recorrencias-cadastradas-na-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"recorrencias\": [\n \"string\"\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "recorrencias": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a72307d7a8100053919a2a" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-da-loja.openapi.json b/wake/utils/openapi/retorna-dados-da-loja.openapi.json deleted file mode 100644 index a96d01eb6..000000000 --- a/wake/utils/openapi/retorna-dados-da-loja.openapi.json +++ /dev/null @@ -1,139 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/loja": { - "get": { - "summary": "Retorna dados da loja", - "description": "Dados da loja", - "operationId": "retorna-dados-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"nome\": \"string\",\n \"urlSite\": \"string\",\n \"urlCarrinho\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "urlSite": { - "type": "string", - "example": "string" - }, - "urlCarrinho": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "400": { - "description": "400", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5ee235e44b60096d8d631" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json b/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json deleted file mode 100644 index 1771d8cb6..000000000 --- a/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/graficoformapagamento": { - "get": { - "summary": "Retorna dados para alimentar o gráfico forma de pagamento", - "description": "Gráfico Forma de Pagamento", - "operationId": "retorna-dados-para-alimentar-o-grafico-forma-de-pagamento", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "parceiroId", - "in": "query", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"cor\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4150a7e261001ab102fc" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json b/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json deleted file mode 100644 index e8771f382..000000000 --- a/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json +++ /dev/null @@ -1,196 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/graficofaturamento": { - "get": { - "summary": "Retorna dados para carregar o gráfico do faturamento", - "description": "Gráfico do Faturamento", - "operationId": "retorna-dados-para-carregar-o-grafico-do-faturamento", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial do faturamento que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final do faturamento que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "isLoja", - "in": "query", - "description": "Se o faturamento é somente da loja", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "parceiroId", - "in": "query", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"parceiroId\": 0,\n \"parceiro\": \"string\",\n \"receitaPagos\": 0,\n \"transacoesPagos\": 0,\n \"valorMedioPagos\": 0,\n \"usuarioEnderecoEstado\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "parceiro": { - "type": "string", - "example": "string" - }, - "receitaPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "transacoesPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMedioPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioEnderecoEstado": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa369bf08a61002e60f7c3" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json b/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json deleted file mode 100644 index 88e00f0a1..000000000 --- a/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json +++ /dev/null @@ -1,231 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/faturamento": { - "get": { - "summary": "Retorna indicadores de faturamento (receita, ticket médio e número de pedidos) da loja", - "description": "Indicadores de Faturamento", - "operationId": "retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos indicadores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos indicadores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataInicialComparativo", - "in": "query", - "description": "Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinalComparativo", - "in": "query", - "description": "Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"indicadorReceita\": 0,\n \"indicadorPedido\": 0,\n \"indicadorTicketMedio\": 0,\n \"indicadorReceitaComparativo\": 0,\n \"indicadorPedidoComparativo\": 0,\n \"indicadorTicketMedioComparativo\": 0,\n \"indicadorReceitaFormatado\": \"string\",\n \"indicadorPedidoFormatado\": \"string\",\n \"indicadorTicketMedioFormatado\": \"string\",\n \"indicadorReceitaComparativoFormatado\": \"string\",\n \"indicadorPedidoComparativoFormatado\": \"string\",\n \"indicadorTicketMedioComparativoFormatado\": \"string\",\n \"indicadorReceitaPorcentagem\": \"string\",\n \"indicadorPedidoPorcentagem\": \"string\",\n \"indicadorTicketMedioPorcentagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "indicadorReceita": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorPedido": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorTicketMedio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorReceitaComparativo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorPedidoComparativo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorTicketMedioComparativo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "indicadorReceitaFormatado": { - "type": "string", - "example": "string" - }, - "indicadorPedidoFormatado": { - "type": "string", - "example": "string" - }, - "indicadorTicketMedioFormatado": { - "type": "string", - "example": "string" - }, - "indicadorReceitaComparativoFormatado": { - "type": "string", - "example": "string" - }, - "indicadorPedidoComparativoFormatado": { - "type": "string", - "example": "string" - }, - "indicadorTicketMedioComparativoFormatado": { - "type": "string", - "example": "string" - }, - "indicadorReceitaPorcentagem": { - "type": "string", - "example": "string" - }, - "indicadorPedidoPorcentagem": { - "type": "string", - "example": "string" - }, - "indicadorTicketMedioPorcentagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa3538d6fe640062ab9c55" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json b/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json deleted file mode 100644 index bbfc9885e..000000000 --- a/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json +++ /dev/null @@ -1,168 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/atacarejo": { - "get": { - "summary": "Retorna Lista de Atacarejos do Produto Variante", - "description": "Lista de Atacarejos", - "operationId": "retorna-lista-de-atacarejos-do-produto-variante", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtacadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoAtacado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4926cdd3939006bc5477a" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-eventos.openapi.json b/wake/utils/openapi/retorna-lista-de-eventos.openapi.json deleted file mode 100644 index 2b1dd9b23..000000000 --- a/wake/utils/openapi/retorna-lista-de-eventos.openapi.json +++ /dev/null @@ -1,363 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos": { - "get": { - "summary": "Retorna lista de eventos", - "description": "Lista de produtos variantes vinculados aos tipo de evento", - "operationId": "retorna-lista-de-eventos", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data de inicio do evento", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data do termino do evento", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "disponivel", - "in": "query", - "description": "Status do evento", - "schema": { - "type": "boolean" - } - }, - { - "name": "titulo", - "in": "query", - "description": "Titulo do evento", - "schema": { - "type": "string" - } - }, - { - "name": "usuarioEmail", - "in": "query", - "description": "Email do Usuário", - "schema": { - "type": "string" - } - }, - { - "name": "tipoEventoId", - "in": "query", - "description": "Identificador do Tipo de Evento", - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.747Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.747Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "userId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "enderecoEntregaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-17T11:14:38.747Z" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-17T11:14:38.747Z" - }, - "titulo": { - "type": "string", - "example": "string" - }, - "url": { - "type": "string", - "example": "string" - }, - "disponivel": { - "type": "boolean", - "example": true, - "default": true - }, - "diasDepoisEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "diasAntesEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "urlLogoEvento": { - "type": "string", - "example": "string" - }, - "urlCapaEvento": { - "type": "string", - "example": "string" - }, - "proprietarioEvento": { - "type": "string", - "example": "string" - }, - "abaInfo01Habilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "textoInfo01": { - "type": "string", - "example": "string" - }, - "conteudoInfo01": { - "type": "string", - "example": "string" - }, - "abaInfo02Habilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "textoInfo02": { - "type": "string", - "example": "string" - }, - "conteudoInfo02": { - "type": "string", - "example": "string" - }, - "abaMensagemHabilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "fotos": { - "type": "string", - "example": "string" - }, - "enumTipoListaPresenteId": { - "type": "string", - "example": "Default" - }, - "enumTipoEntregaId": { - "type": "string", - "example": "EntregaAgendada" - }, - "eventoProdutoSelecionado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "recebidoForaLista": { - "type": "boolean", - "example": true, - "default": true - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "enderecoEvento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "enderecoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac7bac971c6000a1704904" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json b/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json deleted file mode 100644 index ff1f45c65..000000000 --- a/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/newsletter": { - "get": { - "summary": "Retorna lista de usuários cadastrados/descadastrados na newsletter", - "description": "Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página)", - "operationId": "retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter", - "parameters": [ - { - "name": "ordenarPor", - "in": "query", - "description": "Tipo de ordenação", - "schema": { - "type": "string", - "enum": [ - "DataCadastro", - "DataAtualizacao" - ] - } - }, - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "status", - "in": "query", - "description": "Status do usuário", - "schema": { - "type": "boolean" - } - }, - { - "name": "doubleOptIn", - "in": "query", - "description": "DoubleOptIn aceito (verificar estado da configuração)", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "[\n {\n \"nome\": \"string\",\n \"email\": \"string\",\n \"sexo\": \"string\",\n \"status\": true,\n \"grupoInformacao\": [\n {\n \"nome\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "sexo": { - "type": "string", - "example": "string" - }, - "status": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de9b925c29e9001aac9006" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json b/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json deleted file mode 100644 index 3b9b6a30e..000000000 --- a/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json +++ /dev/null @@ -1,252 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}": { - "get": { - "summary": "Retorna Loja Física pelo Id", - "description": "Loja Física", - "operationId": "retorna-loja-fisica-pelo-id", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ddd": { - "type": "integer", - "example": 0, - "default": 0 - }, - "telefone": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoMaximoRetirada": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "textoComplementar": { - "type": "string", - "example": "string" - }, - "retirarNaLoja": { - "type": "boolean", - "example": true, - "default": true - }, - "latitude": { - "type": "integer", - "example": 0, - "default": 0 - }, - "longitude": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b999e6c7342b00761401c2" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json b/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json deleted file mode 100644 index faf76133c..000000000 --- a/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json +++ /dev/null @@ -1,168 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/estoque": { - "get": { - "summary": "Retorna o estoque total e o estoque por centro de distribuição", - "description": "Objeto com o estoque total e o estoque por centro de distribuição de um produto variante", - "operationId": "retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"listProdutoVarianteCentroDistribuicaoEstoque\": [\n {\n \"centroDistribuicaoId\": 0,\n \"nome\": \"string\",\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "listProdutoVarianteCentroDistribuicaoEstoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4862956685300527c28db" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json deleted file mode 100644 index db3609235..000000000 --- a/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/historicoSituacao": { - "get": { - "summary": "Retorna o histórico de situações de um pedido", - "description": "", - "operationId": "retorna-o-historico-de-situacoes-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Identificador do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"situacoes\": [\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"dataAtualizacao\": \"2022-09-01T13:25:07.718Z\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "situacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-09-01T13:25:07.718Z" - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:6310b4d82785aa001af2f690" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json deleted file mode 100644 index 7c17f5916..000000000 --- a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/limiteCreditoPorEmail/{email}": { - "get": { - "summary": "Retorna o limite de crédito de um usuário específico", - "description": "Limite de crédito de um usuário específico", - "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico-1", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "saldo": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de93b9ce20a30356051482" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json deleted file mode 100644 index a747e263d..000000000 --- a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/limiteCreditoPorUsuarioId/{usuarioId}": { - "get": { - "summary": "Retorna o limite de crédito de um usuário específico", - "description": "Limite de crédito de um usuário específico", - "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "saldo": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de9343e07d3d009caf88a6" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json b/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json deleted file mode 100644 index 5f5b0567c..000000000 --- a/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{parceiroId}": { - "get": { - "summary": "Retorna o parceiro pelo id", - "description": "Parceiro encontrado", - "operationId": "retorna-o-parceiro-pelo-id", - "parameters": [ - { - "name": "parceiroId", - "in": "path", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "marketPlaceId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEscopo": { - "type": "string", - "example": "Aberto" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "origem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb328562b1e00531bf637" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json b/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json deleted file mode 100644 index f9e33488d..000000000 --- a/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{nome}": { - "get": { - "summary": "Retorna o parceiro pelo nome", - "description": "Parceiro encontrado", - "operationId": "retorna-o-parceiro-pelo-nome", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do parceiro", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "marketPlaceId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEscopo": { - "type": "string", - "example": "Aberto" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "origem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb40668e01c003df9743c" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json b/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json deleted file mode 100644 index 562034fa5..000000000 --- a/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}": { - "get": { - "summary": "Retorna o portfolio pelo id", - "description": "Portfolio encontrado", - "operationId": "retorna-o-portfolio-pelo-id", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef21394d3260096d7e47d" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json b/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json deleted file mode 100644 index df5cc57eb..000000000 --- a/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json +++ /dev/null @@ -1,121 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{nome}": { - "get": { - "summary": "Retorna o portfolio pelo nome", - "description": "Portfolio encontrado", - "operationId": "retorna-o-portfolio-pelo-nome", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do portfolio que se deseja buscar", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef2ddb96cca009dc16e6e" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json b/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json deleted file mode 100644 index 63f76c7cd..000000000 --- a/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/preco": { - "get": { - "summary": "Retorna o precoDe e precoPor de um produto", - "description": "Objeto com o precoDe e precoPor de um produto variante", - "operationId": "retorna-o-precode-e-precopor-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c46e8fc4be3400559ac9ae" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json deleted file mode 100644 index 8c50f32cc..000000000 --- a/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json +++ /dev/null @@ -1,198 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/receita": { - "get": { - "summary": "Retorna o relatório de receitas de um determinado período", - "description": "Relatório de receitas de um determinado período", - "operationId": "retorna-o-relatorio-de-receitas-de-um-determinado-periodo", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "tipoAgrupamento", - "in": "query", - "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", - "schema": { - "type": "string", - "enum": [ - "Hora", - "Dia", - "Semana", - "Mes", - "Ano" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.736Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tipoAgrupamento": { - "type": "string", - "example": "Hora" - }, - "dados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "example": "2022-06-17T11:14:38.736Z" - }, - "pedidosCaptados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosEnviados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosCancelados": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4203d0375900704b00f2" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json deleted file mode 100644 index 2b6b0c42d..000000000 --- a/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json +++ /dev/null @@ -1,198 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/ticketMedio": { - "get": { - "summary": "Retorna o relatório de ticket médio de um determinado período", - "description": "Relatório de ticket médio de um determinado período", - "operationId": "retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "tipoAgrupamento", - "in": "query", - "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", - "schema": { - "type": "string", - "enum": [ - "Hora", - "Dia", - "Semana", - "Mes", - "Ano" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.739Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tipoAgrupamento": { - "type": "string", - "example": "Hora" - }, - "dados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "example": "2022-06-17T11:14:38.739Z" - }, - "pedidosCaptados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosEnviados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosCancelados": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4238335a250013ebd023" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json deleted file mode 100644 index 85646d200..000000000 --- a/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json +++ /dev/null @@ -1,198 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/transacoes": { - "get": { - "summary": "Retorna o relatório de transações de um determinado período", - "description": "Relatório de transações de um determinado período", - "operationId": "retorna-o-relatorio-de-transacoes-de-um-determinado-periodo", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "tipoAgrupamento", - "in": "query", - "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", - "schema": { - "type": "string", - "enum": [ - "Hora", - "Dia", - "Semana", - "Mes", - "Ano" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.743Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tipoAgrupamento": { - "type": "string", - "example": "Hora" - }, - "dados": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "example": "2022-06-17T11:14:38.743Z" - }, - "pedidosCaptados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosPagos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosEnviados": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidosCancelados": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa4265f66d9b001a2145a3" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json deleted file mode 100644 index 136819389..000000000 --- a/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json +++ /dev/null @@ -1,133 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/contascorrentes/{email}": { - "get": { - "summary": "Retorna o saldo de um usuário", - "description": "", - "operationId": "retorna-o-saldo-de-um-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa27f6a5716d006d027578" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json deleted file mode 100644 index c78adf599..000000000 --- a/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json +++ /dev/null @@ -1,205 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/status": { - "get": { - "summary": "Retorna o último status de um pedido", - "description": "Último status do pedido", - "operationId": "retorna-o-ultimo-status-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"situacaoPedidoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.193Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.193Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"nomeTransportadora\": \"string\",\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"situacaoProdutoId\": 0,\n \"quantidade\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.193Z" - }, - "notaFiscal": { - "type": "string", - "example": "string" - }, - "cfop": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataEnviado": { - "type": "string", - "example": "2022-06-28T11:18:19.193Z" - }, - "chaveAcessoNFE": { - "type": "string", - "example": "string" - }, - "rastreamento": { - "type": "string", - "example": "string" - }, - "urlRastreamento": { - "type": "string", - "example": "string" - }, - "nomeTransportadora": { - "type": "string", - "example": "string" - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb0eb3b2d02402aeeebedf" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json deleted file mode 100644 index 92eea626e..000000000 --- a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/midias": { - "get": { - "summary": "Retorna o xml com os dados de todas as mídias entre duas datas", - "description": "Xml com os dados das mídias entre duas datas", - "operationId": "retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bda2506db2dc00311668ba" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json deleted file mode 100644 index d91694fdd..000000000 --- a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json +++ /dev/null @@ -1,230 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/midias/{identificador}": { - "get": { - "summary": "Retorna o xml com os dados de uma mídia específicas entre duas datas", - "description": "Xml com os dados de uma mídia específicas entre duas datas", - "operationId": "retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "identificador", - "in": "path", - "description": "Identificar da mídia (ex.: 7-CPA)", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"dias\": {\n \"diaMidiaApiModel\": [\n {\n \"dia\": \"2022-06-30T11:24:34.731Z\",\n \"investimento\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"pedidos\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"roi\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"receita\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"visitas\": {\n \"meta\": 0,\n \"realizado\": 0\n }\n }\n ]\n },\n \"id\": 0,\n \"nome\": \"string\",\n \"tipo\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "dias": { - "type": "object", - "properties": { - "diaMidiaApiModel": { - "type": "array", - "items": { - "type": "object", - "properties": { - "dia": { - "type": "string", - "example": "2022-06-30T11:24:34.731Z" - }, - "investimento": { - "type": "object", - "properties": { - "meta": { - "type": "integer", - "example": 0, - "default": 0 - }, - "realizado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "pedidos": { - "type": "object", - "properties": { - "meta": { - "type": "integer", - "example": 0, - "default": 0 - }, - "realizado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "roi": { - "type": "object", - "properties": { - "meta": { - "type": "integer", - "example": 0, - "default": 0 - }, - "realizado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "receita": { - "type": "object", - "properties": { - "meta": { - "type": "integer", - "example": 0, - "default": 0 - }, - "realizado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "visitas": { - "type": "object", - "properties": { - "meta": { - "type": "integer", - "example": 0, - "default": 0 - }, - "realizado": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - }, - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bda3695cd2a0001a9004fc" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json b/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json deleted file mode 100644 index 66fc43297..000000000 --- a/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/camposcadastropersonalizado": { - "get": { - "summary": "Retorna os campos de cadastro personalizado existentes", - "description": "Campos de cadastro personalizado encontrados", - "operationId": "retorna-os-campos-de-cadastro-personalizado-existentes", - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"grupoInformacaoCadastralId\": 0,\n \"nome\": \"string\",\n \"tipo\": \"TextoLivre\",\n \"obrigatorio\": true,\n \"ordem\": 0,\n \"valorPreDefinido\": [\n {\n \"valoresDefinidosCampoGrupoInformacaoId\": 0,\n \"valor\": \"string\",\n \"ordem\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "grupoInformacaoCadastralId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "TextoLivre" - }, - "obrigatorio": { - "type": "boolean", - "example": true, - "default": true - }, - "ordem": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorPreDefinido": { - "type": "array", - "items": { - "type": "object", - "properties": { - "valoresDefinidosCampoGrupoInformacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "string", - "example": "string" - }, - "ordem": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dec853d52c65010d6da284" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json deleted file mode 100644 index 300b377cc..000000000 --- a/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}/listaDesejos": { - "get": { - "summary": "Retorna os dados da lista de desejos de um usuário", - "description": "Dados da lista de desejos de um usuário", - "operationId": "retorna-os-dados-da-lista-de-desejos-de-um-usuario", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"dataAdicao\": \"2022-07-25T11:26:13.971Z\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAdicao": { - "type": "string", - "example": "2022-07-25T11:26:13.971Z" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dea5b1d78713001491e863" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json deleted file mode 100644 index 09ae746d6..000000000 --- a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento": { - "get": { - "summary": "Retorna os dados de rastreamento/nf de um pedido", - "description": "Lista de pedidos", - "operationId": "retorna-os-dados-de-rastreamentonf-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"pedidoRastreamentoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.200Z\",\n \"notaFiscal\": \"string\",\n \"serieNF\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.200Z\",\n \"urlNFE\": \"string\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.200Z\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "pedidoRastreamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.200Z" - }, - "notaFiscal": { - "type": "string", - "example": "string" - }, - "serieNF": { - "type": "string", - "example": "string" - }, - "cfop": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataEnviado": { - "type": "string", - "example": "2022-06-28T11:18:19.200Z" - }, - "urlNFE": { - "type": "string", - "example": "string" - }, - "chaveAcessoNFE": { - "type": "string", - "example": "string" - }, - "rastreamento": { - "type": "string", - "example": "string" - }, - "urlRastreamento": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "dataEntrega": { - "type": "string", - "example": "2022-06-28T11:18:19.200Z" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb111fe2a40c0190687631" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json deleted file mode 100644 index 724cba691..000000000 --- a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/rastreamento/produtos": { - "get": { - "summary": "Retorna os dados de rastreamento/nf dos produtos de um pedido", - "description": "Lista de pedidos", - "operationId": "retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"rastreamentos\": [\n {\n \"pedidoRastreamentoProdutoId\": 0,\n \"quantidade\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.238Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.238Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"dataEntrega\": \"2022-06-28T11:18:19.238Z\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "rastreamentos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoRastreamentoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.238Z" - }, - "notaFiscal": { - "type": "string", - "example": "string" - }, - "cfop": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataEnviado": { - "type": "string", - "example": "2022-06-28T11:18:19.238Z" - }, - "chaveAcessoNFE": { - "type": "string", - "example": "string" - }, - "rastreamento": { - "type": "string", - "example": "string" - }, - "urlRastreamento": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataEntrega": { - "type": "string", - "example": "2022-06-28T11:18:19.238Z" - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb2e7db8853603c36ae9bf" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json deleted file mode 100644 index f44e8ec4d..000000000 --- a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json +++ /dev/null @@ -1,190 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/pedido/{pedidoId}": { - "get": { - "summary": "Retorna os dados de uma assinatura a partir do id do Pedido", - "description": "Assinatura de um determinado pedido", - "operationId": "retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "id do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"assinaturaPedidoId\": 0,\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"pedidoId\": 0,\n \"valor\": 0,\n \"data\": \"2022-06-08T11:32:39.571Z\",\n \"origemPedidoEnumId\": 0,\n \"produtoVarianteId\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoPeriodo": { - "type": "string", - "example": "string" - }, - "tempoPeriodo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-08T11:32:39.571Z" - }, - "origemPedidoEnumId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0b81da846fe01699b429d" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json deleted file mode 100644 index 165a67314..000000000 --- a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json +++ /dev/null @@ -1,226 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}": { - "get": { - "summary": "Retorna os dados de uma assinatura específica", - "description": "Detalhes de uma assinatura", - "operationId": "retorna-os-dados-de-uma-assinatura-especifica", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Id da assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.154Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.154Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataProximoPedido": { - "type": "string", - "example": "2022-06-13T11:13:55.154Z" - }, - "periodoRecorrencia": { - "type": "string", - "example": "string" - }, - "situacaoAssinatura": { - "type": "string", - "example": "Ativa" - }, - "dataAssinatura": { - "type": "string", - "example": "2022-06-13T11:13:55.154Z" - }, - "grupoAssinatura": { - "type": "string", - "example": "string" - }, - "enderecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioCartaoCreditoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupom": { - "type": "string", - "example": "string" - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a71ec21c0501011e64c99b" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json deleted file mode 100644 index a582d2d76..000000000 --- a/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/transacoes/{transacaoId}": { - "get": { - "summary": "Retorna os detalhes da transação de um pedido", - "description": "Dados de transação do pedido", - "operationId": "retorna-os-detalhes-da-transacao-de-um-pedido", - "parameters": [ - { - "name": "transacaoId", - "in": "path", - "description": "Número da Transação que se deseja buscar os dados", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb3025563588032bb623bc" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json b/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json deleted file mode 100644 index 4856d0732..000000000 --- a/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/frete": { - "get": { - "summary": "Retorna os detalhes do serviço de frete", - "description": "Dados do serviço de frete do pedido", - "operationId": "retorna-os-detalhes-do-servico-de-frete", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar os dados", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb32ac1fb82e001474ef11" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json deleted file mode 100644 index 3d1abd109..000000000 --- a/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json +++ /dev/null @@ -1,183 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/erros/{assinaturaId}": { - "get": { - "summary": "Retorna os erros de uma assinatura especifica", - "description": "Assinatura com erro na loja", - "operationId": "retorna-os-erros-de-uma-assinatura-especifica", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "id da Assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.566Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaErroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "string", - "example": "string" - }, - "visualizado": { - "type": "boolean", - "example": true, - "default": true - }, - "dataErro": { - "type": "string", - "example": "2022-06-08T11:32:39.566Z" - }, - "resolvido": { - "type": "boolean", - "example": true, - "default": true - }, - "codigoAssinaturaErro": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaErroNome": { - "type": "string", - "example": "string" - }, - "assinaturaErroDescricao": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0b66b878668005c2953e9" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json deleted file mode 100644 index f6daa27ea..000000000 --- a/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json +++ /dev/null @@ -1,177 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/{assinaturaId}/produtos": { - "get": { - "summary": "Retorna os produtos de uma assinatura específica", - "description": "Produtos de uma assinatura", - "operationId": "retorna-os-produtos-de-uma-assinatura-especifica", - "parameters": [ - { - "name": "assinaturaId", - "in": "path", - "description": "Id da assinatura", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a72176e5800c00e7e6b712" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json deleted file mode 100644 index b81e30d11..000000000 --- a/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}/produtos": { - "get": { - "summary": "Retorna os produtos de uma tabela de preços", - "description": "Lista de produtos de uma tabela de preços", - "operationId": "retorna-os-produtos-de-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"tabelaPrecoProdutoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"sku\": \"string\",\n \"produtoVarianteId\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoProdutoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a97ac5887702643ffec2" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json b/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json deleted file mode 100644 index 328fd8568..000000000 --- a/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{parceiroId}/usuarios": { - "get": { - "summary": "Retorna os usuários pelo id do parceiro", - "description": "Usuários encontrados", - "operationId": "retorna-os-usuarios-pelo-id-do-parceiro", - "parameters": [ - { - "name": "parceiroId", - "in": "path", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.775Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.775Z\",\n \"vinculoVitalicio\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "email": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "dataInicial": { - "type": "string", - "example": "2022-06-30T11:24:34.775Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-06-30T11:24:34.775Z" - }, - "vinculoVitalicio": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb43bba061200699c0766" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json b/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json deleted file mode 100644 index 23258f9ee..000000000 --- a/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/{nome}/usuarios": { - "get": { - "summary": "Retorna os usuários pelo nome do parceiro", - "description": "Usuários encontrados", - "operationId": "retorna-os-usuarios-pelo-nome-do-parceiro", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do parceiro", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.778Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.778Z\",\n \"vinculoVitalicio\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "email": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "dataInicial": { - "type": "string", - "example": "2022-06-30T11:24:34.778Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-06-30T11:24:34.778Z" - }, - "vinculoVitalicio": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb47d68e01c003df97796" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-produtos-por-seller.openapi.json b/wake/utils/openapi/retorna-produtos-por-seller.openapi.json deleted file mode 100644 index 20d086738..000000000 --- a/wake/utils/openapi/retorna-produtos-por-seller.openapi.json +++ /dev/null @@ -1,526 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/produtos/{identificador}": { - "get": { - "summary": "Retorna produtos por Seller", - "description": "Lista de produtos", - "operationId": "retorna-produtos-por-seller", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o reseller", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller", - "schema": { - "type": "string", - "enum": [ - "ResellerId", - "RazaoSocial" - ] - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "somenteValidos", - "in": "query", - "description": "Se deve retornar apenas produtos válidos (padrão: false)", - "schema": { - "type": "boolean" - } - }, - { - "name": "camposAdicionais", - "in": "query", - "description": "Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-18T11:04:10.596Z\",\n \"dataAtualizacao\": \"2022-07-18T11:04:10.596Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "idPaiExterno": { - "type": "string", - "example": "string" - }, - "idVinculoExterno": { - "type": "string", - "example": "string" - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "nomeProdutoPai": { - "type": "string", - "example": "string" - }, - "urlProduto": { - "type": "string", - "example": "string" - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "contraProposta": { - "type": "boolean", - "example": true, - "default": true - }, - "fabricante": { - "type": "string", - "example": "string" - }, - "autor": { - "type": "string", - "example": "string" - }, - "editora": { - "type": "string", - "example": "string" - }, - "colecao": { - "type": "string", - "example": "string" - }, - "genero": { - "type": "string", - "example": "string" - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirSite": { - "type": "boolean", - "example": true, - "default": true - }, - "freteGratis": { - "type": "string", - "example": "Sempre" - }, - "trocaGratis": { - "type": "boolean", - "example": true, - "default": true - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "garantia": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isTelevendas": { - "type": "boolean", - "example": true, - "default": true - }, - "ean": { - "type": "string", - "example": "string" - }, - "localizacaoEstoque": { - "type": "string", - "example": "string" - }, - "listaAtacado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "estoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alertaEstoque": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoAtributo": { - "type": "string", - "example": "Selecao" - }, - "isFiltro": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - }, - "exibir": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "condicao": { - "type": "string", - "example": "Novo" - }, - "informacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - }, - "tabelasPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-18T11:04:10.596Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-18T11:04:10.596Z" - }, - "urlVideo": { - "type": "string", - "example": "string" - }, - "spot": { - "type": "boolean", - "example": true, - "default": true - }, - "paginaProduto": { - "type": "boolean", - "example": true, - "default": true - }, - "marketplace": { - "type": "boolean", - "example": true, - "default": true - }, - "somenteParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "reseller": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d5445d1946d7007b5759a1" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json b/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json deleted file mode 100644 index 4523f9204..000000000 --- a/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/disponibilidade": { - "get": { - "summary": "Retorna se o produto variante está disponível ou não", - "description": "", - "operationId": "retorna-se-o-produto-variante-esta-disponivel-ou-nao", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c46dc726fb0e001aac9680" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json b/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json deleted file mode 100644 index e23d5df3a..000000000 --- a/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/comunicacao": { - "get": { - "summary": "Retorna se o usuário ativou o recebimento de newsletter", - "description": "Retorna se o usuário ativou o recebimento de newsletter", - "operationId": "retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário cujos pedidos devem ser selecionados", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"recebimentoNewsletter\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "recebimentoNewsletter": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dea2cd9efd2a007503d9f5" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json deleted file mode 100644 index b165c89a6..000000000 --- a/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json +++ /dev/null @@ -1,207 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtoavaliacao": { - "get": { - "summary": "Retorna todas as avaliações dos produtos variantes da loja", - "description": "Lista de avaliações de produtos", - "operationId": "retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja", - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Referente ao status que libera a visualização da avaliação no site", - "schema": { - "type": "string", - "enum": [ - "Pendente", - "NaoAprovado", - "Aprovado" - ] - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-14T19:01:50.098Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "produtoAvaliacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comentario": { - "type": "string", - "example": "string" - }, - "avaliacao": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAvaliacao": { - "type": "string", - "example": "2022-07-14T19:01:50.098Z" - }, - "nome": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "status": { - "type": "string", - "example": "Pendente" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d0686406066a0085762de7" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json b/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json deleted file mode 100644 index f7f2be29e..000000000 --- a/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json +++ /dev/null @@ -1,213 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/categorias": { - "get": { - "summary": "Retorna todas as categorias de um produto", - "description": "Lista de categorias de um produto", - "operationId": "retorna-todas-as-categorias-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId", - "ProdutoId" - ] - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\",\n \"caminhoHierarquia\": \"string\",\n \"categoriaPrincipal\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "categoriaPaiId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "categoriaERPId": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isReseller": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoCompra": { - "type": "integer", - "example": 0, - "default": 0 - }, - "exibeMenu": { - "type": "boolean", - "example": true, - "default": true - }, - "urlHotSite": { - "type": "string", - "example": "string" - }, - "caminhoHierarquia": { - "type": "string", - "example": "string" - }, - "categoriaPrincipal": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c44b6585171d0013b584f1" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-categorias.openapi.json b/wake/utils/openapi/retorna-todas-as-categorias.openapi.json deleted file mode 100644 index 0fd0e2ddf..000000000 --- a/wake/utils/openapi/retorna-todas-as-categorias.openapi.json +++ /dev/null @@ -1,215 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias": { - "get": { - "summary": "Retorna todas as categorias", - "description": "Lista de categorias", - "operationId": "retorna-todas-as-categorias", - "parameters": [ - { - "name": "hierarquia", - "in": "query", - "description": "Hierarquia da categoria", - "schema": { - "type": "boolean" - } - }, - { - "name": "apenasReseller", - "in": "query", - "description": "Se será apresentado apenas Reseller", - "schema": { - "type": "boolean" - } - }, - { - "name": "apenasUltimoNivel", - "in": "query", - "description": "Se será apresentado apenas o último nível das categorias", - "schema": { - "type": "boolean" - } - }, - { - "name": "somenteFilhos", - "in": "query", - "description": "Se será apresentado somente categorias filhas", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "categoriaPaiId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "categoriaERPId": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isReseller": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoCompra": { - "type": "integer", - "example": 0, - "default": 0 - }, - "exibeMenu": { - "type": "boolean", - "example": true, - "default": true - }, - "urlHotSite": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a9e825da84df002ec5bc83" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json deleted file mode 100644 index 5f7672033..000000000 --- a/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/formasPagamento": { - "get": { - "summary": "Retorna todas as formas de pagamento da loja", - "description": "Lista de formas de pagamento", - "operationId": "retorna-todas-as-formas-de-pagamento-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"formaPagamentoId\": 0,\n \"nome\": \"string\",\n \"nomeExibicao\": \"string\",\n \"descricao\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "formaPagamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "nomeExibicao": { - "type": "string", - "example": "string" - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0a4f9f17cd2008820e6de" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json b/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json deleted file mode 100644 index 380b289e2..000000000 --- a/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/informacoes": { - "get": { - "summary": "Retorna todas as informações de um produto", - "description": "Retorna todas as informações de um produto específico", - "operationId": "retorna-todas-as-informacoes-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId", - "ProdutoId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c44079d5d89100930b2659" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json b/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json deleted file mode 100644 index f30b3c19c..000000000 --- a/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json +++ /dev/null @@ -1,263 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas": { - "get": { - "summary": "Retorna todas as Lojas Físicas", - "description": "Lista de Lojas Físicas", - "operationId": "retorna-todas-as-lojas-fisicas", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ddd": { - "type": "integer", - "example": 0, - "default": 0 - }, - "telefone": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoMaximoRetirada": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "textoComplementar": { - "type": "string", - "example": "string" - }, - "retirarNaLoja": { - "type": "boolean", - "example": true, - "default": true - }, - "latitude": { - "type": "integer", - "example": 0, - "default": 0 - }, - "longitude": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5ef5058633d00afe39f5a" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json deleted file mode 100644 index bbb4f2a0b..000000000 --- a/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/situacoesPedido": { - "get": { - "summary": "Retorna todas as situações de pedido da loja", - "description": "Lista de situações de pedido", - "operationId": "retorna-todas-as-situacoes-de-pedido-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"observacao\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "descricao": { - "type": "string", - "example": "string" - }, - "observacao": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c48b8c02a0f600140ba458" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json b/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json deleted file mode 100644 index d9fda2aba..000000000 --- a/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos": { - "get": { - "summary": "Retorna todas as tabelas de preços", - "description": "Lista de tabelas de preços", - "operationId": "retorna-todas-as-tabelas-de-precos", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.621Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.621Z\",\n \"ativo\": true,\n \"isSite\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dataInicial": { - "type": "string", - "example": "2022-07-19T11:05:47.621Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-07-19T11:05:47.621Z" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isSite": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a6f38e22dc00626f5b0f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-atributos.openapi.json b/wake/utils/openapi/retorna-todos-os-atributos.openapi.json deleted file mode 100644 index 5ae7c861c..000000000 --- a/wake/utils/openapi/retorna-todos-os-atributos.openapi.json +++ /dev/null @@ -1,132 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/atributos": { - "get": { - "summary": "Retorna todos os atributos", - "description": "Lista de atributos", - "operationId": "retorna-todos-os-atributos", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "Selecao" - }, - "tipoExibicao": { - "type": "string", - "example": "Combo" - }, - "prioridade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{}" - } - }, - "schema": { - "type": "object", - "properties": {} - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0e06fbddf01005ea57c98" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json b/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json deleted file mode 100644 index 1a53be277..000000000 --- a/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/centrosdistribuicao": { - "get": { - "summary": "Retorna todos os centros de distribuição", - "description": "Lista de centros de distribuição", - "operationId": "retorna-todos-os-centros-de-distribuicao", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"cep\": 0,\n \"padrao\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "integer", - "example": 0, - "default": 0 - }, - "padrao": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa21284a1124092dea1ced" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json b/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json deleted file mode 100644 index 8cc52e93b..000000000 --- a/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json +++ /dev/null @@ -1,156 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes": { - "get": { - "summary": "Retorna todos os fabricantes", - "description": "Lista de fabricantes", - "operationId": "retorna-todos-os-fabricantes", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fabricanteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "urlLogoTipo": { - "type": "string", - "example": "string" - }, - "urlLink": { - "type": "string", - "example": "string" - }, - "urlCarrossel": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b05f788599140131516021" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json b/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json deleted file mode 100644 index e306d4773..000000000 --- a/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros/comPedidos": { - "get": { - "summary": "Retorna todos os parceiros com pedidos", - "description": "Lista de parceiros com pedidos", - "operationId": "retorna-todos-os-parceiros-com-pedidos", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "marketPlaceId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEscopo": { - "type": "string", - "example": "Aberto" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "origem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdb286323e93009dc43328" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json b/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json deleted file mode 100644 index 6f52fbd77..000000000 --- a/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/parceiros": { - "get": { - "summary": "Retorna todos os parceiros", - "description": "Lista de parceiros", - "operationId": "retorna-todos-os-parceiros", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "parceiroId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "marketPlaceId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEscopo": { - "type": "string", - "example": "Aberto" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "origem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bdab39d6cd5b00a493f0bc" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json b/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json deleted file mode 100644 index f0637829f..000000000 --- a/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json +++ /dev/null @@ -1,113 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios": { - "get": { - "summary": "Retorna todos os portfolios", - "description": "Lista de portfolios", - "operationId": "retorna-todos-os-portfolios", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "portfolioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bedb30a15e8e013e95ec4a" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json b/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json deleted file mode 100644 index 13003c356..000000000 --- a/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json +++ /dev/null @@ -1,187 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/precos": { - "get": { - "summary": "Retorna todos os preços referente ao produto variante, incluindo os preços de tabela de preço", - "description": "Preços do produto variante informado", - "operationId": "retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"precosTabelaPreco\": [\n {\n \"produtoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precosTabelaPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c49a3c454fa5009df9d5c0" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json b/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json deleted file mode 100644 index 3f2208162..000000000 --- a/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json +++ /dev/null @@ -1,222 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/alteracoes": { - "get": { - "summary": "Retorna todos os produtos", - "description": "Lista de preços e estoque de produtos que sofreram alterações", - "operationId": "retorna-todos-os-produtos-1", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "alteradosPartirDe", - "in": "query", - "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"disponivel\": true,\n \"valido\": true,\n \"exibirSite\": true,\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "disponivel": { - "type": "boolean", - "example": true, - "default": true - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirSite": { - "type": "boolean", - "example": true, - "default": true - }, - "estoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alertaEstoque": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "tabelasPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c3301d254560009866ae5f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-produtos.openapi.json b/wake/utils/openapi/retorna-todos-os-produtos.openapi.json deleted file mode 100644 index 2f15f2b60..000000000 --- a/wake/utils/openapi/retorna-todos-os-produtos.openapi.json +++ /dev/null @@ -1,558 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos": { - "get": { - "summary": "Retorna todos os produtos", - "description": "Lista de produtos", - "operationId": "retorna-todos-os-produtos", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "categorias", - "in": "query", - "description": "Lista de categorias que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as categorias", - "schema": { - "type": "string" - } - }, - { - "name": "fabricantes", - "in": "query", - "description": "Lista de fabricantes que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", - "schema": { - "type": "string" - } - }, - { - "name": "centrosDistribuicao", - "in": "query", - "description": "Lista de centros de distribuição que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará produtos de todos os cd's", - "schema": { - "type": "string" - } - }, - { - "name": "alteradosPartirDe", - "in": "query", - "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "somenteValidos", - "in": "query", - "description": "Retorna apenas os produtos que estão marcados como válido", - "schema": { - "type": "boolean" - } - }, - { - "name": "camposAdicionais", - "in": "query", - "description": "Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.472Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.472Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}\n ]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "idPaiExterno": { - "type": "string", - "example": "string" - }, - "idVinculoExterno": { - "type": "string", - "example": "string" - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "nomeProdutoPai": { - "type": "string", - "example": "string" - }, - "urlProduto": { - "type": "string", - "example": "string" - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "contraProposta": { - "type": "boolean", - "example": true, - "default": true - }, - "fabricante": { - "type": "string", - "example": "string" - }, - "autor": { - "type": "string", - "example": "string" - }, - "editora": { - "type": "string", - "example": "string" - }, - "colecao": { - "type": "string", - "example": "string" - }, - "genero": { - "type": "string", - "example": "string" - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirSite": { - "type": "boolean", - "example": true, - "default": true - }, - "freteGratis": { - "type": "string", - "example": "Sempre" - }, - "trocaGratis": { - "type": "boolean", - "example": true, - "default": true - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "garantia": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isTelevendas": { - "type": "boolean", - "example": true, - "default": true - }, - "ean": { - "type": "string", - "example": "string" - }, - "localizacaoEstoque": { - "type": "string", - "example": "string" - }, - "listaAtacado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "estoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alertaEstoque": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoAtributo": { - "type": "string", - "example": "Selecao" - }, - "isFiltro": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - }, - "exibir": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "condicao": { - "type": "string", - "example": "Novo" - }, - "informacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - }, - "tabelasPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-04T11:52:02.472Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-04T11:52:02.472Z" - }, - "urlVideo": { - "type": "string", - "example": "string" - }, - "spot": { - "type": "boolean", - "example": true, - "default": true - }, - "paginaProduto": { - "type": "boolean", - "example": true, - "default": true - }, - "marketplace": { - "type": "boolean", - "example": true, - "default": true - }, - "somenteParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "reseller": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "consumo": { - "type": "object", - "properties": { - "quantidadeDias": { - "type": "integer", - "example": 0, - "default": 0 - }, - "enviarEmail": { - "type": "boolean", - "example": true, - "default": true - } - } - }, - "prazoValidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c2d48988437b002e0ccb21" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json b/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json deleted file mode 100644 index 54f611231..000000000 --- a/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers": { - "get": { - "summary": "Retorna todos os Sellers da loja", - "description": "Lista de resellers", - "operationId": "retorna-todos-os-sellers-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d1a2e941f16f047b130439" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json b/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json deleted file mode 100644 index abe73a354..000000000 --- a/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json +++ /dev/null @@ -1,210 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento": { - "get": { - "summary": "Retorna todos os tipos de eventos", - "description": "Lista de tipos de evento", - "operationId": "retorna-todos-os-tipos-de-eventos", - "parameters": [ - { - "name": "ativo", - "in": "query", - "description": "Status do tipo de evento", - "schema": { - "type": "boolean" - } - }, - { - "name": "disponivel", - "in": "query", - "description": "Se o tipo de evento está disponível", - "schema": { - "type": "boolean" - } - }, - { - "name": "nome", - "in": "query", - "description": "Nome do tipo de evento", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tipoEntrega": { - "type": "string", - "example": "EntregaAgendada" - }, - "tipoDisponibilizacao": { - "type": "string", - "example": "DisponibilizacaoDeCreditos" - }, - "permitirRemocaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "corHexTituloInformacoes": { - "type": "string", - "example": "string" - }, - "corHexCorpoInformacoes": { - "type": "string", - "example": "string" - }, - "numeroAbasInformacoes": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeDiasParaEventoExpirar": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroLocaisEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "disponivel": { - "type": "boolean", - "example": true, - "default": true - }, - "tipoBeneficiarioFrete": { - "type": "string", - "example": "DonodaLista" - }, - "caminhoLogoEvento": { - "type": "string", - "example": "string" - }, - "caminhoSubTemplate": { - "type": "string", - "example": "string" - }, - "sugestaoProdutos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ced411426e4d0434332791" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json b/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json deleted file mode 100644 index 02e19d251..000000000 --- a/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json +++ /dev/null @@ -1,285 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios": { - "get": { - "summary": "Retorna todos os usuários", - "description": "Lista de usuários", - "operationId": "retorna-todos-os-usuarios", - "parameters": [ - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "enumTipoFiltroData", - "in": "query", - "description": "Tipo de filtro de data", - "schema": { - "type": "string", - "enum": [ - "DataAlteracao", - "DataCriacao" - ] - } - }, - { - "name": "aprovado", - "in": "query", - "description": "Status de aprovação", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:16:24.396Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:16:24.396Z\",\n \"dataAtualizacao\": \"2022-07-20T17:16:24.396Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "bloqueado": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-07-20T17:16:24.396Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-20T17:16:24.396Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-20T17:16:24.396Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "avatar": { - "type": "string", - "example": "string" - }, - "ip": { - "type": "string", - "example": "string" - }, - "aprovado": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d8388ed91557004d74d91f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json b/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json deleted file mode 100644 index c3f2646c5..000000000 --- a/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/lojasFisicas/{lojaFisicaId}/rangeCep": { - "get": { - "summary": "Retorna todos ranges de cep que essa loja atende", - "description": "Lista de Ranges de Ceps de uma Loja Física", - "operationId": "retorna-todos-ranges-de-cep-que-essa-loja-atende", - "parameters": [ - { - "name": "lojaFisicaId", - "in": "path", - "description": "Id da loja física", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"rangeCepId\": 0,\n \"nome\": \"string\",\n \"cepInicial\": \"string\",\n \"cepFinal\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "rangeCepId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "cepInicial": { - "type": "string", - "example": "string" - }, - "cepFinal": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b9b8ac72164000486fc745" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json deleted file mode 100644 index 5a33d034d..000000000 --- a/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { - "get": { - "summary": "Retorna um Atacarejo pelo Id", - "description": "Atacarejo", - "operationId": "retorna-um-atacarejo-pelo-id", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "produtoVarianteAtacadoId", - "in": "path", - "description": "Id do Atacarejo", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtoVarianteAtacadoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoAtacado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c4951df0ecbb00469ed2f6" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json b/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json deleted file mode 100644 index e5f58120b..000000000 --- a/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/atributos/{nome}": { - "get": { - "summary": "Retorna um atributo específico", - "description": "Atributo encontrado", - "operationId": "retorna-um-atributo-especifico", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do atributo", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "nome": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "Selecao" - }, - "tipoExibicao": { - "type": "string", - "example": "Combo" - }, - "prioridade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a0eeb071a9a9003ad8bc0b" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json b/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json deleted file mode 100644 index ae59ee233..000000000 --- a/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json +++ /dev/null @@ -1,217 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}": { - "get": { - "summary": "Retorna um contrato de frete", - "description": "Frete encontrado", - "operationId": "retorna-um-contrato-de-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "freteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "volumeMaximo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCubado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "entregaAgendadaConfiguracaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "linkRastreamento": { - "type": "string", - "example": "string" - }, - "ehAssinatura": { - "type": "boolean", - "example": true, - "default": true - }, - "larguraMaxima": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alturaMaxima": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimentoMaximo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "limiteMaximoDimensoes": { - "type": "integer", - "example": 0, - "default": 0 - }, - "limitePesoCubado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tempoMinimoDespacho": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoProdutos": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d16f06cf210036e5b3f1" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-evento-especifico.openapi.json b/wake/utils/openapi/retorna-um-evento-especifico.openapi.json deleted file mode 100644 index 151441c0c..000000000 --- a/wake/utils/openapi/retorna-um-evento-especifico.openapi.json +++ /dev/null @@ -1,322 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}": { - "get": { - "summary": "Retorna um evento especifico", - "description": "Lista de produtos variantes vinculados aos tipo de evento", - "operationId": "retorna-um-evento-especifico", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.758Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.758Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "userId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "enderecoEntregaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-17T11:14:38.758Z" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-17T11:14:38.758Z" - }, - "titulo": { - "type": "string", - "example": "string" - }, - "url": { - "type": "string", - "example": "string" - }, - "disponivel": { - "type": "boolean", - "example": true, - "default": true - }, - "diasDepoisEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "diasAntesEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "urlLogoEvento": { - "type": "string", - "example": "string" - }, - "urlCapaEvento": { - "type": "string", - "example": "string" - }, - "proprietarioEvento": { - "type": "string", - "example": "string" - }, - "abaInfo01Habilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "textoInfo01": { - "type": "string", - "example": "string" - }, - "conteudoInfo01": { - "type": "string", - "example": "string" - }, - "abaInfo02Habilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "textoInfo02": { - "type": "string", - "example": "string" - }, - "conteudoInfo02": { - "type": "string", - "example": "string" - }, - "abaMensagemHabilitado": { - "type": "boolean", - "example": true, - "default": true - }, - "fotos": { - "type": "string", - "example": "string" - }, - "enumTipoListaPresenteId": { - "type": "string", - "example": "Default" - }, - "enumTipoEntregaId": { - "type": "string", - "example": "EntregaAgendada" - }, - "eventoProdutoSelecionado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "recebidoForaLista": { - "type": "boolean", - "example": true, - "default": true - }, - "removido": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "enderecoEvento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "enderecoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "eventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac8191b902e4002d17e805" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json deleted file mode 100644 index 4dd661f3e..000000000 --- a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes/{fabricanteId}": { - "get": { - "summary": "Retorna um fabricante específico pelo id", - "description": "Fabricante encontrado", - "operationId": "retorna-um-fabricante-especifico-pelo-id", - "parameters": [ - { - "name": "fabricanteId", - "in": "path", - "description": "Id do fabricante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "fabricanteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "urlLogoTipo": { - "type": "string", - "example": "string" - }, - "urlLink": { - "type": "string", - "example": "string" - }, - "urlCarrossel": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b08432c9c44d008e7522b8" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json deleted file mode 100644 index 394937aa1..000000000 --- a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json +++ /dev/null @@ -1,164 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fabricantes/{nome}": { - "get": { - "summary": "Retorna um fabricante específico pelo nome", - "description": "Fabricante encontrado", - "operationId": "retorna-um-fabricante-especifico-pelo-nome", - "parameters": [ - { - "name": "nome", - "in": "path", - "description": "Nome do fabricante", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "fabricanteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "urlLogoTipo": { - "type": "string", - "example": "string" - }, - "urlLink": { - "type": "string", - "example": "string" - }, - "urlCarrossel": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b08b25c8ee0a02277e6dd3" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json b/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json deleted file mode 100644 index 89c2531a4..000000000 --- a/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json +++ /dev/null @@ -1,1219 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}": { - "get": { - "summary": "Retorna um pedido especifico", - "description": "Pedido encontrado", - "operationId": "retorna-um-pedido-especifico", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-17T11:14:39.010Z\",\n \"dataPagamento\": \"2022-06-17T11:14:39.010Z\",\n \"dataUltimaAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-17T11:14:39.010Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-17T11:14:39.010Z\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-17T11:14:39.011Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-17T11:14:39.011Z\",\n \"ate\": \"2022-06-17T11:14:39.011Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.011Z\",\n \"dataUltimoStatus\": \"2022-06-17T11:14:39.011Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-17T11:14:39.011Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoRastreamentoPedido": { - "type": "string", - "example": "SemRastreamento" - }, - "transacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "dataPagamento": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "dataUltimaAtualizacao": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "valorFrete": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotalPedido": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDebitoCC": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupomDesconto": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoId": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoSiteId": { - "type": "string", - "example": "string" - }, - "canalId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "canalNome": { - "type": "string", - "example": "string" - }, - "canalOrigem": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isPedidoEvento": { - "type": "boolean", - "example": true, - "default": true - }, - "usuario": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-17T11:14:39.010Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "pedidoEndereco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Entrega" - }, - "nome": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "tipoLogradouro": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - }, - "frete": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "referenciaConector": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centrosDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "servico": { - "type": "object", - "properties": { - "servicoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoNome": { - "type": "string", - "example": "string" - }, - "preco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoTransporte": { - "type": "integer", - "example": 0, - "default": 0 - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoMeta": { - "type": "string", - "example": "string" - }, - "custo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "token": { - "type": "string", - "example": "string" - } - } - }, - "retiradaAgendada": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "retiradaData": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - }, - "retiradaPeriodo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "documento": { - "type": "string", - "example": "string" - }, - "codigoRetirada": { - "type": "string", - "example": "string" - } - } - }, - "agendamento": { - "type": "object", - "properties": { - "de": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - }, - "ate": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "itens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isBrinde": { - "type": "boolean", - "example": true, - "default": true - }, - "valorAliquota": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "totais": { - "type": "object", - "properties": { - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "ajustes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Frete" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "observacao": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - } - } - } - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "valoresAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Acrescimo" - }, - "origem": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtributoValor": { - "type": "string", - "example": "string" - }, - "produtoVarianteAtributoNome": { - "type": "string", - "example": "string" - } - } - } - }, - "embalagens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEmbalagemId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeTipoEmbalagem": { - "type": "string", - "example": "string" - }, - "mensagem": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - }, - "personalizacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nomePersonalizacao": { - "type": "string", - "example": "string" - }, - "valorPersonalizacao": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "frete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dadosProdutoEvento": { - "type": "object", - "properties": { - "tipoPresenteRecebimento": { - "type": "string", - "example": "None" - } - } - }, - "formulas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chaveAjuste": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "expressao": { - "type": "string", - "example": "string" - }, - "expressaoInterpretada": { - "type": "string", - "example": "string" - }, - "endPoint": { - "type": "string", - "example": "string" - } - } - } - }, - "seller": { - "type": "object", - "properties": { - "sellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sellerNome": { - "type": "string", - "example": "string" - }, - "sellerPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "assinatura": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoPeriodo": { - "type": "string", - "example": "string" - }, - "tempoPeriodo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "percentualDesconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "pagamento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "formaPagamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroParcelas": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorParcela": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorJuros": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "boleto": { - "type": "object", - "properties": { - "urlBoleto": { - "type": "string", - "example": "string" - }, - "codigoDeBarras": { - "type": "string", - "example": "string" - } - } - }, - "cartaoCredito": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroCartao": { - "type": "string", - "example": "string" - }, - "nomeTitular": { - "type": "string", - "example": "string" - }, - "dataValidade": { - "type": "string", - "example": "string" - }, - "codigoSeguranca": { - "type": "string", - "example": "string" - }, - "documentoCartaoCredito": { - "type": "string", - "example": "string" - }, - "token": { - "type": "string", - "example": "string" - }, - "info": { - "type": "string", - "example": "string" - }, - "bandeira": { - "type": "string", - "example": "string" - } - } - } - }, - "pagamentoStatus": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroAutorizacao": { - "type": "string", - "example": "string" - }, - "numeroComprovanteVenda": { - "type": "string", - "example": "string" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - }, - "dataUltimoStatus": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - }, - "adquirente": { - "type": "string", - "example": "string" - }, - "tid": { - "type": "string", - "example": "string" - } - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "observacao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "observacao": { - "type": "string", - "example": "string" - }, - "usuario": { - "type": "string", - "example": "string" - }, - "data": { - "type": "string", - "example": "2022-06-17T11:14:39.011Z" - }, - "publica": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "valorCreditoFidelidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "valorSubTotalSemDescontos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoSplit": { - "type": "array", - "items": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac84cdc617f9008362d02b" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json b/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json deleted file mode 100644 index c14f14114..000000000 --- a/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json +++ /dev/null @@ -1,530 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}": { - "get": { - "summary": "Retorna um produto buscando pelo seu identificador", - "description": "Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais.", - "operationId": "retorna-um-produto-buscando-pelo-seu-identificador", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId", - "ProdutoId" - ] - } - }, - { - "name": "camposAdicionais", - "in": "query", - "description": "Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "idPaiExterno": { - "type": "string", - "example": "string" - }, - "idVinculoExterno": { - "type": "string", - "example": "string" - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "nomeProdutoPai": { - "type": "string", - "example": "string" - }, - "urlProduto": { - "type": "string", - "example": "string" - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "contraProposta": { - "type": "boolean", - "example": true, - "default": true - }, - "fabricante": { - "type": "string", - "example": "string" - }, - "autor": { - "type": "string", - "example": "string" - }, - "editora": { - "type": "string", - "example": "string" - }, - "colecao": { - "type": "string", - "example": "string" - }, - "genero": { - "type": "string", - "example": "string" - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "fatorMultiplicadorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirSite": { - "type": "boolean", - "example": true, - "default": true - }, - "freteGratis": { - "type": "string", - "example": "Sempre" - }, - "trocaGratis": { - "type": "boolean", - "example": true, - "default": true - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "altura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "largura": { - "type": "integer", - "example": 0, - "default": 0 - }, - "garantia": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isTelevendas": { - "type": "boolean", - "example": true, - "default": true - }, - "ean": { - "type": "string", - "example": "string" - }, - "localizacaoEstoque": { - "type": "string", - "example": "string" - }, - "listaAtacado": { - "type": "array", - "items": { - "type": "object", - "properties": { - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "estoque": { - "type": "array", - "items": { - "type": "object", - "properties": { - "estoqueFisico": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estoqueReservado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alertaEstoque": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoAtributo": { - "type": "string", - "example": "Selecao" - }, - "isFiltro": { - "type": "boolean", - "example": true, - "default": true - }, - "nome": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - }, - "exibir": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeMinimaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "condicao": { - "type": "string", - "example": "Novo" - }, - "informacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "informacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "titulo": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "tipoInformacao": { - "type": "string", - "example": "Informacoes" - } - } - } - }, - "tabelasPreco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "precoDe": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-04T11:52:02.490Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-04T11:52:02.490Z" - }, - "urlVideo": { - "type": "string", - "example": "string" - }, - "spot": { - "type": "boolean", - "example": true, - "default": true - }, - "paginaProduto": { - "type": "boolean", - "example": true, - "default": true - }, - "marketplace": { - "type": "boolean", - "example": true, - "default": true - }, - "somenteParceiros": { - "type": "boolean", - "example": true, - "default": true - }, - "reseller": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "consumo": { - "type": "object", - "properties": { - "quantidadeDias": { - "type": "integer", - "example": 0, - "default": 0 - }, - "enviarEmail": { - "type": "boolean", - "example": true, - "default": true - } - } - }, - "prazoValidade": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "\tProduto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c32871981a41006f6cb2b9" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json b/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json deleted file mode 100644 index 0cfc1e0c4..000000000 --- a/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json +++ /dev/null @@ -1,241 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}": { - "get": { - "summary": "Retorna um rastreamento de produto", - "description": "Rastreamento de produto encontrado", - "operationId": "retorna-um-rastreamento-de-produto", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Número do pedido que se deseja buscar", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "produtoVarianteId", - "in": "path", - "description": "Id do Produto Variante", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "pedidoRastreamentoProdutoId", - "in": "path", - "description": "Id do Pedido Rastreamento Produto", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"pedidoRastreamentoProdutoId\": 0,\n \"pedidoId\": 0,\n \"produtoVarianteId\": 0,\n \"pedidoProdutoId\": 0,\n \"dataInclusao\": \"2022-06-28T11:18:19.225Z\",\n \"dataAlteracao\": \"2022-06-28T11:18:19.225Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.225Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"quantidade\": 0,\n \"urlNFE\": \"string\",\n \"serieNFE\": \"string\",\n \"tipoPostagem\": \"string\",\n \"centroDistribuicao\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.225Z\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "pedidoRastreamentoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataInclusao": { - "type": "string", - "example": "2022-06-28T11:18:19.225Z" - }, - "dataAlteracao": { - "type": "string", - "example": "2022-06-28T11:18:19.225Z" - }, - "notaFiscal": { - "type": "string", - "example": "string" - }, - "cfop": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataEnviado": { - "type": "string", - "example": "2022-06-28T11:18:19.225Z" - }, - "chaveAcessoNFE": { - "type": "string", - "example": "string" - }, - "rastreamento": { - "type": "string", - "example": "string" - }, - "urlRastreamento": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "urlNFE": { - "type": "string", - "example": "string" - }, - "serieNFE": { - "type": "string", - "example": "string" - }, - "tipoPostagem": { - "type": "string", - "example": "string" - }, - "centroDistribuicao": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "dataEntrega": { - "type": "string", - "example": "2022-06-28T11:18:19.225Z" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb2a3456172300834e2406" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json b/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json deleted file mode 100644 index e69e83a71..000000000 --- a/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/{resellerId}": { - "get": { - "summary": "Retorna um Seller específico da loja", - "description": "Reseller específico", - "operationId": "retorna-um-seller-especifico-da-loja-1", - "parameters": [ - { - "name": "resellerId", - "in": "path", - "description": "Valor único utilizado para identificar o seller", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d1c003daaa690093b8c56a" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json b/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json deleted file mode 100644 index 6bd5761c8..000000000 --- a/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/resellers/token": { - "get": { - "summary": "Retorna um Seller específico da loja", - "description": "Reseller específico", - "operationId": "retorna-um-seller-especifico-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "ativacaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "autonomia": { - "type": "boolean", - "example": true, - "default": true - }, - "buyBox": { - "type": "boolean", - "example": true, - "default": true - }, - "nomeMarketPlace": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d1bf8e04ae690047164e3f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json b/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json deleted file mode 100644 index 5070e5ea5..000000000 --- a/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json +++ /dev/null @@ -1,193 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}": { - "get": { - "summary": "Retorna um tipo de evento especifico", - "description": "Tipo evento buscado", - "operationId": "retorna-um-tipo-de-evento-especifico", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "tipoEntrega": { - "type": "string", - "example": "EntregaAgendada" - }, - "tipoDisponibilizacao": { - "type": "string", - "example": "DisponibilizacaoDeCreditos" - }, - "permitirRemocaoAutomaticaProdutos": { - "type": "boolean", - "example": true, - "default": true - }, - "corHexTituloInformacoes": { - "type": "string", - "example": "string" - }, - "corHexCorpoInformacoes": { - "type": "string", - "example": "string" - }, - "numeroAbasInformacoes": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidadeDiasParaEventoExpirar": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroLocaisEvento": { - "type": "integer", - "example": 0, - "default": 0 - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "disponivel": { - "type": "boolean", - "example": true, - "default": true - }, - "tipoBeneficiarioFrete": { - "type": "string", - "example": "DonodaLista" - }, - "caminhoLogoEvento": { - "type": "string", - "example": "string" - }, - "caminhoSubTemplate": { - "type": "string", - "example": "string" - }, - "sugestaoProdutos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ced188dfc5120a1a83da98" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json deleted file mode 100644 index 1b61af73d..000000000 --- a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json +++ /dev/null @@ -1,235 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/cnpj/{cnpj}": { - "get": { - "summary": "Retorna um usuário específico pelo cnpj", - "description": "Usuário encontrado", - "operationId": "retorna-um-usuario-especifico-pelo-cnpj", - "parameters": [ - { - "name": "cnpj", - "in": "path", - "description": "CNPJ do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.476Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.476Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.476Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "bloqueado": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-07-20T17:54:12.476Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-20T17:54:12.476Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-20T17:54:12.476Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "avatar": { - "type": "string", - "example": "string" - }, - "ip": { - "type": "string", - "example": "string" - }, - "aprovado": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d8443170fd50003ff16f5f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json deleted file mode 100644 index e80d2b842..000000000 --- a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json +++ /dev/null @@ -1,235 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/cpf/{cpf}": { - "get": { - "summary": "Retorna um usuário específico pelo cpf", - "description": "Usuário encontrado", - "operationId": "retorna-um-usuario-especifico-pelo-cpf", - "parameters": [ - { - "name": "cpf", - "in": "path", - "description": "CPF do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.473Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.473Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.473Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "bloqueado": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-07-20T17:54:12.473Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-20T17:54:12.473Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-20T17:54:12.473Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "avatar": { - "type": "string", - "example": "string" - }, - "ip": { - "type": "string", - "example": "string" - }, - "aprovado": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d843d937827c001a37f151" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json deleted file mode 100644 index 7761e88f6..000000000 --- a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json +++ /dev/null @@ -1,235 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/email/{email}": { - "get": { - "summary": "Retorna um usuário específico pelo e-mail", - "description": "Usuário encontrado", - "operationId": "retorna-um-usuario-especifico-pelo-e-mail", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "bloqueado": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "avatar": { - "type": "string", - "example": "string" - }, - "ip": { - "type": "string", - "example": "string" - }, - "aprovado": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d841c858ce1d0044ba8fc3" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json deleted file mode 100644 index 6ddb66fd6..000000000 --- a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json +++ /dev/null @@ -1,236 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/usuarioId/{usuarioId}": { - "get": { - "summary": "Retorna um usuário específico pelo id", - "description": "Usuário encontrado", - "operationId": "retorna-um-usuario-especifico-pelo-id", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "bloqueado": { - "type": "boolean", - "example": true, - "default": true - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-07-20T17:54:12.466Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "avatar": { - "type": "string", - "example": "string" - }, - "ip": { - "type": "string", - "example": "string" - }, - "aprovado": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d99025f01e4d002f3a1731" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json deleted file mode 100644 index 03d3e7546..000000000 --- a/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json +++ /dev/null @@ -1,206 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/erp/{id}": { - "get": { - "summary": "Retorna uma categoria específica utilizando o id do erp como identificador", - "description": "Categoria encontrada", - "operationId": "retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - }, - { - "name": "hierarquia", - "in": "query", - "description": "Hierarquia da categoria", - "schema": { - "type": "boolean" - } - }, - { - "name": "somenteFilhos", - "in": "query", - "description": "Se será apresentado somente categorias filhas", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "categoriaPaiId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "categoriaERPId": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isReseller": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoCompra": { - "type": "integer", - "example": 0, - "default": 0 - }, - "exibeMenu": { - "type": "boolean", - "example": true, - "default": true - }, - "urlHotSite": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa0c992bc4a200a3366ee1" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json b/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json deleted file mode 100644 index deb5a8eae..000000000 --- a/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json +++ /dev/null @@ -1,206 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/categorias/{id}": { - "get": { - "summary": "Retorna uma categoria específica", - "description": "Categoria encontrada", - "operationId": "retorna-uma-categoria-especifica", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id da categoria", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - }, - { - "name": "hierarquia", - "in": "query", - "description": "Hierarquia da categoria", - "schema": { - "type": "boolean" - } - }, - { - "name": "somenteFilhos", - "in": "query", - "description": "Se será apresentado somente categorias filhas", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "categoriaPaiId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "categoriaERPId": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isReseller": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirMatrizAtributos": { - "type": "string", - "example": "Sim" - }, - "quantidadeMaximaCompraUnidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoCompra": { - "type": "integer", - "example": 0, - "default": 0 - }, - "exibeMenu": { - "type": "boolean", - "example": true, - "default": true - }, - "urlHotSite": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa055a959bb4009b9ebcba" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json b/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json deleted file mode 100644 index 591a8bbcd..000000000 --- a/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json +++ /dev/null @@ -1,204 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/pedidos/{pedidoId}/cotacoes": { - "get": { - "summary": "Retorna uma cotação de frete para o carrinho do pedido", - "description": "Objeto com as cotações de frete", - "operationId": "retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido", - "parameters": [ - { - "name": "pedidoId", - "in": "path", - "description": "Id do pedido", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - }, - { - "name": "forcarCotacaoTodosCDs", - "in": "query", - "description": "Força cotação de todos os CD's.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"centroDistribuicao\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tabelaFreteId": { - "type": "string", - "example": "string" - }, - "tipo": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicao": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:63d40199f6dd870085f457fe" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json b/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json deleted file mode 100644 index a476f8aaf..000000000 --- a/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json +++ /dev/null @@ -1,251 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas": { - "get": { - "summary": "Retorna uma lista com os dados das assinaturas", - "description": "Lista com assinaturas", - "operationId": "retorna-uma-lista-com-os-dados-das-assinaturas", - "parameters": [ - { - "name": "situacaoAssinatura", - "in": "query", - "description": "Situação da assinatura", - "schema": { - "type": "string", - "enum": [ - "Ativa", - "Pausada", - "Cancelada" - ] - } - }, - { - "name": "periodoRecorrencia", - "in": "query", - "description": "Período de recorrência", - "schema": { - "type": "string" - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "dataInicialProximaRecorrencia", - "in": "query", - "description": "Data inicial da próxima recorrência", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinalProximaRecorrencia", - "in": "query", - "description": "Data final da próxima recorrencia", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataInicialCancelamento", - "in": "query", - "description": "Data inicial de cancelamento", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinalCancelamento", - "in": "query", - "description": "Data final de cancelamento", - "schema": { - "type": "string", - "format": "date" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.131Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.131Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataProximoPedido": { - "type": "string", - "example": "2022-06-13T11:13:55.131Z" - }, - "periodoRecorrencia": { - "type": "string", - "example": "string" - }, - "situacaoAssinatura": { - "type": "string", - "example": "Ativa" - }, - "dataAssinatura": { - "type": "string", - "example": "2022-06-13T11:13:55.131Z" - }, - "grupoAssinatura": { - "type": "string", - "example": "string" - }, - "enderecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioCartaoCreditoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupom": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "\t{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a71e408531cf0116289180" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json deleted file mode 100644 index ed1baac90..000000000 --- a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/documento/{documento}/pedidos": { - "get": { - "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", - "description": "Retorna lista contendo os Id's dos pedidos do usuário", - "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1", - "parameters": [ - { - "name": "documento", - "in": "path", - "description": "Documento (CPF ou CNPJ) do usuário cujos pedidos devem ser selecionados. Utilizar apenas números, sem caracteres especiais", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoDocumento", - "in": "query", - "description": "Define se o documento informado é um CPF ou um CNPJ", - "schema": { - "type": "string", - "enum": [ - "Cpf", - "Cnpj" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "links": { - "type": "array", - "items": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "string" - }, - "rel": { - "type": "string", - "example": "string" - }, - "method": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de9fe86b05db02773d3a7b" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json deleted file mode 100644 index 9512d5613..000000000 --- a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/pedidos": { - "get": { - "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", - "description": "Retorna lista contendo os Id's dos pedidos do usuário", - "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário cujos pedidos devem ser selecionados", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "links": { - "type": "array", - "items": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "string" - }, - "rel": { - "type": "string", - "example": "string" - }, - "method": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de9eecdd8ea90037ba6dac" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json deleted file mode 100644 index 4b8e4f492..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json +++ /dev/null @@ -1,228 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/avaliacoes": { - "get": { - "summary": "Retorna uma lista de avaliações referente ao identificador informado", - "description": "Lista de avaliações de produtos", - "operationId": "retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "status", - "in": "query", - "description": "Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado']", - "schema": { - "type": "string", - "enum": [ - "Pendente", - "NaoAprovado", - "Aprovado" - ] - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-05T11:54:29.823Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "produtoAvaliacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comentario": { - "type": "string", - "example": "string" - }, - "avaliacao": { - "type": "integer", - "example": 0, - "default": 0 - }, - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "dataAvaliacao": { - "type": "string", - "example": "2022-07-05T11:54:29.823Z" - }, - "nome": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "status": { - "type": "string", - "example": "Pendente" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c491a0321dcc00476abb30" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json deleted file mode 100644 index d1146e6d8..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json +++ /dev/null @@ -1,195 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes/{freteId}/detalhes": { - "get": { - "summary": "Retorna uma lista de detalhes de um contrato de frete", - "description": "Lista de detalhes de frete", - "operationId": "retorna-uma-lista-de-detalhes-de-um-contrato-de-frete", - "parameters": [ - { - "name": "freteId", - "in": "path", - "description": "Id do contrato de frete", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"freteId\": 0,\n \"cepInicial\": 0,\n \"cepFinal\": 0,\n \"variacoesFreteDetalhe\": [\n {\n \"pesoInicial\": 0,\n \"pesoFinal\": 0,\n \"valorFrete\": 0,\n \"prazoEntrega\": 0,\n \"valorPreco\": 0,\n \"valorPeso\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cepInicial": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cepFinal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "variacoesFreteDetalhe": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pesoInicial": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoFinal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFrete": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEntrega": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorPreco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorPeso": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0d3c93b7a6b014fcbfeea" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json deleted file mode 100644 index a5d313d70..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/enderecos": { - "get": { - "summary": "Retorna uma lista de endereços de um usuário pelo e-mail do usuário", - "description": "Retorna usuário encontrado", - "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "enderecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeEndereco": { - "type": "string", - "example": "string" - }, - "rua": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "utilizadoUltimoPedido": { - "type": "boolean", - "example": true, - "default": true - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62daac9ece40ec00a5a65a44" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json deleted file mode 100644 index 232278225..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{usuarioId}/enderecos": { - "get": { - "summary": "Retorna uma lista de endereços de um usuário pelo id do usuário", - "description": "Retorna usuário encontrado", - "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario", - "parameters": [ - { - "name": "usuarioId", - "in": "path", - "description": "Id do usuário", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "enderecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeEndereco": { - "type": "string", - "example": "string" - }, - "rua": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "utilizadoUltimoPedido": { - "type": "boolean", - "example": true, - "default": true - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62dad4e0c63a6b0060b401bc" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json deleted file mode 100644 index fdc066421..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json +++ /dev/null @@ -1,208 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/fretes": { - "get": { - "summary": "Retorna uma lista de fretes", - "description": "Lista de fretes", - "operationId": "retorna-uma-lista-de-fretes", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "volumeMaximo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCubado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "entregaAgendadaConfiguracaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "linkRastreamento": { - "type": "string", - "example": "string" - }, - "ehAssinatura": { - "type": "boolean", - "example": true, - "default": true - }, - "larguraMaxima": { - "type": "integer", - "example": 0, - "default": 0 - }, - "alturaMaxima": { - "type": "integer", - "example": 0, - "default": 0 - }, - "comprimentoMaximo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "limiteMaximoDimensoes": { - "type": "integer", - "example": 0, - "default": 0 - }, - "limitePesoCubado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tempoMinimoDespacho": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorMinimoProdutos": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b0a6283b94840120ec907e" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json deleted file mode 100644 index 1fe1eb719..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json +++ /dev/null @@ -1,149 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/grupospersonalizacao": { - "get": { - "summary": "Retorna uma lista de Grupos de Personalização", - "description": "Lista de Grupos de Personalização", - "operationId": "retorna-uma-lista-de-grupos-de-personalizacao", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"grupoPersonalizacaoId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"obrigatorio\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "grupoPersonalizacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "obrigatorio": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5bb6ad8135202d40e7db6" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json deleted file mode 100644 index bde6ad449..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json +++ /dev/null @@ -1,169 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/imagens": { - "get": { - "summary": "Retorna uma lista de imagens de um produto", - "description": "Lista de imagens vinculadas a um produtos", - "operationId": "retorna-uma-lista-de-imagens-de-um-produto", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - }, - { - "name": "produtosIrmaos", - "in": "query", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"idImagem\": 0,\n \"nomeArquivo\": \"string\",\n \"url\": \"string\",\n \"ordem\": 0,\n \"estampa\": true,\n \"exibirMiniatura\": true\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "idImagem": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeArquivo": { - "type": "string", - "example": "string" - }, - "url": { - "type": "string", - "example": "string" - }, - "ordem": { - "type": "integer", - "example": 0, - "default": 0 - }, - "estampa": { - "type": "boolean", - "example": true, - "default": true - }, - "exibirMiniatura": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c468bf652a13003566a311" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json deleted file mode 100644 index 5ef99bc9a..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json +++ /dev/null @@ -1,1280 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/formaPagamento/{formasPagamento}": { - "get": { - "summary": "Retorna uma lista de pedido baseado nas formas de pagamento", - "description": "Lista de pedidos", - "operationId": "retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento", - "parameters": [ - { - "name": "formasPagamento", - "in": "path", - "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3)", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "enumTipoFiltroData", - "in": "query", - "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", - "schema": { - "type": "string", - "enum": [ - "DataPedido", - "DataAprovacao", - "DataModificacaoStatus", - "DataAlteracao", - "DataCriacao" - ] - } - }, - { - "name": "situacoesPedido", - "in": "query", - "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", - "schema": { - "type": "string" - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.169Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.169Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.169Z\",\n \"ate\": \"2022-06-28T11:18:19.169Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.169Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoRastreamentoPedido": { - "type": "string", - "example": "SemRastreamento" - }, - "transacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "dataPagamento": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "dataUltimaAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "valorFrete": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotalPedido": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDebitoCC": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupomDesconto": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoId": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoSiteId": { - "type": "string", - "example": "string" - }, - "canalId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "canalNome": { - "type": "string", - "example": "string" - }, - "canalOrigem": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isPedidoEvento": { - "type": "boolean", - "example": true, - "default": true - }, - "usuario": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "pedidoEndereco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Entrega" - }, - "nome": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "tipoLogradouro": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - }, - "frete": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "referenciaConector": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centrosDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "servico": { - "type": "object", - "properties": { - "servicoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoNome": { - "type": "string", - "example": "string" - }, - "preco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoTransporte": { - "type": "integer", - "example": 0, - "default": 0 - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoMeta": { - "type": "string", - "example": "string" - }, - "custo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "token": { - "type": "string", - "example": "string" - } - } - }, - "retiradaAgendada": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "retiradaData": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "retiradaPeriodo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "documento": { - "type": "string", - "example": "string" - }, - "codigoRetirada": { - "type": "string", - "example": "string" - } - } - }, - "agendamento": { - "type": "object", - "properties": { - "de": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "ate": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "itens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isBrinde": { - "type": "boolean", - "example": true, - "default": true - }, - "valorAliquota": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "totais": { - "type": "object", - "properties": { - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "ajustes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Frete" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "observacao": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - } - } - } - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "valoresAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Acrescimo" - }, - "origem": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtributoValor": { - "type": "string", - "example": "string" - }, - "produtoVarianteAtributoNome": { - "type": "string", - "example": "string" - } - } - } - }, - "embalagens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEmbalagemId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeTipoEmbalagem": { - "type": "string", - "example": "string" - }, - "mensagem": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - }, - "personalizacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nomePersonalizacao": { - "type": "string", - "example": "string" - }, - "valorPersonalizacao": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "frete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dadosProdutoEvento": { - "type": "object", - "properties": { - "tipoPresenteRecebimento": { - "type": "string", - "example": "None" - } - } - }, - "formulas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chaveAjuste": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "expressao": { - "type": "string", - "example": "string" - }, - "expressaoInterpretada": { - "type": "string", - "example": "string" - }, - "endPoint": { - "type": "string", - "example": "string" - } - } - } - }, - "seller": { - "type": "object", - "properties": { - "sellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sellerNome": { - "type": "string", - "example": "string" - }, - "sellerPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "assinatura": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoPeriodo": { - "type": "string", - "example": "string" - }, - "tempoPeriodo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "percentualDesconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "pagamento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "formaPagamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroParcelas": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorParcela": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorJuros": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "boleto": { - "type": "object", - "properties": { - "urlBoleto": { - "type": "string", - "example": "string" - }, - "codigoDeBarras": { - "type": "string", - "example": "string" - } - } - }, - "cartaoCredito": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroCartao": { - "type": "string", - "example": "string" - }, - "nomeTitular": { - "type": "string", - "example": "string" - }, - "dataValidade": { - "type": "string", - "example": "string" - }, - "codigoSeguranca": { - "type": "string", - "example": "string" - }, - "documentoCartaoCredito": { - "type": "string", - "example": "string" - }, - "token": { - "type": "string", - "example": "string" - }, - "info": { - "type": "string", - "example": "string" - }, - "bandeira": { - "type": "string", - "example": "string" - } - } - } - }, - "pagamentoStatus": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroAutorizacao": { - "type": "string", - "example": "string" - }, - "numeroComprovanteVenda": { - "type": "string", - "example": "string" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "dataUltimoStatus": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "adquirente": { - "type": "string", - "example": "string" - }, - "tid": { - "type": "string", - "example": "string" - } - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "observacao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "observacao": { - "type": "string", - "example": "string" - }, - "usuario": { - "type": "string", - "example": "string" - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.169Z" - }, - "publica": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "valorCreditoFidelidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "valorSubTotalSemDescontos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoSplit": { - "type": "array", - "items": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb0dadb323c1002b595c79" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json deleted file mode 100644 index 723a239e7..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json +++ /dev/null @@ -1,1288 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/situacaoPedido/{situacoesPedido}": { - "get": { - "summary": "Retorna uma lista de pedido baseado nas situações de pedidos", - "description": "Lista de pedidos", - "operationId": "retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "enumTipoFiltroData", - "in": "query", - "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", - "schema": { - "type": "string", - "enum": [ - "DataPedido", - "DataAprovacao", - "DataModificacaoStatus", - "DataAlteracao", - "DataCriacao" - ] - } - }, - { - "name": "formasPagamento", - "in": "query", - "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", - "schema": { - "type": "string" - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "situacoesPedido", - "in": "path", - "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "apenasAssinaturas", - "in": "query", - "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.146Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.146Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.146Z\",\n \"ate\": \"2022-06-28T11:18:19.146Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.146Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoRastreamentoPedido": { - "type": "string", - "example": "SemRastreamento" - }, - "transacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "dataPagamento": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "dataUltimaAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "valorFrete": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotalPedido": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDebitoCC": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupomDesconto": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoId": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoSiteId": { - "type": "string", - "example": "string" - }, - "canalId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "canalNome": { - "type": "string", - "example": "string" - }, - "canalOrigem": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isPedidoEvento": { - "type": "boolean", - "example": true, - "default": true - }, - "usuario": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "pedidoEndereco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Entrega" - }, - "nome": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "tipoLogradouro": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - }, - "frete": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "referenciaConector": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centrosDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "servico": { - "type": "object", - "properties": { - "servicoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoNome": { - "type": "string", - "example": "string" - }, - "preco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoTransporte": { - "type": "integer", - "example": 0, - "default": 0 - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoMeta": { - "type": "string", - "example": "string" - }, - "custo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "token": { - "type": "string", - "example": "string" - } - } - }, - "retiradaAgendada": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "retiradaData": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "retiradaPeriodo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "documento": { - "type": "string", - "example": "string" - }, - "codigoRetirada": { - "type": "string", - "example": "string" - } - } - }, - "agendamento": { - "type": "object", - "properties": { - "de": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "ate": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "itens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isBrinde": { - "type": "boolean", - "example": true, - "default": true - }, - "valorAliquota": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "totais": { - "type": "object", - "properties": { - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "ajustes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Frete" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "observacao": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - } - } - } - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "valoresAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Acrescimo" - }, - "origem": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtributoValor": { - "type": "string", - "example": "string" - }, - "produtoVarianteAtributoNome": { - "type": "string", - "example": "string" - } - } - } - }, - "embalagens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEmbalagemId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeTipoEmbalagem": { - "type": "string", - "example": "string" - }, - "mensagem": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - }, - "personalizacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nomePersonalizacao": { - "type": "string", - "example": "string" - }, - "valorPersonalizacao": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "frete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dadosProdutoEvento": { - "type": "object", - "properties": { - "tipoPresenteRecebimento": { - "type": "string", - "example": "None" - } - } - }, - "formulas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chaveAjuste": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "expressao": { - "type": "string", - "example": "string" - }, - "expressaoInterpretada": { - "type": "string", - "example": "string" - }, - "endPoint": { - "type": "string", - "example": "string" - } - } - } - }, - "seller": { - "type": "object", - "properties": { - "sellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sellerNome": { - "type": "string", - "example": "string" - }, - "sellerPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "assinatura": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoPeriodo": { - "type": "string", - "example": "string" - }, - "tempoPeriodo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "percentualDesconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "pagamento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "formaPagamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroParcelas": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorParcela": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorJuros": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "boleto": { - "type": "object", - "properties": { - "urlBoleto": { - "type": "string", - "example": "string" - }, - "codigoDeBarras": { - "type": "string", - "example": "string" - } - } - }, - "cartaoCredito": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroCartao": { - "type": "string", - "example": "string" - }, - "nomeTitular": { - "type": "string", - "example": "string" - }, - "dataValidade": { - "type": "string", - "example": "string" - }, - "codigoSeguranca": { - "type": "string", - "example": "string" - }, - "documentoCartaoCredito": { - "type": "string", - "example": "string" - }, - "token": { - "type": "string", - "example": "string" - }, - "info": { - "type": "string", - "example": "string" - }, - "bandeira": { - "type": "string", - "example": "string" - } - } - } - }, - "pagamentoStatus": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroAutorizacao": { - "type": "string", - "example": "string" - }, - "numeroComprovanteVenda": { - "type": "string", - "example": "string" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "dataUltimoStatus": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "adquirente": { - "type": "string", - "example": "string" - }, - "tid": { - "type": "string", - "example": "string" - } - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "observacao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "observacao": { - "type": "string", - "example": "string" - }, - "usuario": { - "type": "string", - "example": "string" - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.146Z" - }, - "publica": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "valorCreditoFidelidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "valorSubTotalSemDescontos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoSplit": { - "type": "array", - "items": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb0b3f0e1e7e0046b3e6f6" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json deleted file mode 100644 index 7ef76245c..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json +++ /dev/null @@ -1,1311 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos": { - "get": { - "summary": "Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas", - "description": "Lista de pedidos", - "operationId": "retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "enumTipoFiltroData", - "in": "query", - "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", - "schema": { - "type": "string", - "enum": [ - "DataPedido", - "DataAprovacao", - "DataModificacaoStatus", - "DataAlteracao", - "DataCriacao" - ] - } - }, - { - "name": "situacoesPedido", - "in": "query", - "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", - "schema": { - "type": "string" - } - }, - { - "name": "formasPagamento", - "in": "query", - "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", - "schema": { - "type": "string" - } - }, - { - "name": "pagina", - "in": "query", - "description": "Página da lista (padrão: 1)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "quantidadeRegistros", - "in": "query", - "description": "Quantidade de registros que deverão retornar (max: 50)", - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "email", - "in": "query", - "description": "Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado", - "schema": { - "type": "string" - } - }, - { - "name": "valido", - "in": "query", - "description": "Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado)", - "schema": { - "type": "boolean" - } - }, - { - "name": "sku", - "in": "query", - "description": "Deverá retornar apenas pedidos que o produto de determinado sku foi comprado", - "schema": { - "type": "string" - } - }, - { - "name": "apenasAssinaturas", - "in": "query", - "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.095Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.095Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.095Z\",\n \"ate\": \"2022-06-28T11:18:19.095Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.095Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoRastreamentoPedido": { - "type": "string", - "example": "SemRastreamento" - }, - "transacaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "dataPagamento": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "dataUltimaAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "valorFrete": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotalPedido": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDebitoCC": { - "type": "integer", - "example": 0, - "default": 0 - }, - "cupomDesconto": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoId": { - "type": "string", - "example": "string" - }, - "marketPlacePedidoSiteId": { - "type": "string", - "example": "string" - }, - "canalId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "canalNome": { - "type": "string", - "example": "string" - }, - "canalOrigem": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isPedidoEvento": { - "type": "boolean", - "example": true, - "default": true - }, - "usuario": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - }, - "tipoPessoa": { - "type": "string", - "example": "Fisica" - }, - "origemContato": { - "type": "string", - "example": "Google" - }, - "tipoSexo": { - "type": "string", - "example": "Undefined" - }, - "nome": { - "type": "string", - "example": "string" - }, - "cpf": { - "type": "string", - "example": "string" - }, - "email": { - "type": "string", - "example": "string" - }, - "rg": { - "type": "string", - "example": "string" - }, - "telefoneResidencial": { - "type": "string", - "example": "string" - }, - "telefoneCelular": { - "type": "string", - "example": "string" - }, - "telefoneComercial": { - "type": "string", - "example": "string" - }, - "dataNascimento": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "razaoSocial": { - "type": "string", - "example": "string" - }, - "cnpj": { - "type": "string", - "example": "string" - }, - "inscricaoEstadual": { - "type": "string", - "example": "string" - }, - "responsavel": { - "type": "string", - "example": "string" - }, - "dataCriacao": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "revendedor": { - "type": "boolean", - "example": true, - "default": true - }, - "listaInformacaoCadastral": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "pedidoEndereco": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Entrega" - }, - "nome": { - "type": "string", - "example": "string" - }, - "endereco": { - "type": "string", - "example": "string" - }, - "numero": { - "type": "string", - "example": "string" - }, - "complemento": { - "type": "string", - "example": "string" - }, - "referencia": { - "type": "string", - "example": "string" - }, - "cep": { - "type": "string", - "example": "string" - }, - "tipoLogradouro": { - "type": "string", - "example": "string" - }, - "logradouro": { - "type": "string", - "example": "string" - }, - "bairro": { - "type": "string", - "example": "string" - }, - "cidade": { - "type": "string", - "example": "string" - }, - "estado": { - "type": "string", - "example": "string" - }, - "pais": { - "type": "string", - "example": "string" - } - } - } - }, - "frete": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "referenciaConector": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "retiradaLojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "centrosDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "servico": { - "type": "object", - "properties": { - "servicoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "transportadora": { - "type": "string", - "example": "string" - }, - "prazo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoNome": { - "type": "string", - "example": "string" - }, - "preco": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoTransporte": { - "type": "integer", - "example": 0, - "default": 0 - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "servicoMeta": { - "type": "string", - "example": "string" - }, - "custo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "token": { - "type": "string", - "example": "string" - } - } - }, - "retiradaAgendada": { - "type": "object", - "properties": { - "lojaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "retiradaData": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "retiradaPeriodo": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "documento": { - "type": "string", - "example": "string" - }, - "codigoRetirada": { - "type": "string", - "example": "string" - } - } - }, - "agendamento": { - "type": "object", - "properties": { - "de": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "ate": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "itens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sku": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isBrinde": { - "type": "boolean", - "example": true, - "default": true - }, - "valorAliquota": { - "type": "integer", - "example": 0, - "default": 0 - }, - "isMarketPlace": { - "type": "boolean", - "example": true, - "default": true - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "totais": { - "type": "object", - "properties": { - "precoCusto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoVenda": { - "type": "integer", - "example": 0, - "default": 0 - }, - "precoPor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "desconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - }, - "ajustes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Frete" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "observacao": { - "type": "string", - "example": "string" - }, - "nome": { - "type": "string", - "example": "string" - } - } - } - }, - "centroDistribuicao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoProdutoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "valoresAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipo": { - "type": "string", - "example": "Acrescimo" - }, - "origem": { - "type": "string", - "example": "string" - }, - "texto": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "atributos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteAtributoValor": { - "type": "string", - "example": "string" - }, - "produtoVarianteAtributoNome": { - "type": "string", - "example": "string" - } - } - } - }, - "embalagens": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEmbalagemId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeTipoEmbalagem": { - "type": "string", - "example": "string" - }, - "mensagem": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "descricao": { - "type": "string", - "example": "string" - } - } - } - }, - "personalizacoes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "nomePersonalizacao": { - "type": "string", - "example": "string" - }, - "valorPersonalizacao": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "frete": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContratoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "freteContrato": { - "type": "string", - "example": "string" - }, - "valorFreteEmpresa": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorFreteCliente": { - "type": "integer", - "example": 0, - "default": 0 - }, - "peso": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pesoCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volume": { - "type": "integer", - "example": 0, - "default": 0 - }, - "volumeCobrado": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvio": { - "type": "integer", - "example": 0, - "default": 0 - }, - "prazoEnvioTexto": { - "type": "string", - "example": "string" - }, - "centroDistribuicaoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "dadosProdutoEvento": { - "type": "object", - "properties": { - "tipoPresenteRecebimento": { - "type": "string", - "example": "None" - } - } - }, - "formulas": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chaveAjuste": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "expressao": { - "type": "string", - "example": "string" - }, - "expressaoInterpretada": { - "type": "string", - "example": "string" - }, - "endPoint": { - "type": "string", - "example": "string" - } - } - } - }, - "seller": { - "type": "object", - "properties": { - "sellerId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "sellerNome": { - "type": "string", - "example": "string" - }, - "sellerPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - }, - "assinatura": { - "type": "array", - "items": { - "type": "object", - "properties": { - "assinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "tipoPeriodo": { - "type": "string", - "example": "string" - }, - "tempoPeriodo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "percentualDesconto": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - }, - "pagamento": { - "type": "array", - "items": { - "type": "object", - "properties": { - "formaPagamentoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "numeroParcelas": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorParcela": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorDesconto": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorJuros": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valorTotal": { - "type": "integer", - "example": 0, - "default": 0 - }, - "boleto": { - "type": "object", - "properties": { - "urlBoleto": { - "type": "string", - "example": "string" - }, - "codigoDeBarras": { - "type": "string", - "example": "string" - } - } - }, - "cartaoCredito": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroCartao": { - "type": "string", - "example": "string" - }, - "nomeTitular": { - "type": "string", - "example": "string" - }, - "dataValidade": { - "type": "string", - "example": "string" - }, - "codigoSeguranca": { - "type": "string", - "example": "string" - }, - "documentoCartaoCredito": { - "type": "string", - "example": "string" - }, - "token": { - "type": "string", - "example": "string" - }, - "info": { - "type": "string", - "example": "string" - }, - "bandeira": { - "type": "string", - "example": "string" - } - } - } - }, - "pagamentoStatus": { - "type": "array", - "items": { - "type": "object", - "properties": { - "numeroAutorizacao": { - "type": "string", - "example": "string" - }, - "numeroComprovanteVenda": { - "type": "string", - "example": "string" - }, - "dataAtualizacao": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "dataUltimoStatus": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "adquirente": { - "type": "string", - "example": "string" - }, - "tid": { - "type": "string", - "example": "string" - } - } - } - }, - "informacoesAdicionais": { - "type": "array", - "items": { - "type": "object", - "properties": { - "chave": { - "type": "string", - "example": "string" - }, - "valor": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "observacao": { - "type": "array", - "items": { - "type": "object", - "properties": { - "observacao": { - "type": "string", - "example": "string" - }, - "usuario": { - "type": "string", - "example": "string" - }, - "data": { - "type": "string", - "example": "2022-06-28T11:18:19.095Z" - }, - "publica": { - "type": "boolean", - "example": true, - "default": true - } - } - } - }, - "valorCreditoFidelidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valido": { - "type": "boolean", - "example": true, - "default": true - }, - "valorSubTotalSemDescontos": { - "type": "integer", - "example": 0, - "default": 0 - }, - "pedidoSplit": { - "type": "array", - "items": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bae3b9b8853603c36aa0ac" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json deleted file mode 100644 index 267be5679..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { - "get": { - "summary": "Retorna uma lista de produtos vinculados a um Grupo de Personalização", - "description": "Lista de produtos de um Grupo de Personalização", - "operationId": "retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao", - "parameters": [ - { - "name": "grupoPersonalizacaoId", - "in": "path", - "description": "Id do grupo de personalização", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoId\": 0,\n \"nome\": \"string\",\n \"alias\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "alias": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5eaba411a4f0490f2ff6f" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json deleted file mode 100644 index f1ae7e096..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json +++ /dev/null @@ -1,114 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/limiteCredito": { - "get": { - "summary": "Retorna uma lista de usuários com o limite de credito de cada um", - "description": "Limite de crédito que estão vinculados aos usuários", - "operationId": "retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "usuarioId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "valor": { - "type": "integer", - "example": 0, - "default": 0 - }, - "saldo": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de92ea30c2cc001a8dab2c" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json deleted file mode 100644 index 7075c74fa..000000000 --- a/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/usuarios/{email}/parceiros": { - "get": { - "summary": "Retorna uma lista de vínculos entre usuário e parceiro", - "description": "", - "operationId": "retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro", - "parameters": [ - { - "name": "email", - "in": "path", - "description": "E-mail do usuário", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62de8551112bba03862e8816" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json b/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json deleted file mode 100644 index d493fe95e..000000000 --- a/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json +++ /dev/null @@ -1,181 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/produtos": { - "get": { - "summary": "Retorna uma listagem com dados dos produtos mais vendidos pela loja ou parceiro", - "description": "Produtos Mais Vendidos", - "operationId": "retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro", - "parameters": [ - { - "name": "dataInicial", - "in": "query", - "description": "Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "dataFinal", - "in": "query", - "description": "Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", - "schema": { - "type": "string", - "format": "date" - } - }, - { - "name": "parceiroId", - "in": "query", - "description": "Id do parceiro", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"produtoVarianteId\": 0,\n \"nomeProduto\": \"string\",\n \"sku\": \"string\",\n \"quantidade\": 0,\n \"receita\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nomeProduto": { - "type": "string", - "example": "string" - }, - "sku": { - "type": "string", - "example": "string" - }, - "quantidade": { - "type": "integer", - "example": 0, - "default": 0 - }, - "receita": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa3c01412c6f0066379e7d" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json b/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json deleted file mode 100644 index 54b9bd021..000000000 --- a/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json +++ /dev/null @@ -1,160 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/dashboard/pedidos": { - "get": { - "summary": "Retorna uma listagem com os últimos dez pedidos da loja", - "description": "Últimos Pedidos", - "operationId": "retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"situacaoNome\": \"string\",\n \"data\": \"2022-06-15T13:26:37.804Z\",\n \"dataFormatado\": \"string\",\n \"hora\": \"string\",\n \"valorTotal\": \"string\"\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoPedidoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "situacaoNome": { - "type": "string", - "example": "string" - }, - "data": { - "type": "string", - "example": "2022-06-15T13:26:37.804Z" - }, - "dataFormatado": { - "type": "string", - "example": "string" - }, - "hora": { - "type": "string", - "example": "string" - }, - "valorTotal": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62aa381d3b0ee700a1f930f6" -} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json deleted file mode 100644 index 6733d2dc7..000000000 --- a/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json +++ /dev/null @@ -1,135 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tabelaPrecos/{tabelaPrecoId}": { - "get": { - "summary": "Retorna uma tabela de preços", - "description": "Tabela de preços específica", - "operationId": "retorna-uma-tabela-de-precos", - "parameters": [ - { - "name": "tabelaPrecoId", - "in": "path", - "description": "Id da tabela de preço", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "{\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.627Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.627Z\",\n \"ativo\": true,\n \"isSite\": true\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "tabelaPrecoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dataInicial": { - "type": "string", - "example": "2022-07-19T11:05:47.627Z" - }, - "dataFinal": { - "type": "string", - "example": "2022-07-19T11:05:47.627Z" - }, - "ativo": { - "type": "boolean", - "example": true, - "default": true - }, - "isSite": { - "type": "boolean", - "example": true, - "default": true - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d6a8456f513300317abca1" -} \ No newline at end of file diff --git a/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json b/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json deleted file mode 100644 index 35301bd18..000000000 --- a/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json +++ /dev/null @@ -1,161 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/assinaturas/grupoassinatura": { - "get": { - "summary": "Retorna os dados de um grupo de assinatura de uma loja", - "description": "Grupo de assinatura", - "operationId": "retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "[\n {\n \"grupoAssinaturaId\": 0,\n \"nome\": \"string\",\n \"recorrencias\": [\n {\n \"recorrenciaId\": 0,\n \"nome\": \"string\",\n \"dias\": 0\n }\n ]\n }\n]" - } - }, - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "grupoAssinaturaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "recorrencias": { - "type": "array", - "items": { - "type": "object", - "properties": { - "recorrenciaId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "nome": { - "type": "string", - "example": "string" - }, - "dias": { - "type": "integer", - "example": 0, - "default": 0 - } - } - } - } - } - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:63adc84efc75ef0061a4e4b0" -} \ No newline at end of file diff --git a/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json b/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json deleted file mode 100644 index 2180cd130..000000000 --- a/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json +++ /dev/null @@ -1,126 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/principal": { - "put": { - "summary": "Seta identificador como variante principal", - "description": "Seta identificador como variante principal", - "operationId": "seta-identificador-como-variante-principal", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c49900ba2366007d5c7cf0" -} \ No newline at end of file diff --git a/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json b/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json deleted file mode 100644 index 3e3b11657..000000000 --- a/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json +++ /dev/null @@ -1,147 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/pedidos/complete": { - "post": { - "summary": "Seta o pedido como integrado", - "description": "", - "operationId": "seta-o-pedido-como-integrado", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "object", - "description": "Pedido que se deseja inserir o \"complete\"", - "properties": { - "pedidoId": { - "type": "integer", - "description": "Id do pedido", - "format": "int32" - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bb38fe1be7fc00138e6340" -} \ No newline at end of file diff --git a/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json b/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json deleted file mode 100644 index e8bc5f012..000000000 --- a/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/produtos/{identificador}/situacao": { - "put": { - "summary": "Seta status ativo/inativo do produto variante", - "description": "Seta status do produto variante como ativo ou inativo", - "operationId": "seta-status-ativoinativo-do-produto-variante", - "parameters": [ - { - "name": "identificador", - "in": "path", - "description": "Valor único utilizado para identificar o produto", - "schema": { - "type": "string" - }, - "required": true - }, - { - "name": "tipoIdentificador", - "in": "query", - "description": "Define se o identificador informado é um sku ou um id interno.", - "schema": { - "type": "string", - "enum": [ - "Sku", - "ProdutoVarianteId" - ] - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "status": { - "type": "boolean", - "description": "Define se o produto variante informado será ativo ou inativo" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62c499af3ccc21003edd7624" -} \ No newline at end of file diff --git a/wake/utils/openapi/templates.openapi.json b/wake/utils/openapi/templates.openapi.json deleted file mode 100644 index 7ace52fc3..000000000 --- a/wake/utils/openapi/templates.openapi.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/templates": { - "get": { - "summary": "Templates", - "description": "", - "operationId": "templates", - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "OK": { - "value": "OK" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62d070a2477c3d00691210b6" -} \ No newline at end of file diff --git a/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json b/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json deleted file mode 100644 index ae94a5414..000000000 --- a/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/autenticacao/trocarLoja/{novaLoja}": { - "post": { - "summary": "Troca o usuário de loja e gera um novo access_token para acesso a nova loja", - "description": "Novo token gerado com sucesso", - "operationId": "troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja", - "parameters": [ - { - "name": "novaLoja", - "in": "path", - "description": "Loja para qual o usuário deseja autenticar.", - "schema": { - "type": "string" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.424Z\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "lojas": { - "type": "array", - "items": { - "type": "string", - "example": "string" - } - }, - "accessToken": { - "type": "string", - "example": "string" - }, - "dataExpiracaoAccessTokenUTC": { - "type": "string", - "example": "2022-06-09T11:21:37.424Z" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a2492cf0f787009eb5b9b0" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json b/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json deleted file mode 100644 index bbcd9d8ab..000000000 --- a/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/hotsites": { - "post": { - "summary": "Vincula hotsites com um banner específico", - "description": "", - "operationId": "vincula-hotsites-com-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve vincular os hotsites", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "RAW_BODY": { - "type": "array", - "description": "lista de identificadores de hotsites a serem vinculados ao banner", - "items": { - "properties": { - "hotSiteId": { - "type": "integer", - "description": "Id do hotsite (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a749052436ab012aa552c9" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json b/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json deleted file mode 100644 index 1879ffe5d..000000000 --- a/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/banners/{bannerId}/parceiros": { - "post": { - "summary": "Vincula parceiros com um banner específico", - "description": "", - "operationId": "vincula-parceiros-com-um-banner-especifico", - "parameters": [ - { - "name": "bannerId", - "in": "path", - "description": "Identificador do banner que deve vincular os parceiros", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de Id dos parceiros", - "items": { - "properties": { - "parceiroId": { - "type": "integer", - "description": "Id do parceiro (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a7753bb2fa3800809051e5" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json deleted file mode 100644 index 9aff71bd4..000000000 --- a/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { - "post": { - "summary": "Vincula produtos a um Grupo de Personalização", - "description": "", - "operationId": "vincula-produtos-a-um-grupo-de-personalizacao", - "parameters": [ - { - "name": "grupoPersonalizacaoId", - "in": "path", - "description": "Id do grupo de personalização", - "schema": { - "type": "integer", - "format": "int32" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de Id dos produtos", - "items": { - "properties": { - "produtoId": { - "type": "integer", - "description": "Id do produto", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "201": { - "description": "201", - "content": { - "application/json": { - "examples": { - "Vinculo de produto com um Grupo de Personalização": { - "value": "Vínculo de produto com um Grupo de Personalização" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62b5eb60dcc89300505b65c2" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json deleted file mode 100644 index 038aceec9..000000000 --- a/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/banners": { - "post": { - "summary": "Vincula um ou mais banners a um hotsite específico", - "description": "", - "operationId": "vincula-um-ou-mais-banners-a-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser vinculado os banners", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "banners": { - "type": "array", - "description": "Lista de identificadores de banners para vincular ao hotsite", - "items": { - "properties": { - "bannerId": { - "type": "integer", - "description": "Identificador do banner (optional)", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a89dc7ae39270014280dd1" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json deleted file mode 100644 index ac8067fd7..000000000 --- a/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json +++ /dev/null @@ -1,162 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/hotsites/{hotsiteId}/conteudos": { - "post": { - "summary": "Vincula um ou mais conteúdos a um hotsite específico", - "description": "", - "operationId": "vincula-um-ou-mais-conteudos-a-um-hotsite-especifico", - "parameters": [ - { - "name": "hotsiteId", - "in": "path", - "description": "Identificador do hotsite a ser vinculado os conteúdos", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista de identificadores de conteúdos a serem vinculados", - "items": { - "properties": { - "conteudoId": { - "type": "integer", - "description": "Identificador do conteúdo", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62a8e60d0fc56200a8a966f2" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json deleted file mode 100644 index 7b97a81e5..000000000 --- a/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/eventos/{eventoId}/produtos": { - "post": { - "summary": "Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente", - "description": "", - "operationId": "vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente", - "parameters": [ - { - "name": "eventoId", - "in": "path", - "description": "Identificador do evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtosVariante": { - "type": "array", - "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "422": { - "description": "422", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ac8bbd70735c003bc9576a" -} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json deleted file mode 100644 index cc99163c0..000000000 --- a/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json +++ /dev/null @@ -1,177 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/tiposEvento/{tipoEventoId}/produtos": { - "post": { - "summary": "Vincula um ou mais produtos como sugestão para um tipo de evento", - "description": "Lista de resposta para cada produto vinculado", - "operationId": "vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento", - "parameters": [ - { - "name": "tipoEventoId", - "in": "path", - "description": "Identificador do tipo de evento", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "produtos": { - "type": "array", - "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", - "items": { - "properties": { - "produtoVarianteId": { - "type": "integer", - "description": "Identificador do produto variante", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "{\n \"sugestaoProdutosInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosNaoInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ]\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "sugestaoProdutosInseridos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - }, - "produtosNaoInseridos": { - "type": "array", - "items": { - "type": "object", - "properties": { - "tipoEventoId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "produtoVarianteId": { - "type": "integer", - "example": 0, - "default": 0 - }, - "detalhes": { - "type": "string", - "example": "string" - } - } - } - } - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Result": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62ceb295f1e06a02cf6061e8" -} \ No newline at end of file diff --git a/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json b/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json deleted file mode 100644 index ebc5ad505..000000000 --- a/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json +++ /dev/null @@ -1,143 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "API Pública", - "version": "1.0" - }, - "servers": [ - { - "url": "https://api.fbits.net/" - } - ], - "components": { - "securitySchemes": { - "sec0": { - "type": "apiKey", - "in": "header", - "x-default": "", - "name": "Authorization", - "x-bearer-format": "basic" - } - } - }, - "security": [ - { - "sec0": [] - } - ], - "paths": { - "/portfolios/{portfolioId}/produtos": { - "put": { - "summary": "Vinculo de produtos ao portfolio", - "description": "", - "operationId": "vinculo-de-produtos-ao-portfolio", - "parameters": [ - { - "name": "portfolioId", - "in": "path", - "description": "Id do portfolio que se deseja atualizar os produtos", - "schema": { - "type": "integer", - "format": "int64" - }, - "required": true - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "RAW_BODY" - ], - "properties": { - "RAW_BODY": { - "type": "array", - "description": "Lista dos Id's dos produtos", - "items": { - "properties": { - "produtoId": { - "type": "integer", - "description": "Id do produto", - "format": "int32" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "200", - "content": { - "application/json": { - "examples": { - "True": { - "value": "True" - } - } - } - } - }, - "404": { - "description": "404", - "content": { - "application/json": { - "examples": { - "Produto não encontrado": { - "value": "Produto não encontrado" - } - } - } - } - }, - "500": { - "description": "500", - "content": { - "application/json": { - "examples": { - "Erro no processamento da operação": { - "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" - } - }, - "schema": { - "type": "object", - "properties": { - "resultadoOperacao": { - "type": "boolean", - "example": true, - "default": true - }, - "codigo": { - "type": "integer", - "example": 0, - "default": 0 - }, - "mensagem": { - "type": "string", - "example": "string" - } - } - } - } - } - } - }, - "deprecated": false - } - } - }, - "x-readme": { - "headers": [], - "explorer-enabled": true, - "proxy-enabled": true, - "samples-enabled": true - }, - "x-readme-fauxas": true, - "_id": "629f940ff6822d00a2406e17:62bef37c5e40970014a6239c" -} \ No newline at end of file diff --git a/wake/utils/openapi/openapi.gen.ts b/wake/utils/openapi/wake.openapi.gen.ts similarity index 53% rename from wake/utils/openapi/openapi.gen.ts rename to wake/utils/openapi/wake.openapi.gen.ts index 635c7d1c6..05bae9cc8 100644 --- a/wake/utils/openapi/openapi.gen.ts +++ b/wake/utils/openapi/wake.openapi.gen.ts @@ -4,35 +4,67 @@ export interface API { /** @description Últimos Pedidos */ - "GET /dashboard/pedidos": { - response: { - pedidoId?: number; - situacaoPedidoId?: number; - situacaoNome?: string; - data?: string; - dataFormatado?: string; - hora?: string; - valorTotal?: string; - }[]; + "GET /dashboard/pedidos": {}; + /** @description Lista de hotsites vinculados ao banner */ + "GET /banners/:bannerId/hotsites": {}; + /** @description Vincula hotsites com um banner específico */ + "POST /banners/:bannerId/hotsites": { + searchParams: { + /** + * lista de identificadores de hotsites a serem vinculados ao banner + */ + RAW_BODY?: { + /** + * Id do hotsite (optional) + */ + hotSiteId?: number; + }[]; + }; }; /** @description Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não */ "PUT /banners/:bannerId/hotsites": { - body: { + searchParams: { /** * Exibição do banner nos hotsites */ exibirEmTodosHotsites?: boolean; }; }; + /** @description Deleta o vinculo de um ou mais hotsites com um banner específico */ + "DELETE /banners/:bannerId/hotsites": { + searchParams: { + /** + * Lista de identificadores de hotsites para desvincular do banner (optional) + */ + listaHotsites?: { + /** + * Id do hotsite para vinculo com banner + */ + hotSiteId?: { + /** + * Id do hotsite para vinculo com banner + */ + hotSiteId?: unknown[]; + }[]; + }; + }; + }; /** @description Retorna se o usuário ativou o recebimento de newsletter */ - "GET /usuarios/:email/comunicacao": { - response: { + "GET /usuarios/:email/comunicacao": {}; + /** @description Atualiza a comunicação de um usuário via newsletter */ + "PUT /usuarios/:email/comunicacao": { + searchParams: { + /** + * Novo status da comunicação via new ajuste realisletter + */ recebimentoNewsletter?: boolean; }; }; + /** @description Buscar autor por id */ + "GET /autores/:autorId": {}; /** @description Atualizar autor */ "PUT /autores/:autorId": { - body: { + searchParams: { /** * Nome do Autor */ @@ -43,179 +75,478 @@ export interface API { ativo?: boolean; }; }; + /** @description Deletar autor */ + "DELETE /autores/:autorId": {}; /** @description Retorna lista contendo os Id's dos pedidos do usuário */ - "GET /usuarios/:email/pedidos": { - response: { - pedidoId?: number; - links?: { - href?: string; - rel?: string; - method?: string; - }[]; - }[]; - }; + "GET /usuarios/:email/pedidos": {}; /** @description Usuário encontrado */ - "GET /usuarios/cpf/:cpf": { - response: { - usuarioId?: number; - bloqueado?: boolean; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - avatar?: string; - ip?: string; - aprovado?: boolean; - }; - }; + "GET /usuarios/cpf/:cpf": {}; /** @description Loja Física */ - "GET /lojasFisicas/:lojaFisicaId": { - response: { + "GET /lojasFisicas/:lojaFisicaId": {}; + /** @description Atualiza uma Loja Física */ + "PUT /lojasFisicas/:lojaFisicaId": { + searchParams: { + /** + * Id da loja (optional) + */ lojaId?: number; + /** + * Nome da loja (optional) + */ nome?: string; + /** + * DDD da localidade de destino da loja (optional) + */ ddd?: number; + /** + * Telefone da loja (optional) + */ telefone?: string; + /** + * E-mail de contato da loja (optional) + */ email?: string; + /** + * CEP do endereço da loja (optional) + */ cep?: string; + /** + * Logradouro do endereço da loja (optional) + */ logradouro?: string; + /** + * Número de localização do endereço da loja (optional) + */ numero?: string; + /** + * Complemento para localização da loja (optional) + */ complemento?: string; + /** + * Bairro do endereço do loja (optional) + */ bairro?: string; + /** + * Cidade em que a loja se encontra (optional) + */ cidade?: string; + /** + * Id do estado em que a loja se encontra (optional) + */ estadoId?: number; + /** + * Prazo de entrega (optional) + */ prazoEntrega?: number; + /** + * Prazo máximo para retirada (optional) + */ prazoMaximoRetirada?: number; + /** + * Status da loja (optional) + */ ativo?: boolean; + /** + * Valido (optional) + */ valido?: boolean; + /** + * Informações complementares da loja (optional) + */ textoComplementar?: string; + /** + * Se a retirada na loja será ativada (optional) + */ retirarNaLoja?: boolean; + /** + * Latitude (optional) + */ latitude?: number; + /** + * Longitude (optional) + */ longitude?: number; - centroDistribuicaoId?: number; + /** + * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) + */ centroDistribuicao?: { + /** + * Id do centro de distribuição + */ centroDistribuicaoId?: number; + /** + * Prazo de entrega + */ prazoEntrega?: number; }[]; }; }; + /** @description Remove uma Loja Física */ + "DELETE /lojasFisicas/:lojaFisicaId": {}; /** @description Atributo encontrado */ - "GET /atributos/:nome": { - response: { + "GET /atributos/:nome": {}; + /** @description Atualiza um atributo */ + "PUT /atributos/:nome": { + searchParams: { + /** + * Nome do atributo (optional) + */ nome?: string; - tipo?: string; - tipoExibicao?: string; + /** + * Tipo do atributo (optional) + */ + tipo?: + | { + "0": "S"; + "1": "e"; + "2": "l"; + "3": "e"; + "4": "c"; + "5": "a"; + "6": "o"; + } + | { "0": "F"; "1": "i"; "2": "l"; "3": "t"; "4": "r"; "5": "o" } + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "p"; + "4": "a"; + "5": "r"; + "6": "a"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "C"; + "1": "o"; + "2": "n"; + "3": "f"; + "4": "i"; + "5": "g"; + "6": "u"; + "7": "r"; + "8": "a"; + "9": "c"; + "10": "a"; + "11": "o"; + } + | { + "0": "E"; + "1": "x"; + "2": "c"; + "3": "l"; + "4": "u"; + "5": "s"; + "6": "i"; + "7": "v"; + "8": "o"; + "9": "G"; + "10": "o"; + "11": "o"; + "12": "g"; + "13": "l"; + "14": "e"; + }; + /** + * Tipo de exibição (optional) + */ + tipoExibicao?: + | { "0": "C"; "1": "o"; "2": "m"; "3": "b"; "4": "o" } + | { "0": "D"; "1": "i"; "2": "v" } + | { + "0": "D"; + "1": "i"; + "2": "v"; + "3": "C"; + "4": "o"; + "5": "m"; + "6": "C"; + "7": "o"; + "8": "r"; + } + | { + "0": "D"; + "1": "i"; + "2": "v"; + "3": "C"; + "4": "o"; + "5": "m"; + "6": "F"; + "7": "o"; + "8": "t"; + "9": "o"; + "10": "D"; + "11": "o"; + "12": "P"; + "13": "r"; + "14": "o"; + "15": "d"; + "16": "u"; + "17": "t"; + "18": "o"; + "19": "V"; + "20": "a"; + "21": "r"; + "22": "i"; + "23": "a"; + "24": "n"; + "25": "t"; + "26": "e"; + } + | { + "0": "J"; + "1": "a"; + "2": "v"; + "3": "a"; + "4": "s"; + "5": "c"; + "6": "r"; + "7": "i"; + "8": "p"; + "9": "t"; + }; + /** + * Prioridade do atributo (optional) + */ prioridade?: number; }; }; + /** @description Deleta um atributo */ + "DELETE /atributos/:nome": {}; /** @description Lista de resellers */ - "GET /resellers": { - response: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }[]; - }; - /** @description Reseller específico */ - "GET /resellers/:resellerId": { - response: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; - }; - /** @description Método que insere um produto na base */ - "POST /produtos": { - body: { + "GET /resellers": {}; + /** @description Insere um novo Seller no marketplace */ + "POST /resellers": { + searchParams: { /** - * Representa o ProdutoId agrupador por variante (optional) + * Razão Social/Nome do Reseller */ - idPaiExterno?: string; + razaoSocial?: string; /** - * Representa o ParentId agrupador por parent (optional) + * CNPJ do Seller */ - idVinculoExterno?: string; + cnpj?: string; /** - * (Max Length: 50) Sku do produto + * Inscrição Estadual do Seller */ - sku?: string; + inscricaoEstadual?: string; /** - * (Max Length: 300) Nome do produto variante + * Seller isento de inscrição estadual */ - nome?: string; + isento?: boolean; /** - * Nome do produto (pai do variante) (optional) + * Email de contato do Seller */ - nomeProdutoPai?: string; + email?: string; /** - * Tipo de exibição da matriz de atributos (optional) + * Telefone de contato do seller com ddd (xx) xxxx-xxxx */ - exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + telefone?: string; /** - * Se o produto aceita contra proposta (optional) + * Tipo de autonomia do vendedor */ - contraProposta?: boolean; + tipoAutonomia?: + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "A"; + "4": "u"; + "5": "t"; + "6": "o"; + "7": "n"; + "8": "o"; + "9": "m"; + "10": "i"; + "11": "a"; + } + | { + "0": "S"; + "1": "e"; + "2": "m"; + "3": "A"; + "4": "u"; + "5": "t"; + "6": "o"; + "7": "n"; + "8": "o"; + "9": "m"; + "10": "i"; + "11": "a"; + }; /** - * (Max Length: 100) Nome do fabricante + * Seller Ativo */ - fabricante?: string; + ativo?: boolean; /** - * (Max Length: 500) Nome do autor (optional) + * Se irá ter Split de frete boolean. Default:false */ - autor?: string; + split?: boolean; /** - * (Max Length: 100) Nome da editora (optional) + * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, */ - editora?: string; + buyBox?: boolean; /** - * (Max Length: 100) Nome da coleção (optional) + * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, */ - colecao?: string; + ativacaoAutomaticaProdutos?: boolean; /** - * (Max Length: 100) Nome do gênero (optional) + * Cep do Seller (utilizado para o calculo de frete) */ - genero?: string; + cep?: string; + }; + }; + /** @description Atualiza um novo Seller no marketplace */ + "PUT /resellers": { + searchParams: { /** - * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) + * Razão Social/Nome do Reseller */ - precoCusto?: number; + razaoSocial?: string; /** - * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) + * CNPJ do Seller */ - precoDe?: number; + cnpj?: string; /** - * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante + * Inscrição Estadual do Seller + */ + inscricaoEstadual?: string; + /** + * Seller isento de inscrição estadual + */ + isento?: boolean; + /** + * Email de contato do Seller + */ + email?: string; + /** + * Telefone de contato do seller com ddd (xx) xxxx-xxxx + */ + telefone?: string; + /** + * Tipo de autonomia do vendedor + */ + tipoAutonomia?: + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "A"; + "4": "u"; + "5": "t"; + "6": "o"; + "7": "n"; + "8": "o"; + "9": "m"; + "10": "i"; + "11": "a"; + } + | { + "0": "S"; + "1": "e"; + "2": "m"; + "3": "A"; + "4": "u"; + "5": "t"; + "6": "o"; + "7": "n"; + "8": "o"; + "9": "m"; + "10": "i"; + "11": "a"; + }; + /** + * Seller Ativo + */ + ativo?: boolean; + /** + * Se irá ter Split de frete boolean. Default:false + */ + split?: boolean; + /** + * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, + */ + buyBox?: boolean; + /** + * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, + */ + ativacaoAutomaticaProdutos?: boolean; + /** + * Cep do Seller (utilizado para o calculo de frete) + */ + cep?: string; + }; + }; + /** @description Reseller específico */ + "GET /resellers/:resellerId": {}; + /** @description Lista de produtos */ + "GET /produtos": {}; + /** @description Método que insere um produto na base */ + "POST /produtos": { + searchParams: { + /** + * Representa o ProdutoId agrupador por variante (optional) + */ + idPaiExterno?: string; + /** + * Representa o ParentId agrupador por parent (optional) + */ + idVinculoExterno?: string; + /** + * (Max Length: 50) Sku do produto + */ + sku?: string; + /** + * (Max Length: 300) Nome do produto variante + */ + nome?: string; + /** + * Nome do produto (pai do variante) (optional) + */ + nomeProdutoPai?: string; + /** + * Tipo de exibição da matriz de atributos (optional) + */ + exibirMatrizAtributos?: + | { "0": "S"; "1": "i"; "2": "m" } + | { "0": "N"; "1": "a"; "2": "o" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + /** + * Se o produto aceita contra proposta (optional) + */ + contraProposta?: boolean; + /** + * (Max Length: 100) Nome do fabricante + */ + fabricante?: string; + /** + * (Max Length: 500) Nome do autor (optional) + */ + autor?: string; + /** + * (Max Length: 100) Nome da editora (optional) + */ + editora?: string; + /** + * (Max Length: 100) Nome da coleção (optional) + */ + colecao?: string; + /** + * (Max Length: 100) Nome do gênero (optional) + */ + genero?: string; + /** + * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) + */ + precoCusto?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) + */ + precoDe?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante */ precoPor?: number; /** @@ -237,7 +568,32 @@ export interface API { /** * Define a qual regra de calculo de frete o produto vai pertencer */ - freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; + freteGratis?: + | { "0": "S"; "1": "e"; "2": "m"; "3": "p"; "4": "r"; "5": "e" } + | { "0": "N"; "1": "u"; "2": "n"; "3": "c"; "4": "a" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" } + | { + "0": "D"; + "1": "e"; + "2": "s"; + "3": "c"; + "4": "o"; + "5": "n"; + "6": "s"; + "7": "i"; + "8": "d"; + "9": "e"; + "10": "r"; + "11": "a"; + "12": "r"; + "13": "_"; + "14": "R"; + "15": "e"; + "16": "g"; + "17": "r"; + "18": "a"; + "19": "s"; + }; /** * Define se o produto variante tem troca grátis (optional) */ @@ -336,7 +692,31 @@ export interface API { /** * Condição do produto variante (optional) */ - condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; + condicao?: + | { "0": "N"; "1": "o"; "2": "v"; "3": "o" } + | { "0": "U"; "1": "s"; "2": "a"; "3": "d"; "4": "o" } + | { + "0": "R"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "v"; + "5": "a"; + "6": "d"; + "7": "o"; + } + | { + "0": "D"; + "1": "a"; + "2": "n"; + "3": "i"; + "4": "f"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "d"; + "9": "o"; + }; /** * Url do vídeo do Produto (optional) */ @@ -384,11 +764,11 @@ export interface API { "DELETE /tabelaPrecos/:tabelaPrecoId/:sku": {}; /** @description Atualiza o frete de todos os produtos de um pedido */ "PUT /pedidos/:pedidoId/changeseller": { - body: { + searchParams: { /** * Objeto com os dados de cotação e responsável */ - RAW_BODY: { + RAW_BODY?: { /** * ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes */ @@ -401,73 +781,204 @@ export interface API { }; }; /** @description Objeto do banner */ - "GET /banners/:bannerId": { - response: { - id?: number; + "GET /banners/:bannerId": {}; + /** @description Atualiza um banner existente */ + "PUT /banners/:bannerId": { + searchParams: { + /** + * Nome do banner + */ nome?: string; + /** + * Data de inicio de exibição do banner + */ dataInicio?: string; + /** + * Data de termino de exibição do banner (optional) + */ dataFim?: string; + /** + * Banner ativo/inativo (optional) + */ ativo?: boolean; + /** + * Detalhes do banner + */ detalhe?: { + /** + * Local de posicionamento do banner + */ posicionamentoId?: number; - urlBanner?: string; + /** + * Imagem do banner (caso o campo "UrlBanner" estiver preenchido esse campo será desconsiderado) (optional) + */ imagemBanner?: { - nome?: string; + /** + * string da imagem em base 64 + */ base64?: string; - formato?: string; + /** + * formato da imagem + */ + formato?: + | { "0": "P"; "1": "N"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; + /** + * nome da imagem + */ + nome?: string; }; + /** + * Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional) + */ + urlBanner?: string; + /** + * Ordem de exibição do banner (optional) + */ ordemExibicao?: number; - abrirBannerNovaAba?: boolean; + /** + * Se o banner deve ou não abrir em nova aba (optional) + */ + abrirLinkNovaAba?: boolean; + /** + * Largura do banner em pixels (optional) + */ largura?: number; + /** + * Altura do banner em pixels (optional) + */ altura?: number; + /** + * Title da imagem do banner (optional) + */ title?: string; + /** + * Url de destino para quando o usuário clicar no Banner (optional) + */ urlClique?: string; + /** + * URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional) + */ urlBannerAlternativo?: string; - titleAlternativo?: string; - diasExibicao?: { - todosDias?: boolean; - domingo?: boolean; - segunda?: boolean; - terca?: boolean; - quarta?: boolean; - quinta?: boolean; - sexta?: boolean; - sabado?: boolean; - }; + /** + * Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner + */ textoAlternativo?: string; }; + /** + * Dias da semana que o banner deverá ser exibido (optional) + */ + diasExibicao?: { + /** + * Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como "true" os demais serão desconsiderados) + */ + todosDias?: boolean; + /** + * Se o banner deverá ser apresentado no domingo + */ + domingo?: boolean; + /** + * Se o banner deverá ser apresentado na segunda + */ + segunda?: boolean; + /** + * Se o banner deverá ser apresentado na terça + */ + terca?: boolean; + /** + * Se o banner deverá ser apresentado na quarta + */ + quarta?: boolean; + /** + * Se o banner deverá ser apresentado na quinta + */ + quinta?: boolean; + /** + * Se o banner deverá ser apresentado na sexta + */ + sexta?: boolean; + /** + * Se o banner deverá ser apresentado no sábado + */ + sabado?: boolean; + }; + /** + * Apresentação do banner (optional) + */ apresentacao?: { + /** + * Se o banner deverá ser exibido em todo o site + */ exibirNoSite?: boolean; + /** + * Se o banner deverá ser exibido em todas as buscas + */ exibirEmTodasBuscas?: boolean; + /** + * Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ naoExibirEmBuscas?: boolean; + /** + * Termos que o banner será exibido na busca + */ termosBusca?: string; + /** + * Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ + exibirEmTodasCategorias?: boolean; + /** + * Em quais hotsites o banner deve ser exibido + */ listaHotsites?: { - exibirEmTodosHotSites?: boolean; - hotSites?: { + /** + * Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como "true" o campo HotSites será desconsiderado) (optional) + */ + exibirEmTodosHotsites?: boolean; + /** + * Lista de hotsite's que o banner será exibido + */ + hotsites?: { + /** + * Id do hotsite (optional) + */ hotSiteId?: number; }[]; }; - exibirEmTodasCategorias?: boolean; - listaParceiros?: { - exibirEmTodosParceiros?: boolean; - parceiros?: { - parceiroId?: number; - }[]; - }; }; - }; - }; - /** @description Atualiza um produto em uma assinatura */ - "PUT /assinaturas/produtos/:assinaturaProdutoId/Alterar": { - body: { - /** - * Novo valor do produto na assinatura (optional) - */ - valor?: number; /** - * Se o produto será considerado removido ou não da assinatura (optional) + * Em quais parceiros o banner deve ser exibido */ - removido?: boolean; + listaParceiros?: { + /** + * Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) (optional) + */ + exibirEmTodosParceiros?: boolean; + /** + * Lista de parceiros que o banner será exibido + */ + parceiros?: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + }[]; + }; + }; + }; + /** @description Deleta um banner existente */ + "DELETE /banners/:bannerId": {}; + /** @description Atualiza um produto em uma assinatura */ + "PUT /assinaturas/produtos/:assinaturaProdutoId/Alterar": { + searchParams: { + /** + * Novo valor do produto na assinatura (optional) + */ + valor?: number; + /** + * Se o produto será considerado removido ou não da assinatura (optional) + */ + removido?: boolean; /** * Quantidade do produto na assinatura (optional) */ @@ -475,38 +986,146 @@ export interface API { }; }; /** @description Parceiro encontrado */ - "GET /parceiros/:parceiroId": { - response: { - parceiroId?: number; - marketPlaceId?: number; + "GET /parceiros/:parceiroId": {}; + /** @description Parceiro atualizado com sucesso */ + "PUT /parceiros/:parceiroId": { + searchParams: { + /** + * Nome do parceiro + */ nome?: string; + /** + * Id da tabela de preço (optional) + */ tabelaPrecoId?: number; + /** + * Id do portfolio (optional) + */ portfolioId?: number; - tipoEscopo?: string; + /** + * Tipo de escopo + */ + tipoEscopo?: + | { + "0": "A"; + "1": "b"; + "2": "e"; + "3": "r"; + "4": "t"; + "5": "o"; + "6": '"'; + } + | { + "0": "F"; + "1": "e"; + "2": "c"; + "3": "h"; + "4": "a"; + "5": "d"; + "6": "o"; + } + | { + "0": "P"; + "1": "o"; + "2": "r"; + "3": "C"; + "4": "l"; + "5": "i"; + "6": "e"; + "7": "n"; + "8": "t"; + "9": "e"; + }; + /** + * Status do parceiro + */ ativo?: boolean; + /** + * Se o parceiro é marketplace (optional) + */ isMarketPlace?: boolean; + /** + * Origem (optional) + */ origem?: string; + /** + * alias (optional) + */ + alias?: string; }; }; + /** @description Parceiro excluído com sucesso */ + "DELETE /parceiros/:parceiroId": {}; /** @description Lista de parceiros */ - "GET /parceiros": { - response: { - parceiroId?: number; - marketPlaceId?: number; + "GET /parceiros": {}; + /** @description Insere um novo parceiro */ + "POST /parceiros": { + searchParams: { + /** + * Nome do parceiro + */ nome?: string; + /** + * Id da tabela de preço (optional) + */ tabelaPrecoId?: number; + /** + * Id do portfolio (optional) + */ portfolioId?: number; - tipoEscopo?: string; + /** + * Tipo de escopo + */ + tipoEscopo?: + | { + "0": "A"; + "1": "b"; + "2": "e"; + "3": "r"; + "4": "t"; + "5": "o"; + "6": '"'; + } + | { + "0": "F"; + "1": "e"; + "2": "c"; + "3": "h"; + "4": "a"; + "5": "d"; + "6": "o"; + } + | { + "0": "P"; + "1": "o"; + "2": "r"; + "3": "C"; + "4": "l"; + "5": "i"; + "6": "e"; + "7": "n"; + "8": "t"; + "9": "e"; + }; + /** + * Status do parceiro + */ ativo?: boolean; + /** + * Se o parceiro é marketplace (optional) + */ isMarketPlace?: boolean; + /** + * Origem (optional) + */ origem?: string; - }[]; + }; }; - /** @description Deleta um banner existente */ - "DELETE /banners/:bannerId": {}; + /** @description Lista de tipos de evento */ + "GET /tiposEvento": {}; /** @description Insere um novo tipo de evento */ "POST /tiposEvento": { - body: { + searchParams: { /** * Nome do Tipo de Evento */ @@ -515,17 +1134,118 @@ export interface API { * Tipo de entrega */ tipoEntrega?: - | "EntregaAgendada" - | "EntregaConformeCompraRealizada" - | "Todos" - | "Nenhum"; + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "A"; + "8": "g"; + "9": "e"; + "10": "n"; + "11": "d"; + "12": "a"; + "13": "d"; + "14": "a"; + } + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "C"; + "8": "o"; + "9": "n"; + "10": "f"; + "11": "o"; + "12": "r"; + "13": "m"; + "14": "e"; + "15": "C"; + "16": "o"; + "17": "m"; + "18": "p"; + "19": "r"; + "20": "a"; + "21": "R"; + "22": "e"; + "23": "a"; + "24": "l"; + "25": "i"; + "26": "z"; + "27": "a"; + "28": "d"; + "29": "a"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } + | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; /** * Disponibilização do Tipo de Evento */ tipoDisponibilizacao?: - | "DisponibilizacaoDeCreditos" - | "DisponibilizacaoDeProdutos" - | "Todos"; + | { + "0": "D"; + "1": "i"; + "2": "s"; + "3": "p"; + "4": "o"; + "5": "n"; + "6": "i"; + "7": "b"; + "8": "i"; + "9": "l"; + "10": "i"; + "11": "z"; + "12": "a"; + "13": "c"; + "14": "a"; + "15": "o"; + "16": "D"; + "17": "e"; + "18": "C"; + "19": "r"; + "20": "e"; + "21": "d"; + "22": "i"; + "23": "t"; + "24": "o"; + "25": "s"; + } + | { + "0": "D"; + "1": "i"; + "2": "s"; + "3": "p"; + "4": "o"; + "5": "n"; + "6": "i"; + "7": "b"; + "8": "i"; + "9": "l"; + "10": "i"; + "11": "z"; + "12": "a"; + "13": "c"; + "14": "a"; + "15": "o"; + "16": "D"; + "17": "e"; + "18": "P"; + "19": "r"; + "20": "o"; + "21": "d"; + "22": "u"; + "23": "t"; + "24": "o"; + "25": "s"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" }; /** * Permissão para remoção automática de produtos */ @@ -561,7 +1281,31 @@ export interface API { /** * O beneficiário do frete */ - tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; + tipoBeneficiarioFrete?: + | { + "0": "D"; + "1": "o"; + "2": "n"; + "3": "o"; + "4": "d"; + "5": "a"; + "6": "L"; + "7": "i"; + "8": "s"; + "9": "t"; + "10": "a"; + } + | { + "0": "C"; + "1": "o"; + "2": "n"; + "3": "v"; + "4": "i"; + "5": "d"; + "6": "a"; + "7": "d"; + "8": "o"; + }; /** * Imagem da logo do evento em base64 */ @@ -582,84 +1326,188 @@ export interface API { }; }; /** @description Lista de preços e estoque de produtos que sofreram alterações */ - "GET /produtos/alteracoes": { + "GET /produtos/alteracoes": {}; + /** @description Retorna a situação reseller de um produto */ + "GET /produtos/:identificador/situacaoReseller": {}; + /** @description Lista de atributos */ + "GET /atributos": {}; + /** @description Insere um novo atributo */ + "POST /atributos": { searchParams: { /** - * Página da lista (padrão: 1) + * Nome do atributo (optional) */ - pagina?: number; + nome?: string; /** - * Quantidade de registros que deverão retornar (max: 50) + * Tipo do atributo (optional) */ - quantidadeRegistros?: number; + tipo?: + | { + "0": "S"; + "1": "e"; + "2": "l"; + "3": "e"; + "4": "c"; + "5": "a"; + "6": "o"; + } + | { "0": "F"; "1": "i"; "2": "l"; "3": "t"; "4": "r"; "5": "o" } + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "p"; + "4": "a"; + "5": "r"; + "6": "a"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "C"; + "1": "o"; + "2": "n"; + "3": "f"; + "4": "i"; + "5": "g"; + "6": "u"; + "7": "r"; + "8": "a"; + "9": "c"; + "10": "a"; + "11": "o"; + } + | { + "0": "E"; + "1": "x"; + "2": "c"; + "3": "l"; + "4": "u"; + "5": "s"; + "6": "i"; + "7": "v"; + "8": "o"; + "9": "G"; + "10": "o"; + "11": "o"; + "12": "g"; + "13": "l"; + "14": "e"; + }; /** - * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + * Tipo de exibição (optional) */ - alteradosPartirDe?: string; - }; - response: { - produtoId?: number; - produtoVarianteId?: number; - sku?: string; - precoDe?: number; - precoPor?: number; - disponivel?: boolean; - valido?: boolean; - exibirSite?: boolean; - estoque?: { - estoqueFisico?: number; - estoqueReservado?: number; - centroDistribuicaoId?: number; - alertaEstoque?: number; - }[]; - tabelasPreco?: { - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; - }[]; - }[]; - }; - /** @description Retorna a situação reseller de um produto */ - "GET /produtos/:identificador/situacaoReseller": { - searchParams: { + tipoExibicao?: + | { "0": "C"; "1": "o"; "2": "m"; "3": "b"; "4": "o" } + | { "0": "D"; "1": "i"; "2": "v" } + | { + "0": "D"; + "1": "i"; + "2": "v"; + "3": "C"; + "4": "o"; + "5": "m"; + "6": "C"; + "7": "o"; + "8": "r"; + } + | { + "0": "D"; + "1": "i"; + "2": "v"; + "3": "C"; + "4": "o"; + "5": "m"; + "6": "F"; + "7": "o"; + "8": "t"; + "9": "o"; + "10": "D"; + "11": "o"; + "12": "P"; + "13": "r"; + "14": "o"; + "15": "d"; + "16": "u"; + "17": "t"; + "18": "o"; + "19": "V"; + "20": "a"; + "21": "r"; + "22": "i"; + "23": "a"; + "24": "n"; + "25": "t"; + "26": "e"; + } + | { + "0": "J"; + "1": "a"; + "2": "v"; + "3": "a"; + "4": "s"; + "5": "c"; + "6": "r"; + "7": "i"; + "8": "p"; + "9": "t"; + }; /** - * Define se o identificador informado é um sku ou um id interno + * Prioridade do atributo (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - }; - /** @description Buscar autor por id */ - "GET /autores/:autorId": {}; - /** @description Lista de atributos */ - "GET /atributos": { - response: { - nome?: string; - tipo?: string; - tipoExibicao?: string; prioridade?: number; - }[]; + }; }; /** @description Inscrição */ - "GET /webhook/inscricao/:inscricaoId": { - response: { - inscricaoId?: number; + "GET /webhook/inscricao/:inscricaoId": {}; + /** @description Atualiza uma inscrição */ + "PUT /webhook/inscricao/:inscricaoId": { + searchParams: { + /** + * Nome da inscrição + */ nome?: string; + /** + * Url para qual deve ser enviada as notificações + */ appUrl?: string; + /** + * Tópicos em que deseja se inscrever + */ + topicos?: string[]; + /** + * Usuário que está realizando a inscrição + */ + usuario?: string; + /** + * Status da inscrição, se ativada ou desativada + */ ativo?: boolean; + /** + * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado + */ emailResponsavel?: string; - topico?: string[]; - usuario?: string; - header?: { - headerId?: number; + /** + * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) + */ + headers?: { + /** + * Chave do header, por exemplo: 'Authorization' + */ chave?: string; + /** + * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' + */ valor?: string; }[]; }; }; + /** @description Produtos de uma assinatura */ + "GET /assinaturas/:assinaturaId/produtos": {}; /** @description Insere um novo produto na assinatura */ "POST /assinaturas/:assinaturaId/produtos": { - body: { + searchParams: { /** * Produto Variante que será incluído na assinatura */ @@ -670,9 +1518,11 @@ export interface API { quantidade?: number; }; }; + /** @description Categoria encontrada */ + "GET /categorias/:id": {}; /** @description Atualiza uma categoria */ "PUT /categorias/:id": { - body: { + searchParams: { /** * Nome da categoria (optional) */ @@ -696,7 +1546,10 @@ export interface API { /** * Exibir Matriz de Atributos (optional) */ - exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + exibirMatrizAtributos?: + | { "0": "S"; "1": "i"; "2": "m" } + | { "0": "N"; "1": "a"; "2": "o" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; /** * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ @@ -711,27 +1564,14 @@ export interface API { exibeMenu?: boolean; }; }; - /** @description Deletar autor */ - "DELETE /autores/:autorId": {}; + /** @description Exclui uma categoria */ + "DELETE /categorias/:id": {}; /** @description Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado */ - "GET /produtos/:identificador/relacionados": { - searchParams: { - /** - * Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId - */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - response: { - produtoId?: number; - parentId?: number; - produtoVarianteId?: number; - sku?: string; - }[]; - }; + "GET /produtos/:identificador/relacionados": {}; /** @description Atualiza um valor pré definido pelo id */ "PUT /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": { - body: { + searchParams: { /** * Valor para o campo (optional) */ @@ -742,9 +1582,14 @@ export interface API { ordem?: number; }; }; + /** @description Remove um valor pré definido */ + "DELETE /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": + {}; + /** @description Lista de banners */ + "GET /banners": {}; /** @description Insere um novo banner */ "POST /banners": { - body: { + searchParams: { /** * Nome do banner */ @@ -780,7 +1625,10 @@ export interface API { /** * formato da imagem */ - formato?: "PNG" | "JPG" | "JPEG"; + formato?: + | { "0": "P"; "1": "N"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; /** * nome da imagem */ @@ -923,119 +1771,94 @@ export interface API { }; }; }; - /** @description Deleta um avatar de um usuário */ - "DELETE /usuarios/:email/avatar": {}; - /** @description Atualiza uma inscrição */ - "PUT /webhook/inscricao/:inscricaoId": { - body: { - /** - * Nome da inscrição - */ - nome?: string; + /** @description Avatar do usuário encontrado */ + "GET /usuarios/:email/avatar": {}; + /** @description Insere um novo avatar para o usuário */ + "POST /usuarios/:email/avatar": { + searchParams: { /** - * Url para qual deve ser enviada as notificações + * Imagem do avatar em base64 (optional) */ - appUrl?: string; + base64?: string; /** - * Tópicos em que deseja se inscrever + * Formato da imagem (optional) */ - topicos: string[]; + formato?: string; + }; + }; + /** @description Deleta um avatar de um usuário */ + "DELETE /usuarios/:email/avatar": {}; + /** @description Fabricante encontrado */ + "GET /fabricantes/:fabricanteId": {}; + /** @description Atualiza um fabricante */ + "PUT /fabricantes/:fabricanteId": { + searchParams: { /** - * Usuário que está realizando a inscrição + * Nome do fabricante (optional) */ - usuario?: string; + nome?: string; /** - * Status da inscrição, se ativada ou desativada + * URL tipo logo (optional) */ - ativo?: boolean; + urlLogoTipo?: string; /** - * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado + * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) */ - emailResponsavel?: string; + urlLink?: string; /** - * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) + * Insira nesse campo a URL do Carrossel da Marca (optional) */ - headers?: { - /** - * Chave do header, por exemplo: 'Authorization' - */ - chave?: string; - /** - * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' - */ - valor?: string; - }[]; + urlCarrossel?: string; }; }; /** @description Exclui um fabricante */ "DELETE /fabricantes/:fabricanteId": {}; /** @description Lista de posicionamentos do banner */ - "GET /banners/posicionamentos": { - response: { - posicionamentoId?: number; - descricao?: string; - }[]; - }; - /** @description Insere um novo avatar para o usuário */ - "POST /usuarios/:email/avatar": { - body: { - /** - * Imagem do avatar em base64 (optional) - */ - base64?: string; - /** - * Formato da imagem (optional) - */ - formato?: string; - }; - response: { - urlAvatar?: string; - }; - }; + "GET /banners/posicionamentos": {}; /** @description Preços do produto variante informado */ - "GET /produtos/:identificador/precos": { + "GET /produtos/:identificador/precos": {}; + /** @description Atualiza a autonomia de um Seller */ + "PUT /resellers/:resellerId/autonomia": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Status da autonomia do seller */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + ativo?: boolean; }; - response: { - produtoVarianteId?: number; - sku?: string; - precoDe?: number; - precoPor?: number; - fatorMultiplicadorPreco?: number; - precosTabelaPreco?: { + }; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos/:eventoId/produtos": {}; + /** @description Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente */ + "POST /eventos/:eventoId/produtos": { + searchParams: { + /** + * Identificadores dos produtos variantes a serem vinculados ao evento desejado + */ + produtosVariante?: { + /** + * Identificador do produto variante + */ produtoVarianteId?: number; - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; }[]; }; }; - /** @description Atualiza a autonomia de um Seller */ - "PUT /resellers/:resellerId/autonomia": { - body: { + /** @description Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request */ + "PUT /eventos/:eventoId/produtos": { + searchParams: { /** - * Status da autonomia do seller + * Identificadores dos produtos variantes a serem vinculados ao evento desejado */ - ativo?: boolean; + produtosVariante?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; }; }; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos/:eventoId/produtos": { - response: { - eventoId?: number; - produtoVarianteId?: number; - recebidoForaLista?: boolean; - removido?: boolean; - }[]; - }; /** @description Atualiza o status do hotsite, sendo ativo (true) ou inativo (false) */ "PUT /hotsites/:hotsiteId/status": { - body: { + searchParams: { /** * Status para qual o hotsite indicado deve ir */ @@ -1044,7 +1867,7 @@ export interface API { }; /** @description Autenticação realizada com sucesso */ "POST /autenticacao/login": { - body: { + searchParams: { /** * Login do usuário (optional) */ @@ -1056,28 +1879,10 @@ export interface API { }; }; /** @description Parceiro encontrado */ - "GET /parceiros/:nome": { - response: { - parceiroId?: number; - marketPlaceId?: number; - nome?: string; - tabelaPrecoId?: number; - portfolioId?: number; - tipoEscopo?: string; - ativo?: boolean; - isMarketPlace?: boolean; - origem?: string; - }; - }; + "GET /parceiros/:nome": {}; /** @description Seta status do produto variante como ativo ou inativo */ "PUT /produtos/:identificador/situacao": { searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { /** * Define se o produto variante informado será ativo ou inativo */ @@ -1085,418 +1890,49 @@ export interface API { }; }; /** @description Lista de Grupos de Personalização */ - "GET /grupospersonalizacao": { - response: { - grupoPersonalizacaoId?: number; - nome?: string; - ativo?: boolean; - obrigatorio?: boolean; - }[]; - }; + "GET /grupospersonalizacao": {}; /** @description Retorna o saldo de um usuário */ "GET /contascorrentes/:email": {}; - /** @description Lista de produtos */ - "GET /resellers/produtos/:identificador": { + /** @description Realiza um novo lançamento na conta corrente do cliente */ + "POST /contascorrentes/:email": { searchParams: { /** - * Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller - */ - tipoIdentificador?: "ResellerId" | "RazaoSocial"; - /** - * Página da lista (padrão: 1) + * Valor da conta corrente (optional) */ - pagina?: number; + valor?: number; /** - * Quantidade de registros que deverão retornar (max: 50) + * Tipo de Lançamento (optional) */ - quantidadeRegistros?: number; + tipoLancamento?: + | { + "0": "C"; + "1": "r"; + "2": "e"; + "3": "d"; + "4": "i"; + "5": "t"; + "6": "o"; + } + | { "0": "D"; "1": "e"; "2": "b"; "3": "i"; "4": "t"; "5": "o" }; /** - * Se deve retornar apenas produtos válidos (padrão: false) + * Observação (optional) */ - somenteValidos?: boolean; + observacao?: string; /** - * Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo + * Se será visível para o cliente (optional) */ - camposAdicionais?: string[]; + visivelParaCliente?: boolean; }; - response: { - produtoVarianteId?: number; - produtoId?: number; - idPaiExterno?: string; - idVinculoExterno?: string; - sku?: string; - nome?: string; - nomeProdutoPai?: string; - urlProduto?: string; - exibirMatrizAtributos?: string; - contraProposta?: boolean; - fabricante?: string; - autor?: string; - editora?: string; - colecao?: string; - genero?: string; - precoCusto?: number; - precoDe?: number; - precoPor?: number; - fatorMultiplicadorPreco?: number; - prazoEntrega?: number; - valido?: boolean; - exibirSite?: boolean; - freteGratis?: string; - trocaGratis?: boolean; - peso?: number; - altura?: number; - comprimento?: number; - largura?: number; - garantia?: number; - isTelevendas?: boolean; - ean?: string; - localizacaoEstoque?: string; - listaAtacado?: { - precoPor?: number; - quantidade?: number; - }[]; - estoque?: { - estoqueFisico?: number; - estoqueReservado?: number; - centroDistribuicaoId?: number; - alertaEstoque?: number; - }[]; - atributos?: { - tipoAtributo?: string; - isFiltro?: boolean; - nome?: string; - valor?: string; - exibir?: boolean; - }[]; - quantidadeMaximaCompraUnidade?: number; - quantidadeMinimaCompraUnidade?: number; - condicao?: string; - informacoes?: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; - }[]; - tabelasPreco?: { - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; - }[]; - dataCriacao?: string; - dataAtualizacao?: string; - urlVideo?: string; - spot?: boolean; - paginaProduto?: boolean; - marketplace?: boolean; - somenteParceiros?: boolean; - reseller?: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; - buyBox?: boolean; - }[]; }; + /** @description Lista de produtos */ + "GET /resellers/produtos/:identificador": {}; /** @description Lista de pedidos */ - "GET /pedidos/formaPagamento/:formasPagamento": { - searchParams: { - /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) - */ - dataInicial?: string; - /** - * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) - */ - dataFinal?: string; - /** - * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) - */ - enumTipoFiltroData?: - | "DataPedido" - | "DataAprovacao" - | "DataModificacaoStatus" - | "DataAlteracao" - | "DataCriacao"; - /** - * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações - */ - situacoesPedido?: string; - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadeRegistros?: number; - }; - response: { - pedidoId?: number; - situacaoPedidoId?: number; - tipoRastreamentoPedido?: string; - transacaoId?: number; - data?: string; - dataPagamento?: string; - dataUltimaAtualizacao?: string; - valorFrete?: number; - valorTotalPedido?: number; - valorDesconto?: number; - valorDebitoCC?: number; - cupomDesconto?: string; - marketPlacePedidoId?: string; - marketPlacePedidoSiteId?: string; - canalId?: number; - canalNome?: string; - canalOrigem?: string; - retiradaLojaId?: number; - isPedidoEvento?: boolean; - usuario?: { - usuarioId?: number; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - }; - pedidoEndereco?: { - tipo?: string; - nome?: string; - endereco?: string; - numero?: string; - complemento?: string; - referencia?: string; - cep?: string; - tipoLogradouro?: string; - logradouro?: string; - bairro?: string; - cidade?: string; - estado?: string; - pais?: string; - }[]; - frete?: { - freteContratoId?: number; - freteContrato?: string; - referenciaConector?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - retiradaLojaId?: number; - centrosDistribuicao?: { - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - servico?: { - servicoId?: number; - nome?: string; - transportadora?: string; - prazo?: number; - servicoNome?: string; - preco?: number; - servicoTransporte?: number; - codigo?: number; - servicoMeta?: string; - custo?: number; - token?: string; - }; - retiradaAgendada?: { - lojaId?: number; - retiradaData?: string; - retiradaPeriodo?: string; - nome?: string; - documento?: string; - codigoRetirada?: string; - }; - agendamento?: { - de?: string; - ate?: string; - }; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }; - itens?: { - produtoVarianteId?: number; - sku?: string; - nome?: string; - quantidade?: number; - precoCusto?: number; - precoVenda?: number; - isBrinde?: boolean; - valorAliquota?: number; - isMarketPlace?: boolean; - precoPor?: number; - desconto?: number; - totais?: { - precoCusto?: number; - precoVenda?: number; - precoPor?: number; - desconto?: number; - }; - ajustes?: { - tipo?: string; - valor?: number; - observacao?: string; - nome?: string; - }[]; - centroDistribuicao?: { - centroDistribuicaoId?: number; - quantidade?: number; - situacaoProdutoId?: number; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - }[]; - valoresAdicionais?: { - tipo?: string; - origem?: string; - texto?: string; - valor?: number; - }[]; - atributos?: { - produtoVarianteAtributoValor?: string; - produtoVarianteAtributoNome?: string; - }[]; - embalagens?: { - tipoEmbalagemId?: number; - nomeTipoEmbalagem?: string; - mensagem?: string; - valor?: number; - descricao?: string; - }[]; - personalizacoes?: { - nomePersonalizacao?: string; - valorPersonalizacao?: string; - valor?: number; - }[]; - frete?: { - quantidade?: number; - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - dadosProdutoEvento?: { - tipoPresenteRecebimento?: string; - }; - formulas?: { - chaveAjuste?: string; - valor?: number; - nome?: string; - expressao?: string; - expressaoInterpretada?: string; - endPoint?: string; - }[]; - seller?: { - sellerId?: number; - sellerNome?: string; - sellerPedidoId?: number; - }; - }[]; - assinatura?: { - assinaturaId?: number; - grupoAssinaturaId?: number; - tipoPeriodo?: string; - tempoPeriodo?: number; - percentualDesconto?: number; - }[]; - pagamento?: { - formaPagamentoId?: number; - numeroParcelas?: number; - valorParcela?: number; - valorDesconto?: number; - valorJuros?: number; - valorTotal?: number; - boleto?: { - urlBoleto?: string; - codigoDeBarras?: string; - }; - cartaoCredito?: { - numeroCartao?: string; - nomeTitular?: string; - dataValidade?: string; - codigoSeguranca?: string; - documentoCartaoCredito?: string; - token?: string; - info?: string; - bandeira?: string; - }[]; - pagamentoStatus?: { - numeroAutorizacao?: string; - numeroComprovanteVenda?: string; - dataAtualizacao?: string; - dataUltimoStatus?: string; - adquirente?: string; - tid?: string; - }[]; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }[]; - observacao?: { - observacao?: string; - usuario?: string; - data?: string; - publica?: boolean; - }[]; - valorCreditoFidelidade?: number; - valido?: boolean; - valorSubTotalSemDescontos?: number; - pedidoSplit?: number[]; - }[]; - }; + "GET /pedidos/formaPagamento/:formasPagamento": {}; + /** @description Lista de pedidos */ + "GET /pedidos": {}; /** @description Caso a loja utilize as formas de pagamento do gateway o campo "formaPagamentoId" do objeto "pagamento" deverá conter o valor "200". */ "POST /pedidos": { - body: { + searchParams: { /** * Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional) */ @@ -1750,51 +2186,125 @@ export interface API { }; }; /** @description Lista de portfolios */ - "GET /portfolios": { - response: { - portfolioId?: number; - nome?: string; - ativo?: boolean; - }[]; - }; - /** @description Lista de imagens vinculadas a um produtos */ - "GET /produtos/:identificador/imagens": { + "GET /portfolios": {}; + /** @description Insere um novo portfolio */ + "POST /portfolios": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Nome do portfolio */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - produtosIrmaos?: boolean; + nome?: string; + }; + }; + /** @description Lista de imagens vinculadas a um produtos */ + "GET /produtos/:identificador/imagens": {}; + /** @description Adiciona uma nova imagem vinculada a um produto */ + "POST /produtos/:identificador/imagens": { + searchParams: { + /** + * Lista com as imagens do produto no formato base 64 (optional) + */ + RAW_BODY?: { + /** + * Imagem do produto em base64 + */ + base64?: string; + /** + * JPG ou PNG + */ + formato?: string; + /** + * Se a imagem será apresentada como miniatura + */ + exibirMiniatura?: boolean; + /** + * Se a imagem será apresentada como estampa + */ + estampa?: boolean; + /** + * Ordem para apresentação da imagem + */ + ordem?: number; + }[]; }; - response: { - idImagem?: number; - nomeArquivo?: string; - url?: string; - ordem?: number; - estampa?: boolean; - exibirMiniatura?: boolean; - }[]; }; /** @description Limite de crédito de um usuário específico */ - "GET /usuarios/limiteCreditoPorUsuarioId/:usuarioId": { - response: { - usuarioId?: number; - valor?: number; - saldo?: number; + "GET /usuarios/limiteCreditoPorUsuarioId/:usuarioId": {}; + /** @description SEO do produto informado */ + "GET /produtos/:identificador/seo": {}; + /** @description Insere um SEO para um produto específico */ + "POST /produtos/:identificador/seo": { + searchParams: { + /** + * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) + */ + tagCanonical?: string; + /** + * Informe o title da página do produto (optional) + */ + title?: string; + /** + * Informe os dados da Meta Tag (optional) + */ + metaTags?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; + }[]; }; }; - /** @description Deleta o SEO de um produto específico */ - "DELETE /produtos/:identificador/seo": { + /** @description Atualiza um SEO de um produto específico */ + "PUT /produtos/:identificador/seo": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) + */ + tagCanonical?: string; + /** + * Informe o title da página do produto (optional) + */ + title?: string; + /** + * Informe os dados da Meta Tag (optional) */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + metaTags?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; + }[]; }; }; + /** @description Deleta o SEO de um produto específico */ + "DELETE /produtos/:identificador/seo": {}; /** @description Adiciona um vínculo entre usuário e parceiro */ "POST /usuarios/:email/parceiro": { - body: { + searchParams: { /** * Id do parceiro (optional) */ @@ -1813,527 +2323,630 @@ export interface API { dataFinal?: string; }; }; - /** @description Atualiza um banner existente */ - "PUT /banners/:bannerId": { - body: { + /** @description Atualiza um vínculo entre usuário e parceiro */ + "PUT /usuarios/:email/parceiro": { + searchParams: { /** - * Nome do banner + * Vinculo vitalício (optional) + */ + vinculoVitalicio?: boolean; + /** + * Data inicial do vinculo entre usuário e parceiro (optional) + */ + dataInicial?: string; + /** + * Data final do vinculo entre usuário e parceiro (optional) + */ + dataFinal?: string; + }; + }; + /** @description Remove o vínculo entre usuário e parceiro */ + "DELETE /usuarios/:email/parceiro": { + searchParams: { + /** + * Número identificador do parceiro (Max Length: 4) + */ + parceiroId?: number; + }; + }; + /** @description Retorna usuário encontrado */ + "GET /usuarios/:email/enderecos": {}; + /** @description Insere um endereço para um usuário pelo e-mail */ + "POST /usuarios/:email/enderecos": { + searchParams: { + /** + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + */ + nomeEndereco?: string; + /** + * Nome da rua (Max Length: 500) + */ + rua?: string; + /** + * Número do local (Max Length: 50) + */ + numero?: string; + /** + * Complemento (Max Length: 250) (optional) + */ + complemento?: string; + /** + * Referência para a localização do endereço (Max Length: 500) (optional) + */ + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; + }; + }; + /** @description Atualiza um script existente */ + "PUT /gestorscripts/scripts/:scriptId": { + searchParams: { + /** + * Nome do script */ nome?: string; /** - * Data de inicio de exibição do banner + * Data inicial do script */ - dataInicio?: string; + dataInicial?: string; /** - * Data de termino de exibição do banner (optional) + * Data final do script */ - dataFim?: string; + dataFinal?: string; /** - * Banner ativo/inativo (optional) + * Informe se o script está ativo ou não */ ativo?: boolean; /** - * Detalhes do banner + * Prioridade do script */ - detalhe?: { - /** - * Local de posicionamento do banner - */ - posicionamentoId?: number; - /** - * Imagem do banner (caso o campo "UrlBanner" estiver preenchido esse campo será desconsiderado) (optional) - */ - imagemBanner?: { - /** - * string da imagem em base 64 - */ - base64?: string; - /** - * formato da imagem - */ - formato?: "PNG" | "JPG" | "JPEG"; - /** - * nome da imagem - */ - nome?: string; + prioridade?: number; + /** + * Posição do script + */ + posicao?: + | { + "0": "H"; + "1": "e"; + "2": "a"; + "3": "d"; + "4": "e"; + "5": "r"; + "6": "P"; + "7": "r"; + "8": "i"; + "9": "m"; + "10": "e"; + "11": "i"; + "12": "r"; + "13": "a"; + "14": "L"; + "15": "i"; + "16": "n"; + "17": "h"; + "18": "a"; + } + | { + "0": "H"; + "1": "e"; + "2": "a"; + "3": "d"; + "4": "e"; + "5": "r"; + "6": "U"; + "7": "l"; + "8": "t"; + "9": "i"; + "10": "m"; + "11": "a"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; + } + | { + "0": "B"; + "1": "o"; + "2": "d"; + "3": "y"; + "4": "P"; + "5": "r"; + "6": "i"; + "7": "m"; + "8": "e"; + "9": "i"; + "10": "r"; + "11": "a"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; + } + | { + "0": "B"; + "1": "o"; + "2": "d"; + "3": "y"; + "4": "U"; + "5": "l"; + "6": "t"; + "7": "i"; + "8": "m"; + "9": "a"; + "10": "L"; + "11": "i"; + "12": "n"; + "13": "h"; + "14": "a"; + } + | { + "0": "F"; + "1": "o"; + "2": "o"; + "3": "t"; + "4": "e"; + "5": "r"; + "6": "P"; + "7": "r"; + "8": "i"; + "9": "m"; + "10": "e"; + "11": "i"; + "12": "r"; + "13": "a"; + "14": "L"; + "15": "i"; + "16": "n"; + "17": "h"; + "18": "a"; + } + | { + "0": "F"; + "1": "o"; + "2": "o"; + "3": "t"; + "4": "e"; + "5": "r"; + "6": "U"; + "7": "l"; + "8": "t"; + "9": "i"; + "10": "m"; + "11": "e"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; }; - /** - * Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional) - */ - urlBanner?: string; - /** - * Ordem de exibição do banner (optional) - */ - ordemExibicao?: number; - /** - * Se o banner deve ou não abrir em nova aba (optional) - */ - abrirLinkNovaAba?: boolean; - /** - * Largura do banner em pixels (optional) - */ - largura?: number; - /** - * Altura do banner em pixels (optional) - */ - altura?: number; - /** - * Title da imagem do banner (optional) - */ - title?: string; - /** - * Url de destino para quando o usuário clicar no Banner (optional) - */ - urlClique?: string; - /** - * URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional) - */ - urlBannerAlternativo?: string; - /** - * Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner - */ - textoAlternativo?: string; - }; /** - * Dias da semana que o banner deverá ser exibido (optional) + * Tipo da página do script */ - diasExibicao?: { - /** - * Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como "true" os demais serão desconsiderados) - */ - todosDias?: boolean; - /** - * Se o banner deverá ser apresentado no domingo - */ - domingo?: boolean; - /** - * Se o banner deverá ser apresentado na segunda - */ - segunda?: boolean; - /** - * Se o banner deverá ser apresentado na terça - */ - terca?: boolean; - /** - * Se o banner deverá ser apresentado na quarta - */ - quarta?: boolean; - /** - * Se o banner deverá ser apresentado na quinta - */ - quinta?: boolean; - /** - * Se o banner deverá ser apresentado na sexta - */ - sexta?: boolean; - /** - * Se o banner deverá ser apresentado no sábado - */ - sabado?: boolean; - }; + tipoPagina?: + | { "0": "T"; "1": "o"; "2": "d"; "3": "a"; "4": "s" } + | { "0": "H"; "1": "o"; "2": "m"; "3": "e" } + | { "0": "B"; "1": "u"; "2": "s"; "3": "c"; "4": "a" } + | { + "0": "C"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "g"; + "5": "o"; + "6": "r"; + "7": "i"; + "8": "a"; + } + | { + "0": "F"; + "1": "a"; + "2": "b"; + "3": "r"; + "4": "i"; + "5": "c"; + "6": "a"; + "7": "n"; + "8": "t"; + "9": "e"; + } + | { + "0": "E"; + "1": "s"; + "2": "t"; + "3": "a"; + "4": "t"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "s"; + } + | { + "0": "P"; + "1": "r"; + "2": "o"; + "3": "d"; + "4": "u"; + "5": "t"; + "6": "o"; + } + | { + "0": "C"; + "1": "a"; + "2": "r"; + "3": "r"; + "4": "i"; + "5": "n"; + "6": "h"; + "7": "o"; + }; /** - * Apresentação do banner (optional) + * Identificador da página */ - apresentacao?: { - /** - * Se o banner deverá ser exibido em todo o site - */ - exibirNoSite?: boolean; - /** - * Se o banner deverá ser exibido em todas as buscas - */ - exibirEmTodasBuscas?: boolean; - /** - * Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) - */ - naoExibirEmBuscas?: boolean; - /** - * Termos que o banner será exibido na busca - */ - termosBusca?: string; - /** - * Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) - */ - exibirEmTodasCategorias?: boolean; - /** - * Em quais hotsites o banner deve ser exibido - */ - listaHotsites?: { - /** - * Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como "true" o campo HotSites será desconsiderado) (optional) - */ - exibirEmTodosHotsites?: boolean; - /** - * Lista de hotsite's que o banner será exibido - */ - hotsites?: { - /** - * Id do hotsite (optional) - */ - hotSiteId?: number; - }[]; - }; - }; + identificadorPagina?: string; /** - * Em quais parceiros o banner deve ser exibido + * Conteúdo do script */ - listaParceiros?: { - /** - * Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) (optional) - */ - exibirEmTodosParceiros?: boolean; - /** - * Lista de parceiros que o banner será exibido - */ - parceiros?: { - /** - * Id do parceiro (optional) - */ - parceiroId?: number; - }[]; - }; + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; }; }; - /** @description Retorna usuário encontrado */ - "GET /usuarios/:email/enderecos": { - response: { - enderecoId?: number; - nomeEndereco?: string; - rua?: string; - numero?: string; - complemento?: string; - referencia?: string; - bairro?: string; - cidade?: string; - estado?: string; - cep?: string; - utilizadoUltimoPedido?: boolean; - pais?: string; - }[]; - }; /** @description Exclui um Script */ "DELETE /gestorscripts/scripts/:scriptId": {}; /** @description Ativa ou desativa um endereço de um usuário com base no id do usuário */ "PUT /usuarios/:usuarioId/enderecos/:enderecoId/ativar": { - body: { + searchParams: { /** * Status do endereço */ status?: boolean; }; }; - /** @description Atualiza um vínculo entre usuário e parceiro */ - "PUT /usuarios/:email/parceiro": { - body: { + /** @description Ativa ou desativa um Seller */ + "PUT /resellers/:resellerId/status": { + searchParams: { /** - * Vinculo vitalício (optional) + * Status do seller (ativo / inativo) */ - vinculoVitalicio?: boolean; + ativo?: boolean; + }; + }; + /** @description Atacarejo */ + "GET /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": {}; + /** @description Atualiza um Atacarejo */ + "PUT /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { /** - * Data inicial do vinculo entre usuário e parceiro (optional) + * Preço atacado (optional) */ - dataInicial?: string; + precoAtacado?: number; /** - * Data final do vinculo entre usuário e parceiro (optional) + * Quantidade do produto (optional) */ - dataFinal?: string; + quantidade?: number; }; }; - /** @description Ativa ou desativa um Seller */ - "PUT /resellers/:resellerId/status": { - body: { + /** @description Remove um Atacarejo */ + "DELETE /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": {}; + /** @description Buscar todos os autores */ + "GET /autores": {}; + /** @description Inserir autor */ + "POST /autores": { + searchParams: { /** - * Status do seller (ativo / inativo) + * Nome do Autor + */ + nome?: string; + /** + * Status do autor */ ativo?: boolean; }; }; - /** @description Lista de produtos */ - "GET /produtos": { + /** @description Lista dos estados */ + "GET /lojasFisicas/estados": {}; + /** @description Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais. */ + "GET /produtos/:identificador": {}; + /** @description Atualiza um produto com base nos dados enviados */ + "PUT /produtos/:identificador": { searchParams: { /** - * Página da lista (padrão: 1) + * Representa o ProdutoId agrupador por variante (optional) */ - pagina?: number; + idPaiExterno?: string; /** - * Lista de categorias que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as categorias + * Representa o ParentId agrupador por parent (optional) */ - categorias?: string; + idVinculoExterno?: string; /** - * Lista de fabricantes que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + * (Max Length: 50) Sku do produto */ - fabricantes?: string; + sku?: string; /** - * Lista de centros de distribuição que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará produtos de todos os cd's + * (Max Length: 300) Nome do produto variante */ - centrosDistribuicao?: string; + nome?: string; /** - * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + * Nome do produto (pai do variante) (optional) */ - alteradosPartirDe?: string; + nomeProdutoPai?: string; /** - * Quantidade de registros que deverão retornar (max: 50) + * Tipo de exibição da matriz de atributos (optional) */ - quantidadeRegistros?: number; + exibirMatrizAtributos?: + | { "0": "S"; "1": "i"; "2": "m" } + | { "0": "N"; "1": "a"; "2": "o" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; /** - * Retorna apenas os produtos que estão marcados como válido + * Se o produto aceita contra proposta (optional) */ - somenteValidos?: boolean; + contraProposta?: boolean; /** - * Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + * (Max Length: 100) Nome do fabricante */ - camposAdicionais?: string[]; - }; - response: { - produtoVarianteId?: number; - produtoId?: number; - idPaiExterno?: string; - idVinculoExterno?: string; - sku?: string; - nome?: string; - nomeProdutoPai?: string; - urlProduto?: string; - exibirMatrizAtributos?: string; - contraProposta?: boolean; fabricante?: string; + /** + * (Max Length: 500) Nome do autor (optional) + */ autor?: string; + /** + * (Max Length: 100) Nome da editora (optional) + */ editora?: string; + /** + * (Max Length: 100) Nome da coleção (optional) + */ colecao?: string; + /** + * (Max Length: 100) Nome do gênero (optional) + */ genero?: string; + /** + * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) + */ precoCusto?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) + */ precoDe?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante + */ precoPor?: number; + /** + * (Max Length: 8, "0000.0000,00") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) + */ fatorMultiplicadorPreco?: number; + /** + * Prazo de entrega do produto variante (optional) + */ prazoEntrega?: number; + /** + * Define se um produto variante é valido ou não (optional) + */ valido?: boolean; + /** + * Define se um produto deve ser exibido no site (optional) + */ exibirSite?: boolean; - freteGratis?: string; + /** + * Define a qual regra de calculo de frete o produto vai pertencer + */ + freteGratis?: + | { "0": "S"; "1": "e"; "2": "m"; "3": "p"; "4": "r"; "5": "e" } + | { "0": "N"; "1": "u"; "2": "n"; "3": "c"; "4": "a" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" } + | { + "0": "D"; + "1": "e"; + "2": "s"; + "3": "c"; + "4": "o"; + "5": "n"; + "6": "s"; + "7": "i"; + "8": "d"; + "9": "e"; + "10": "r"; + "11": "a"; + "12": "r"; + "13": "_"; + "14": "R"; + "15": "e"; + "16": "g"; + "17": "r"; + "18": "a"; + "19": "s"; + }; + /** + * Define se o produto variante tem troca grátis (optional) + */ trocaGratis?: boolean; + /** + * (Max Length: 8, "0000.0000,00") Peso do produto variante, em gramas (g) + */ peso?: number; + /** + * (Max Length: 8, "0000.0000,00") Altura do produto variante, em centímetros (cm). + */ altura?: number; + /** + * (Max Length: 8, "0000.0000,00") Comprimento do produto variante, em centímetros (cm). + */ comprimento?: number; + /** + * (Max Length: 8, "0000.0000,00") Largura do produto variante, em centímetros (cm). + */ largura?: number; + /** + * Define se o produto variante tem garantia (optional) + */ garantia?: number; + /** + * Define se o produto contém televendas (optional) + */ isTelevendas?: boolean; + /** + * (Max Length: 25) EAN do produto variante (optional) + */ ean?: string; + /** + * (Max Length: 255) Localização no estoque do produto variante (optional) + */ localizacaoEstoque?: string; + /** + * Dados de atacado do produto variante (optional) + */ listaAtacado?: { + /** + * (Max Length: 8, "0000.0000,00") - Preco Por do item por atacado + */ precoPor?: number; + /** + * Quantidade para compra de atacado + */ quantidade?: number; }[]; + /** + * Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional) + */ estoque?: { + /** + * Estoque físico do produto + */ estoqueFisico?: number; - estoqueReservado?: number; - centroDistribuicaoId?: number; + /** + * Estoque reservado do produto + */ + estoqueReservado?: number; + /** + * Id do centro de distribuição do estoque do produto + */ + centroDistribuicaoId?: number; + /** + * Quantidade para ativar o alerta de estoque + */ alertaEstoque?: number; }[]; - atributos?: { - tipoAtributo?: string; - isFiltro?: boolean; + /** + * Lista de atributos do produto + */ + listaAtributos?: { + /** + * (Max Length: 100) - Define o nome do atributo + */ nome?: string; + /** + * (Max Length: 8, "0000.0000,00") - Define o valor do atributo + */ valor?: string; + /** + * Define se o atributo deverá ser exibido + */ exibir?: boolean; }[]; - quantidadeMaximaCompraUnidade?: number; - quantidadeMinimaCompraUnidade?: number; - condicao?: string; - informacoes?: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; - }[]; - tabelasPreco?: { - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; - }[]; - dataCriacao?: string; - dataAtualizacao?: string; - urlVideo?: string; - spot?: boolean; - paginaProduto?: boolean; - marketplace?: boolean; - somenteParceiros?: boolean; - reseller?: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; - buyBox?: boolean; - consumo?: { - quantidadeDias?: number; - enviarEmail?: boolean; - }; - prazoValidade?: number; - }[]; - }; - /** @description Remove um Atacarejo */ - "DELETE /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { - searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Quantidade máxima de compra do produto variante (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - }; - /** @description Inserir autor */ - "POST /autores": { - body: { + quantidadeMaximaCompraUnidade?: number; /** - * Nome do Autor + * Quantidade mínima de compra do produto variante (optional) */ - nome?: string; + quantidadeMinimaCompraUnidade?: number; /** - * Status do autor + * Condição do produto variante (optional) */ - ativo?: boolean; - }; - }; - /** @description Lista dos estados */ - "GET /lojasFisicas/estados": { - response: { - estadoId?: number; - nome?: string; - sigla?: string; - regiao?: string; - }[]; - }; - /** @description Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais. */ - "GET /produtos/:identificador": { - searchParams: { + condicao?: + | { "0": "N"; "1": "o"; "2": "v"; "3": "o" } + | { "0": "U"; "1": "s"; "2": "a"; "3": "d"; "4": "o" } + | { + "0": "R"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "v"; + "5": "a"; + "6": "d"; + "7": "o"; + } + | { + "0": "D"; + "1": "a"; + "2": "n"; + "3": "i"; + "4": "f"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "d"; + "9": "o"; + }; /** - * Define se o identificador informado é um sku ou um id interno + * Url do vídeo do Produto (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + urlVideo?: string; /** - * Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + * Se o produto aparece no Spot (optional) */ - camposAdicionais?: string[]; - }; - response: { - produtoVarianteId?: number; - produtoId?: number; - idPaiExterno?: string; - idVinculoExterno?: string; - sku?: string; - nome?: string; - nomeProdutoPai?: string; - urlProduto?: string; - exibirMatrizAtributos?: string; - contraProposta?: boolean; - fabricante?: string; - autor?: string; - editora?: string; - colecao?: string; - genero?: string; - precoCusto?: number; - precoDe?: number; - precoPor?: number; - fatorMultiplicadorPreco?: number; - prazoEntrega?: number; - valido?: boolean; - exibirSite?: boolean; - freteGratis?: string; - trocaGratis?: boolean; - peso?: number; - altura?: number; - comprimento?: number; - largura?: number; - garantia?: number; - isTelevendas?: boolean; - ean?: string; - localizacaoEstoque?: string; - listaAtacado?: { - precoPor?: number; - quantidade?: number; - }[]; - estoque?: { - estoqueFisico?: number; - estoqueReservado?: number; - centroDistribuicaoId?: number; - alertaEstoque?: number; - }[]; - atributos?: { - tipoAtributo?: string; - isFiltro?: boolean; - nome?: string; - valor?: string; - exibir?: boolean; - }[]; - quantidadeMaximaCompraUnidade?: number; - quantidadeMinimaCompraUnidade?: number; - condicao?: string; - informacoes?: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; - }[]; - tabelasPreco?: { - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; - }[]; - dataCriacao?: string; - dataAtualizacao?: string; - urlVideo?: string; spot?: boolean; + /** + * Se o produto aparece na Url (optional) + */ paginaProduto?: boolean; + /** + * Se o produto aparece no Marketplace (optional) + */ marketplace?: boolean; + /** + * Se o produto aparece somente nos Parceiros + */ somenteParceiros?: boolean; - reseller?: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; + /** + * Se o produto deve ser agrupado pelo EAN (optional) + */ buyBox?: boolean; + /** + * Prazo de validade ou consumo do produto (optional) + */ + prazoValidade?: number; + /** + * Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional) + */ consumo?: { + /** + * Quantidade de Dias (optional) + */ quantidadeDias?: number; + /** + * Enviar e-mail (optional) + */ enviarEmail?: boolean; }; - prazoValidade?: number; }; }; /** @description Lista de versões */ - "GET /gestorscripts/scripts/:scriptId/versoes": { - response: { - versaoId?: number; - scriptId?: number; - dataCadastro?: string; - identificadorPagina?: string; - publicado?: boolean; - usuario?: string; - }[]; - }; - /** @description Reseller específico */ - "GET /resellers/token": { - response: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; - }; + "GET /gestorscripts/scripts/:scriptId/versoes": {}; /** @description Insere uma versão para um script existente */ "POST /gestorscripts/scripts/:scriptId/versoes": { - body: { + searchParams: { /** * Identificador da página */ @@ -2348,9 +2961,13 @@ export interface API { publicado?: boolean; }; }; + /** @description Reseller específico */ + "GET /resellers/token": {}; + /** @description Categoria encontrada */ + "GET /categorias/erp/:id": {}; /** @description Atualiza uma categoria utilizando o id do erp como identificador */ "PUT /categorias/erp/:id": { - body: { + searchParams: { /** * Nome da categoria (optional) */ @@ -2374,7 +2991,10 @@ export interface API { /** * Exibir Matriz de Atributos (optional) */ - exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + exibirMatrizAtributos?: + | { "0": "S"; "1": "i"; "2": "m" } + | { "0": "N"; "1": "a"; "2": "o" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; /** * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ @@ -2389,34 +3009,190 @@ export interface API { exibeMenu?: boolean; }; }; + /** @description Categoria excluída com sucesso */ + "DELETE /categorias/erp/:id": {}; /** @description Templates */ "GET /templates": {}; + /** @description Lista de usuários */ + "GET /usuarios": {}; /** @description Insere um novo usuário */ "POST /usuarios": { - body: { + searchParams: { /** * Tipo de pessoa */ - tipoPessoa?: "Fisica" | "Juridica"; + tipoPessoa?: + | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } + | { + "0": "J"; + "1": "u"; + "2": "r"; + "3": "i"; + "4": "d"; + "5": "i"; + "6": "c"; + "7": "a"; + }; /** * Origem do contato */ origemContato?: - | "Google" - | "Bing" - | "Jornal" - | "PatrocinioEsportivo" - | "RecomendacaoAlguem" - | "Revista" - | "SiteInternet" - | "Televisao" - | "Outro" - | "UsuarioImportadoViaAdmin" - | "PayPalExpress"; + | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } + | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } + | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } + | { + "0": "P"; + "1": "a"; + "2": "t"; + "3": "r"; + "4": "o"; + "5": "c"; + "6": "i"; + "7": "n"; + "8": "i"; + "9": "o"; + "10": "E"; + "11": "s"; + "12": "p"; + "13": "o"; + "14": "r"; + "15": "t"; + "16": "i"; + "17": "v"; + "18": "o"; + } + | { + "0": "R"; + "1": "e"; + "2": "c"; + "3": "o"; + "4": "m"; + "5": "e"; + "6": "n"; + "7": "d"; + "8": "a"; + "9": "c"; + "10": "a"; + "11": "o"; + "12": "A"; + "13": "l"; + "14": "g"; + "15": "u"; + "16": "e"; + "17": "m"; + } + | { + "0": "R"; + "1": "e"; + "2": "v"; + "3": "i"; + "4": "s"; + "5": "t"; + "6": "a"; + } + | { + "0": "S"; + "1": "i"; + "2": "t"; + "3": "e"; + "4": "I"; + "5": "n"; + "6": "t"; + "7": "e"; + "8": "r"; + "9": "n"; + "10": "e"; + "11": "t"; + } + | { + "0": "T"; + "1": "e"; + "2": "l"; + "3": "e"; + "4": "v"; + "5": "i"; + "6": "s"; + "7": "a"; + "8": "o"; + } + | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } + | { + "0": "U"; + "1": "s"; + "2": "u"; + "3": "a"; + "4": "r"; + "5": "i"; + "6": "o"; + "7": "I"; + "8": "m"; + "9": "p"; + "10": "o"; + "11": "r"; + "12": "t"; + "13": "a"; + "14": "d"; + "15": "o"; + "16": "V"; + "17": "i"; + "18": "a"; + "19": "A"; + "20": "d"; + "21": "m"; + "22": "i"; + "23": "n"; + } + | { + "0": "P"; + "1": "a"; + "2": "y"; + "3": "P"; + "4": "a"; + "5": "l"; + "6": "E"; + "7": "x"; + "8": "p"; + "9": "r"; + "10": "e"; + "11": "s"; + "12": "s"; + }; /** * Tipo Sexo (optional) */ - tipoSexo?: "Undefined" | "Masculino" | "Feminino"; + tipoSexo?: + | { + "0": "U"; + "1": "n"; + "2": "d"; + "3": "e"; + "4": "f"; + "5": "i"; + "6": "n"; + "7": "e"; + "8": "d"; + } + | { + "0": "M"; + "1": "a"; + "2": "s"; + "3": "c"; + "4": "u"; + "5": "l"; + "6": "i"; + "7": "n"; + "8": "o"; + } + | { + "0": "F"; + "1": "e"; + "2": "m"; + "3": "i"; + "4": "n"; + "5": "i"; + "6": "n"; + "7": "o"; + }; /** * Nome do usuário (Max Length: 100) */ @@ -2504,3671 +3280,511 @@ export interface API { aprovado?: boolean; }; }; + /** @description Dados da loja */ + "GET /loja": {}; + /** @description Indicadores de Faturamento */ + "GET /dashboard/faturamento": {}; + /** @description Grupo de assinatura */ + "GET /assinaturas/grupoassinatura": {}; /** @description Lista de pedidos */ - "GET /pedidos": { + "GET /pedidos/:pedidoId/rastreamento": {}; + /** @description Insere um rastreamento e status a um pedido */ + "POST /pedidos/:pedidoId/rastreamento": { searchParams: { /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + * Id da situação do pedido */ - dataInicial?: string; + situacaoPedidoId?: number; /** - * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + * Id do centro de distribuição */ - dataFinal?: string; + centroDistribuicaoId?: number; /** - * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + * Rastreamento (optional) */ - enumTipoFiltroData?: - | "DataPedido" - | "DataAprovacao" - | "DataModificacaoStatus" - | "DataAlteracao" - | "DataCriacao"; + rastreamento?: string; /** - * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + * Data do pedido (optional) */ - situacoesPedido?: string; + dataEvento?: string; /** - * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + * Número da nota fiscal (optional) */ - formasPagamento?: string; + numeroNotaFiscal?: string; /** - * Página da lista (padrão: 1) + * Chave acesso NFE (optional) */ - pagina?: number; + chaveAcessoNFE?: string; /** - * Quantidade de registros que deverão retornar (max: 50) + * URL NFE (optional) */ - quantidadeRegistros?: number; + urlNFE?: string; /** - * Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado + * Serie NFE (optional) */ - email?: string; + serieNFE?: string; /** - * Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado) + * CFOP (optional) */ - valido?: boolean; + cfop?: string; /** - * Deverá retornar apenas pedidos que o produto de determinado sku foi comprado + * URL Rastreamento (optional) */ - sku?: string; + urlRastreamento?: string; + }; + }; + /** @description Atualiza a data de entrega do pedido */ + "PUT /pedidos/:pedidoId/rastreamento": { + searchParams: { /** - * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + * Objeto com os dados do rastreamento */ - apenasAssinaturas?: boolean; - }; - response: { - pedidoId?: number; - situacaoPedidoId?: number; - tipoRastreamentoPedido?: string; - transacaoId?: number; - data?: string; - dataPagamento?: string; - dataUltimaAtualizacao?: string; - valorFrete?: number; - valorTotalPedido?: number; - valorDesconto?: number; - valorDebitoCC?: number; - cupomDesconto?: string; - marketPlacePedidoId?: string; - marketPlacePedidoSiteId?: string; - canalId?: number; - canalNome?: string; - canalOrigem?: string; - retiradaLojaId?: number; - isPedidoEvento?: boolean; - usuario?: { - usuarioId?: number; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; + RAW_BODY?: { + /** + * Código de verificação do transporte do produto + */ + rastreamento?: string; + /** + * Data que a entrega foi realizada + */ + dataEntrega?: string; }; - pedidoEndereco?: { - tipo?: string; - nome?: string; - endereco?: string; - numero?: string; - complemento?: string; - referencia?: string; - cep?: string; - tipoLogradouro?: string; - logradouro?: string; - bairro?: string; - cidade?: string; - estado?: string; - pais?: string; - }[]; - frete?: { - freteContratoId?: number; - freteContrato?: string; - referenciaConector?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - retiradaLojaId?: number; - centrosDistribuicao?: { - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - servico?: { - servicoId?: number; - nome?: string; - transportadora?: string; - prazo?: number; - servicoNome?: string; - preco?: number; - servicoTransporte?: number; - codigo?: number; - servicoMeta?: string; - custo?: number; - token?: string; - }; - retiradaAgendada?: { - lojaId?: number; - retiradaData?: string; - retiradaPeriodo?: string; - nome?: string; - documento?: string; - codigoRetirada?: string; - }; - agendamento?: { - de?: string; - ate?: string; - }; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }; - itens?: { - produtoVarianteId?: number; - sku?: string; - nome?: string; - quantidade?: number; - precoCusto?: number; - precoVenda?: number; - isBrinde?: boolean; - valorAliquota?: number; - isMarketPlace?: boolean; - precoPor?: number; - desconto?: number; - totais?: { - precoCusto?: number; - precoVenda?: number; - precoPor?: number; - desconto?: number; - }; - ajustes?: { - tipo?: string; - valor?: number; - observacao?: string; - nome?: string; - }[]; - centroDistribuicao?: { - centroDistribuicaoId?: number; - quantidade?: number; - situacaoProdutoId?: number; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - }[]; - valoresAdicionais?: { - tipo?: string; - origem?: string; - texto?: string; - valor?: number; - }[]; - atributos?: { - produtoVarianteAtributoValor?: string; - produtoVarianteAtributoNome?: string; - }[]; - embalagens?: { - tipoEmbalagemId?: number; - nomeTipoEmbalagem?: string; - mensagem?: string; - valor?: number; - descricao?: string; - }[]; - personalizacoes?: { - nomePersonalizacao?: string; - valorPersonalizacao?: string; - valor?: number; - }[]; - frete?: { - quantidade?: number; - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - dadosProdutoEvento?: { - tipoPresenteRecebimento?: string; - }; - formulas?: { - chaveAjuste?: string; - valor?: number; - nome?: string; - expressao?: string; - expressaoInterpretada?: string; - endPoint?: string; - }[]; - seller?: { - sellerId?: number; - sellerNome?: string; - sellerPedidoId?: number; - }; - }[]; - assinatura?: { - assinaturaId?: number; - grupoAssinaturaId?: number; - tipoPeriodo?: string; - tempoPeriodo?: number; - percentualDesconto?: number; - }[]; - pagamento?: { - formaPagamentoId?: number; - numeroParcelas?: number; - valorParcela?: number; - valorDesconto?: number; - valorJuros?: number; - valorTotal?: number; - boleto?: { - urlBoleto?: string; - codigoDeBarras?: string; - }; - cartaoCredito?: { - numeroCartao?: string; - nomeTitular?: string; - dataValidade?: string; - codigoSeguranca?: string; - documentoCartaoCredito?: string; - token?: string; - info?: string; - bandeira?: string; - }[]; - pagamentoStatus?: { - numeroAutorizacao?: string; - numeroComprovanteVenda?: string; - dataAtualizacao?: string; - dataUltimoStatus?: string; - adquirente?: string; - tid?: string; - }[]; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }[]; - observacao?: { - observacao?: string; - usuario?: string; - data?: string; - publica?: boolean; - }[]; - valorCreditoFidelidade?: number; - valido?: boolean; - valorSubTotalSemDescontos?: number; - pedidoSplit?: number[]; - }[]; - }; - /** @description Dados da loja */ - "GET /loja": { - response: { - nome?: string; - urlSite?: string; - urlCarrinho?: string; - }; - }; - /** @description Indicadores de Faturamento */ - "GET /dashboard/faturamento": { - searchParams: { - /** - * Data inicial dos indicadores que deverão retonar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos indicadores que deverão retonar (aaaa-mm-dd) - */ - dataFinal?: string; - /** - * Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) - */ - dataInicialComparativo?: string; - /** - * Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) - */ - dataFinalComparativo?: string; - }; - response: { - indicadorReceita?: number; - indicadorPedido?: number; - indicadorTicketMedio?: number; - indicadorReceitaComparativo?: number; - indicadorPedidoComparativo?: number; - indicadorTicketMedioComparativo?: number; - indicadorReceitaFormatado?: string; - indicadorPedidoFormatado?: string; - indicadorTicketMedioFormatado?: string; - indicadorReceitaComparativoFormatado?: string; - indicadorPedidoComparativoFormatado?: string; - indicadorTicketMedioComparativoFormatado?: string; - indicadorReceitaPorcentagem?: string; - indicadorPedidoPorcentagem?: string; - indicadorTicketMedioPorcentagem?: string; - }; - }; - /** @description Grupo de assinatura */ - "GET /assinaturas/grupoassinatura": { - response: { - grupoAssinaturaId?: number; - nome?: string; - recorrencias?: { - recorrenciaId?: number; - nome?: string; - dias?: number; - }[]; - }[]; - }; - /** @description Atualiza um produto com base nos dados enviados */ - "PUT /produtos/:identificador": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { - /** - * Representa o ProdutoId agrupador por variante (optional) - */ - idPaiExterno?: string; - /** - * Representa o ParentId agrupador por parent (optional) - */ - idVinculoExterno?: string; - /** - * (Max Length: 50) Sku do produto - */ - sku?: string; - /** - * (Max Length: 300) Nome do produto variante - */ - nome?: string; - /** - * Nome do produto (pai do variante) (optional) - */ - nomeProdutoPai?: string; - /** - * Tipo de exibição da matriz de atributos (optional) - */ - exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; - /** - * Se o produto aceita contra proposta (optional) - */ - contraProposta?: boolean; - /** - * (Max Length: 100) Nome do fabricante - */ - fabricante?: string; - /** - * (Max Length: 500) Nome do autor (optional) - */ - autor?: string; - /** - * (Max Length: 100) Nome da editora (optional) - */ - editora?: string; - /** - * (Max Length: 100) Nome da coleção (optional) - */ - colecao?: string; - /** - * (Max Length: 100) Nome do gênero (optional) - */ - genero?: string; - /** - * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) - */ - precoCusto?: number; - /** - * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) - */ - precoDe?: number; - /** - * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante - */ - precoPor?: number; - /** - * (Max Length: 8, "0000.0000,00") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) - */ - fatorMultiplicadorPreco?: number; - /** - * Prazo de entrega do produto variante (optional) - */ - prazoEntrega?: number; - /** - * Define se um produto variante é valido ou não (optional) - */ - valido?: boolean; - /** - * Define se um produto deve ser exibido no site (optional) - */ - exibirSite?: boolean; - /** - * Define a qual regra de calculo de frete o produto vai pertencer - */ - freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; - /** - * Define se o produto variante tem troca grátis (optional) - */ - trocaGratis?: boolean; - /** - * (Max Length: 8, "0000.0000,00") Peso do produto variante, em gramas (g) - */ - peso?: number; - /** - * (Max Length: 8, "0000.0000,00") Altura do produto variante, em centímetros (cm). - */ - altura?: number; - /** - * (Max Length: 8, "0000.0000,00") Comprimento do produto variante, em centímetros (cm). - */ - comprimento?: number; - /** - * (Max Length: 8, "0000.0000,00") Largura do produto variante, em centímetros (cm). - */ - largura?: number; - /** - * Define se o produto variante tem garantia (optional) - */ - garantia?: number; - /** - * Define se o produto contém televendas (optional) - */ - isTelevendas?: boolean; - /** - * (Max Length: 25) EAN do produto variante (optional) - */ - ean?: string; - /** - * (Max Length: 255) Localização no estoque do produto variante (optional) - */ - localizacaoEstoque?: string; - /** - * Dados de atacado do produto variante (optional) - */ - listaAtacado?: { - /** - * (Max Length: 8, "0000.0000,00") - Preco Por do item por atacado - */ - precoPor?: number; - /** - * Quantidade para compra de atacado - */ - quantidade?: number; - }[]; - /** - * Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional) - */ - estoque?: { - /** - * Estoque físico do produto - */ - estoqueFisico?: number; - /** - * Estoque reservado do produto - */ - estoqueReservado?: number; - /** - * Id do centro de distribuição do estoque do produto - */ - centroDistribuicaoId?: number; - /** - * Quantidade para ativar o alerta de estoque - */ - alertaEstoque?: number; - }[]; - /** - * Lista de atributos do produto - */ - listaAtributos?: { - /** - * (Max Length: 100) - Define o nome do atributo - */ - nome?: string; - /** - * (Max Length: 8, "0000.0000,00") - Define o valor do atributo - */ - valor?: string; - /** - * Define se o atributo deverá ser exibido - */ - exibir?: boolean; - }[]; - /** - * Quantidade máxima de compra do produto variante (optional) - */ - quantidadeMaximaCompraUnidade?: number; - /** - * Quantidade mínima de compra do produto variante (optional) - */ - quantidadeMinimaCompraUnidade?: number; - /** - * Condição do produto variante (optional) - */ - condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; - /** - * Url do vídeo do Produto (optional) - */ - urlVideo?: string; - /** - * Se o produto aparece no Spot (optional) - */ - spot?: boolean; - /** - * Se o produto aparece na Url (optional) - */ - paginaProduto?: boolean; - /** - * Se o produto aparece no Marketplace (optional) - */ - marketplace?: boolean; - /** - * Se o produto aparece somente nos Parceiros - */ - somenteParceiros?: boolean; - /** - * Se o produto deve ser agrupado pelo EAN (optional) - */ - buyBox?: boolean; - /** - * Prazo de validade ou consumo do produto (optional) - */ - prazoValidade?: number; - /** - * Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional) - */ - consumo?: { - /** - * Quantidade de Dias (optional) - */ - quantidadeDias?: number; - /** - * Enviar e-mail (optional) - */ - enviarEmail?: boolean; - }; - }; - }; - /** @description Lista de pedidos */ - "GET /pedidos/:pedidoId/rastreamento": { - response: { - pedidoRastreamentoId?: number; - dataAtualizacao?: string; - notaFiscal?: string; - serieNF?: string; - cfop?: number; - dataEnviado?: string; - urlNFE?: string; - chaveAcessoNFE?: string; - rastreamento?: string; - urlRastreamento?: string; - transportadora?: string; - dataEntrega?: string; - }; - }; - /** @description Atualiza rastreamento de produto completo (com os dados da N.F.) */ - "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": - { - body: { - /** - * Nota Fiscal - */ - notaFiscal?: string; - /** - * CFOP - */ - cfop?: number; - /** - * Data Enviado - */ - dataEnviado?: string; - /** - * Chave de acesso NFE - */ - chaveAcessoNFE?: string; - /** - * Rastreamento (optional) - */ - rastreamento?: string; - /** - * URL de rastreamento (optional) - */ - urlRastreamento?: string; - /** - * Transportadora (optional) - */ - transportadora?: string; - /** - * Data da entrega (optional) - */ - dataEntrega?: string; - }; - }; - /** @description Insere um novo detalhe de frete vinculado a um contrato de frete */ - "POST /fretes/:freteId/detalhes": { - body: { - /** - * Informe o cep inicial (optional) - */ - cepInicial?: number; - /** - * Informe o cep final (optional) - */ - cepFinal?: number; - /** - * Variações de detalhe do frete (optional) - */ - variacoesFreteDetalhe?: { - /** - * Informe o peso inicial - */ - pesoInicial?: number; - /** - * Informe o peso final - */ - pesoFinal?: number; - /** - * Informe o valor do frete - */ - valorFrete?: number; - /** - * Informe o prazo de entrega - */ - prazoEntrega?: number; - /** - * Informe o valor preço - */ - valorPreco?: number; - /** - * Informe o valor peso - */ - valorPeso?: number; - }[]; - }; - }; - /** @description Insere um novo portfolio */ - "POST /portfolios": { - body: { - /** - * Nome do portfolio - */ - nome?: string; - }; - }; - /** @description Lista de banners */ - "GET /banners": { - searchParams: { - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadePorPagina?: number; - }; - response: { - id?: number; - nome?: string; - dataInicio?: string; - dataFim?: string; - ativo?: boolean; - detalhe?: { - posicionamentoId?: number; - urlBanner?: string; - imagemBanner?: { - nome?: string; - base64?: string; - formato?: string; - }; - ordemExibicao?: number; - abrirBannerNovaAba?: boolean; - largura?: number; - altura?: number; - title?: string; - urlClique?: string; - urlBannerAlternativo?: string; - titleAlternativo?: string; - diasExibicao?: { - todosDias?: boolean; - domingo?: boolean; - segunda?: boolean; - terca?: boolean; - quarta?: boolean; - quinta?: boolean; - sexta?: boolean; - sabado?: boolean; - }; - textoAlternativo?: string; - }; - apresentacao?: { - exibirNoSite?: boolean; - exibirEmTodasBuscas?: boolean; - naoExibirEmBuscas?: boolean; - termosBusca?: string; - listaHotsites?: { - exibirEmTodosHotSites?: boolean; - hotSites?: { - hotSiteId?: number; - }[]; - }; - exibirEmTodasCategorias?: boolean; - listaParceiros?: { - exibirEmTodosParceiros?: boolean; - parceiros?: { - parceiroId?: number; - }[]; - }; - }; - }[]; - }; - /** @description Pedido encontrado */ - "GET /pedidos/:pedidoId": { - response: { - pedidoId?: number; - situacaoPedidoId?: number; - tipoRastreamentoPedido?: string; - transacaoId?: number; - data?: string; - dataPagamento?: string; - dataUltimaAtualizacao?: string; - valorFrete?: number; - valorTotalPedido?: number; - valorDesconto?: number; - valorDebitoCC?: number; - cupomDesconto?: string; - marketPlacePedidoId?: string; - marketPlacePedidoSiteId?: string; - canalId?: number; - canalNome?: string; - canalOrigem?: string; - retiradaLojaId?: number; - isPedidoEvento?: boolean; - usuario?: { - usuarioId?: number; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - }; - pedidoEndereco?: { - tipo?: string; - nome?: string; - endereco?: string; - numero?: string; - complemento?: string; - referencia?: string; - cep?: string; - tipoLogradouro?: string; - logradouro?: string; - bairro?: string; - cidade?: string; - estado?: string; - pais?: string; - }[]; - frete?: { - freteContratoId?: number; - freteContrato?: string; - referenciaConector?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - retiradaLojaId?: number; - centrosDistribuicao?: { - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - servico?: { - servicoId?: number; - nome?: string; - transportadora?: string; - prazo?: number; - servicoNome?: string; - preco?: number; - servicoTransporte?: number; - codigo?: number; - servicoMeta?: string; - custo?: number; - token?: string; - }; - retiradaAgendada?: { - lojaId?: number; - retiradaData?: string; - retiradaPeriodo?: string; - nome?: string; - documento?: string; - codigoRetirada?: string; - }; - agendamento?: { - de?: string; - ate?: string; - }; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }; - itens?: { - produtoVarianteId?: number; - sku?: string; - nome?: string; - quantidade?: number; - precoCusto?: number; - precoVenda?: number; - isBrinde?: boolean; - valorAliquota?: number; - isMarketPlace?: boolean; - precoPor?: number; - desconto?: number; - totais?: { - precoCusto?: number; - precoVenda?: number; - precoPor?: number; - desconto?: number; - }; - ajustes?: { - tipo?: string; - valor?: number; - observacao?: string; - nome?: string; - }[]; - centroDistribuicao?: { - centroDistribuicaoId?: number; - quantidade?: number; - situacaoProdutoId?: number; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - }[]; - valoresAdicionais?: { - tipo?: string; - origem?: string; - texto?: string; - valor?: number; - }[]; - atributos?: { - produtoVarianteAtributoValor?: string; - produtoVarianteAtributoNome?: string; - }[]; - embalagens?: { - tipoEmbalagemId?: number; - nomeTipoEmbalagem?: string; - mensagem?: string; - valor?: number; - descricao?: string; - }[]; - personalizacoes?: { - nomePersonalizacao?: string; - valorPersonalizacao?: string; - valor?: number; - }[]; - frete?: { - quantidade?: number; - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - dadosProdutoEvento?: { - tipoPresenteRecebimento?: string; - }; - formulas?: { - chaveAjuste?: string; - valor?: number; - nome?: string; - expressao?: string; - expressaoInterpretada?: string; - endPoint?: string; - }[]; - seller?: { - sellerId?: number; - sellerNome?: string; - sellerPedidoId?: number; - }; - }[]; - assinatura?: { - assinaturaId?: number; - grupoAssinaturaId?: number; - tipoPeriodo?: string; - tempoPeriodo?: number; - percentualDesconto?: number; - }[]; - pagamento?: { - formaPagamentoId?: number; - numeroParcelas?: number; - valorParcela?: number; - valorDesconto?: number; - valorJuros?: number; - valorTotal?: number; - boleto?: { - urlBoleto?: string; - codigoDeBarras?: string; - }; - cartaoCredito?: { - numeroCartao?: string; - nomeTitular?: string; - dataValidade?: string; - codigoSeguranca?: string; - documentoCartaoCredito?: string; - token?: string; - info?: string; - bandeira?: string; - }[]; - pagamentoStatus?: { - numeroAutorizacao?: string; - numeroComprovanteVenda?: string; - dataAtualizacao?: string; - dataUltimoStatus?: string; - adquirente?: string; - tid?: string; - }[]; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }[]; - observacao?: { - observacao?: string; - usuario?: string; - data?: string; - publica?: boolean; - }[]; - valorCreditoFidelidade?: number; - valido?: boolean; - valorSubTotalSemDescontos?: number; - pedidoSplit?: number[]; - }; - }; - /** @description Avatar do usuário encontrado */ - "GET /usuarios/:email/avatar": { - response: { - urlAvatar?: string; - }; - }; - /** @description Lista de identificadores de conteúdos vinculados ao hotsite */ - "GET /hotsites/:hotsiteId/conteudos": { - response: { - conteudoId?: number; - }[]; - }; - /** @description Atualiza um campo de cadastro personalizado pelo id */ - "PUT /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": { - body: { - /** - * Nome do campo (optional) - */ - nome?: string; - /** - * Se o campo será obrigatório (optional) - */ - obrigatorio?: boolean; - /** - * Ordem (optional) - */ - ordem?: number; - }; - }; - /** @description Dados do serviço de frete do pedido */ - "GET /pedidos/:pedidoId/frete": {}; - /** @description Atualiza uma tabela de preços */ - "PUT /tabelaPrecos/:tabelaPrecoId": { - body: { - /** - * Nome da tabela de preço - */ - nome?: string; - /** - * Data que inicia a tabela de preço - */ - dataInicial?: string; - /** - * Data de término da tabela de preço - */ - dataFinal?: string; - /** - * Status da tabela de preço - */ - ativo?: boolean; - }; - }; - /** @description Atualiza a situação do status do pedido */ - "PUT /pedidos/:pedidoId/status": { - body: { - /** - * Id da situação do pedido - */ - RAW_BODY: { - /** - * Id da situação do pedido - */ - id?: number; - }; - }; - }; - /** @description Lista de Tópicos */ - "GET /webhook/Topicos": { - response: { - nome?: string; - descricao?: string; - payload?: string; - }[]; - }; - /** @description Seta o pedido como integrado */ - "POST /pedidos/complete": { - body: { - /** - * Pedido que se deseja inserir o "complete" - */ - RAW_BODY: { - /** - * Id do pedido - */ - pedidoId?: number; - }; - }; - }; - /** @description Deleta um portfolio */ - "DELETE /portfolios/:portfolioId": {}; - /** @description Retorna se o produto variante está disponível ou não */ - "GET /produtos/:identificador/disponibilidade": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - }; - /** @description Lista de formas de pagamento */ - "GET /formasPagamento": { - response: { - formaPagamentoId?: number; - nome?: string; - nomeExibicao?: string; - descricao?: string; - }[]; - }; - /** @description Último status do pedido */ - "GET /pedidos/:pedidoId/status": { - response: { - situacaoPedidoId?: number; - dataAtualizacao?: string; - notaFiscal?: string; - cfop?: number; - dataEnviado?: string; - chaveAcessoNFE?: string; - rastreamento?: string; - urlRastreamento?: string; - nomeTransportadora?: string; - produtos?: { - produtoVarianteId?: number; - situacaoProdutoId?: number; - quantidade?: number; - centroDistribuicaoId?: number; - }[]; - }; - }; - /** @description Lista de pedidos */ - "GET /pedidos/:pedidoId/rastreamento/produtos": { - response: { - produtoVarianteId?: number; - rastreamentos?: { - pedidoRastreamentoProdutoId?: number; - quantidade?: number; - dataAtualizacao?: string; - notaFiscal?: string; - cfop?: number; - dataEnviado?: string; - chaveAcessoNFE?: string; - rastreamento?: string; - urlRastreamento?: string; - transportadora?: string; - centroDistribuicaoId?: number; - dataEntrega?: string; - }[]; - }[]; - }; - /** @description Altera o status de um portfolio */ - "PUT /portfolios/:portfolioId/status": { - body: { - /** - * Status do portfolio: true ou false - */ - RAW_BODY?: { - /** - * Novo status do portfolio - */ - ativo?: boolean; - }; - }; - }; - /** @description Limite de crédito que estão vinculados aos usuários */ - "GET /usuarios/limiteCredito": { - response: { - usuarioId?: number; - valor?: number; - saldo?: number; - }[]; - }; - /** @description Exclui uma imagem de um produto */ - "DELETE /produtos/:identificador/imagens/:id": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - }; - /** @description Atualiza um atributo */ - "PUT /atributos/:nome": { - body: { - /** - * Nome do atributo (optional) - */ - nome?: string; - /** - * Tipo do atributo (optional) - */ - tipo?: - | "Selecao" - | "Filtro" - | "Comparacao" - | "Configuracao" - | "ExclusivoGoogle"; - /** - * Tipo de exibição (optional) - */ - tipoExibicao?: - | "Combo" - | "Div" - | "DivComCor" - | "DivComFotoDoProdutoVariante" - | "Javascript"; - /** - * Prioridade do atributo (optional) - */ - prioridade?: number; - }; - }; - /** @description Atualiza um portfolio */ - "PUT /portfolios/:portfolioId": { - body: { - /** - * Nome do portfolio - */ - nome?: string; - }; - }; - /** @description Extrato retornado com sucesso */ - "GET /contascorrentes/:email/extrato": { - searchParams: { - /** - * Data Inicial para verificar extrato - */ - dataInicial?: string; - /** - * Data Final para verificar extrato - */ - dataFinal?: string; - }; - response: { - data?: string; - historico?: string; - valor?: number; - tipoLancamento?: string; - observacao?: string; - visivelParaCliente?: boolean; - }[]; - }; - /** @description Fabricante encontrado */ - "GET /fabricantes/:fabricanteId": { - response: { - fabricanteId?: number; - ativo?: boolean; - nome?: string; - urlLogoTipo?: string; - urlLink?: string; - urlCarrossel?: string; - }; - }; - /** @description Insere uma observação a um pedido */ - "POST /pedidos/:pedidoId/observacao": { - body: { - /** - * Objeto com os dados da observação (optional) - */ - RAW_BODY: { - /** - * Texto da observação - */ - observacao?: string; - /** - * Nome do usuário que está inserindo a observação - */ - usuario?: string; - /** - * Se a observação é publica ou privada - */ - publica?: boolean; - }; - }; - }; - /** @description Lista de tipos de evento */ - "GET /tiposEvento": { - searchParams: { - /** - * Status do tipo de evento - */ - ativo?: boolean; - /** - * Se o tipo de evento está disponível - */ - disponivel?: boolean; - /** - * Nome do tipo de evento - */ - nome?: string; - }; - response: { - tipoEventoId?: number; - nome?: string; - tipoEntrega?: string; - tipoDisponibilizacao?: string; - permitirRemocaoAutomaticaProdutos?: boolean; - corHexTituloInformacoes?: string; - corHexCorpoInformacoes?: string; - numeroAbasInformacoes?: number; - quantidadeDiasParaEventoExpirar?: number; - numeroLocaisEvento?: number; - ativo?: boolean; - disponivel?: boolean; - tipoBeneficiarioFrete?: string; - caminhoLogoEvento?: string; - caminhoSubTemplate?: string; - sugestaoProdutos?: { - tipoEventoId?: number; - produtoVarianteId?: number; - }[]; - }[]; - }; - /** @description Lista de centros de distribuição */ - "GET /centrosdistribuicao": { - response: { - id?: number; - nome?: string; - cep?: number; - padrao?: boolean; - }[]; - }; - /** @description Rastreamento de produto encontrado */ - "GET /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": - { - response: { - pedidoRastreamentoProdutoId?: number; - pedidoId?: number; - produtoVarianteId?: number; - pedidoProdutoId?: number; - dataInclusao?: string; - dataAlteracao?: string; - notaFiscal?: string; - cfop?: number; - dataEnviado?: string; - chaveAcessoNFE?: string; - rastreamento?: string; - urlRastreamento?: string; - quantidade?: number; - urlNFE?: string; - serieNFE?: string; - tipoPostagem?: string; - centroDistribuicao?: string; - transportadora?: string; - dataEntrega?: string; - }; - }; - /** @description Lista de avaliações de produtos */ - "GET /produtoavaliacao": { - searchParams: { - /** - * Referente ao status que libera a visualização da avaliação no site - */ - status?: "Pendente" | "NaoAprovado" | "Aprovado"; - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadeRegistros?: number; - }; - response: { - produtoVarianteId?: number; - sku?: string; - produtoAvaliacaoId?: number; - comentario?: string; - avaliacao?: number; - usuarioId?: number; - dataAvaliacao?: string; - nome?: string; - email?: string; - status?: string; - }[]; - }; - /** @description Conteúdo encontrado */ - "GET /conteudos/:conteudoId": {}; - /** @description Lista de usuários */ - "GET /usuarios": { - searchParams: { - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadeRegistros?: number; - /** - * Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) - */ - dataInicial?: string; - /** - * Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) - */ - dataFinal?: string; - /** - * Tipo de filtro de data - */ - enumTipoFiltroData?: "DataAlteracao" | "DataCriacao"; - /** - * Status de aprovação - */ - aprovado?: boolean; - }; - response: { - usuarioId?: number; - bloqueado?: boolean; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - avatar?: string; - ip?: string; - aprovado?: boolean; - }[]; - }; - /** @description Desvincula um ou mais conteúdos de um hotsite específico */ - "DELETE /hotsites/:hotsiteId/conteudos": { - body: { - /** - * Lista de identificadores de conteúdos a serem desvinculados - */ - conteudos?: { - /** - * Identificador do conteúdo - */ - conteudoId?: number; - }[]; - }; - }; - /** @description Atualiza o status do tipo de evento, ativando-o ou inativando-o */ - "PUT /tiposEvento/:tipoEventoId/AlterarStatus": {}; - /** @description Exclui os detalhes de um contrato de frete */ - "DELETE /fretes/:freteId/detalhes": {}; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /tiposEvento/:tipoEventoId/produtos": { - response: { - tipoEventoId?: number; - produtoVariantePrincipalId?: number; - }[]; - }; - /** @description Atualiza a ativação automática de produtos de um Seller */ - "PUT /resellers/:resellerId/ativacaoAutomaticaProdutos": { - body: { - /** - * Status da ativação automática de produtos - */ - ativo?: boolean; - }; - }; - /** @description Insere um SEO para um produto específico */ - "POST /produtos/:identificador/seo": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - body: { - /** - * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) - */ - tagCanonical?: string; - /** - * Informe o title da página do produto (optional) - */ - title?: string; - /** - * Informe os dados da Meta Tag (optional) - */ - metaTags?: { - /** - * Dados da Meta Tag - */ - content?: string; - /** - * Dados da Meta Tag - */ - httpEquiv?: string; - /** - * Dados da Meta Tag - */ - name?: string; - /** - * Dados da Meta Tag - */ - scheme?: string; - }[]; - }; - }; - /** @description Gráfico Forma de Pagamento */ - "GET /dashboard/graficoformapagamento": { - searchParams: { - /** - * Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) - */ - dataFinal?: string; - /** - * Id do parceiro - */ - parceiroId?: number; - }; - response: { - nome?: string; - quantidade?: number; - cor?: string; - }[]; - }; - /** @description Lista de números de pedidos ainda não integrados */ - "GET /pedidos/naoIntegrados": { - response: { - pedidoId?: number; - }[]; - }; - /** @description Dados da lista de desejos de um usuário */ - "GET /usuarios/:usuarioId/listaDesejos": { - response: { - produtoId?: number; - produtoVarianteId?: number; - quantidade?: number; - dataAdicao?: string; - }[]; - }; - /** @description Portfolio encontrado */ - "GET /portfolios/:portfolioId": { - response: { - portfolioId?: number; - nome?: string; - ativo?: boolean; - }; - }; - /** @description Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request */ - "PUT /eventos/:eventoId/produtos": { - body: { - /** - * Identificadores dos produtos variantes a serem vinculados ao evento desejado - */ - produtosVariante?: { - /** - * Identificador do produto variante - */ - produtoVarianteId?: number; - }[]; - }; - }; - /** @description Usuários encontrados */ - "GET /parceiros/:nome/usuarios": { - response: { - usuarioId?: number; - email?: string; - ativo?: boolean; - dataInicial?: string; - dataFinal?: string; - vinculoVitalicio?: boolean; - }[]; - }; - /** @description Indicador dos Novos Compradores */ - "GET /dashboard/novoscompradores": { - searchParams: { - /** - * Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos novos compradores que deverão retonar (aaaa-mm-dd) - */ - dataFinal?: string; - }; - response: { - indicadorComprador?: string; - }; - }; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos": { - searchParams: { - /** - * Data de inicio do evento - */ - dataInicial?: string; - /** - * Data do termino do evento - */ - dataFinal?: string; - /** - * Status do evento - */ - disponivel?: boolean; - /** - * Titulo do evento - */ - titulo?: string; - /** - * Email do Usuário - */ - usuarioEmail?: string; - /** - * Identificador do Tipo de Evento - */ - tipoEventoId?: number; - }; - response: { - eventoId?: number; - tipoEventoId?: number; - userId?: number; - enderecoEntregaId?: number; - data?: string; - dataCriacao?: string; - titulo?: string; - url?: string; - disponivel?: boolean; - diasDepoisEvento?: number; - diasAntesEvento?: number; - urlLogoEvento?: string; - urlCapaEvento?: string; - proprietarioEvento?: string; - abaInfo01Habilitado?: boolean; - textoInfo01?: string; - conteudoInfo01?: string; - abaInfo02Habilitado?: boolean; - textoInfo02?: string; - conteudoInfo02?: string; - abaMensagemHabilitado?: boolean; - fotos?: string; - enumTipoListaPresenteId?: string; - enumTipoEntregaId?: string; - eventoProdutoSelecionado?: { - eventoId?: number; - produtoVarianteId?: number; - recebidoForaLista?: boolean; - removido?: boolean; - }[]; - enderecoEvento?: { - enderecoEventoId?: number; - eventoId?: number; - nome?: string; - cep?: string; - endereco?: string; - numero?: string; - bairro?: string; - cidade?: string; - estado?: string; - }[]; - }[]; - }; - /** @description Realiza um novo lançamento na conta corrente do cliente */ - "POST /contascorrentes/:email": { - body: { - /** - * Valor da conta corrente (optional) - */ - valor?: number; - /** - * Tipo de Lançamento (optional) - */ - tipoLancamento?: "Credito" | "Debito"; - /** - * Observação (optional) - */ - observacao?: string; - /** - * Se será visível para o cliente (optional) - */ - visivelParaCliente?: boolean; - }; - }; - /** @description Retorna todas as informações de um produto específico */ - "GET /produtos/:identificador/informacoes": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; - }; - response: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; - }[]; - }; - /** @description Insere um novo atributo */ - "POST /atributos": { - body: { - /** - * Nome do atributo (optional) - */ - nome?: string; - /** - * Tipo do atributo (optional) - */ - tipo?: - | "Selecao" - | "Filtro" - | "Comparacao" - | "Configuracao" - | "ExclusivoGoogle"; - /** - * Tipo de exibição (optional) - */ - tipoExibicao?: - | "Combo" - | "Div" - | "DivComCor" - | "DivComFotoDoProdutoVariante" - | "Javascript"; - /** - * Prioridade do atributo (optional) - */ - prioridade?: number; - }; - }; - /** @description Indicador do Carrinho Abandonado */ - "GET /dashboard/carrinhoabandonado": { - searchParams: { - /** - * Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) - */ - dataFinal?: string; - }; - response: { - indicadorCarrinhoAbandonado?: string; - }; - }; - /** @description Deleta um ou mais Metatags de produto */ - "DELETE /produtos/:identificador/seo/metaTag": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno - */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - body: { - /** - * Lista de identificadores de metatags (optional) - */ - metatags?: { - /** - * Identificador do MetaTag - */ - metatagId?: number; - }[]; - }; - }; - /** @description Frete encontrado */ - "GET /fretes/:freteId": { - response: { - freteId?: number; - nome?: string; - ativo?: boolean; - volumeMaximo?: number; - pesoCubado?: number; - entregaAgendadaConfiguracaoId?: number; - linkRastreamento?: string; - ehAssinatura?: boolean; - larguraMaxima?: number; - alturaMaxima?: number; - comprimentoMaximo?: number; - limiteMaximoDimensoes?: number; - limitePesoCubado?: number; - tempoMinimoDespacho?: number; - centroDistribuicaoId?: number; - valorMinimoProdutos?: number; - }; - }; - /** @description Relatório de transações de um determinado período */ - "GET /dashboard/transacoes": { - searchParams: { - /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos pedidos que deverão retornar (aaaa-mm-dd) - */ - dataFinal?: string; - /** - * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) - */ - tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; - }; - response: { - tipoAgrupamento?: string; - dados?: { - data?: string; - pedidosCaptados?: number; - pedidosPagos?: number; - pedidosEnviados?: number; - pedidosCancelados?: number; - }[]; - }; - }; - /** @description Lista de produtos de uma tabela de preços */ - "GET /tabelaPrecos/:tabelaPrecoId/produtos": { - searchParams: { - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadeRegistros?: number; - }; - response: { - tabelaPrecoProdutoVarianteId?: number; - tabelaPrecoId?: number; - sku?: string; - produtoVarianteId?: number; - precoDe?: number; - precoPor?: number; - }[]; - }; - /** @description Insere um novo script */ - "POST /gestorscripts/scripts": { - body: { - /** - * Nome do script - */ - nome?: string; - /** - * Data inicial do script - */ - dataInicial?: string; - /** - * Data final do script - */ - dataFinal?: string; - /** - * Informe se o script está ativo ou não - */ - ativo?: boolean; - /** - * Prioridade do script - */ - prioridade?: number; - /** - * Posição do script - */ - posicao?: - | "HeaderPrimeiraLinha" - | "HeaderUltimaLinha" - | "BodyPrimeiraLinha" - | "BodyUltimaLinha" - | "FooterPrimeiraLinha" - | "FooterUltimeLinha"; - /** - * Tipo da página do script - */ - tipoPagina?: - | "Todas" - | "Home" - | "Busca" - | "Categoria" - | "Fabricante" - | "Estaticas" - | "Produto" - | "Carrinho"; - /** - * Identificador da página - */ - identificadorPagina?: string; - /** - * Conteúdo do script - */ - conteudo?: string; - /** - * Status do script - */ - publicado?: boolean; - }; - }; - /** @description Assinaturas com erro na loja */ - "GET /assinaturas/erros": { - searchParams: { - /** - * Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) - */ - dataInicial?: string; - /** - * Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) - */ - dataFinal?: string; - /** - * Erros já resolvidos ou não - */ - resolvidos?: boolean; - }; - }; - /** @description Método que realiza uma cotação de frete */ - "POST /fretes/cotacoes": { - searchParams: { - /** - * Cep de entrega - */ - cep?: string; - /** - * Define se o identificador informado é um sku ou um id interno da fstore - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - /** - * Define se deve retornar as opções de retirada em loja ("False" por padrão) (optional) - */ - retiradaLoja?: boolean; - }; - body: { - /** - * Valor total do pedido (optional) - */ - valorTotal?: number; - /** - * Lista de produtos da cotação - */ - produtos?: { - /** - * Id do produto variante - */ - identificador?: string; - /** - * Quantidade do produto - */ - quantidade?: number; - }[]; - }; - response: { - id?: string; - nome?: string; - prazo?: number; - tabelaFreteId?: string; - tipo?: string; - valor?: number; - produtos?: { - produtoVarianteId?: number; - valor?: number; - }[]; - }[]; - }; - /** @description Remove uma lista de range de cep de uma Loja Física */ - "DELETE /lojasFisicas/:lojaFisicaId/rangeCep": { - body: { - /** - * Lista de range de cep a serem excluídos da loja física - */ - RAW_BODY: { - /** - * Id da faixa de cep a ser deletado - */ - rangeCepId?: number; - }[]; - }; - }; - /** @description Insere um endereço para um usuário pelo id do usuário */ - "POST /usuarios/:usuarioId/enderecos": { - body: { - /** - * Nome de identificação do endereço a ser cadastrado (Max Length: 100) - */ - nomeEndereco?: string; - /** - * Nome da rua (Max Length: 500) - */ - rua?: string; - /** - * Número do local (Max Length: 50) - */ - numero?: string; - /** - * Complemento (Max Length: 250) (optional) - */ - complemento?: string; - /** - * Referência para a localização do endereço (Max Length: 500) (optional) - */ - referencia?: string; - /** - * Bairro do endereço (Max Length: 100) - */ - bairro?: string; - /** - * Cidade em que se localiza o endereço (Max Length: 100) - */ - cidade?: string; - /** - * O estado (Max Length: 100) - */ - estado?: string; - /** - * Código do cep (Max Length: 50) - */ - cep?: string; - }; - }; - /** @description Categoria excluída com sucesso */ - "DELETE /categorias/erp/:id": {}; - /** @description Retorna uma lista de vínculos entre usuário e parceiro */ - "GET /usuarios/:email/parceiros": {}; - /** @description Produtos de uma assinatura */ - "GET /assinaturas/:assinaturaId/produtos": { - response: { - assinaturaProdutoId?: number; - assinaturaId?: number; - produtoId?: number; - produtoVarianteId?: number; - quantidade?: number; - valor?: number; - removido?: boolean; - }[]; - }; - /** @description Insere um endereço para um usuário pelo e-mail */ - "POST /usuarios/:email/enderecos": { - body: { - /** - * Nome de identificação do endereço a ser cadastrado (Max Length: 100) - */ - nomeEndereco?: string; - /** - * Nome da rua (Max Length: 500) - */ - rua?: string; - /** - * Número do local (Max Length: 50) - */ - numero?: string; - /** - * Complemento (Max Length: 250) (optional) - */ - complemento?: string; - /** - * Referência para a localização do endereço (Max Length: 500) (optional) - */ - referencia?: string; - /** - * Bairro do endereço (Max Length: 100) - */ - bairro?: string; - /** - * Cidade em que se localiza o endereço (Max Length: 100) - */ - cidade?: string; - /** - * O estado (Max Length: 100) - */ - estado?: string; - /** - * Código do cep (Max Length: 50) - */ - cep?: string; - }; - }; - /** @description Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ - "PUT /produtos/precos": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { - /** - * Lista com os dados da atualização do preço (optional) - */ - RAW_BODY: { - /** - * Identificador do produto (ProdutoVarianteId ou SKU) - */ - identificador?: string; - /** - * Preço de custo do produto variante - */ - precoCusto?: number; - /** - * "PrecoDe" do produto variante - */ - precoDe?: number; - /** - * "PrecoPor" do produto variante - */ - precoPor?: number; - /** - * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) - */ - fatorMultiplicadorPreco?: number; - }[]; - }; - response: { - produtosNaoAtualizados?: { - produtoVarianteId?: number; - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - produtosAtualizados?: { - produtoVarianteId?: number; - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - }; - }; - /** @description Usuário encontrado */ - "GET /usuarios/email/:email": { - response: { - usuarioId?: number; - bloqueado?: boolean; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - avatar?: string; - ip?: string; - aprovado?: boolean; - }; - }; - /** @description Novo token gerado com sucesso */ - "POST /autenticacao/trocarLoja/:novaLoja": { - response: { - lojas?: string[]; - accessToken?: string; - dataExpiracaoAccessTokenUTC?: string; - }; - }; - /** @description Remove um campo de cadastro personalizado */ - "DELETE /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": - {}; - /** @description Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente */ - "POST /eventos/:eventoId/produtos": { - body: { - /** - * Identificadores dos produtos variantes a serem vinculados ao evento desejado - */ - produtosVariante?: { - /** - * Identificador do produto variante - */ - produtoVarianteId?: number; - }[]; - }; - }; - /** @description Campos de cadastro personalizado encontrados */ - "GET /usuarios/camposcadastropersonalizado": { - response: { - grupoInformacaoCadastralId?: number; - nome?: string; - tipo?: string; - obrigatorio?: boolean; - ordem?: number; - valorPreDefinido?: { - valoresDefinidosCampoGrupoInformacaoId?: number; - valor?: string; - ordem?: number; - }[]; - }[]; - }; - /** @description Atualiza os dados de um hotsite existente */ - "PUT /hotsites/:hotsiteId": { - body: { - /** - * Nome do hotsite - */ - nome?: string; - /** - * Data/hora em que o hotsite começará a ser exibido (optional) - */ - dataInicio?: string; - /** - * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) - */ - dataFinal?: string; - /** - * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início - */ - url?: string; - /** - * Informe o número de produtos que deve ser exibido por página - */ - tamanhoPagina?: number; - /** - * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates - */ - templateId?: number; - /** - * Informe qual será a ordenação dos Produtos no Hotsite (optional) - */ - ordenacao?: - | "Nenhuma" - | "NomeCrescente" - | "NomeDecrescente" - | "Lancamento" - | "MenorPreco" - | "MaiorPreco" - | "MaisVendidos" - | "MaioresDescontos" - | "Aleatorio" - | "MenorEstoque" - | "MaiorEstoque"; - /** - * Produtos que devem aparecer no hotsite - */ - listaProdutos?: { - /** - * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) - */ - expressao?: string; - /** - * Id dos produtos - */ - produtos?: { - /** - * Identificador do produto a ser mostrado no hotsite - */ - produtoId?: number; - /** - * Ordem para apresentação do produto (optional) - */ - ordem?: number; - }[]; - }; - /** - * Dados de seo - */ - seo?: { - /** - * Informe o Título que será exibido quando o Hotsite for acessado (optional) - */ - titulo?: string; - /** - * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) - */ - metas?: { - /** - * Informe os dados da Metatag - */ - conteudo?: string; - /** - * Informe os dados da Metatag - */ - nome?: string; - /** - * Informe os dados da Metatag - */ - httpEquiv?: string; - /** - * Informe os dados da Metatag - */ - scheme?: string; - }[]; - }; - /** - * Lista de identificadores de banners a serem vinculados ao hotsite - */ - banners?: { - /** - * Identificador do banner (optional) - */ - bannerId?: number; - }[]; - /** - * Lista de identificadores de conteúdos a serem vinculados ao hotsite - */ - conteudos?: { - /** - * Identificador do conteúdo - */ - conteudoId?: number; - }[]; - /** - * Status do hotsite (optional) - */ - ativo?: boolean; - }; - }; - /** @description Lista com assinaturas */ - "GET /assinaturas": { - searchParams: { - /** - * Situação da assinatura - */ - situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; - /** - * Período de recorrência - */ - periodoRecorrencia?: string; - /** - * Página da lista (padrão: 1) - */ - pagina?: number; - /** - * Quantidade de registros que deverão retornar (max: 50) - */ - quantidadeRegistros?: number; - /** - * Data inicial da próxima recorrência - */ - dataInicialProximaRecorrencia?: string; - /** - * Data final da próxima recorrencia - */ - dataFinalProximaRecorrencia?: string; - /** - * Data inicial de cancelamento - */ - dataInicialCancelamento?: string; - /** - * Data final de cancelamento - */ - dataFinalCancelamento?: string; - }; - response: { - assinaturaId?: number; - usuarioId?: number; - dataProximoPedido?: string; - periodoRecorrencia?: string; - situacaoAssinatura?: string; - dataAssinatura?: string; - grupoAssinatura?: string; - enderecoId?: number; - usuarioCartaoCreditoId?: number; - cupom?: string; - }[]; - }; - /** @description Lista de categorias */ - "GET /categorias": { - searchParams: { - /** - * Hierarquia da categoria - */ - hierarquia?: boolean; - /** - * Se será apresentado apenas Reseller - */ - apenasReseller?: boolean; - /** - * Se será apresentado apenas o último nível das categorias - */ - apenasUltimoNivel?: boolean; - /** - * Se será apresentado somente categorias filhas - */ - somenteFilhos?: boolean; - }; - response: { - id?: number; - nome?: string; - categoriaPaiId?: number; - categoriaERPId?: string; - ativo?: boolean; - isReseller?: boolean; - exibirMatrizAtributos?: string; - quantidadeMaximaCompraUnidade?: number; - valorMinimoCompra?: number; - exibeMenu?: boolean; - urlHotSite?: string; - }[]; - }; - /** @description Insere um novo fabricante */ - "POST /fabricantes": { - body: { - /** - * Nome do fabricante (optional) - */ - nome?: string; - /** - * URL tipo logo (optional) - */ - urlLogoTipo?: string; - /** - * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) - */ - urlLink?: string; - /** - * Insira nesse campo a URL do Carrossel da Marca (optional) - */ - urlCarrossel?: string; - }; - }; - /** @description Atualiza o campo Recebido de um produto vinculado a um evento */ - "PUT /eventos/:eventoId/produtos/recebido": { - body: { - /** - * Id do produto variante (optional) - */ - produtoVarianteId?: number; - /** - * Se o produto foi recebido fora da lista (optional) - */ - recebidoForaLista?: boolean; - }; - }; - /** @description Atualiza o tipo evento */ - "PUT /tiposEvento/:tipoEventoId": { - body: { - /** - * Nome do Tipo de Evento - */ - nome?: string; - /** - * Tipo de entrega - */ - tipoEntrega?: - | "EntregaAgendada" - | "EntregaConformeCompraRealizada" - | "Todos" - | "Nenhum"; - /** - * Disponibilização do Tipo de Evento - */ - tipoDisponibilizacao?: - | "DisponibilizacaoDeCreditos" - | "DisponibilizacaoDeProdutos" - | "Todos"; - /** - * Permissão para remoção automática de produtos - */ - permitirRemocaoAutomaticaProdutos?: boolean; - /** - * Cor em hexadecimal para o titulo de informações - */ - corHexTituloInformacoes?: string; - /** - * Cor em hexadecimal para o corpo de informações - */ - corHexCorpoInformacoes?: string; - /** - * Número de abas de informações, podendo ser de 1 a 2 - */ - numeroAbasInformacoes?: number; - /** - * Quantidade de dias para que o evento expire - */ - quantidadeDiasParaEventoExpirar?: number; - /** - * Quantidade de locais do evento - */ - numeroLocaisEvento?: number; - /** - * Informa se o evento está ativo ou inativo - */ - ativo?: boolean; - /** - * Informa a disponibilidade do evento - */ - disponivel?: boolean; - /** - * O beneficiário do frete - */ - tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; - /** - * Imagem da logo do evento em base64 - */ - imagemLogoEvento?: string; - /** - * Produtos Sugeridos para este evento (optional) - */ - sugestaoProdutos?: { - /** - * Id do tipo de evento - */ - tipoEventoId?: number; - /** - * Identificador do produto variante - */ - produtoVarianteId?: number; - }[]; - }; - }; - /** @description Produtos de uma assinatura */ - "GET /assinaturas/:email": { - response: { - assinaturaId?: number; - usuarioId?: number; - dataProximoPedido?: string; - periodoRecorrencia?: string; - situacaoAssinatura?: string; - dataAssinatura?: string; - grupoAssinatura?: string; - enderecoId?: number; - usuarioCartaoCreditoId?: number; - cupom?: string; - produtos?: { - assinaturaProdutoId?: number; - assinaturaId?: number; - produtoId?: number; - produtoVarianteId?: number; - quantidade?: number; - valor?: number; - removido?: boolean; - }[]; - }[]; - }; - /** @description Atualiza uma Loja Física */ - "PUT /lojasFisicas/:lojaFisicaId": { - body: { - /** - * Id da loja (optional) - */ - lojaId?: number; - /** - * Nome da loja (optional) - */ - nome?: string; - /** - * DDD da localidade de destino da loja (optional) - */ - ddd?: number; - /** - * Telefone da loja (optional) - */ - telefone?: string; - /** - * E-mail de contato da loja (optional) - */ - email?: string; - /** - * CEP do endereço da loja (optional) - */ - cep?: string; - /** - * Logradouro do endereço da loja (optional) - */ - logradouro?: string; - /** - * Número de localização do endereço da loja (optional) - */ - numero?: string; - /** - * Complemento para localização da loja (optional) - */ - complemento?: string; - /** - * Bairro do endereço do loja (optional) - */ - bairro?: string; - /** - * Cidade em que a loja se encontra (optional) - */ - cidade?: string; - /** - * Id do estado em que a loja se encontra (optional) - */ - estadoId?: number; - /** - * Prazo de entrega (optional) - */ - prazoEntrega?: number; - /** - * Prazo máximo para retirada (optional) - */ - prazoMaximoRetirada?: number; - /** - * Status da loja (optional) - */ - ativo?: boolean; - /** - * Valido (optional) - */ - valido?: boolean; - /** - * Informações complementares da loja (optional) - */ - textoComplementar?: string; - /** - * Se a retirada na loja será ativada (optional) - */ - retirarNaLoja?: boolean; - /** - * Latitude (optional) - */ - latitude?: number; - /** - * Longitude (optional) - */ - longitude?: number; - /** - * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) - */ - centroDistribuicao?: { - /** - * Id do centro de distribuição - */ - centroDistribuicaoId?: number; - /** - * Prazo de entrega - */ - prazoEntrega?: number; - }[]; - }; - }; - /** @description Atualiza um evento */ - "PUT /eventos/:eventoId": { - body: { - /** - * Identificador do tipo de evento - */ - tipoEventoId?: number; - /** - * Identificador do endereço de entrega - */ - enderecoEntregaId?: number; - /** - * Titulo do evento - */ - titulo?: string; - /** - * Atributo obsoleto - (optional) - */ - url?: string; - /** - * Data do Evento - */ - data?: string; - /** - * Email do usuário - */ - usuarioEmail?: string; - /** - * Disponibilidade do evento (optional) - */ - disponivel?: boolean; - /** - * Quantos dias antes do evento ele será exibido (optional) - */ - diasAntesEvento?: number; - /** - * Até quantos dias depois do evento ele será exibido (optional) - */ - diasDepoisEvento?: number; - /** - * Url do Logo. (Base64) - */ - urlLogo?: string; - /** - * Url da Capa. (Base64) - */ - urlCapa?: string; - /** - * Quem é o proprietário - */ - proprietario?: string; - /** - * Se a aba de informação 01 será habilitada - */ - abaInfo01Habilitado?: boolean; - /** - * Texto para o campo informação 01 (optional) - */ - textoInfo01?: string; - /** - * Conteúdo para o campo informação 01 (optional) - */ - conteudoInfo01?: string; - /** - * Se a aba de informação 02 será habilitada - */ - abaInfo02Habilitado?: boolean; - /** - * Texto para o campo informação 02 (optional) - */ - textoInfo02?: string; - /** - * Conteúdo para o campo informação 02 (optional) - */ - conteudoInfo02?: string; - /** - * Se a aba de mensagem será habilitada (optional) - */ - abaMensagemHabilitado?: boolean; - /** - * Tipo de lista de presente - */ - enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; - /** - * Tipo de entrega - */ - enumTipoEntregaId?: - | "EntregaAgendada" - | "EntregaConformeCompraRealizada" - | "Todos" - | "Nenhum"; - /** - * Seleção de produto no evento - */ - eventoProdutoSelecionado?: { - /** - * Id do produto variante - */ - produtoVarianteId?: number; - /** - * Se produto recebido fora da lista (optional) - */ - recebidoForaLista?: boolean; - /** - * Se produto removido (optional) - */ - removido?: boolean; - }[]; - /** - * Endereço do Evento - */ - enderecoEvento?: { - /** - * Nome para identificação do endereço - */ - nome?: string; - /** - * Endereço - */ - endereco?: string; - /** - * Cep do endereço - */ - cep?: string; - /** - * Numero do endereço - */ - numero?: string; - /** - * Bairro do endereço - */ - bairro?: string; - /** - * Cidade do endereço - */ - cidade?: string; - /** - * Estado do endereço - */ - estado?: string; - }[]; - }; - }; - /** @description Lista de identificadores de banners vinculados ao hotsite */ - "GET /hotsites/:hotsiteId/banners": { - response: { - bannerId?: number; - }[]; - }; - /** @description Atualiza a comunicação de um usuário via newsletter */ - "PUT /usuarios/:email/comunicacao": { - body: { - /** - * Novo status da comunicação via new ajuste realisletter - */ - recebimentoNewsletter?: boolean; - }; - }; - /** @description Insere uma nova categoria */ - "POST /categorias": { - body: { - /** - * Nome da categoria (optional) - */ - nome?: string; - /** - * Id da categoria pai (optional) - */ - categoriaPaiId?: number; - /** - * Id da categoria ERP (optional) - */ - categoriaERPId?: string; - /** - * Categoria ativo/inativo (optional) - */ - ativo?: boolean; - /** - * Categoria de reseller (optional) - */ - isReseller?: boolean; - /** - * Exibir Matriz de Atributos (optional) - */ - exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; - /** - * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) - */ - quantidadeMaximaCompraUnidade?: number; - /** - * Informe o valor mínimo para compra em produtos desta categoria (optional) - */ - valorMinimoCompra?: number; - /** - * Informe se será exibida no menu (optional) - */ - exibeMenu?: boolean; - }; - }; - /** @description Estorna um valor menor ou igual ao total do pedido "Pago" */ - "POST /pedidos/estorno/:pedidoId": { - body: { - /** - * Valor a ser estornado do pedido. Total ou parcial. - */ - Valor?: number; - }; - }; - /** @description Pedidos que terão vínculo com o grupo de assinatura informado. */ - "POST /assinaturas/grupoassinatura/assinatura": { - body: { - /** - * Lista de pedidos a serem vinculados a assinatura - */ - pedidos?: { - /** - * Id do pedido - */ - pedidoId?: number; - }[]; - /** - * ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura - */ - recorrenciaId?: number; - /** - * ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura - */ - grupoAssinaturaId?: number; - }; - }; - /** @description Lista de hotsites vinculados ao banner */ - "GET /banners/:bannerId/hotsites": { - response: { - exibirEmTodosHotSites?: boolean; - hotSites?: { - hotSiteId?: number; - }[]; - }; - }; - /** @description Lista de situações de pedido */ - "GET /situacoesPedido": { - response: { - situacaoPedidoId?: number; - nome?: string; - descricao?: string; - observacao?: string; - }[]; - }; - /** @description Insere uma Loja Física */ - "POST /lojasFisicas": { - body: { - /** - * Id da loja (optional) - */ - lojaId?: number; - /** - * Nome da loja (optional) - */ - nome?: string; - /** - * DDD da localidade de destino da loja (optional) - */ - ddd?: number; - /** - * Telefone da loja (optional) - */ - telefone?: string; - /** - * E-mail de contato da loja (optional) - */ - email?: string; - /** - * CEP do endereço da loja (optional) - */ - cep?: string; - /** - * Logradouro do endereço da loja (optional) - */ - logradouro?: string; - /** - * Número de localização do endereço da loja (optional) - */ - numero?: string; - /** - * Complemento para localização da loja (optional) - */ - complemento?: string; - /** - * Bairro do endereço do loja (optional) - */ - bairro?: string; - /** - * Cidade em que a loja se encontra (optional) - */ - cidade?: string; - /** - * Id do estado em que a loja se encontra (optional) - */ - estadoId?: number; - /** - * Prazo de entrega (optional) - */ - prazoEntrega?: number; - /** - * Prazo máximo para retirada (optional) - */ - prazoMaximoRetirada?: number; - /** - * Status da loja (optional) - */ - ativo?: boolean; - /** - * Valido (optional) - */ - valido?: boolean; - /** - * Informações complementares da loja (optional) - */ - textoComplementar?: string; - /** - * Se a retirada na loja será ativada (optional) - */ - retirarNaLoja?: boolean; - /** - * Latitude (optional) - */ - latitude?: number; - /** - * Longitude (optional) - */ - longitude?: number; - /** - * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) - */ - centroDistribuicao?: { - /** - * Id do centro de distribuição - */ - centroDistribuicaoId?: number; - /** - * Prazo de entrega - */ - prazoEntrega?: number; - }[]; - }; - }; - /** @description Atualiza um usuário pelo email */ - "PUT /usuarios/:email": { - body: { - /** - * Tipo de pessoa - */ - tipoPessoa?: "Fisica" | "Juridica"; - /** - * Origem do contato - */ - origemContato?: - | "Google" - | "Bing" - | "Jornal" - | "PatrocinioEsportivo" - | "RecomendacaoAlguem" - | "Revista" - | "SiteInternet" - | "Televisao" - | "Outro" - | "UsuarioImportadoViaAdmin" - | "PayPalExpress"; - /** - * Tipo Sexo (optional) - */ - tipoSexo?: "Undefined" | "Masculino" | "Feminino"; - /** - * Nome do usuário (Max Length: 100) - */ - nome?: string; - /** - * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) - */ - cpf?: string; - /** - * E-mail do usuário (Max Length: 100) - */ - email?: string; - /** - * RG do usuário caso seja pessoa física (Max Length: 50) (optional) - */ - rg?: string; - /** - * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) - */ - telefoneResidencial?: string; - /** - * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) - */ - telefoneCelular?: string; - /** - * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) - */ - telefoneComercial?: string; - /** - * Data de nascimento (optional) - */ - dataNascimento?: string; - /** - * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) - */ - razaoSocial?: string; - /** - * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) - */ - cnpj?: string; - /** - * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) - */ - inscricaoEstadual?: string; - /** - * Responsável(Max Length: 100) (optional) - */ - responsavel?: string; - /** - * Data de criação do cadastro (optional) - */ - dataCriacao?: string; - /** - * Data de atualização do cadastro (optional) - */ - dataAtualizacao?: string; - /** - * Se o usuário é revendedor (optional) - */ - revendedor?: boolean; - /** - * Informação cadastral (optional) - */ - listaInformacaoCadastral?: { + }; + }; + /** @description Rastreamento de produto encontrado */ + "GET /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": + {}; + /** @description Atualiza rastreamento de produto completo (com os dados da N.F.) */ + "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": + { + searchParams: { /** - * Chave + * Nota Fiscal */ - chave?: string; + notaFiscal?: string; /** - * Valor + * CFOP */ - valor?: string; - }[]; - /** - * Avatar (Max Length: 50) (optional) - */ - avatar?: string; - /** - * IP do usuário (Max Length: 20) (optional) - */ - ip?: string; - /** - * Seta ou retorna o valor de Aprovado (optional) - */ - aprovado?: boolean; - }; - }; - /** @description Insere um novo campo de cadastro personalizado */ - "POST /usuarios/CadastroPersonalizado": { - body: { - /** - * Nome do campo - */ - nome?: string; - /** - * Tipo do campo - */ - tipo?: "TextoLivre" | "ValoresPredefinidos" | "RadioButton"; - /** - * Se o campo será obrigatório - */ - obrigatorio?: boolean; - /** - * Ordem - */ - ordem?: number; - /** - * Informação para os campos (optional) - */ - valorPreDefinido?: { + cfop?: number; /** - * Valor + * Data Enviado */ - valor?: string; + dataEnviado?: string; /** - * Ordem + * Chave de acesso NFE */ - ordem?: number; - }[]; - }; - }; - /** @description Seta identificador como variante principal */ - "PUT /produtos/:identificador/principal": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - }; - /** @description Insere uma inscrição */ - "POST /webhook/inscricao": { - body: { - /** - * Nome da inscrição - */ - nome?: string; - /** - * Url para qual deve ser enviada as notificações - */ - appUrl?: string; - /** - * Tópicos em que deseja se inscrever - */ - topicos: string[]; - /** - * Usuário que está realizando a inscrição - */ - usuario?: string; - /** - * Status da inscrição, se ativada ou desativada - */ - ativo?: boolean; - /** - * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado - */ - emailResponsavel?: string; - /** - * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) - */ - headers?: { + chaveAcessoNFE?: string; /** - * Chave do header, por exemplo: 'Authorization' + * Rastreamento (optional) */ - chave?: string; + rastreamento?: string; /** - * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' + * URL de rastreamento (optional) */ - valor?: string; - }[]; + urlRastreamento?: string; + /** + * Transportadora (optional) + */ + transportadora?: string; + /** + * Data da entrega (optional) + */ + dataEntrega?: string; + }; }; - }; - /** @description Lista de produtos de um Grupo de Personalização */ - "GET /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { - response: { - produtoId?: number; - nome?: string; - alias?: string; - }[]; - }; - /** @description Lista de inscrições */ - "GET /webhook/inscricao": { - response: { - inscricaoId?: number; - nome?: string; - appUrl?: string; - ativo?: boolean; - emailResponsavel?: string; - topico?: string[]; - usuario?: string; - header?: { - headerId?: number; - chave?: string; - valor?: string; - }[]; - }[]; - }; - /** @description Gráfico do Faturamento */ - "GET /dashboard/graficofaturamento": { + /** @description Lista de detalhes de frete */ + "GET /fretes/:freteId/detalhes": {}; + /** @description Insere um novo detalhe de frete vinculado a um contrato de frete */ + "POST /fretes/:freteId/detalhes": { searchParams: { /** - * Data inicial do faturamento que deverão retonar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final do faturamento que deverão retonar (aaaa-mm-dd) - */ - dataFinal?: string; - /** - * Se o faturamento é somente da loja - */ - isLoja?: number; - /** - * Id do parceiro + * Informe o cep inicial (optional) */ - parceiroId?: number; - }; - response: { - parceiroId?: number; - parceiro?: string; - receitaPagos?: number; - transacoesPagos?: number; - valorMedioPagos?: number; - usuarioEnderecoEstado?: string; - }[]; - }; - /** @description Exclui uma informação de um produto */ - "DELETE /produtos/:identificador/informacoes/:informacaoId": { - searchParams: { + cepInicial?: number; /** - * Define se o identificador informado é um sku ou um id interno. + * Informe o cep final (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - response: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; - }[]; - }; - /** @description Assinatura de um determinado pedido */ - "GET /assinaturas/pedido/:pedidoId": { - response: { - assinaturaPedidoId?: number; - assinaturaId?: number; - grupoAssinaturaId?: number; - tipoPeriodo?: string; - tempoPeriodo?: number; - pedidoId?: number; - valor?: number; - data?: string; - origemPedidoEnumId?: number; - produtoVarianteId?: number; - }[]; - }; - /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ - "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId/parcial": { - body: { + cepFinal?: number; /** - * Objeto Pedido Rastreamento + * Variações de detalhe do frete (optional) */ - RAW_BODY: { + variacoesFreteDetalhe?: { /** - * Rastreamento (optional) + * Informe o peso inicial */ - rastreamento?: string; + pesoInicial?: number; /** - * URL de Rastreamento (optional) + * Informe o peso final */ - urlRastreamento?: string; - }; - }; - }; - /** @description Inseri uma lista de produto variantes em uma tabela de preços */ - "POST /tabelaPrecos/:tabelaPrecoId/produtos": { - body: { - /** - * Lista de produtos variantes - */ - RAW_BODY: { + pesoFinal?: number; /** - * SKU do produto + * Informe o valor do frete */ - sku?: string; + valorFrete?: number; /** - * Preço De do produto + * Informe o prazo de entrega */ - precoDe?: number; + prazoEntrega?: number; /** - * Preço Por do produto + * Informe o valor preço */ - precoPor?: number; - }[]; - }; - response: { - sucesso?: { - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - erro?: { - sku?: string; - resultado?: boolean; - detalhes?: string; + valorPreco?: number; + /** + * Informe o valor peso + */ + valorPeso?: number; }[]; }; }; - /** @description Access token atualizado com sucesso */ - "POST /autenticacao/refresh": { - response: { - lojas?: string[]; - accessToken?: string; - dataExpiracaoAccessTokenUTC?: string; - }; - }; - /** @description Ativa ou inativa uma inscrição */ - "PUT /webhook/inscricao/:inscricaoId/Ativar": { - body: { - /** - * Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada) - */ - ativo?: boolean; - /** - * Usuário que está realizando a atualização - */ - usuario?: string; + /** @description Exclui os detalhes de um contrato de frete */ + "DELETE /fretes/:freteId/detalhes": {}; + /** @description Pedido encontrado */ + "GET /pedidos/:pedidoId": {}; + /** @description Lista de identificadores de conteúdos vinculados ao hotsite */ + "GET /hotsites/:hotsiteId/conteudos": {}; + /** @description Vincula um ou mais conteúdos a um hotsite específico */ + "POST /hotsites/:hotsiteId/conteudos": { + searchParams: { /** - * Observação que deseje fazer com relação a ativação/desativação da inscrição (optional) + * Lista de identificadores de conteúdos a serem vinculados */ - observacao?: string; - }; - }; - /** @description Assinatura com erro na loja */ - "GET /assinaturas/erros/:assinaturaId": { - response: { - assinaturaErroId?: number; - assinaturaId?: number; - usuarioId?: string; - visualizado?: boolean; - dataErro?: string; - resolvido?: boolean; - codigoAssinaturaErro?: number; - assinaturaErroNome?: string; - assinaturaErroDescricao?: string; - }[]; - }; - /** @description Limite de crédito de um usuário específico */ - "GET /usuarios/limiteCreditoPorEmail/:email": { - response: { - usuarioId?: number; - valor?: number; - saldo?: number; - }; - }; - /** @description Retorna o histórico de situações de um pedido */ - "GET /pedidos/:pedidoId/historicoSituacao": { - response: { - situacoes?: { - situacaoPedidoId?: number; - nome?: string; - dataAtualizacao?: string; + RAW_BODY?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; }[]; }; }; - /** @description SEO do produto informado */ - "GET /produtos/:identificador/seo": { + /** @description Desvincula um ou mais conteúdos de um hotsite específico */ + "DELETE /hotsites/:hotsiteId/conteudos": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Lista de identificadores de conteúdos a serem desvinculados */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - response: { - tagCanonical?: string; - title?: string; - metatags?: { - metatagId?: number; - content?: string; - httpEquiv?: string; - name?: string; - scheme?: string; + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; }[]; }; }; - /** @description Atualiza o limite de crédito para um usuário */ - "PUT /usuarios/limiteCredito/:usuarioId": { + /** @description Atualiza um campo de cadastro personalizado pelo id */ + "PUT /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": { searchParams: { /** - * CPF ou CNPJ do usuário - */ - cpf_cnpj?: string; - /** - * Valor do limite de crédito - */ - valor?: number; - }; - }; - /** @description Exclui uma categoria */ - "DELETE /categorias/:id": {}; - /** @description Retorna a lista de produtos de um portfolio */ - "GET /portfolios/:portfolioId/produtos": { - response: { - produtoId?: number; - }[]; - }; - /** @description Insere um rastreamento e status a um produto variante */ - "POST /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento": { - body: { - /** - * Id da situação do pedido - */ - situacaoPedidoId?: number; - /** - * Quantidade (optional) - */ - quantidade?: number; - /** - * Id do centro de distribuição - */ - centroDistribuicaoId?: number; - /** - * Rastreamento (optional) + * Nome do campo (optional) */ - rastreamento?: string; + nome?: string; /** - * Data (optional) + * Se o campo será obrigatório (optional) */ - dataEvento?: string; + obrigatorio?: boolean; /** - * Número da nota fiscal (optional) + * Ordem (optional) */ - numeroNotaFiscal?: string; + ordem?: number; + }; + }; + /** @description Remove um campo de cadastro personalizado */ + "DELETE /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": + {}; + /** @description Dados do serviço de frete do pedido */ + "GET /pedidos/:pedidoId/frete": {}; + /** @description Tabela de preços específica */ + "GET /tabelaPrecos/:tabelaPrecoId": {}; + /** @description Atualiza uma tabela de preços */ + "PUT /tabelaPrecos/:tabelaPrecoId": { + searchParams: { /** - * Chave de acesso NFE (optional) + * Nome da tabela de preço */ - chaveAcessoNFE?: string; + nome?: string; /** - * URL NFE (optional) + * Data que inicia a tabela de preço */ - urlNFE?: string; + dataInicial?: string; /** - * Serie NFE (optional) + * Data de término da tabela de preço */ - serieNFE?: string; + dataFinal?: string; /** - * CFOP (optional) + * Status da tabela de preço */ - cfop?: number; + ativo?: boolean; + }; + }; + /** @description Exclui uma tabela de preços */ + "DELETE /tabelaPrecos/:tabelaPrecoId": {}; + /** @description Último status do pedido */ + "GET /pedidos/:pedidoId/status": {}; + /** @description Atualiza a situação do status do pedido */ + "PUT /pedidos/:pedidoId/status": { + searchParams: { /** - * URL de rastreamento (optional) + * Id da situação do pedido */ - urlRastreamento?: string; + RAW_BODY?: { + /** + * Id da situação do pedido + */ + id?: number; + }; }; }; - /** @description Lista de resposta para cada produto vinculado */ - "POST /tiposEvento/:tipoEventoId/produtos": { - body: { + /** @description Lista de Tópicos */ + "GET /webhook/Topicos": {}; + /** @description Seta o pedido como integrado */ + "POST /pedidos/complete": { + searchParams: { /** - * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado + * Pedido que se deseja inserir o "complete" */ - produtos?: { + RAW_BODY?: { /** - * Identificador do produto variante + * Id do pedido */ - produtoVarianteId?: number; - }[]; + pedidoId?: number; + }; }; - response: { - sugestaoProdutosInseridos?: { - tipoEventoId?: number; - produtoVarianteId?: number; - detalhes?: string; - }[]; - produtosNaoInseridos?: { - tipoEventoId?: number; - produtoVarianteId?: number; - detalhes?: string; - }[]; + }; + /** @description Portfolio encontrado */ + "GET /portfolios/:portfolioId": {}; + /** @description Atualiza um portfolio */ + "PUT /portfolios/:portfolioId": { + searchParams: { + /** + * Nome do portfolio + */ + nome?: string; }; }; - /** @description Desvincula um ou mais banners de um hotsite específico */ - "DELETE /hotsites/:hotsiteId/banners": { - body: { + /** @description Deleta um portfolio */ + "DELETE /portfolios/:portfolioId": {}; + /** @description Retorna se o produto variante está disponível ou não */ + "GET /produtos/:identificador/disponibilidade": {}; + /** @description Lista de formas de pagamento */ + "GET /formasPagamento": {}; + /** @description Lista de pedidos */ + "GET /pedidos/:pedidoId/rastreamento/produtos": {}; + /** @description Altera o status de um portfolio */ + "PUT /portfolios/:portfolioId/status": { + searchParams: { /** - * Lista de identificadores de banners a serem desvinculados + * Status do portfolio: true ou false */ - banners?: { + RAW_BODY?: { /** - * Identificador do banner (optional) + * Novo status do portfolio */ - bannerId?: number; - }[]; + ativo?: boolean; + }; }; }; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos/:eventoId": { - response: { - eventoId?: number; - tipoEventoId?: number; - userId?: number; - enderecoEntregaId?: number; - data?: string; - dataCriacao?: string; - titulo?: string; - url?: string; - disponivel?: boolean; - diasDepoisEvento?: number; - diasAntesEvento?: number; - urlLogoEvento?: string; - urlCapaEvento?: string; - proprietarioEvento?: string; - abaInfo01Habilitado?: boolean; - textoInfo01?: string; - conteudoInfo01?: string; - abaInfo02Habilitado?: boolean; - textoInfo02?: string; - conteudoInfo02?: string; - abaMensagemHabilitado?: boolean; - fotos?: string; - enumTipoListaPresenteId?: string; - enumTipoEntregaId?: string; - eventoProdutoSelecionado?: { - eventoId?: number; - produtoVarianteId?: number; - recebidoForaLista?: boolean; - removido?: boolean; - }[]; - enderecoEvento?: { - enderecoEventoId?: number; - eventoId?: number; - nome?: string; - cep?: string; - endereco?: string; - numero?: string; - bairro?: string; - cidade?: string; - estado?: string; - }[]; - }[]; - }; - /** @description Usuários encontrados */ - "GET /parceiros/:parceiroId/usuarios": { - response: { - usuarioId?: number; - email?: string; - ativo?: boolean; - dataInicial?: string; - dataFinal?: string; - vinculoVitalicio?: boolean; - }[]; - }; - /** @description Atualiza a data de entrega do pedido */ - "PUT /pedidos/:pedidoId/rastreamento": { - body: { + /** @description Limite de crédito que estão vinculados aos usuários */ + "GET /usuarios/limiteCredito": {}; + /** @description Exclui uma imagem de um produto */ + "DELETE /produtos/:identificador/imagens/:id": {}; + /** @description Extrato retornado com sucesso */ + "GET /contascorrentes/:email/extrato": {}; + /** @description Lista de observações de um pedido */ + "GET /pedidos/:pedidoId/observacao": {}; + /** @description Insere uma observação a um pedido */ + "POST /pedidos/:pedidoId/observacao": { + searchParams: { /** - * Objeto com os dados do rastreamento + * Objeto com os dados da observação (optional) */ - RAW_BODY: { + RAW_BODY?: { /** - * Código de verificação do transporte do produto + * Texto da observação */ - rastreamento?: string; + observacao?: string; + /** + * Nome do usuário que está inserindo a observação + */ + usuario?: string; /** - * Data que a entrega foi realizada + * Se a observação é publica ou privada */ - dataEntrega?: string; + publica?: boolean; }; }; }; - /** @description Atualiza um fabricante */ - "PUT /fabricantes/:fabricanteId": { - body: { + /** @description Lista de centros de distribuição */ + "GET /centrosdistribuicao": {}; + /** @description Lista de avaliações de produtos */ + "GET /produtoavaliacao": {}; + /** @description Conteúdo encontrado */ + "GET /conteudos/:conteudoId": {}; + /** @description Atualiza um conteúdo */ + "PUT /conteudos/:conteudoId": { + searchParams: { /** - * Nome do fabricante (optional) + * Titulo do conteúdo */ - nome?: string; + titulo?: string; /** - * URL tipo logo (optional) + * Conteúdo ativo/inativo */ - urlLogoTipo?: string; + ativo?: boolean; /** - * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) + * Data de inicio de exibição do conteúdo (optional) */ - urlLink?: string; + dataInicio?: string; /** - * Insira nesse campo a URL do Carrossel da Marca (optional) + * Data de final de exibição do conteúdo (optional) */ - urlCarrossel?: string; + dataFim?: string; + /** + * Posicionamento do conteúdo + */ + posicionamento?: + | { "0": "T"; "1": "o"; "2": "p"; "3": "o" } + | { "0": "C"; "1": "e"; "2": "n"; "3": "t"; "4": "r"; "5": "o" } + | { "0": "R"; "1": "o"; "2": "d"; "3": "a"; "4": "p"; "5": "e" } + | { + "0": "L"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "r"; + "5": "a"; + "6": "l"; + "7": "D"; + "8": "i"; + "9": "r"; + "10": "e"; + "11": "i"; + "12": "t"; + "13": "a"; + } + | { + "0": "L"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "r"; + "5": "a"; + "6": "l"; + "7": "E"; + "8": "s"; + "9": "q"; + "10": "u"; + "11": "e"; + "12": "r"; + "13": "d"; + "14": "a"; + } + | { + "0": "M"; + "1": "o"; + "2": "b"; + "3": "i"; + "4": "l"; + "5": "e"; + "6": "T"; + "7": "o"; + "8": "p"; + "9": "o"; + } + | { + "0": "M"; + "1": "o"; + "2": "b"; + "3": "i"; + "4": "l"; + "5": "e"; + "6": "R"; + "7": "o"; + "8": "d"; + "9": "a"; + "10": "p"; + "11": "e"; + }; + /** + * Informações do conteúdo + */ + conteudo?: string; + /** + * Insira em qual Termo de Busca o Conteúdo será exibido (optional) + */ + termoBusca?: string; + /** + * Exibição do conteúdo nas buscas + */ + exibeTodasBuscas?: boolean; + /** + * Não exibição do conteúdo nas buscas + */ + naoExibeBuscas?: boolean; + /** + * Exibição do conteúdo nos hotsites + */ + exibeTodosHotsites?: boolean; + /** + * Insira quais Hotsites que o Conteúdo será exibido (optional) + */ + hotsiteId?: number[]; }; }; - /** @description Dados de transação do pedido */ - "GET /pedidos/transacoes/:transacaoId": {}; - /** @description Operação realizada com ou sem sucesso para os usuários */ - "PUT /usuarios/autorizar": { + /** @description Atualiza o status do tipo de evento, ativando-o ou inativando-o */ + "PUT /tiposEvento/:tipoEventoId/AlterarStatus": {}; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /tiposEvento/:tipoEventoId/produtos": {}; + /** @description Lista de resposta para cada produto vinculado */ + "POST /tiposEvento/:tipoEventoId/produtos": { searchParams: { /** - * Tipo de Identificador + * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado */ - tipoIdentificador?: "UsuarioId" | "Email"; + produtos?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; }; - body: { + }; + /** @description Atualiza os produtos sugeridos de um tipo de evento */ + "PUT /tiposEvento/:tipoEventoId/produtos": { + searchParams: { /** - * Usuários + * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado */ - RAW_BODY?: { - /** - * Identificador - */ - identificador?: string; + produtos?: { /** - * Status de aprovação + * Identificador do produto variante */ - aprovado?: boolean; + produtoVarianteId?: number; }[]; }; - response: { - usuariosAtualizados?: string[]; - usuariosNaoAtualizados?: string[]; + }; + /** @description Atualiza a ativação automática de produtos de um Seller */ + "PUT /resellers/:resellerId/ativacaoAutomaticaProdutos": { + searchParams: { + /** + * Status da ativação automática de produtos + */ + ativo?: boolean; }; }; + /** @description Gráfico Forma de Pagamento */ + "GET /dashboard/graficoformapagamento": {}; + /** @description Lista de números de pedidos ainda não integrados */ + "GET /pedidos/naoIntegrados": {}; + /** @description Dados da lista de desejos de um usuário */ + "GET /usuarios/:usuarioId/listaDesejos": {}; + /** @description Usuários encontrados */ + "GET /parceiros/:nome/usuarios": {}; + /** @description Indicador dos Novos Compradores */ + "GET /dashboard/novoscompradores": {}; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos": {}; /** @description Cria um Novo Evento */ "POST /eventos": { - body: { + searchParams: { /** * Identificador do tipo de evento */ @@ -6248,15 +3864,88 @@ export interface API { /** * Tipo de lista de presente */ - enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; + enumTipoListaPresenteId?: + | { + "0": "L"; + "1": "i"; + "2": "s"; + "3": "t"; + "4": "a"; + "5": "P"; + "6": "r"; + "7": "o"; + "8": "n"; + "9": "t"; + "10": "a"; + } + | { + "0": "L"; + "1": "i"; + "2": "s"; + "3": "t"; + "4": "a"; + "5": "M"; + "6": "a"; + "7": "n"; + "8": "u"; + "9": "a"; + "10": "l"; + }; /** * Tipo de entrega */ enumTipoEntregaId?: - | "EntregaAgendada" - | "EntregaConformeCompraRealizada" - | "Todos" - | "Nenhum"; + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "A"; + "8": "g"; + "9": "e"; + "10": "n"; + "11": "d"; + "12": "a"; + "13": "d"; + "14": "a"; + } + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "C"; + "8": "o"; + "9": "n"; + "10": "f"; + "11": "o"; + "12": "r"; + "13": "m"; + "14": "e"; + "15": "C"; + "16": "o"; + "17": "m"; + "18": "p"; + "19": "r"; + "20": "a"; + "21": "R"; + "22": "e"; + "23": "a"; + "24": "l"; + "25": "i"; + "26": "z"; + "27": "a"; + "28": "d"; + "29": "a"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } + | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; /** * Seleção de produto no evento */ @@ -6309,254 +3998,668 @@ export interface API { }[]; }; }; - /** @description Atualiza a data de cadastro um produto com base nos dados enviados */ - "PUT /produtos/:identificador/DataCadastro": { + /** @description Retorna todas as informações de um produto específico */ + "GET /produtos/:identificador/informacoes": {}; + /** @description Adiciona uma nova informação */ + "POST /produtos/:identificador/informacoes": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno + * Titulo da informação (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + titulo?: string; /** - * Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss + * Texto da informação (optional) + */ + texto?: string; + /** + * Informação se o produto variante está visível no site. */ - dataCadastro?: string; - }; - response: { - produtoVarianteId?: number; - produtoId?: number; - idPaiExterno?: string; - idVinculoExterno?: string; - sku?: string; - nome?: string; - nomeProdutoPai?: string; - urlProduto?: string; - exibirMatrizAtributos?: string; - contraProposta?: boolean; - fabricante?: string; - autor?: string; - editora?: string; - colecao?: string; - genero?: string; - precoCusto?: number; - precoDe?: number; - precoPor?: number; - fatorMultiplicadorPreco?: number; - prazoEntrega?: number; - valido?: boolean; exibirSite?: boolean; - freteGratis?: string; - trocaGratis?: boolean; - peso?: number; - altura?: number; - comprimento?: number; - largura?: number; - garantia?: number; - isTelevendas?: boolean; - ean?: string; - localizacaoEstoque?: string; - listaAtacado?: { - precoPor?: number; - quantidade?: number; - }[]; - estoque?: { - estoqueFisico?: number; - estoqueReservado?: number; - centroDistribuicaoId?: number; - alertaEstoque?: number; - }[]; - atributos?: { - tipoAtributo?: string; - isFiltro?: boolean; - nome?: string; - valor?: string; - exibir?: boolean; - }[]; - quantidadeMaximaCompraUnidade?: number; - quantidadeMinimaCompraUnidade?: number; - condicao?: string; - informacoes?: { - informacaoId?: number; - titulo?: string; - texto?: string; - tipoInformacao?: string; + /** + * Tipo de informação do produto (optional) + */ + tipoInformacao?: + | { + "0": "I"; + "1": "n"; + "2": "f"; + "3": "o"; + "4": "r"; + "5": "m"; + "6": "a"; + "7": "c"; + "8": "o"; + "9": "e"; + "10": "s"; + } + | { + "0": "B"; + "1": "e"; + "2": "n"; + "3": "e"; + "4": "f"; + "5": "i"; + "6": "c"; + "7": "i"; + "8": "o"; + "9": "s"; + } + | { + "0": "E"; + "1": "s"; + "2": "p"; + "3": "e"; + "4": "c"; + "5": "i"; + "6": "f"; + "7": "i"; + "8": "c"; + "9": "a"; + "10": "c"; + "11": "o"; + "12": "e"; + "13": "s"; + } + | { + "0": "D"; + "1": "a"; + "2": "d"; + "3": "o"; + "4": "s"; + "5": "T"; + "6": "e"; + "7": "c"; + "8": "n"; + "9": "i"; + "10": "c"; + "11": "o"; + "12": "s"; + } + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "p"; + "4": "o"; + "5": "s"; + "6": "i"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "M"; + "1": "o"; + "2": "d"; + "3": "o"; + "4": "D"; + "5": "e"; + "6": "U"; + "7": "s"; + "8": "a"; + "9": "r"; + } + | { + "0": "C"; + "1": "u"; + "2": "i"; + "3": "d"; + "4": "a"; + "5": "d"; + "6": "o"; + "7": "s"; + } + | { + "0": "I"; + "1": "t"; + "2": "e"; + "3": "n"; + "4": "s"; + "5": "I"; + "6": "n"; + "7": "c"; + "8": "l"; + "9": "u"; + "10": "s"; + "11": "o"; + "12": "s"; + } + | { "0": "D"; "1": "i"; "2": "c"; "3": "a"; "4": "s" } + | { "0": "V"; "1": "i"; "2": "d"; "3": "e"; "4": "o" } + | { + "0": "D"; + "1": "e"; + "2": "s"; + "3": "c"; + "4": "r"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "o"; + } + | { + "0": "V"; + "1": "a"; + "2": "l"; + "3": "o"; + "4": "r"; + "5": "R"; + "6": "e"; + "7": "f"; + "8": "e"; + "9": "r"; + "10": "e"; + "11": "n"; + "12": "t"; + "13": "e"; + } + | { + "0": "P"; + "1": "o"; + "2": "p"; + "3": "U"; + "4": "p"; + "5": "R"; + "6": "e"; + "7": "f"; + "8": "e"; + "9": "r"; + "10": "e"; + "11": "n"; + "12": "t"; + "13": "e"; + } + | { + "0": "P"; + "1": "r"; + "2": "e"; + "3": "s"; + "4": "c"; + "5": "r"; + "6": "i"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "T"; + "1": "a"; + "2": "b"; + "3": "e"; + "4": "l"; + "5": "a"; + "6": "D"; + "7": "e"; + "8": "M"; + "9": "e"; + "10": "d"; + "11": "i"; + "12": "d"; + "13": "a"; + "14": "s"; + } + | { "0": "S"; "1": "p"; "2": "o"; "3": "t" } + | { + "0": "S"; + "1": "i"; + "2": "n"; + "3": "o"; + "4": "p"; + "5": "s"; + "6": "e"; + } + | { + "0": "C"; + "1": "a"; + "2": "r"; + "3": "r"; + "4": "i"; + "5": "n"; + "6": "h"; + "7": "o"; + }; + }; + }; + /** @description Indicador do Carrinho Abandonado */ + "GET /dashboard/carrinhoabandonado": {}; + /** @description Lista de Metatags do produto informado */ + "GET /produtos/:identificador/seo/metaTag": {}; + /** @description Insere um ou mais metatags para um produto */ + "POST /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Lista de metatags (optional) + */ + metas?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; }[]; - tabelasPreco?: { - tabelaPrecoId?: number; - nome?: string; - precoDe?: number; - precoPor?: number; + }; + }; + /** @description Deleta um ou mais Metatags de produto */ + "DELETE /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Lista de identificadores de metatags (optional) + */ + metatags?: { + /** + * Identificador do MetaTag + */ + metatagId?: number; }[]; - dataCriacao?: string; - dataAtualizacao?: string; - urlVideo?: string; - spot?: boolean; - paginaProduto?: boolean; - marketplace?: boolean; - somenteParceiros?: boolean; - reseller?: { - resellerId?: number; - razaoSocial?: string; - centroDistribuicaoId?: number; - ativo?: boolean; - ativacaoAutomaticaProdutos?: boolean; - autonomia?: boolean; - buyBox?: boolean; - nomeMarketPlace?: string; - }; - buyBox?: boolean; }; }; - /** @description Insere um novo Seller no marketplace */ - "POST /resellers": { - body: { + /** @description Frete encontrado */ + "GET /fretes/:freteId": {}; + /** @description Frete atualizado com sucesso */ + "PUT /fretes/:freteId": { + searchParams: { /** - * Razão Social/Nome do Reseller + * Nome do contrato de frete (optional) */ - razaoSocial?: string; + nome?: string; /** - * CNPJ do Seller + * Status do contrato de frete (optional) */ - cnpj?: string; + ativo?: boolean; /** - * Inscrição Estadual do Seller + * Volume máximo permitido, em metro cúbico (m³). (optional) */ - inscricaoEstadual?: string; + volumeMaximo?: number; /** - * Seller isento de inscrição estadual + * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) + */ + pesoCubado?: number; + /** + * Id da configuração entrega agendada (optional) + */ + entregaAgendadaConfiguracaoId?: number; + /** + * URL rastreamento (optional) + */ + linkRastreamento?: string; + /** + * Contrato é exclusivo assinatura (optional) */ - isento?: boolean; + ehAssinatura?: boolean; /** - * Email de contato do Seller + * Informe a largura máxima, em centímetros (cm). (optional) */ - email?: string; + larguraMaxima?: number; /** - * Telefone de contato do seller com ddd (xx) xxxx-xxxx + * Informe a altura máxima, em centímetros (cm). (optional) */ - telefone?: string; + alturaMaxima?: number; /** - * Tipo de autonomia do vendedor + * Informe o comprimento máximo, em centímetros (cm). (optional) */ - tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; + comprimentoMaximo?: number; /** - * Seller Ativo + * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) */ - ativo?: boolean; + limiteMaximoDimensoes?: number; /** - * Se irá ter Split de frete boolean. Default:false + * Informe o limite de peso cubado, em gramas (g). (optional) */ - split?: boolean; + limitePesoCubado?: number; /** - * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, + * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) */ - buyBox?: boolean; + tempoMinimoDespacho?: number; /** - * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, + * Informe o Id do centro de distribuição (optional) */ - ativacaoAutomaticaProdutos?: boolean; + centroDistribuicaoId?: number; /** - * Cep do Seller (utilizado para o calculo de frete) + * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) */ - cep?: string; + valorMinimoProdutos?: number; }; }; - /** @description Atualiza a situação do status de um produto do pedido */ - "PUT /pedidos/:pedidoId/:produtoVarianteId/status": { - body: { + /** @description Relatório de transações de um determinado período */ + "GET /dashboard/transacoes": {}; + /** @description Lista de produtos de uma tabela de preços */ + "GET /tabelaPrecos/:tabelaPrecoId/produtos": {}; + /** @description Inseri uma lista de produto variantes em uma tabela de preços */ + "POST /tabelaPrecos/:tabelaPrecoId/produtos": { + searchParams: { /** - * Dados da situação do produto (optional) + * Lista de produtos variantes */ - RAW_BODY: { + RAW_BODY?: { /** - * Id do centro de distribuição do produto + * SKU do produto */ - centroDistribuicaoId?: number; + sku?: string; /** - * Quantidade de produtos do centro de distribuição + * Preço De do produto */ - quantidade?: number; + precoDe?: number; /** - * Novo status da situação do produto (são os mesmo status do pedido) + * Preço Por do produto */ - situacaoPedidoProdutoId?: number; - }; + precoPor?: number; + }[]; }; }; - /** @description Lista de Lojas Físicas */ - "GET /lojasFisicas": { + /** @description Lista com o retorno do processamento dos produtos enviados */ + "PUT /tabelaPrecos/:tabelaPrecoId/produtos": { searchParams: { /** - * Página da lista (padrão: 1) + * Lista de produtos variantes */ - pagina?: number; + RAW_BODY?: { + /** + * SKU do produto + */ + sku?: string; + /** + * Preço De do produto + */ + precoDe?: number; + /** + * Preço Por do produto + */ + precoPor?: number; + }[]; + }; + }; + /** @description Lista de scripts */ + "GET /gestorscripts/scripts": {}; + /** @description Insere um novo script */ + "POST /gestorscripts/scripts": { + searchParams: { /** - * Quantidade de registros que deverão retornar (max: 50) + * Nome do script */ - quantidadeRegistros?: number; - }; - response: { - lojaId?: number; nome?: string; - ddd?: number; - telefone?: string; - email?: string; - cep?: string; - logradouro?: string; - numero?: string; - complemento?: string; - bairro?: string; - cidade?: string; - estadoId?: number; - prazoEntrega?: number; - prazoMaximoRetirada?: number; + /** + * Data inicial do script + */ + dataInicial?: string; + /** + * Data final do script + */ + dataFinal?: string; + /** + * Informe se o script está ativo ou não + */ ativo?: boolean; - valido?: boolean; - textoComplementar?: string; - retirarNaLoja?: boolean; - latitude?: number; - longitude?: number; - centroDistribuicaoId?: number; - centroDistribuicao?: { - centroDistribuicaoId?: number; - prazoEntrega?: number; - }[]; - }[]; + /** + * Prioridade do script + */ + prioridade?: number; + /** + * Posição do script + */ + posicao?: + | { + "0": "H"; + "1": "e"; + "2": "a"; + "3": "d"; + "4": "e"; + "5": "r"; + "6": "P"; + "7": "r"; + "8": "i"; + "9": "m"; + "10": "e"; + "11": "i"; + "12": "r"; + "13": "a"; + "14": "L"; + "15": "i"; + "16": "n"; + "17": "h"; + "18": "a"; + } + | { + "0": "H"; + "1": "e"; + "2": "a"; + "3": "d"; + "4": "e"; + "5": "r"; + "6": "U"; + "7": "l"; + "8": "t"; + "9": "i"; + "10": "m"; + "11": "a"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; + } + | { + "0": "B"; + "1": "o"; + "2": "d"; + "3": "y"; + "4": "P"; + "5": "r"; + "6": "i"; + "7": "m"; + "8": "e"; + "9": "i"; + "10": "r"; + "11": "a"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; + } + | { + "0": "B"; + "1": "o"; + "2": "d"; + "3": "y"; + "4": "U"; + "5": "l"; + "6": "t"; + "7": "i"; + "8": "m"; + "9": "a"; + "10": "L"; + "11": "i"; + "12": "n"; + "13": "h"; + "14": "a"; + } + | { + "0": "F"; + "1": "o"; + "2": "o"; + "3": "t"; + "4": "e"; + "5": "r"; + "6": "P"; + "7": "r"; + "8": "i"; + "9": "m"; + "10": "e"; + "11": "i"; + "12": "r"; + "13": "a"; + "14": "L"; + "15": "i"; + "16": "n"; + "17": "h"; + "18": "a"; + } + | { + "0": "F"; + "1": "o"; + "2": "o"; + "3": "t"; + "4": "e"; + "5": "r"; + "6": "U"; + "7": "l"; + "8": "t"; + "9": "i"; + "10": "m"; + "11": "e"; + "12": "L"; + "13": "i"; + "14": "n"; + "15": "h"; + "16": "a"; + }; + /** + * Tipo da página do script + */ + tipoPagina?: + | { "0": "T"; "1": "o"; "2": "d"; "3": "a"; "4": "s" } + | { "0": "H"; "1": "o"; "2": "m"; "3": "e" } + | { "0": "B"; "1": "u"; "2": "s"; "3": "c"; "4": "a" } + | { + "0": "C"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "g"; + "5": "o"; + "6": "r"; + "7": "i"; + "8": "a"; + } + | { + "0": "F"; + "1": "a"; + "2": "b"; + "3": "r"; + "4": "i"; + "5": "c"; + "6": "a"; + "7": "n"; + "8": "t"; + "9": "e"; + } + | { + "0": "E"; + "1": "s"; + "2": "t"; + "3": "a"; + "4": "t"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "s"; + } + | { + "0": "P"; + "1": "r"; + "2": "o"; + "3": "d"; + "4": "u"; + "5": "t"; + "6": "o"; + } + | { + "0": "C"; + "1": "a"; + "2": "r"; + "3": "r"; + "4": "i"; + "5": "n"; + "6": "h"; + "7": "o"; + }; + /** + * Identificador da página + */ + identificadorPagina?: string; + /** + * Conteúdo do script + */ + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; + }; }; - /** @description Atualiza os produtos sugeridos de um tipo de evento */ - "PUT /tiposEvento/:tipoEventoId/produtos": { - body: { + /** @description Assinaturas com erro na loja */ + "GET /assinaturas/erros": {}; + /** @description Método que realiza uma cotação de frete */ + "POST /fretes/cotacoes": { + searchParams: { /** - * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado + * Valor total do pedido (optional) + */ + valorTotal?: number; + /** + * Lista de produtos da cotação */ produtos?: { /** - * Identificador do produto variante + * Id do produto variante */ - produtoVarianteId?: number; + identificador?: string; + /** + * Quantidade do produto + */ + quantidade?: number; }[]; }; }; - /** @description Indicadores dos Produtos no Estoque */ - "GET /dashboard/produtoestoque": { + /** @description Lista de Ranges de Ceps de uma Loja Física */ + "GET /lojasFisicas/:lojaFisicaId/rangeCep": {}; + /** @description Insere um range de cep em uma Loja Física */ + "POST /lojasFisicas/:lojaFisicaId/rangeCep": { searchParams: { /** - * Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd) + * Nome do range de cep */ - dataInicial?: string; + nome?: string; /** - * Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd) + * Cep inicial do range. Formato: 00.000-000 */ - dataFinal?: string; + cepInicial?: string; + /** + * Cep final do range. Formato: 00.000-000 + */ + cepFinal?: string; }; - response: { - indicadorProdutoComEstoque?: string; - indicadorProdutoSemEstoque?: string; + }; + /** @description Remove uma lista de range de cep de uma Loja Física */ + "DELETE /lojasFisicas/:lojaFisicaId/rangeCep": { + searchParams: { + /** + * Lista de range de cep a serem excluídos da loja física + */ + RAW_BODY?: { + /** + * Id da faixa de cep a ser deletado + */ + rangeCepId?: number; + }[]; }; }; - /** @description Atualiza um endereço de um usuário pelo e-mail do usuário */ - "PUT /usuarios/:email/enderecos/:enderecoId": { - body: { + /** @description Retorna usuário encontrado */ + "GET /usuarios/:usuarioId/enderecos": {}; + /** @description Insere um endereço para um usuário pelo id do usuário */ + "POST /usuarios/:usuarioId/enderecos": { + searchParams: { /** * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ @@ -6595,1464 +4698,1400 @@ export interface API { cep?: string; }; }; - /** @description Deleta um atributo */ - "DELETE /atributos/:nome": {}; - /** @description Parceiro excluído com sucesso */ - "DELETE /parceiros/:parceiroId": { - response: { - resultadoOperacao?: boolean; - codigo?: number; - mensagem?: string; - }; - }; - /** @description Atualiza o status de uma avaliação de um produto variante */ - "PUT /produtoavaliacao/:produtoAvaliacaoId/status": { - body: { + /** @description Retorna uma lista de vínculos entre usuário e parceiro */ + "GET /usuarios/:email/parceiros": {}; + /** @description Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + "PUT /produtos/precos": { + searchParams: { /** - * Status para a avaliação + * Lista com os dados da atualização do preço (optional) */ - status?: "Pendente" | "NaoAprovado" | "Aprovado"; + RAW_BODY?: { + /** + * Identificador do produto (ProdutoVarianteId ou SKU) + */ + identificador?: string; + /** + * Preço de custo do produto variante + */ + precoCusto?: number; + /** + * "PrecoDe" do produto variante + */ + precoDe?: number; + /** + * "PrecoPor" do produto variante + */ + precoPor?: number; + /** + * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) + */ + fatorMultiplicadorPreco?: number; + }[]; }; }; - /** @description Insere um rastreamento e status a um pedido */ - "POST /pedidos/:pedidoId/rastreamento": { - body: { - /** - * Id da situação do pedido - */ - situacaoPedidoId?: number; - /** - * Id do centro de distribuição - */ - centroDistribuicaoId?: number; - /** - * Rastreamento (optional) - */ - rastreamento?: string; + /** @description Usuário encontrado */ + "GET /usuarios/email/:email": {}; + /** @description Novo token gerado com sucesso */ + "POST /autenticacao/trocarLoja/:novaLoja": {}; + /** @description Campos de cadastro personalizado encontrados */ + "GET /usuarios/camposcadastropersonalizado": {}; + /** @description Objeto do hotsite */ + "GET /hotsites/:hotsiteId": {}; + /** @description Atualiza os dados de um hotsite existente */ + "PUT /hotsites/:hotsiteId": { + searchParams: { /** - * Data do pedido (optional) + * Nome do hotsite */ - dataEvento?: string; + nome?: string; /** - * Número da nota fiscal (optional) + * Data/hora em que o hotsite começará a ser exibido (optional) */ - numeroNotaFiscal?: string; + dataInicio?: string; /** - * Chave acesso NFE (optional) + * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) */ - chaveAcessoNFE?: string; + dataFinal?: string; /** - * URL NFE (optional) + * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início */ - urlNFE?: string; + url?: string; /** - * Serie NFE (optional) + * Informe o número de produtos que deve ser exibido por página */ - serieNFE?: string; + tamanhoPagina?: number; /** - * CFOP (optional) + * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates */ - cfop?: string; + templateId?: number; /** - * URL Rastreamento (optional) + * Informe qual será a ordenação dos Produtos no Hotsite (optional) */ - urlRastreamento?: string; - }; - }; - /** @description Fabricante encontrado */ - "GET /fabricantes/:nome": { - response: { - fabricanteId?: number; - ativo?: boolean; - nome?: string; - urlLogoTipo?: string; - urlLink?: string; - urlCarrossel?: string; - }; - }; - /** @description Vincula parceiros com um banner específico */ - "POST /banners/:bannerId/parceiros": { - body: { + ordenacao?: + | { + "0": "N"; + "1": "e"; + "2": "n"; + "3": "h"; + "4": "u"; + "5": "m"; + "6": "a"; + } + | { + "0": "N"; + "1": "o"; + "2": "m"; + "3": "e"; + "4": "C"; + "5": "r"; + "6": "e"; + "7": "s"; + "8": "c"; + "9": "e"; + "10": "n"; + "11": "t"; + "12": "e"; + } + | { + "0": "N"; + "1": "o"; + "2": "m"; + "3": "e"; + "4": "D"; + "5": "e"; + "6": "c"; + "7": "r"; + "8": "e"; + "9": "s"; + "10": "c"; + "11": "e"; + "12": "n"; + "13": "t"; + "14": "e"; + } + | { + "0": "L"; + "1": "a"; + "2": "n"; + "3": "c"; + "4": "a"; + "5": "m"; + "6": "e"; + "7": "n"; + "8": "t"; + "9": "o"; + } + | { + "0": "M"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "r"; + "5": "P"; + "6": "r"; + "7": "e"; + "8": "c"; + "9": "o"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "P"; + "6": "r"; + "7": "e"; + "8": "c"; + "9": "o"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "s"; + "4": "V"; + "5": "e"; + "6": "n"; + "7": "d"; + "8": "i"; + "9": "d"; + "10": "o"; + "11": "s"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "e"; + "6": "s"; + "7": "D"; + "8": "e"; + "9": "s"; + "10": "c"; + "11": "o"; + "12": "n"; + "13": "t"; + "14": "o"; + "15": "s"; + } + | { + "0": "A"; + "1": "l"; + "2": "e"; + "3": "a"; + "4": "t"; + "5": "o"; + "6": "r"; + "7": "i"; + "8": "o"; + } + | { + "0": "M"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "r"; + "5": "E"; + "6": "s"; + "7": "t"; + "8": "o"; + "9": "q"; + "10": "u"; + "11": "e"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "E"; + "6": "s"; + "7": "t"; + "8": "o"; + "9": "q"; + "10": "u"; + "11": "e"; + }; /** - * Lista de Id dos parceiros + * Produtos que devem aparecer no hotsite */ - RAW_BODY: { + listaProdutos?: { /** - * Id do parceiro (optional) + * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) */ - parceiroId?: number; - }[]; - }; - }; - /** @description Lista de tabelas de preços */ - "GET /tabelaPrecos": { - response: { - tabelaPrecoId?: number; - nome?: string; - dataInicial?: string; - dataFinal?: string; - ativo?: boolean; - isSite?: boolean; - }[]; - }; - /** @description Atualiza a imagem do banner */ - "PUT /banners/:bannerId/Imagem": { - body: { - /** - * URL da Imagem (optional) - */ - urlImagem?: string; + expressao?: string; + /** + * Id dos produtos + */ + produtos?: { + /** + * Identificador do produto a ser mostrado no hotsite + */ + produtoId?: number; + /** + * Ordem para apresentação do produto (optional) + */ + ordem?: number; + }[]; + }; /** - * Informações para atualizar a imagem (optional) + * Dados de seo */ - Imagem?: { + seo?: { /** - * string da imagem em base 64 + * Informe o Título que será exibido quando o Hotsite for acessado (optional) */ - base64?: string; + titulo?: string; /** - * formato da imagem + * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) */ - formato?: "PNG" | "JPG" | "JPEG"; + metas?: { + /** + * Informe os dados da Metatag + */ + conteudo?: string; + /** + * Informe os dados da Metatag + */ + nome?: string; + /** + * Informe os dados da Metatag + */ + httpEquiv?: string; + /** + * Informe os dados da Metatag + */ + scheme?: string; + }[]; + }; + /** + * Lista de identificadores de banners a serem vinculados ao hotsite + */ + banners?: { /** - * nome da imagem + * Identificador do banner (optional) */ - nome?: string; - }; - }; - }; - /** @description Atualiza um conteúdo */ - "PUT /conteudos/:conteudoId": { - body: { + bannerId?: number; + }[]; /** - * Titulo do conteúdo + * Lista de identificadores de conteúdos a serem vinculados ao hotsite */ - titulo?: string; + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; /** - * Conteúdo ativo/inativo + * Status do hotsite (optional) */ ativo?: boolean; + }; + }; + /** @description Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados */ + "DELETE /hotsites/:hotsiteId": {}; + /** @description Lista com assinaturas */ + "GET /assinaturas": {}; + /** @description Lista de categorias */ + "GET /categorias": {}; + /** @description Insere uma nova categoria */ + "POST /categorias": { + searchParams: { /** - * Data de inicio de exibição do conteúdo (optional) + * Nome da categoria (optional) */ - dataInicio?: string; + nome?: string; /** - * Data de final de exibição do conteúdo (optional) + * Id da categoria pai (optional) */ - dataFim?: string; + categoriaPaiId?: number; /** - * Posicionamento do conteúdo + * Id da categoria ERP (optional) */ - posicionamento?: - | "Topo" - | "Centro" - | "Rodape" - | "LateralDireita" - | "LateralEsquerda" - | "MobileTopo" - | "MobileRodape"; + categoriaERPId?: string; /** - * Informações do conteúdo + * Categoria ativo/inativo (optional) */ - conteudo?: string; + ativo?: boolean; /** - * Insira em qual Termo de Busca o Conteúdo será exibido (optional) + * Categoria de reseller (optional) */ - termoBusca?: string; + isReseller?: boolean; /** - * Exibição do conteúdo nas buscas + * Exibir Matriz de Atributos (optional) */ - exibeTodasBuscas?: boolean; + exibirMatrizAtributos?: + | { "0": "S"; "1": "i"; "2": "m" } + | { "0": "N"; "1": "a"; "2": "o" } + | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; /** - * Não exibição do conteúdo nas buscas + * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ - naoExibeBuscas?: boolean; + quantidadeMaximaCompraUnidade?: number; /** - * Exibição do conteúdo nos hotsites + * Informe o valor mínimo para compra em produtos desta categoria (optional) */ - exibeTodosHotsites?: boolean; + valorMinimoCompra?: number; /** - * Insira quais Hotsites que o Conteúdo será exibido (optional) + * Informe se será exibida no menu (optional) */ - hotsiteId?: number[]; + exibeMenu?: boolean; }; }; - /** @description Categoria encontrada */ - "GET /categorias/erp/:id": { + /** @description Lista de fabricantes */ + "GET /fabricantes": {}; + /** @description Insere um novo fabricante */ + "POST /fabricantes": { searchParams: { /** - * Hierarquia da categoria - */ - hierarquia?: boolean; - /** - * Se será apresentado somente categorias filhas + * Nome do fabricante (optional) */ - somenteFilhos?: boolean; - }; - response: { - id?: number; - nome?: string; - categoriaPaiId?: number; - categoriaERPId?: string; - ativo?: boolean; - isReseller?: boolean; - exibirMatrizAtributos?: string; - quantidadeMaximaCompraUnidade?: number; - valorMinimoCompra?: number; - exibeMenu?: boolean; - urlHotSite?: string; - }; - }; - /** @description Lista de Ranges de Ceps de uma Loja Física */ - "GET /lojasFisicas/:lojaFisicaId/rangeCep": { - response: { - rangeCepId?: number; nome?: string; - cepInicial?: string; - cepFinal?: string; - }[]; - }; - /** @description Atualiza um Atacarejo */ - "PUT /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { - searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * URL tipo logo (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + urlLogoTipo?: string; /** - * Preço atacado (optional) + * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) */ - precoAtacado?: number; + urlLink?: string; /** - * Quantidade do produto (optional) + * Insira nesse campo a URL do Carrossel da Marca (optional) */ - quantidade?: number; + urlCarrossel?: string; }; }; - /** @description Exclui o vínculo entre uma categoria e um produto */ - "DELETE /produtos/:identificador/categorias/:id": { + /** @description Atualiza o campo Recebido de um produto vinculado a um evento */ + "PUT /eventos/:eventoId/produtos/recebido": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Id do produto variante (optional) + */ + produtoVarianteId?: number; + /** + * Se o produto foi recebido fora da lista (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + recebidoForaLista?: boolean; }; }; - /** @description Xml com os dados de uma mídia específicas entre duas datas */ - "GET /midias/:identificador": { + /** @description Tipo evento buscado */ + "GET /tiposEvento/:tipoEventoId": {}; + /** @description Atualiza o tipo evento */ + "PUT /tiposEvento/:tipoEventoId": { searchParams: { /** - * Data inicial (aaaa-mm-dd) + * Nome do Tipo de Evento */ - dataInicial?: string; + nome?: string; /** - * Data final (aaaa-mm-dd) + * Tipo de entrega */ - dataFinal?: string; - }; - response: { - dias?: { - diaMidiaApiModel?: { - dia?: string; - investimento?: { - meta?: number; - realizado?: number; - }; - pedidos?: { - meta?: number; - realizado?: number; - }; - roi?: { - meta?: number; - realizado?: number; - }; - receita?: { - meta?: number; - realizado?: number; - }; - visitas?: { - meta?: number; - realizado?: number; - }; - }[]; - }; - id?: number; - nome?: string; - tipo?: string; - }; - }; - /** @description A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos. */ - "POST /hotsites": { - body: { + tipoEntrega?: + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "A"; + "8": "g"; + "9": "e"; + "10": "n"; + "11": "d"; + "12": "a"; + "13": "d"; + "14": "a"; + } + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "C"; + "8": "o"; + "9": "n"; + "10": "f"; + "11": "o"; + "12": "r"; + "13": "m"; + "14": "e"; + "15": "C"; + "16": "o"; + "17": "m"; + "18": "p"; + "19": "r"; + "20": "a"; + "21": "R"; + "22": "e"; + "23": "a"; + "24": "l"; + "25": "i"; + "26": "z"; + "27": "a"; + "28": "d"; + "29": "a"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } + | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; /** - * Nome do hotsite + * Disponibilização do Tipo de Evento + */ + tipoDisponibilizacao?: + | { + "0": "D"; + "1": "i"; + "2": "s"; + "3": "p"; + "4": "o"; + "5": "n"; + "6": "i"; + "7": "b"; + "8": "i"; + "9": "l"; + "10": "i"; + "11": "z"; + "12": "a"; + "13": "c"; + "14": "a"; + "15": "o"; + "16": "D"; + "17": "e"; + "18": "C"; + "19": "r"; + "20": "e"; + "21": "d"; + "22": "i"; + "23": "t"; + "24": "o"; + "25": "s"; + } + | { + "0": "D"; + "1": "i"; + "2": "s"; + "3": "p"; + "4": "o"; + "5": "n"; + "6": "i"; + "7": "b"; + "8": "i"; + "9": "l"; + "10": "i"; + "11": "z"; + "12": "a"; + "13": "c"; + "14": "a"; + "15": "o"; + "16": "D"; + "17": "e"; + "18": "P"; + "19": "r"; + "20": "o"; + "21": "d"; + "22": "u"; + "23": "t"; + "24": "o"; + "25": "s"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" }; + /** + * Permissão para remoção automática de produtos + */ + permitirRemocaoAutomaticaProdutos?: boolean; + /** + * Cor em hexadecimal para o titulo de informações + */ + corHexTituloInformacoes?: string; + /** + * Cor em hexadecimal para o corpo de informações + */ + corHexCorpoInformacoes?: string; + /** + * Número de abas de informações, podendo ser de 1 a 2 */ - nome?: string; + numeroAbasInformacoes?: number; /** - * Data/hora em que o hotsite começará a ser exibido (optional) + * Quantidade de dias para que o evento expire */ - dataInicio?: string; + quantidadeDiasParaEventoExpirar?: number; /** - * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) + * Quantidade de locais do evento */ - dataFinal?: string; + numeroLocaisEvento?: number; /** - * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início + * Informa se o evento está ativo ou inativo */ - url?: string; + ativo?: boolean; /** - * Informe o número de produtos que deve ser exibido por página + * Informa a disponibilidade do evento */ - tamanhoPagina?: number; + disponivel?: boolean; /** - * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates + * O beneficiário do frete */ - templateId?: number; + tipoBeneficiarioFrete?: + | { + "0": "D"; + "1": "o"; + "2": "n"; + "3": "o"; + "4": "d"; + "5": "a"; + "6": "L"; + "7": "i"; + "8": "s"; + "9": "t"; + "10": "a"; + } + | { + "0": "C"; + "1": "o"; + "2": "n"; + "3": "v"; + "4": "i"; + "5": "d"; + "6": "a"; + "7": "d"; + "8": "o"; + }; /** - * Informe qual será a ordenação dos Produtos no Hotsite (optional) + * Imagem da logo do evento em base64 */ - ordenacao?: - | "Nenhuma" - | "NomeCrescente" - | "NomeDecrescente" - | "Lancamento" - | "MenorPreco" - | "MaiorPreco" - | "MaisVendidos" - | "MaioresDescontos" - | "Aleatorio" - | "MenorEstoque" - | "MaiorEstoque"; + imagemLogoEvento?: string; /** - * Produtos que devem aparecer no hotsite + * Produtos Sugeridos para este evento (optional) */ - listaProdutos?: { + sugestaoProdutos?: { /** - * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) + * Id do tipo de evento */ - expressao?: string; + tipoEventoId?: number; /** - * Id dos produtos + * Identificador do produto variante */ - produtos?: { - /** - * Identificador do produto a ser mostrado no hotsite - */ - produtoId?: number; - /** - * Ordem para apresentação do produto (optional) - */ - ordem?: number; - }[]; - }; + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Produtos de uma assinatura */ + "GET /assinaturas/:email": {}; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos/:eventoId": {}; + /** @description Atualiza um evento */ + "PUT /eventos/:eventoId": { + searchParams: { /** - * Dados de seo (optional) + * Identificador do tipo de evento */ - seo?: { - /** - * Informe o Título que será exibido quando o Hotsite for acessado (optional) - */ - titulo?: string; - /** - * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) - */ - metas?: { - /** - * Informe os dados da Metatag - */ - conteudo?: string; - /** - * Informe os dados da Metatag - */ - nome?: string; - /** - * Informe os dados da Metatag - */ - httpEquiv?: string; - /** - * Informe os dados da Metatag - */ - scheme?: string; - }[]; - }; + tipoEventoId?: number; /** - * Lista de identificadores de banners a serem vinculados ao hotsite (optional) + * Identificador do endereço de entrega */ - banners?: { - /** - * Identificador do banner (optional) - */ - bannerId?: number; - }[]; + enderecoEntregaId?: number; /** - * Lista de identificadores de conteúdos a serem vinculados ao hotsite + * Titulo do evento */ - conteudos?: { - /** - * Identificador do conteúdo - */ - conteudoId?: number; - }[]; + titulo?: string; /** - * Status do hotsite (optional) + * Atributo obsoleto - (optional) */ - ativo?: boolean; - }; - }; - /** @description Lista de pedidos */ - "GET /pedidos/situacaoPedido/:situacoesPedido": { - searchParams: { + url?: string; /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + * Data do Evento */ - dataInicial?: string; + data?: string; /** - * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + * Email do usuário */ - dataFinal?: string; + usuarioEmail?: string; /** - * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + * Disponibilidade do evento (optional) */ - enumTipoFiltroData?: - | "DataPedido" - | "DataAprovacao" - | "DataModificacaoStatus" - | "DataAlteracao" - | "DataCriacao"; + disponivel?: boolean; /** - * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + * Quantos dias antes do evento ele será exibido (optional) */ - formasPagamento?: string; + diasAntesEvento?: number; /** - * Página da lista (padrão: 1) + * Até quantos dias depois do evento ele será exibido (optional) */ - pagina?: number; + diasDepoisEvento?: number; /** - * Quantidade de registros que deverão retornar (max: 50) + * Url do Logo. (Base64) */ - quantidadeRegistros?: number; + urlLogo?: string; /** - * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + * Url da Capa. (Base64) */ - apenasAssinaturas?: boolean; - }; - response: { - pedidoId?: number; - situacaoPedidoId?: number; - tipoRastreamentoPedido?: string; - transacaoId?: number; - data?: string; - dataPagamento?: string; - dataUltimaAtualizacao?: string; - valorFrete?: number; - valorTotalPedido?: number; - valorDesconto?: number; - valorDebitoCC?: number; - cupomDesconto?: string; - marketPlacePedidoId?: string; - marketPlacePedidoSiteId?: string; - canalId?: number; - canalNome?: string; - canalOrigem?: string; - retiradaLojaId?: number; - isPedidoEvento?: boolean; - usuario?: { - usuarioId?: number; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - }; - pedidoEndereco?: { - tipo?: string; - nome?: string; - endereco?: string; - numero?: string; - complemento?: string; - referencia?: string; - cep?: string; - tipoLogradouro?: string; - logradouro?: string; - bairro?: string; - cidade?: string; - estado?: string; - pais?: string; - }[]; - frete?: { - freteContratoId?: number; - freteContrato?: string; - referenciaConector?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - retiradaLojaId?: number; - centrosDistribuicao?: { - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - servico?: { - servicoId?: number; - nome?: string; - transportadora?: string; - prazo?: number; - servicoNome?: string; - preco?: number; - servicoTransporte?: number; - codigo?: number; - servicoMeta?: string; - custo?: number; - token?: string; - }; - retiradaAgendada?: { - lojaId?: number; - retiradaData?: string; - retiradaPeriodo?: string; - nome?: string; - documento?: string; - codigoRetirada?: string; - }; - agendamento?: { - de?: string; - ate?: string; - }; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }; - itens?: { - produtoVarianteId?: number; - sku?: string; - nome?: string; - quantidade?: number; - precoCusto?: number; - precoVenda?: number; - isBrinde?: boolean; - valorAliquota?: number; - isMarketPlace?: boolean; - precoPor?: number; - desconto?: number; - totais?: { - precoCusto?: number; - precoVenda?: number; - precoPor?: number; - desconto?: number; - }; - ajustes?: { - tipo?: string; - valor?: number; - observacao?: string; - nome?: string; - }[]; - centroDistribuicao?: { - centroDistribuicaoId?: number; - quantidade?: number; - situacaoProdutoId?: number; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - }[]; - valoresAdicionais?: { - tipo?: string; - origem?: string; - texto?: string; - valor?: number; - }[]; - atributos?: { - produtoVarianteAtributoValor?: string; - produtoVarianteAtributoNome?: string; - }[]; - embalagens?: { - tipoEmbalagemId?: number; - nomeTipoEmbalagem?: string; - mensagem?: string; - valor?: number; - descricao?: string; - }[]; - personalizacoes?: { - nomePersonalizacao?: string; - valorPersonalizacao?: string; - valor?: number; - }[]; - frete?: { - quantidade?: number; - freteContratoId?: number; - freteContrato?: string; - valorFreteEmpresa?: number; - valorFreteCliente?: number; - peso?: number; - pesoCobrado?: number; - volume?: number; - volumeCobrado?: number; - prazoEnvio?: number; - prazoEnvioTexto?: string; - centroDistribuicaoId?: number; - }[]; - dadosProdutoEvento?: { - tipoPresenteRecebimento?: string; - }; - formulas?: { - chaveAjuste?: string; - valor?: number; - nome?: string; - expressao?: string; - expressaoInterpretada?: string; - endPoint?: string; - }[]; - seller?: { - sellerId?: number; - sellerNome?: string; - sellerPedidoId?: number; - }; - }[]; - assinatura?: { - assinaturaId?: number; - grupoAssinaturaId?: number; - tipoPeriodo?: string; - tempoPeriodo?: number; - percentualDesconto?: number; - }[]; - pagamento?: { - formaPagamentoId?: number; - numeroParcelas?: number; - valorParcela?: number; - valorDesconto?: number; - valorJuros?: number; - valorTotal?: number; - boleto?: { - urlBoleto?: string; - codigoDeBarras?: string; - }; - cartaoCredito?: { - numeroCartao?: string; - nomeTitular?: string; - dataValidade?: string; - codigoSeguranca?: string; - documentoCartaoCredito?: string; - token?: string; - info?: string; - bandeira?: string; - }[]; - pagamentoStatus?: { - numeroAutorizacao?: string; - numeroComprovanteVenda?: string; - dataAtualizacao?: string; - dataUltimoStatus?: string; - adquirente?: string; - tid?: string; - }[]; - informacoesAdicionais?: { - chave?: string; - valor?: string; - }[]; - }[]; - observacao?: { - observacao?: string; - usuario?: string; - data?: string; - publica?: boolean; - }[]; - valorCreditoFidelidade?: number; - valido?: boolean; - valorSubTotalSemDescontos?: number; - pedidoSplit?: number[]; - }[]; - }; - /** @description Lista de scripts */ - "GET /gestorscripts/scripts": { - response: { - scriptId?: number; - nome?: string; - posicao?: string; - tipoPagina?: string; - dataInicial?: string; - datafinal?: string; - ativo?: boolean; - prioridade?: number; - }[]; - }; - /** @description Portfolio encontrado */ - "GET /portfolios/:nome": { - response: { - portfolioId?: number; - nome?: string; - ativo?: boolean; - }; - }; - /** @description Lista de categorias de um produto */ - "GET /produtos/:identificador/categorias": { - searchParams: { + urlCapa?: string; + /** + * Quem é o proprietário + */ + proprietario?: string; + /** + * Se a aba de informação 01 será habilitada + */ + abaInfo01Habilitado?: boolean; + /** + * Texto para o campo informação 01 (optional) + */ + textoInfo01?: string; + /** + * Conteúdo para o campo informação 01 (optional) + */ + conteudoInfo01?: string; /** - * Define se o identificador informado é um sku ou um id interno. + * Se a aba de informação 02 será habilitada */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + abaInfo02Habilitado?: boolean; /** - * Página da lista (padrão: 1) + * Texto para o campo informação 02 (optional) */ - pagina?: number; + textoInfo02?: string; /** - * Quantidade de registros que deverão retornar (max: 50) + * Conteúdo para o campo informação 02 (optional) */ - quantidadRegistros?: number; - }; - response: { - id?: number; - nome?: string; - categoriaPaiId?: number; - categoriaERPId?: string; - ativo?: boolean; - isReseller?: boolean; - exibirMatrizAtributos?: string; - quantidadeMaximaCompraUnidade?: number; - valorMinimoCompra?: number; - exibeMenu?: boolean; - urlHotSite?: string; - caminhoHierarquia?: string; - categoriaPrincipal?: boolean; - }[]; - }; - /** @description Lista de Atacarejos */ - "GET /produtos/:identificador/atacarejo": { - searchParams: { + conteudoInfo02?: string; /** - * Define se o identificador informado é um sku ou um id interno. + * Se a aba de mensagem será habilitada (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - response: { - produtoVarianteAtacadoId?: number; - precoAtacado?: number; - quantidade?: number; - }[]; - }; - /** @description Retorna usuário encontrado */ - "GET /usuarios/:usuarioId/enderecos": { - response: { - enderecoId?: number; - nomeEndereco?: string; - rua?: string; - numero?: string; - complemento?: string; - referencia?: string; - bairro?: string; - cidade?: string; - estado?: string; - cep?: string; - utilizadoUltimoPedido?: boolean; - pais?: string; - }[]; - }; - /** @description Lista com o retorno do processamento dos produtos enviados */ - "PUT /tabelaPrecos/:tabelaPrecoId/produtos": { - body: { + abaMensagemHabilitado?: boolean; /** - * Lista de produtos variantes + * Tipo de lista de presente + */ + enumTipoListaPresenteId?: + | { + "0": "L"; + "1": "i"; + "2": "s"; + "3": "t"; + "4": "a"; + "5": "P"; + "6": "r"; + "7": "o"; + "8": "n"; + "9": "t"; + "10": "a"; + } + | { + "0": "L"; + "1": "i"; + "2": "s"; + "3": "t"; + "4": "a"; + "5": "M"; + "6": "a"; + "7": "n"; + "8": "u"; + "9": "a"; + "10": "l"; + }; + /** + * Tipo de entrega + */ + enumTipoEntregaId?: + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "A"; + "8": "g"; + "9": "e"; + "10": "n"; + "11": "d"; + "12": "a"; + "13": "d"; + "14": "a"; + } + | { + "0": "E"; + "1": "n"; + "2": "t"; + "3": "r"; + "4": "e"; + "5": "g"; + "6": "a"; + "7": "C"; + "8": "o"; + "9": "n"; + "10": "f"; + "11": "o"; + "12": "r"; + "13": "m"; + "14": "e"; + "15": "C"; + "16": "o"; + "17": "m"; + "18": "p"; + "19": "r"; + "20": "a"; + "21": "R"; + "22": "e"; + "23": "a"; + "24": "l"; + "25": "i"; + "26": "z"; + "27": "a"; + "28": "d"; + "29": "a"; + } + | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } + | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; + /** + * Seleção de produto no evento */ - RAW_BODY: { + eventoProdutoSelecionado?: { /** - * SKU do produto + * Id do produto variante */ - sku?: string; + produtoVarianteId?: number; /** - * Preço De do produto + * Se produto recebido fora da lista (optional) */ - precoDe?: number; + recebidoForaLista?: boolean; /** - * Preço Por do produto + * Se produto removido (optional) */ - precoPor?: number; - }[]; - }; - response: { - sucesso?: { - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - erro?: { - sku?: string; - resultado?: boolean; - detalhes?: string; + removido?: boolean; }[]; - }; - }; - /** @description Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados */ - "DELETE /hotsites/:hotsiteId": {}; - /** @description Recorrências cadastradas na loja */ - "GET /assinaturas/recorrencias": { - response: { - recorrencias?: string[]; - }; - }; - /** @description Atualiza rastreamento completo (com os dados da N.F.) */ - "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId": { - body: { /** - * Objeto Pedido Rastreamento + * Endereço do Evento */ - RAW_BODY: { - /** - * Número da nota fiscal - */ - notaFiscal?: string; + enderecoEvento?: { /** - * Código Fiscal de Operações e Prestações + * Nome para identificação do endereço */ - cfop?: number; + nome?: string; /** - * Data Envio + * Endereço */ - dataEnviado?: string; + endereco?: string; /** - * Chave de Acesso NFE + * Cep do endereço */ - chaveAcessoNFE?: string; + cep?: string; /** - * Rastreamento (optional) + * Numero do endereço */ - rastreamento?: string; + numero?: string; /** - * URL de rastreamento (optional) + * Bairro do endereço */ - urlRastreamento?: string; + bairro?: string; /** - * Transportadora (optional) + * Cidade do endereço */ - transportadora?: string; + cidade?: string; /** - * Data da entrega (optional) + * Estado do endereço */ - dataEntrega?: string; - }; + estado?: string; + }[]; }; }; - /** @description Adiciona o vínculo entre um produto e uma categoria com base na lista enviada */ - "POST /produtos/:identificador/categorias": { + /** @description Lista de identificadores de banners vinculados ao hotsite */ + "GET /hotsites/:hotsiteId/banners": {}; + /** @description Vincula um ou mais banners a um hotsite específico */ + "POST /hotsites/:hotsiteId/banners": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { - /** - * Id da Categoria Principal (optional) - */ - categoriaPrincipalId?: number; - /** - * Id da categoria a qual o produto deverá ser vinculado (optional) + * Lista de identificadores de banners para vincular ao hotsite */ - listaCategoriaId?: number[]; + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; }; }; - /** @description Atualiza a prioridade de um centro de distribuição */ - "PUT /centrosdistribuicao/:centroDistribuicaoId/prioridade": { - body: { - /** - * (optional) - */ - incrementoOrdem?: number; + /** @description Desvincula um ou mais banners de um hotsite específico */ + "DELETE /hotsites/:hotsiteId/banners": { + searchParams: { /** - * (optional) + * Lista de identificadores de banners a serem desvinculados */ - desativarPriorizacao?: boolean; + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; }; - response: {}; }; - /** @description Insere um novo conteúdo na loja */ - "POST /conteudos": { - body: { - /** - * Titulo do conteúdo - */ - titulo?: string; - /** - * Conteúdo ativo/inativo - */ - ativo?: boolean; - /** - * Data de inicio de exibição do conteúdo (optional) - */ - dataInicio?: string; - /** - * Data final de exibição do conteúdo (optional) - */ - dataFim?: string; - /** - * Posicionamento do conteúdo - */ - posicionamento?: - | "Topo" - | "Centro" - | "Rodape" - | "LateralDireita" - | "LateralEsquerda" - | "MobileTopo" - | "MobileRodape"; - /** - * Informações do conteúdo - */ - conteudo?: string; - /** - * Insira em qual Termo de Busca o Conteúdo será exibido (optional) - */ - termoBusca?: string; - /** - * Exibição do conteúdo nas buscas - */ - exibeTodasBuscas?: boolean; - /** - * Não exibição do conteúdo nas buscas - */ - naoExibeBuscas?: boolean; - /** - * Exibição do conteúdo nos hotsites - */ - exibeTodosHotsites?: boolean; + /** @description Estorna um valor menor ou igual ao total do pedido "Pago" */ + "POST /pedidos/estorno/:pedidoId": { + searchParams: { /** - * Insira quais Hotsites que o Conteúdo será exibido (optional) + * Valor a ser estornado do pedido. Total ou parcial. */ - hotsitesId?: number[]; + Valor?: number; }; }; - /** @description Atualiza a imagem de estampa do produto */ - "PUT /produtos/:identificador/imagens/estampa": { + /** @description Pedidos que terão vínculo com o grupo de assinatura informado. */ + "POST /assinaturas/grupoassinatura/assinatura": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Lista de pedidos a serem vinculados a assinatura */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + pedidos?: { + /** + * Id do pedido + */ + pedidoId?: number; + }[]; /** - * Id da imagem que será marcada como estampa + * ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura */ - idImagem?: number; + recorrenciaId?: number; + /** + * ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura + */ + grupoAssinaturaId?: number; }; }; - /** @description Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página) */ - "GET /usuarios/newsletter": { + /** @description Lista de situações de pedido */ + "GET /situacoesPedido": {}; + /** @description Lista de Lojas Físicas */ + "GET /lojasFisicas": {}; + /** @description Insere uma Loja Física */ + "POST /lojasFisicas": { searchParams: { /** - * Tipo de ordenação - */ - ordenarPor?: "DataCadastro" | "DataAtualizacao"; - /** - * Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + * Id da loja (optional) */ - dataInicial?: string; + lojaId?: number; /** - * Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + * Nome da loja (optional) */ - dataFinal?: string; + nome?: string; /** - * Página da lista (padrão: 1) + * DDD da localidade de destino da loja (optional) */ - pagina?: number; + ddd?: number; /** - * Status do usuário + * Telefone da loja (optional) */ - status?: boolean; + telefone?: string; /** - * DoubleOptIn aceito (verificar estado da configuração) + * E-mail de contato da loja (optional) */ - doubleOptIn?: boolean; - }; - response: { - nome?: string; email?: string; - sexo?: string; - status?: boolean; - grupoInformacao?: { - nome?: string; - valor?: string; - }[]; - }[]; - }; - /** @description Ativa ou desativa um endereço de um usuário com base no e-mail do usuário */ - "PUT /usuarios/:email/enderecos/:enderecoId/ativar": { - body: { - /** - * Status do endereço - */ - status?: boolean; - }; - }; - /** @description Conteúdos encontrados */ - "GET /conteudos": { - searchParams: { /** - * Página da lista (padrão: 1) + * CEP do endereço da loja (optional) */ - pagina?: number; + cep?: string; /** - * Quantidade de registros que deverão retornar (max: 50) + * Logradouro do endereço da loja (optional) */ - quantidadePorPagina?: number; - }; - response: { - conteudoId?: number; - titulo?: string; - ativo?: boolean; - dataInicio?: string; - dataFim?: string; - posicionamento?: string; - codigoFonte?: string; - termoBusca?: string; - exibeTodasBuscas?: boolean; - naoExibeBuscas?: boolean; - exibeTodosHotsites?: boolean; - hotsitesId?: number[]; - }[]; - }; - /** @description Insere uma avaliação para um produto variante */ - "POST /produtoavaliacao/:identificador": { - searchParams: { + logradouro?: string; /** - * Define se o identificador informado é um sku ou um id interno da fstore + * Número de localização do endereço da loja (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + numero?: string; /** - * Texto referente a avaliação do produto + * Complemento para localização da loja (optional) */ - comentario?: string; + complemento?: string; /** - * Escala de 1 a 5 para avaliar o produto + * Bairro do endereço do loja (optional) */ - avaliacao?: number; + bairro?: string; /** - * Identificado do usuário + * Cidade em que a loja se encontra (optional) */ - usuarioId?: number; + cidade?: string; /** - * Referente a data que a avaliação foi criada + * Id do estado em que a loja se encontra (optional) */ - dataAvaliacao?: string; + estadoId?: number; /** - * Nome do usuário que avaliou + * Prazo de entrega (optional) */ - nome?: string; + prazoEntrega?: number; /** - * Email do usuário que avaliou + * Prazo máximo para retirada (optional) */ - email?: string; + prazoMaximoRetirada?: number; /** - * Referente ao status que libera a visualização da avaliação no site + * Status da loja (optional) */ - status?: "Pendente" | "NaoAprovado" | "Aprovado"; - }; - }; - /** @description Lista de hotsites */ - "GET /hotsites": { - searchParams: { + ativo?: boolean; /** - * Página da lista (padrão: 1) + * Valido (optional) */ - pagina?: number; + valido?: boolean; /** - * Quantidade de registros que deverão retornar (max: 50) + * Informações complementares da loja (optional) */ - quantidadePorPagina?: number; - }; - response: { - hotsiteId?: number; - nome?: string; - ativo?: boolean; - template?: string; - dataCriacao?: string; - dataInicio?: string; - dataFinal?: string; - url?: string; - tamanhoPagina?: number; - templateId?: number; - ordenacao?: string; - listaProdutos?: { - expressao?: string; - produtos?: { - produtoId?: number; - ordem?: number; - }[]; - }; - seo?: { - seoHotsiteId?: number; - hotsiteId?: number; - titulo?: string; - metas?: { - conteudo?: string; - nome?: string; - httpEquiv?: string; - scheme?: string; - }[]; - }; - banners?: { - bannerId?: number; - }[]; - conteudos?: { - conteudoId?: number; - }[]; - }[]; - }; - /** @description Relatório de receitas de um determinado período */ - "GET /dashboard/receita": { - searchParams: { + textoComplementar?: string; /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + * Se a retirada na loja será ativada (optional) */ - dataInicial?: string; + retirarNaLoja?: boolean; /** - * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + * Latitude (optional) */ - dataFinal?: string; + latitude?: number; /** - * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + * Longitude (optional) */ - tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; - }; - response: { - tipoAgrupamento?: string; - dados?: { - data?: string; - pedidosCaptados?: number; - pedidosPagos?: number; - pedidosEnviados?: number; - pedidosCancelados?: number; - }[]; - }; - }; - /** @description Vincula um ou mais conteúdos a um hotsite específico */ - "POST /hotsites/:hotsiteId/conteudos": { - body: { + longitude?: number; /** - * Lista de identificadores de conteúdos a serem vinculados + * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) */ - RAW_BODY: { + centroDistribuicao?: { /** - * Identificador do conteúdo + * Id do centro de distribuição */ - conteudoId?: number; + centroDistribuicaoId?: number; + /** + * Prazo de entrega + */ + prazoEntrega?: number; }[]; }; }; - /** @description Insere um novo contrato de frete */ - "POST /fretes": { - body: { - /** - * Nome do contrato de frete (optional) - */ - nome?: string; - /** - * Status do contrato de frete (optional) - */ - ativo?: boolean; + /** @description Atualiza um usuário pelo email */ + "PUT /usuarios/:email": { + searchParams: { /** - * Volume máximo permitido , em metro cúbico (m³). (optional) + * Tipo de pessoa */ - volumeMaximo?: number; + tipoPessoa?: + | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } + | { + "0": "J"; + "1": "u"; + "2": "r"; + "3": "i"; + "4": "d"; + "5": "i"; + "6": "c"; + "7": "a"; + }; /** - * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) + * Origem do contato */ - pesoCubado?: number; + origemContato?: + | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } + | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } + | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } + | { + "0": "P"; + "1": "a"; + "2": "t"; + "3": "r"; + "4": "o"; + "5": "c"; + "6": "i"; + "7": "n"; + "8": "i"; + "9": "o"; + "10": "E"; + "11": "s"; + "12": "p"; + "13": "o"; + "14": "r"; + "15": "t"; + "16": "i"; + "17": "v"; + "18": "o"; + } + | { + "0": "R"; + "1": "e"; + "2": "c"; + "3": "o"; + "4": "m"; + "5": "e"; + "6": "n"; + "7": "d"; + "8": "a"; + "9": "c"; + "10": "a"; + "11": "o"; + "12": "A"; + "13": "l"; + "14": "g"; + "15": "u"; + "16": "e"; + "17": "m"; + } + | { + "0": "R"; + "1": "e"; + "2": "v"; + "3": "i"; + "4": "s"; + "5": "t"; + "6": "a"; + } + | { + "0": "S"; + "1": "i"; + "2": "t"; + "3": "e"; + "4": "I"; + "5": "n"; + "6": "t"; + "7": "e"; + "8": "r"; + "9": "n"; + "10": "e"; + "11": "t"; + } + | { + "0": "T"; + "1": "e"; + "2": "l"; + "3": "e"; + "4": "v"; + "5": "i"; + "6": "s"; + "7": "a"; + "8": "o"; + } + | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } + | { + "0": "U"; + "1": "s"; + "2": "u"; + "3": "a"; + "4": "r"; + "5": "i"; + "6": "o"; + "7": "I"; + "8": "m"; + "9": "p"; + "10": "o"; + "11": "r"; + "12": "t"; + "13": "a"; + "14": "d"; + "15": "o"; + "16": "V"; + "17": "i"; + "18": "a"; + "19": "A"; + "20": "d"; + "21": "m"; + "22": "i"; + "23": "n"; + } + | { + "0": "P"; + "1": "a"; + "2": "y"; + "3": "P"; + "4": "a"; + "5": "l"; + "6": "E"; + "7": "x"; + "8": "p"; + "9": "r"; + "10": "e"; + "11": "s"; + "12": "s"; + }; /** - * Id da configuração entrega agendada (optional) + * Tipo Sexo (optional) */ - entregaAgendadaConfiguracaoId?: number; + tipoSexo?: + | { + "0": "U"; + "1": "n"; + "2": "d"; + "3": "e"; + "4": "f"; + "5": "i"; + "6": "n"; + "7": "e"; + "8": "d"; + } + | { + "0": "M"; + "1": "a"; + "2": "s"; + "3": "c"; + "4": "u"; + "5": "l"; + "6": "i"; + "7": "n"; + "8": "o"; + } + | { + "0": "F"; + "1": "e"; + "2": "m"; + "3": "i"; + "4": "n"; + "5": "i"; + "6": "n"; + "7": "o"; + }; /** - * URL rastreamento (optional) + * Nome do usuário (Max Length: 100) */ - linkRastreamento?: string; + nome?: string; /** - * Contrato é exclusivo assinatura (optional) + * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) */ - ehAssinatura?: boolean; + cpf?: string; /** - * Informe a largura máxima, em centímetros (cm). (optional) + * E-mail do usuário (Max Length: 100) */ - larguraMaxima?: number; + email?: string; /** - * Informe a altura máxima, em centímetros (cm). (optional) + * RG do usuário caso seja pessoa física (Max Length: 50) (optional) */ - alturaMaxima?: number; + rg?: string; /** - * Informe o comprimento máximo, em centímetros (cm). (optional) + * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) */ - comprimentoMaximo?: number; + telefoneResidencial?: string; /** - * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) + * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) */ - limiteMaximoDimensoes?: number; + telefoneCelular?: string; /** - * Informe o limite de peso cubado, em gramas (g). (optional) + * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) */ - limitePesoCubado?: number; + telefoneComercial?: string; /** - * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) + * Data de nascimento (optional) */ - tempoMinimoDespacho?: number; + dataNascimento?: string; /** - * Informe o Id do centro de distribuição (optional) + * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) */ - centroDistribuicaoId?: number; + razaoSocial?: string; /** - * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) + * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) */ - valorMinimoProdutos?: number; - }; - }; - /** @description Detalhes de uma assinatura */ - "GET /assinaturas/:assinaturaId": { - response: { - assinaturaId?: number; - usuarioId?: number; - dataProximoPedido?: string; - periodoRecorrencia?: string; - situacaoAssinatura?: string; - dataAssinatura?: string; - grupoAssinatura?: string; - enderecoId?: number; - usuarioCartaoCreditoId?: number; - cupom?: string; - produtos?: { - assinaturaProdutoId?: number; - assinaturaId?: number; - produtoId?: number; - produtoVarianteId?: number; - quantidade?: number; - valor?: number; - removido?: boolean; - }[]; - }; - }; - /** @description Buscar autor pelo nome */ - "GET /autores/:nomeAutor": {}; - /** @description Lista o conteúdo de uma versão */ - "GET /gestorscripts/scripts/:scriptId/versao/:versaoId/conteudo": { - response: { - scriptId?: number; - versaoId?: number; - conteudo?: string; - }[]; - }; - /** @description Remove o vinculo de produtos de um Grupo de Personalização */ - "DELETE /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { - body: { + cnpj?: string; /** - * Lista de Id dos produtos + * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) */ - RAW_BODY: { - /** - * Id do produto - */ - produtoId?: number; - }[]; - }; - }; - /** @description Altera a data de recorrência de uma assinatura */ - "PUT /assinaturas/:assinaturaId/proximaRecorrencia": { - body: { + inscricaoEstadual?: string; /** - * Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados) + * Responsável(Max Length: 100) (optional) */ - proximaRecorrencia?: string; - }; - }; - /** @description Lista de parceiros com pedidos */ - "GET /parceiros/comPedidos": { - searchParams: { + responsavel?: string; /** - * Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss) + * Data de criação do cadastro (optional) */ - dataInicial?: string; + dataCriacao?: string; /** - * Data final dos pedidos (aaaa-mm-dd hh:mm:ss) + * Data de atualização do cadastro (optional) */ - dataFinal?: string; - }; - response: { - parceiroId?: number; - marketPlaceId?: number; - nome?: string; - tabelaPrecoId?: number; - portfolioId?: number; - tipoEscopo?: string; - ativo?: boolean; - isMarketPlace?: boolean; - origem?: string; - }[]; - }; - /** @description Insere um ou mais metatags para um produto */ - "POST /produtos/:identificador/seo/metaTag": { - searchParams: { + dataAtualizacao?: string; /** - * Define se o identificador informado é um sku ou um id interno da fstore + * Se o usuário é revendedor (optional) */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - body: { + revendedor?: boolean; /** - * Lista de metatags (optional) + * Informação cadastral (optional) */ - metas?: { - /** - * Dados da Meta Tag - */ - content?: string; - /** - * Dados da Meta Tag - */ - httpEquiv?: string; + listaInformacaoCadastral?: { /** - * Dados da Meta Tag + * Chave */ - name?: string; + chave?: string; /** - * Dados da Meta Tag + * Valor */ - scheme?: string; + valor?: string; }[]; - }; - response: { - metatagId?: number; - content?: string; - httpEquiv?: string; - name?: string; - scheme?: string; - }[]; - }; - /** @description Frete atualizado com sucesso */ - "PUT /fretes/:freteId": { - body: { /** - * Nome do contrato de frete (optional) + * Avatar (Max Length: 50) (optional) */ - nome?: string; + avatar?: string; /** - * Status do contrato de frete (optional) + * IP do usuário (Max Length: 20) (optional) */ - ativo?: boolean; + ip?: string; /** - * Volume máximo permitido, em metro cúbico (m³). (optional) + * Seta ou retorna o valor de Aprovado (optional) */ - volumeMaximo?: number; + aprovado?: boolean; + }; + }; + /** @description Insere um novo campo de cadastro personalizado */ + "POST /usuarios/CadastroPersonalizado": { + searchParams: { /** - * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) + * Nome do campo */ - pesoCubado?: number; + nome?: string; /** - * Id da configuração entrega agendada (optional) + * Tipo do campo */ - entregaAgendadaConfiguracaoId?: number; + tipo?: + | { + "0": "T"; + "1": "e"; + "2": "x"; + "3": "t"; + "4": "o"; + "5": "L"; + "6": "i"; + "7": "v"; + "8": "r"; + "9": "e"; + } + | { + "0": "V"; + "1": "a"; + "2": "l"; + "3": "o"; + "4": "r"; + "5": "e"; + "6": "s"; + "7": "P"; + "8": "r"; + "9": "e"; + "10": "d"; + "11": "e"; + "12": "f"; + "13": "i"; + "14": "n"; + "15": "i"; + "16": "d"; + "17": "o"; + "18": "s"; + } + | { + "0": "R"; + "1": "a"; + "2": "d"; + "3": "i"; + "4": "o"; + "5": "B"; + "6": "u"; + "7": "t"; + "8": "t"; + "9": "o"; + "10": "n"; + }; /** - * URL rastreamento (optional) + * Se o campo será obrigatório */ - linkRastreamento?: string; + obrigatorio?: boolean; /** - * Contrato é exclusivo assinatura (optional) + * Ordem */ - ehAssinatura?: boolean; + ordem?: number; /** - * Informe a largura máxima, em centímetros (cm). (optional) + * Informação para os campos (optional) */ - larguraMaxima?: number; + valorPreDefinido?: { + /** + * Valor + */ + valor?: string; + /** + * Ordem + */ + ordem?: number; + }[]; + }; + }; + /** @description Seta identificador como variante principal */ + "PUT /produtos/:identificador/principal": {}; + /** @description Lista de inscrições */ + "GET /webhook/inscricao": {}; + /** @description Insere uma inscrição */ + "POST /webhook/inscricao": { + searchParams: { /** - * Informe a altura máxima, em centímetros (cm). (optional) + * Nome da inscrição */ - alturaMaxima?: number; + nome?: string; /** - * Informe o comprimento máximo, em centímetros (cm). (optional) + * Url para qual deve ser enviada as notificações */ - comprimentoMaximo?: number; + appUrl?: string; /** - * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) + * Tópicos em que deseja se inscrever */ - limiteMaximoDimensoes?: number; + topicos?: string[]; /** - * Informe o limite de peso cubado, em gramas (g). (optional) + * Usuário que está realizando a inscrição */ - limitePesoCubado?: number; + usuario?: string; /** - * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) + * Status da inscrição, se ativada ou desativada */ - tempoMinimoDespacho?: number; + ativo?: boolean; /** - * Informe o Id do centro de distribuição (optional) + * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado */ - centroDistribuicaoId?: number; + emailResponsavel?: string; /** - * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) + * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) */ - valorMinimoProdutos?: number; - }; - }; - /** @description Lista de detalhes de frete */ - "GET /fretes/:freteId/detalhes": { - response: { - freteId?: number; - cepInicial?: number; - cepFinal?: number; - variacoesFreteDetalhe?: { - pesoInicial?: number; - pesoFinal?: number; - valorFrete?: number; - prazoEntrega?: number; - valorPreco?: number; - valorPeso?: number; + headers?: { + /** + * Chave do header, por exemplo: 'Authorization' + */ + chave?: string; + /** + * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' + */ + valor?: string; }[]; - }[]; + }; }; - /** @description Buscar todos os autores */ - "GET /autores": {}; - /** @description Adiciona uma nova informação */ - "POST /produtos/:identificador/informacoes": { + /** @description Lista de produtos de um Grupo de Personalização */ + "GET /grupospersonalizacao/:grupoPersonalizacaoId/produtos": {}; + /** @description Vincula produtos a um Grupo de Personalização */ + "POST /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Lista de Id dos produtos */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + RAW_BODY?: { + /** + * Id do produto + */ + produtoId?: number; + }[]; + }; + }; + /** @description Remove o vinculo de produtos de um Grupo de Personalização */ + "DELETE /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { + searchParams: { /** - * Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + * Lista de Id dos produtos */ - tipoRetorno?: "Id" | "Booleano"; + RAW_BODY?: { + /** + * Id do produto + */ + produtoId?: number; + }[]; }; - body: { + }; + /** @description Gráfico do Faturamento */ + "GET /dashboard/graficofaturamento": {}; + /** @description Atualiza uma informação de um produto específico */ + "PUT /produtos/:identificador/informacoes/:informacaoId": { + searchParams: { /** * Titulo da informação (optional) */ @@ -8069,1318 +6108,1716 @@ export interface API { * Tipo de informação do produto (optional) */ tipoInformacao?: - | "Informacoes" - | "Beneficios" - | "Especificacoes" - | "DadosTecnicos" - | "Composicao" - | "ModoDeUsar" - | "Cuidados" - | "ItensInclusos" - | "Dicas" - | "Video" - | "Descricao" - | "ValorReferente" - | "PopUpReferente" - | "Prescricao" - | "TabelaDeMedidas" - | "Spot" - | "Sinopse" - | "Carrinho"; - }; - }; - /** @description Usuário encontrado */ - "GET /usuarios/cnpj/:cnpj": { - response: { - usuarioId?: number; - bloqueado?: boolean; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - avatar?: string; - ip?: string; - aprovado?: boolean; - }; - }; - /** @description Deleta um produto da lista de sugestões de produtos de um tipo de evento */ - "DELETE /tiposEvento/:tipoEventoId/produto/:produtoVarianteId": {}; - /** @description Deleta o vinculo de um produto a um evento */ - "DELETE /eventos/:eventoId/produto/:produtoVarianteId": { - response: string; - }; - /** @description Lista de Metatags do produto informado */ - "GET /produtos/:identificador/seo/metaTag": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno - */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - response: { - metatagId?: number; - content?: string; - httpEquiv?: string; - name?: string; - scheme?: string; - }[]; - }; - /** @description Define uma categoria de um produto como principal */ - "PUT /produtos/:identificador/categoriaPrincipal": { - searchParams: { - /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { - /** - * Id da categoria - */ - categoriaId?: number; + | { + "0": "I"; + "1": "n"; + "2": "f"; + "3": "o"; + "4": "r"; + "5": "m"; + "6": "a"; + "7": "c"; + "8": "o"; + "9": "e"; + "10": "s"; + } + | { + "0": "B"; + "1": "e"; + "2": "n"; + "3": "e"; + "4": "f"; + "5": "i"; + "6": "c"; + "7": "i"; + "8": "o"; + "9": "s"; + } + | { + "0": "E"; + "1": "s"; + "2": "p"; + "3": "e"; + "4": "c"; + "5": "i"; + "6": "f"; + "7": "i"; + "8": "c"; + "9": "a"; + "10": "c"; + "11": "o"; + "12": "e"; + "13": "s"; + } + | { + "0": "D"; + "1": "a"; + "2": "d"; + "3": "o"; + "4": "s"; + "5": "T"; + "6": "e"; + "7": "c"; + "8": "n"; + "9": "i"; + "10": "c"; + "11": "o"; + "12": "s"; + } + | { + "0": "C"; + "1": "o"; + "2": "m"; + "3": "p"; + "4": "o"; + "5": "s"; + "6": "i"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "M"; + "1": "o"; + "2": "d"; + "3": "o"; + "4": "D"; + "5": "e"; + "6": "U"; + "7": "s"; + "8": "a"; + "9": "r"; + } + | { + "0": "C"; + "1": "u"; + "2": "i"; + "3": "d"; + "4": "a"; + "5": "d"; + "6": "o"; + "7": "s"; + } + | { + "0": "I"; + "1": "t"; + "2": "e"; + "3": "n"; + "4": "s"; + "5": "I"; + "6": "n"; + "7": "c"; + "8": "l"; + "9": "u"; + "10": "s"; + "11": "o"; + "12": "s"; + } + | { "0": "D"; "1": "i"; "2": "c"; "3": "a"; "4": "s" } + | { "0": "V"; "1": "i"; "2": "d"; "3": "e"; "4": "o" } + | { + "0": "D"; + "1": "e"; + "2": "s"; + "3": "c"; + "4": "r"; + "5": "i"; + "6": "c"; + "7": "a"; + "8": "o"; + } + | { + "0": "V"; + "1": "a"; + "2": "l"; + "3": "o"; + "4": "r"; + "5": "R"; + "6": "e"; + "7": "f"; + "8": "e"; + "9": "r"; + "10": "e"; + "11": "n"; + "12": "t"; + "13": "e"; + } + | { + "0": "P"; + "1": "o"; + "2": "p"; + "3": "U"; + "4": "p"; + "5": "R"; + "6": "e"; + "7": "f"; + "8": "e"; + "9": "r"; + "10": "e"; + "11": "n"; + "12": "t"; + "13": "e"; + } + | { + "0": "P"; + "1": "r"; + "2": "e"; + "3": "s"; + "4": "c"; + "5": "r"; + "6": "i"; + "7": "c"; + "8": "a"; + "9": "o"; + } + | { + "0": "T"; + "1": "a"; + "2": "b"; + "3": "e"; + "4": "l"; + "5": "a"; + "6": "D"; + "7": "e"; + "8": "M"; + "9": "e"; + "10": "d"; + "11": "i"; + "12": "d"; + "13": "a"; + "14": "s"; + } + | { "0": "S"; "1": "p"; "2": "o"; "3": "t" } + | { + "0": "S"; + "1": "i"; + "2": "n"; + "3": "o"; + "4": "p"; + "5": "s"; + "6": "e"; + } + | { + "0": "C"; + "1": "a"; + "2": "r"; + "3": "r"; + "4": "i"; + "5": "n"; + "6": "h"; + "7": "o"; + }; }; }; - /** @description Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ - "PUT /produtos/estoques": { + /** @description Exclui uma informação de um produto */ + "DELETE /produtos/:identificador/informacoes/:informacaoId": {}; + /** @description Assinatura de um determinado pedido */ + "GET /assinaturas/pedido/:pedidoId": {}; + /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId/parcial": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { - /** - * Lista com os dados da atualização do estoque (optional) + * Objeto Pedido Rastreamento */ - RAW_BODY: { - /** - * Valor único utilizado para identificar o produto - */ - identificador?: string; + RAW_BODY?: { /** - * Prazo de entrega do produto + * Rastreamento (optional) */ - prazoEntrega?: number; + rastreamento?: string; /** - * Lista com os dados da atualização do estoque + * URL de Rastreamento (optional) */ - listaEstoque?: { - /** - * Estoque físico do produto - */ - estoqueFisico?: number; - /** - * Estoque reservado do produto - */ - estoqueReservado?: number; - /** - * Id do centro de distribuição do estoque do produto - */ - centroDistribuicaoId?: number; - /** - * Id do produto variante - */ - produtoVarianteId?: number; - /** - * Quantidade para ativar o alerta de estoque - */ - alertaEstoque?: number; - }[]; - }[]; + urlRastreamento?: string; + }; }; - response: { - produtosNaoAtualizados?: { - produtoVarianteId?: number; - sku?: string; - centroDistribuicaoId?: number; - resultado?: boolean; - detalhes?: string; - }[]; - produtosAtualizados?: { - produtoVarianteId?: number; - sku?: string; - centroDistribuicaoId?: number; - resultado?: boolean; - detalhes?: string; - }[]; + }; + /** @description Access token atualizado com sucesso */ + "POST /autenticacao/refresh": {}; + /** @description Ativa ou inativa uma inscrição */ + "PUT /webhook/inscricao/:inscricaoId/Ativar": { + searchParams: { + /** + * Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada) + */ + ativo?: boolean; + /** + * Usuário que está realizando a atualização + */ + usuario?: string; + /** + * Observação que deseje fazer com relação a ativação/desativação da inscrição (optional) + */ + observacao?: string; }; }; - /** @description Objeto com o estoque total e o estoque por centro de distribuição de um produto variante */ - "GET /produtos/:identificador/estoque": { + /** @description Assinatura com erro na loja */ + "GET /assinaturas/erros/:assinaturaId": {}; + /** @description Limite de crédito de um usuário específico */ + "GET /usuarios/limiteCreditoPorEmail/:email": {}; + /** @description Retorna o histórico de situações de um pedido */ + "GET /pedidos/:pedidoId/historicoSituacao": {}; + /** @description Atualiza o limite de crédito para um usuário */ + "PUT /usuarios/limiteCredito/:usuarioId": {}; + /** @description Retorna a lista de produtos de um portfolio */ + "GET /portfolios/:portfolioId/produtos": {}; + /** @description Vinculo de produtos ao portfolio */ + "PUT /portfolios/:portfolioId/produtos": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Lista dos Id's dos produtos */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - response: { - estoqueFisico?: number; - estoqueReservado?: number; - listProdutoVarianteCentroDistribuicaoEstoque?: { - centroDistribuicaoId?: number; - nome?: string; - estoqueFisico?: number; - estoqueReservado?: number; + RAW_BODY?: { + /** + * Id do produto + */ + produtoId?: number; }[]; }; }; - /** @description Atualiza um script existente */ - "PUT /gestorscripts/scripts/:scriptId": { - body: { + /** @description Insere um rastreamento e status a um produto variante */ + "POST /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento": { + searchParams: { /** - * Nome do script + * Id da situação do pedido */ - nome?: string; + situacaoPedidoId?: number; /** - * Data inicial do script + * Quantidade (optional) */ - dataInicial?: string; + quantidade?: number; /** - * Data final do script + * Id do centro de distribuição */ - dataFinal?: string; + centroDistribuicaoId?: number; /** - * Informe se o script está ativo ou não + * Rastreamento (optional) */ - ativo?: boolean; + rastreamento?: string; /** - * Prioridade do script + * Data (optional) */ - prioridade?: number; + dataEvento?: string; /** - * Posição do script + * Número da nota fiscal (optional) */ - posicao?: - | "HeaderPrimeiraLinha" - | "HeaderUltimaLinha" - | "BodyPrimeiraLinha" - | "BodyUltimaLinha" - | "FooterPrimeiraLinha" - | "FooterUltimeLinha"; + numeroNotaFiscal?: string; /** - * Tipo da página do script + * Chave de acesso NFE (optional) */ - tipoPagina?: - | "Todas" - | "Home" - | "Busca" - | "Categoria" - | "Fabricante" - | "Estaticas" - | "Produto" - | "Carrinho"; + chaveAcessoNFE?: string; /** - * Identificador da página + * URL NFE (optional) */ - identificadorPagina?: string; + urlNFE?: string; /** - * Conteúdo do script + * Serie NFE (optional) */ - conteudo?: string; + serieNFE?: string; /** - * Status do script + * CFOP (optional) */ - publicado?: boolean; + cfop?: number; + /** + * URL de rastreamento (optional) + */ + urlRastreamento?: string; }; }; - /** @description Lista de fabricantes */ - "GET /fabricantes": { - response: { - fabricanteId?: number; - ativo?: boolean; - nome?: string; - urlLogoTipo?: string; - urlLink?: string; - urlCarrossel?: string; - }[]; - }; - /** @description Categoria encontrada */ - "GET /categorias/:id": { + /** @description Usuários encontrados */ + "GET /parceiros/:parceiroId/usuarios": {}; + /** @description Dados de transação do pedido */ + "GET /pedidos/transacoes/:transacaoId": {}; + /** @description Operação realizada com ou sem sucesso para os usuários */ + "PUT /usuarios/autorizar": { searchParams: { /** - * Hierarquia da categoria + * Usuários */ - hierarquia?: boolean; + RAW_BODY?: { + /** + * Identificador + */ + identificador?: string; + /** + * Status de aprovação + */ + aprovado?: boolean; + }[]; + }; + }; + /** @description Atualiza a data de cadastro um produto com base nos dados enviados */ + "PUT /produtos/:identificador/DataCadastro": { + searchParams: { /** - * Se será apresentado somente categorias filhas + * Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss */ - somenteFilhos?: boolean; - }; - response: { - id?: number; - nome?: string; - categoriaPaiId?: number; - categoriaERPId?: string; - ativo?: boolean; - isReseller?: boolean; - exibirMatrizAtributos?: string; - quantidadeMaximaCompraUnidade?: number; - valorMinimoCompra?: number; - exibeMenu?: boolean; - urlHotSite?: string; + dataCadastro?: string; }; }; - /** @description Vincula um ou mais banners a um hotsite específico */ - "POST /hotsites/:hotsiteId/banners": { - body: { + /** @description Atualiza a situação do status de um produto do pedido */ + "PUT /pedidos/:pedidoId/:produtoVarianteId/status": { + searchParams: { /** - * Lista de identificadores de banners para vincular ao hotsite + * Dados da situação do produto (optional) */ - banners?: { + RAW_BODY?: { /** - * Identificador do banner (optional) + * Id do centro de distribuição do produto */ - bannerId?: number; - }[]; + centroDistribuicaoId?: number; + /** + * Quantidade de produtos do centro de distribuição + */ + quantidade?: number; + /** + * Novo status da situação do produto (são os mesmo status do pedido) + */ + situacaoPedidoProdutoId?: number; + }; }; }; - /** @description Exclui uma tabela de preços */ - "DELETE /tabelaPrecos/:tabelaPrecoId": {}; - /** @description Remove uma Loja Física */ - "DELETE /lojasFisicas/:lojaFisicaId": {}; - /** @description Parceiro atualizado com sucesso */ - "PUT /parceiros/:parceiroId": { - body: { + /** @description Indicadores dos Produtos no Estoque */ + "GET /dashboard/produtoestoque": {}; + /** @description Atualiza um endereço de um usuário pelo e-mail do usuário */ + "PUT /usuarios/:email/enderecos/:enderecoId": { + searchParams: { /** - * Nome do parceiro + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ - nome?: string; + nomeEndereco?: string; /** - * Id da tabela de preço (optional) + * Nome da rua (Max Length: 500) */ - tabelaPrecoId?: number; + rua?: string; /** - * Id do portfolio (optional) + * Número do local (Max Length: 50) */ - portfolioId?: number; + numero?: string; /** - * Tipo de escopo + * Complemento (Max Length: 250) (optional) */ - tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; + complemento?: string; /** - * Status do parceiro + * Referência para a localização do endereço (Max Length: 500) (optional) */ - ativo?: boolean; + referencia?: string; /** - * Se o parceiro é marketplace (optional) + * Bairro do endereço (Max Length: 100) */ - isMarketPlace?: boolean; + bairro?: string; /** - * Origem (optional) + * Cidade em que se localiza o endereço (Max Length: 100) */ - origem?: string; + cidade?: string; /** - * alias (optional) + * O estado (Max Length: 100) */ - alias?: string; + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; }; - response: { - resultadoOperacao?: boolean; - codigo?: number; - mensagem?: string; - }[]; }; - /** @description Usuário encontrado */ - "GET /usuarios/usuarioId/:usuarioId": { - response: { - usuarioId?: number; - bloqueado?: boolean; - grupoInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - tipoPessoa?: string; - origemContato?: string; - tipoSexo?: string; - nome?: string; - cpf?: string; - email?: string; - rg?: string; - telefoneResidencial?: string; - telefoneCelular?: string; - telefoneComercial?: string; - dataNascimento?: string; - razaoSocial?: string; - cnpj?: string; - inscricaoEstadual?: string; - responsavel?: string; - dataCriacao?: string; - dataAtualizacao?: string; - revendedor?: boolean; - listaInformacaoCadastral?: { - chave?: string; - valor?: string; - }[]; - avatar?: string; - ip?: string; - aprovado?: boolean; + /** @description Atualiza o status de uma avaliação de um produto variante */ + "PUT /produtoavaliacao/:produtoAvaliacaoId/status": { + searchParams: { + /** + * Status para a avaliação + */ + status?: + | { + "0": "P"; + "1": "e"; + "2": "n"; + "3": "d"; + "4": "e"; + "5": "n"; + "6": "t"; + "7": "e"; + } + | { + "0": "N"; + "1": "a"; + "2": "o"; + "3": "A"; + "4": "p"; + "5": "r"; + "6": "o"; + "7": "v"; + "8": "a"; + "9": "d"; + "10": "o"; + } + | { + "0": "A"; + "1": "p"; + "2": "r"; + "3": "o"; + "4": "v"; + "5": "a"; + "6": "d"; + "7": "o"; + }; }; }; - /** @description Lista de fretes */ - "GET /fretes": { - response: { - freteId?: number; - nome?: string; - ativo?: boolean; - volumeMaximo?: number; - pesoCubado?: number; - entregaAgendadaConfiguracaoId?: number; - linkRastreamento?: string; - ehAssinatura?: boolean; - larguraMaxima?: number; - alturaMaxima?: number; - comprimentoMaximo?: number; - limiteMaximoDimensoes?: number; - limitePesoCubado?: number; - tempoMinimoDespacho?: number; - centroDistribuicaoId?: number; - valorMinimoProdutos?: number; - }[]; - }; - /** @description Vinculo de produtos ao portfolio */ - "PUT /portfolios/:portfolioId/produtos": { - body: { + /** @description Fabricante encontrado */ + "GET /fabricantes/:nome": {}; + /** @description Lista de parceiros vinculados ao banner */ + "GET /banners/:bannerId/parceiros": {}; + /** @description Vincula parceiros com um banner específico */ + "POST /banners/:bannerId/parceiros": { + searchParams: { /** - * Lista dos Id's dos produtos + * Lista de Id dos parceiros */ - RAW_BODY: { + RAW_BODY?: { /** - * Id do produto + * Id do parceiro (optional) */ - produtoId?: number; + parceiroId?: number; }[]; }; }; - /** @description Vincula produtos a um Grupo de Personalização */ - "POST /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { - body: { + /** @description Deleta o vinculo de um ou mais parceiros com um banner específico */ + "DELETE /banners/:bannerId/parceiros": { + searchParams: { /** - * Lista de Id dos produtos + * Lista de identificadores de parceiros para desvincular do banner */ - RAW_BODY: { + listaParceiros?: { /** - * Id do produto + * Id do parceiro (optional) */ - produtoId?: number; + parceiroId?: number; }[]; }; }; - /** @description Atacarejo */ - "GET /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + /** @description Lista de tabelas de preços */ + "GET /tabelaPrecos": {}; + /** @description Insere uma nova tabela de preços */ + "POST /tabelaPrecos": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Nome da tabela de preço */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - response: { - produtoVarianteAtacadoId?: number; - precoAtacado?: number; - quantidade?: number; - }; - }; - /** @description Produtos Mais Vendidos */ - "GET /dashboard/produtos": { - searchParams: { + nome?: string; /** - * Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + * Data que inicia a tabela de preço */ dataInicial?: string; /** - * Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + * Data de término da tabela de preço */ dataFinal?: string; /** - * Id do parceiro + * Status da tabela de preço */ - parceiroId?: number; + ativo?: boolean; }; - response: { - produtoVarianteId?: number; - nomeProduto?: string; - sku?: string; - quantidade?: number; - receita?: string; - }[]; }; - /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ - "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId/parcial": - { - body: { + /** @description Atualiza a imagem do banner */ + "PUT /banners/:bannerId/Imagem": { + searchParams: { + /** + * URL da Imagem (optional) + */ + urlImagem?: string; + /** + * Informações para atualizar a imagem (optional) + */ + Imagem?: { /** - * Objeto Pedido Rastreamento Produto + * string da imagem em base 64 */ - RAW_BODY: { - /** - * Rastreamento (optional) - */ - rastreamento?: string; - /** - * URL de Rastreamento (optional) - */ - urlRastreamento?: string; - }; + base64?: string; + /** + * formato da imagem + */ + formato?: + | { "0": "P"; "1": "N"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "G" } + | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; + /** + * nome da imagem + */ + nome?: string; }; }; - /** @description Atualiza o status do banner pelo id */ - "PUT /banners/:bannerId/status": { - body: { + }; + /** @description Exclui o vínculo entre uma categoria e um produto */ + "DELETE /produtos/:identificador/categorias/:id": {}; + /** @description Xml com os dados de uma mídia específicas entre duas datas */ + "GET /midias/:identificador": {}; + /** @description Lista de hotsites */ + "GET /hotsites": {}; + /** @description A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos. */ + "POST /hotsites": { + searchParams: { /** - * Status para qual deve ir o baner: Ativo (true) ou Inativo (false) + * Nome do hotsite */ - status?: boolean; - }; - }; - /** @description Remove um valor pré definido */ - "DELETE /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": - {}; - /** @description Atualiza um endereço de um usuário pelo id do usuário */ - "PUT /usuarios/:usuarioId/enderecos/:enderecoId": { - body: { + nome?: string; /** - * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + * Data/hora em que o hotsite começará a ser exibido (optional) */ - nomeEndereco?: string; + dataInicio?: string; /** - * Nome da rua (Max Length: 500) + * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) */ - rua?: string; + dataFinal?: string; /** - * Número do local (Max Length: 50) + * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início */ - numero?: string; + url?: string; /** - * Complemento (Max Length: 250) (optional) + * Informe o número de produtos que deve ser exibido por página */ - complemento?: string; + tamanhoPagina?: number; /** - * Referência para a localização do endereço (Max Length: 500) (optional) + * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates */ - referencia?: string; + templateId?: number; /** - * Bairro do endereço (Max Length: 100) + * Informe qual será a ordenação dos Produtos no Hotsite (optional) */ - bairro?: string; + ordenacao?: + | { + "0": "N"; + "1": "e"; + "2": "n"; + "3": "h"; + "4": "u"; + "5": "m"; + "6": "a"; + } + | { + "0": "N"; + "1": "o"; + "2": "m"; + "3": "e"; + "4": "C"; + "5": "r"; + "6": "e"; + "7": "s"; + "8": "c"; + "9": "e"; + "10": "n"; + "11": "t"; + "12": "e"; + } + | { + "0": "N"; + "1": "o"; + "2": "m"; + "3": "e"; + "4": "D"; + "5": "e"; + "6": "c"; + "7": "r"; + "8": "e"; + "9": "s"; + "10": "c"; + "11": "e"; + "12": "n"; + "13": "t"; + "14": "e"; + } + | { + "0": "L"; + "1": "a"; + "2": "n"; + "3": "c"; + "4": "a"; + "5": "m"; + "6": "e"; + "7": "n"; + "8": "t"; + "9": "o"; + } + | { + "0": "M"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "r"; + "5": "P"; + "6": "r"; + "7": "e"; + "8": "c"; + "9": "o"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "P"; + "6": "r"; + "7": "e"; + "8": "c"; + "9": "o"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "s"; + "4": "V"; + "5": "e"; + "6": "n"; + "7": "d"; + "8": "i"; + "9": "d"; + "10": "o"; + "11": "s"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "e"; + "6": "s"; + "7": "D"; + "8": "e"; + "9": "s"; + "10": "c"; + "11": "o"; + "12": "n"; + "13": "t"; + "14": "o"; + "15": "s"; + } + | { + "0": "A"; + "1": "l"; + "2": "e"; + "3": "a"; + "4": "t"; + "5": "o"; + "6": "r"; + "7": "i"; + "8": "o"; + } + | { + "0": "M"; + "1": "e"; + "2": "n"; + "3": "o"; + "4": "r"; + "5": "E"; + "6": "s"; + "7": "t"; + "8": "o"; + "9": "q"; + "10": "u"; + "11": "e"; + } + | { + "0": "M"; + "1": "a"; + "2": "i"; + "3": "o"; + "4": "r"; + "5": "E"; + "6": "s"; + "7": "t"; + "8": "o"; + "9": "q"; + "10": "u"; + "11": "e"; + }; /** - * Cidade em que se localiza o endereço (Max Length: 100) + * Produtos que devem aparecer no hotsite */ - cidade?: string; + listaProdutos?: { + /** + * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) + */ + expressao?: string; + /** + * Id dos produtos + */ + produtos?: { + /** + * Identificador do produto a ser mostrado no hotsite + */ + produtoId?: number; + /** + * Ordem para apresentação do produto (optional) + */ + ordem?: number; + }[]; + }; /** - * O estado (Max Length: 100) + * Dados de seo (optional) */ - estado?: string; + seo?: { + /** + * Informe o Título que será exibido quando o Hotsite for acessado (optional) + */ + titulo?: string; + /** + * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) + */ + metas?: { + /** + * Informe os dados da Metatag + */ + conteudo?: string; + /** + * Informe os dados da Metatag + */ + nome?: string; + /** + * Informe os dados da Metatag + */ + httpEquiv?: string; + /** + * Informe os dados da Metatag + */ + scheme?: string; + }[]; + }; /** - * Código do cep (Max Length: 50) + * Lista de identificadores de banners a serem vinculados ao hotsite (optional) */ - cep?: string; + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; + /** + * Lista de identificadores de conteúdos a serem vinculados ao hotsite + */ + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; + /** + * Status do hotsite (optional) + */ + ativo?: boolean; }; }; - /** @description Vincula hotsites com um banner específico */ - "POST /banners/:bannerId/hotsites": { - body: { + /** @description Lista de pedidos */ + "GET /pedidos/situacaoPedido/:situacoesPedido": {}; + /** @description Portfolio encontrado */ + "GET /portfolios/:nome": {}; + /** @description Lista de categorias de um produto */ + "GET /produtos/:identificador/categorias": {}; + /** @description Adiciona o vínculo entre um produto e uma categoria com base na lista enviada */ + "POST /produtos/:identificador/categorias": { + searchParams: { /** - * lista de identificadores de hotsites a serem vinculados ao banner + * Id da Categoria Principal (optional) + */ + categoriaPrincipalId?: number; + /** + * Id da categoria a qual o produto deverá ser vinculado (optional) + */ + listaCategoriaId?: number[]; + }; + }; + /** @description Lista de Atacarejos */ + "GET /produtos/:identificador/atacarejo": {}; + /** @description Adiciona novos Atacarejos */ + "POST /produtos/:identificador/atacarejo": { + searchParams: { + /** + * Lista de Atacarejos (optional) + */ + RAW_BODY?: { + /** + * Preço atacado + */ + precoAtacado?: number; + /** + * Quantidade do produto + */ + quantidade?: number; + }[]; + }; + }; + /** @description Recorrências cadastradas na loja */ + "GET /assinaturas/recorrencias": {}; + /** @description Atualiza rastreamento completo (com os dados da N.F.) */ + "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId": { + searchParams: { + /** + * Objeto Pedido Rastreamento */ RAW_BODY?: { /** - * Id do hotsite (optional) + * Número da nota fiscal + */ + notaFiscal?: string; + /** + * Código Fiscal de Operações e Prestações + */ + cfop?: number; + /** + * Data Envio + */ + dataEnviado?: string; + /** + * Chave de Acesso NFE + */ + chaveAcessoNFE?: string; + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de rastreamento (optional) + */ + urlRastreamento?: string; + /** + * Transportadora (optional) + */ + transportadora?: string; + /** + * Data da entrega (optional) */ - hotSiteId?: number; - }[]; - }; - }; - /** @description Insere um range de cep em uma Loja Física */ - "POST /lojasFisicas/:lojaFisicaId/rangeCep": { - body: { - /** - * Nome do range de cep - */ - nome?: string; - /** - * Cep inicial do range. Formato: 00.000-000 - */ - cepInicial?: string; - /** - * Cep final do range. Formato: 00.000-000 - */ - cepFinal?: string; + dataEntrega?: string; + }; }; }; - /** @description Lista de avaliações de produtos */ - "GET /produtos/:identificador/avaliacoes": { + /** @description Atualiza a prioridade de um centro de distribuição */ + "PUT /centrosdistribuicao/:centroDistribuicaoId/prioridade": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. - */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - /** - * Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado'] - */ - status?: "Pendente" | "NaoAprovado" | "Aprovado"; - /** - * Página da lista (padrão: 1) + * (optional) */ - pagina?: number; + incrementoOrdem?: number; /** - * Quantidade de registros que deverão retornar (max: 50) + * (optional) */ - quantidadeRegistros?: number; + desativarPriorizacao?: boolean; }; - response: { - produtoVarianteId?: number; - sku?: string; - produtoAvaliacaoId?: number; - comentario?: string; - avaliacao?: number; - usuarioId?: number; - dataAvaliacao?: string; - nome?: string; - email?: string; - status?: string; - }[]; }; - /** @description Atualiza um usuário pelo id */ - "PUT /usuarios/:usuarioId": { - body: { - /** - * Tipo de pessoa - */ - tipoPessoa?: "Fisica" | "Juridica"; - /** - * Origem do contato - */ - origemContato?: - | "Google" - | "Bing" - | "Jornal" - | "PatrocinioEsportivo" - | "RecomendacaoAlguem" - | "Revista" - | "SiteInternet" - | "Televisao" - | "Outro" - | "UsuarioImportadoViaAdmin" - | "PayPalExpress"; - /** - * Tipo Sexo (optional) - */ - tipoSexo?: "Undefined" | "Masculino" | "Feminino"; + /** @description Conteúdos encontrados */ + "GET /conteudos": {}; + /** @description Insere um novo conteúdo na loja */ + "POST /conteudos": { + searchParams: { /** - * Nome do usuário (Max Length: 100) + * Titulo do conteúdo */ - nome?: string; + titulo?: string; /** - * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) + * Conteúdo ativo/inativo */ - cpf?: string; + ativo?: boolean; /** - * E-mail do usuário (Max Length: 100) + * Data de inicio de exibição do conteúdo (optional) */ - email?: string; + dataInicio?: string; /** - * RG do usuário caso seja pessoa física (Max Length: 50) (optional) + * Data final de exibição do conteúdo (optional) */ - rg?: string; + dataFim?: string; /** - * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) + * Posicionamento do conteúdo */ - telefoneResidencial?: string; + posicionamento?: + | { "0": "T"; "1": "o"; "2": "p"; "3": "o" } + | { "0": "C"; "1": "e"; "2": "n"; "3": "t"; "4": "r"; "5": "o" } + | { "0": "R"; "1": "o"; "2": "d"; "3": "a"; "4": "p"; "5": "e" } + | { + "0": "L"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "r"; + "5": "a"; + "6": "l"; + "7": "D"; + "8": "i"; + "9": "r"; + "10": "e"; + "11": "i"; + "12": "t"; + "13": "a"; + } + | { + "0": "L"; + "1": "a"; + "2": "t"; + "3": "e"; + "4": "r"; + "5": "a"; + "6": "l"; + "7": "E"; + "8": "s"; + "9": "q"; + "10": "u"; + "11": "e"; + "12": "r"; + "13": "d"; + "14": "a"; + } + | { + "0": "M"; + "1": "o"; + "2": "b"; + "3": "i"; + "4": "l"; + "5": "e"; + "6": "T"; + "7": "o"; + "8": "p"; + "9": "o"; + } + | { + "0": "M"; + "1": "o"; + "2": "b"; + "3": "i"; + "4": "l"; + "5": "e"; + "6": "R"; + "7": "o"; + "8": "d"; + "9": "a"; + "10": "p"; + "11": "e"; + }; /** - * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) + * Informações do conteúdo */ - telefoneCelular?: string; + conteudo?: string; /** - * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) + * Insira em qual Termo de Busca o Conteúdo será exibido (optional) */ - telefoneComercial?: string; + termoBusca?: string; /** - * Data de nascimento (optional) + * Exibição do conteúdo nas buscas */ - dataNascimento?: string; + exibeTodasBuscas?: boolean; /** - * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) + * Não exibição do conteúdo nas buscas */ - razaoSocial?: string; + naoExibeBuscas?: boolean; /** - * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + * Exibição do conteúdo nos hotsites */ - cnpj?: string; + exibeTodosHotsites?: boolean; /** - * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + * Insira quais Hotsites que o Conteúdo será exibido (optional) */ - inscricaoEstadual?: string; + hotsitesId?: number[]; + }; + }; + /** @description Atualiza a imagem de estampa do produto */ + "PUT /produtos/:identificador/imagens/estampa": { + searchParams: { /** - * Responsável(Max Length: 100) (optional) + * Id da imagem que será marcada como estampa */ - responsavel?: string; + idImagem?: number; + }; + }; + /** @description Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página) */ + "GET /usuarios/newsletter": {}; + /** @description Ativa ou desativa um endereço de um usuário com base no e-mail do usuário */ + "PUT /usuarios/:email/enderecos/:enderecoId/ativar": { + searchParams: { /** - * Data de criação do cadastro (optional) + * Status do endereço */ - dataCriacao?: string; + status?: boolean; + }; + }; + /** @description Insere uma avaliação para um produto variante */ + "POST /produtoavaliacao/:identificador": { + searchParams: { /** - * Data de atualização do cadastro (optional) + * Texto referente a avaliação do produto */ - dataAtualizacao?: string; + comentario?: string; /** - * Se o usuário é revendedor (optional) + * Escala de 1 a 5 para avaliar o produto */ - revendedor?: boolean; + avaliacao?: number; /** - * Informação cadastral (optional) + * Identificado do usuário */ - listaInformacaoCadastral?: { - /** - * Chave - */ - chave?: string; - /** - * Valor - */ - valor?: string; - }[]; + usuarioId?: number; /** - * Avatar (Max Length: 50) (optional) + * Referente a data que a avaliação foi criada */ - avatar?: string; + dataAvaliacao?: string; /** - * IP do usuário (Max Length: 20) (optional) + * Nome do usuário que avaliou */ - ip?: string; + nome?: string; /** - * Seta ou retorna o valor de Aprovado (optional) + * Email do usuário que avaliou */ - aprovado?: boolean; - }; - }; - /** @description Lista de observações de um pedido */ - "GET /pedidos/:pedidoId/observacao": { - response: { - observacao?: string; - usuario?: string; - publica?: boolean; - data?: string; - }[]; - }; - /** @description Tabela de preços específica */ - "GET /tabelaPrecos/:tabelaPrecoId": { - response: { - tabelaPrecoId?: number; - nome?: string; - dataInicial?: string; - dataFinal?: string; - ativo?: boolean; - isSite?: boolean; - }; - }; - /** @description Liberar reservas de pedidos */ - "POST /pedidos/liberarReservas": { - body: { + email?: string; /** - * Números dos pedidos que se deseja buscar + * Referente ao status que libera a visualização da avaliação no site */ - RAW_BODY: number[]; + status?: + | { + "0": "P"; + "1": "e"; + "2": "n"; + "3": "d"; + "4": "e"; + "5": "n"; + "6": "t"; + "7": "e"; + } + | { + "0": "N"; + "1": "a"; + "2": "o"; + "3": "A"; + "4": "p"; + "5": "r"; + "6": "o"; + "7": "v"; + "8": "a"; + "9": "d"; + "10": "o"; + } + | { + "0": "A"; + "1": "p"; + "2": "r"; + "3": "o"; + "4": "v"; + "5": "a"; + "6": "d"; + "7": "o"; + }; }; }; - /** @description Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição */ - "PUT /produtos/precos/lote": { - body: { + /** @description Relatório de receitas de um determinado período */ + "GET /dashboard/receita": {}; + /** @description Lista de fretes */ + "GET /fretes": {}; + /** @description Insere um novo contrato de frete */ + "POST /fretes": { + searchParams: { /** - * Lista com os dados da atualização do preço por lote + * Nome do contrato de frete (optional) */ - RAW_BODY: { - /** - * Identificador do produto (SKU) - */ - sku?: string; - /** - * Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional) - */ - precoCusto?: number; - /** - * "PrecoDe" do produto variante - */ - precoDe?: number; - /** - * "PrecoPor" do produto variante - */ - precoPor?: number; - /** - * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) - */ - fatorMultiplicadorPreco?: number; - }[]; - }; - response: { - produtosNaoAtualizados?: { - produtoVarianteId?: number; - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - produtosAtualizados?: { - produtoVarianteId?: number; - sku?: string; - resultado?: boolean; - detalhes?: string; - }[]; - }; - }; - /** @description Deleta o vinculo de um ou mais hotsites com um banner específico */ - "DELETE /banners/:bannerId/hotsites": { - body: { + nome?: string; /** - * Lista de identificadores de hotsites para desvincular do banner (optional) + * Status do contrato de frete (optional) */ - listaHotsites?: { - /** - * Id do hotsite para vinculo com banner - */ - hotSiteId?: { - /** - * Id do hotsite para vinculo com banner - */ - hotSiteId?: unknown[]; - }[]; - }; - }; - }; - /** @description Atualiza a exibição do banner em parceiros, se deve ser em todos ou não */ - "PUT /banners/:bannerId/Parceiros": { - body: { + ativo?: boolean; /** - * Exibição do banner em parceiros + * Volume máximo permitido , em metro cúbico (m³). (optional) */ - exibirEmTodosParceiros?: boolean; - }; - }; - /** @description Atualiza um SEO de um produto específico */ - "PUT /produtos/:identificador/seo": { - searchParams: { + volumeMaximo?: number; /** - * Define se o identificador informado é um sku ou um id interno + * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) */ - tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; - }; - body: { + pesoCubado?: number; /** - * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) + * Id da configuração entrega agendada (optional) */ - tagCanonical?: string; + entregaAgendadaConfiguracaoId?: number; /** - * Informe o title da página do produto (optional) + * URL rastreamento (optional) */ - title?: string; + linkRastreamento?: string; /** - * Informe os dados da Meta Tag (optional) + * Contrato é exclusivo assinatura (optional) */ - metaTags?: { - /** - * Dados da Meta Tag - */ - content?: string; - /** - * Dados da Meta Tag - */ - httpEquiv?: string; - /** - * Dados da Meta Tag - */ - name?: string; - /** - * Dados da Meta Tag - */ - scheme?: string; - }[]; - }; - }; - /** @description Retorna lista contendo os Id's dos pedidos do usuário */ - "GET /usuarios/documento/:documento/pedidos": { - searchParams: { + ehAssinatura?: boolean; /** - * Define se o documento informado é um CPF ou um CNPJ + * Informe a largura máxima, em centímetros (cm). (optional) */ - tipoDocumento?: "Cpf" | "Cnpj"; - }; - response: { - pedidoId?: number; - links?: { - href?: string; - rel?: string; - method?: string; - }[]; - }[]; - }; - /** @description Objeto com o precoDe e precoPor de um produto variante */ - "GET /produtos/:identificador/preco": { - searchParams: { + larguraMaxima?: number; /** - * Define se o identificador informado é um sku ou um id interno. + * Informe a altura máxima, em centímetros (cm). (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - response: { - precoDe?: number; - precoPor?: number; - fatorMultiplicadorPreco?: number; - }; - }; - /** @description Adiciona novos Atacarejos */ - "POST /produtos/:identificador/atacarejo": { - searchParams: { + alturaMaxima?: number; /** - * Define se o identificador informado é um sku ou um id interno. + * Informe o comprimento máximo, em centímetros (cm). (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + comprimentoMaximo?: number; /** - * Lista de Atacarejos (optional) + * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) */ - RAW_BODY: { - /** - * Preço atacado - */ - precoAtacado?: number; - /** - * Quantidade do produto - */ - quantidade?: number; - }[]; - }; - response: { - produtoVarianteAtacadoId?: number; - precoAtacado?: number; - quantidade?: number; - }[]; - }; - /** @description Objeto do hotsite */ - "GET /hotsites/:hotsiteId": { - response: { - hotsiteId?: number; - nome?: string; - ativo?: boolean; - template?: string; - dataCriacao?: string; - dataInicio?: string; - dataFinal?: string; - url?: string; - tamanhoPagina?: number; - templateId?: number; - ordenacao?: string; - listaProdutos?: { - expressao?: string; - produtos?: { - produtoId?: number; - ordem?: number; - }[]; - }; - seo?: { - seoHotsiteId?: number; - hotsiteId?: number; - titulo?: string; - metas?: { - conteudo?: string; - nome?: string; - httpEquiv?: string; - scheme?: string; - }[]; - }; - banners?: { - bannerId?: number; - }[]; - conteudos?: { - conteudoId?: number; - }[]; - }; - }; - /** @description Adiciona uma nova imagem vinculada a um produto */ - "POST /produtos/:identificador/imagens": { - searchParams: { + limiteMaximoDimensoes?: number; /** - * Define se o identificador informado é um sku ou um id interno. + * Informe o limite de peso cubado, em gramas (g). (optional) */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + limitePesoCubado?: number; /** - * Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) */ - tipoRetorno?: "ListaIds" | "Booleano"; - }; - body: { + tempoMinimoDespacho?: number; /** - * Lista com as imagens do produto no formato base 64 (optional) + * Informe o Id do centro de distribuição (optional) */ - RAW_BODY: { - /** - * Imagem do produto em base64 - */ - base64?: string; - /** - * JPG ou PNG - */ - formato?: string; - /** - * Se a imagem será apresentada como miniatura - */ - exibirMiniatura?: boolean; - /** - * Se a imagem será apresentada como estampa - */ - estampa?: boolean; - /** - * Ordem para apresentação da imagem - */ - ordem?: number; - }[]; - }; - }; - /** @description Remove o vínculo entre usuário e parceiro */ - "DELETE /usuarios/:email/parceiro": { - body: { + centroDistribuicaoId?: number; /** - * Número identificador do parceiro (Max Length: 4) + * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) */ - parceiroId?: number; + valorMinimoProdutos?: number; }; }; - /** @description Insere um novo parceiro */ - "POST /parceiros": { - body: { + /** @description Detalhes de uma assinatura */ + "GET /assinaturas/:assinaturaId": {}; + /** @description Atualiza a situação de uma assinatura específica */ + "PUT /assinaturas/:assinaturaId": { + searchParams: { /** - * Nome do parceiro + * Id do endereço (optional) */ - nome?: string; + enderecoId?: number; /** - * Id da tabela de preço (optional) + * Id do cartão de crédito do usuário (optional) */ - tabelaPrecoId?: number; + usuarioCartaoCreditoId?: number; /** - * Id do portfolio (optional) + * Período Recorrência (optional) */ - portfolioId?: number; + periodoRecorrencia?: string; /** - * Tipo de escopo + * Situação da Assinatura (optional) */ - tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; + situacaoAssinatura?: + | { "0": "A"; "1": "t"; "2": "i"; "3": "v"; "4": "a" } + | { + "0": "P"; + "1": "a"; + "2": "u"; + "3": "s"; + "4": "a"; + "5": "d"; + "6": "a"; + } + | { + "0": "C"; + "1": "a"; + "2": "n"; + "3": "c"; + "4": "e"; + "5": "l"; + "6": "a"; + "7": "d"; + "8": "a"; + }; /** - * Status do parceiro + * Cupom (optional) */ - ativo?: boolean; + cupom?: string; + }; + }; + /** @description Buscar autor pelo nome */ + "GET /autores/:nomeAutor": {}; + /** @description Lista o conteúdo de uma versão */ + "GET /gestorscripts/scripts/:scriptId/versao/:versaoId/conteudo": {}; + /** @description Altera a data de recorrência de uma assinatura */ + "PUT /assinaturas/:assinaturaId/proximaRecorrencia": { + searchParams: { /** - * Se o parceiro é marketplace (optional) + * Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados) */ - isMarketPlace?: boolean; + proximaRecorrencia?: string; + }; + }; + /** @description Lista de parceiros com pedidos */ + "GET /parceiros/comPedidos": {}; + /** @description Usuário encontrado */ + "GET /usuarios/cnpj/:cnpj": {}; + /** @description Deleta um produto da lista de sugestões de produtos de um tipo de evento */ + "DELETE /tiposEvento/:tipoEventoId/produto/:produtoVarianteId": {}; + /** @description Deleta o vinculo de um produto a um evento */ + "DELETE /eventos/:eventoId/produto/:produtoVarianteId": {}; + /** @description Define uma categoria de um produto como principal */ + "PUT /produtos/:identificador/categoriaPrincipal": { + searchParams: { /** - * Origem (optional) + * Id da categoria */ - origem?: string; + categoriaId?: number; }; }; - /** @description Lista de parceiros vinculados ao banner */ - "GET /banners/:bannerId/parceiros": {}; - /** @description Campo atualizado com sucesso */ - "PUT /usuarios/bloquear": { - body: { + /** @description Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + "PUT /produtos/estoques": { + searchParams: { /** - * Usuários (optional) + * Lista com os dados da atualização do estoque (optional) */ RAW_BODY?: { /** - * E-mail do usuário + * Valor único utilizado para identificar o produto */ - email?: string; + identificador?: string; /** - * Status do usuário + * Prazo de entrega do produto */ - bloqueado?: boolean; + prazoEntrega?: number; + /** + * Lista com os dados da atualização do estoque + */ + listaEstoque?: { + /** + * Estoque físico do produto + */ + estoqueFisico?: number; + /** + * Estoque reservado do produto + */ + estoqueReservado?: number; + /** + * Id do centro de distribuição do estoque do produto + */ + centroDistribuicaoId?: number; + /** + * Id do produto variante + */ + produtoVarianteId?: number; + /** + * Quantidade para ativar o alerta de estoque + */ + alertaEstoque?: number; + }[]; }[]; }; - response: { - usuariosAtualizados?: string[]; - usuariosNaoAtualizados?: string[]; - }; }; - /** @description Frete atualizado com sucesso */ - "PUT /fretes/:freteId/Ativo": { - body: { + /** @description Objeto com o estoque total e o estoque por centro de distribuição de um produto variante */ + "GET /produtos/:identificador/estoque": {}; + /** @description Usuário encontrado */ + "GET /usuarios/usuarioId/:usuarioId": {}; + /** @description Produtos Mais Vendidos */ + "GET /dashboard/produtos": {}; + /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId/parcial": + { + searchParams: { + /** + * Objeto Pedido Rastreamento Produto + */ + RAW_BODY?: { + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de Rastreamento (optional) + */ + urlRastreamento?: string; + }; + }; + }; + /** @description Atualiza o status do banner pelo id */ + "PUT /banners/:bannerId/status": { + searchParams: { /** - * Status para atualização do contrato de frete + * Status para qual deve ir o baner: Ativo (true) ou Inativo (false) */ - ativo?: boolean; + status?: boolean; }; }; - /** @description Atualiza a situação de uma assinatura específica */ - "PUT /assinaturas/:assinaturaId": { - body: { + /** @description Atualiza um endereço de um usuário pelo id do usuário */ + "PUT /usuarios/:usuarioId/enderecos/:enderecoId": { + searchParams: { /** - * Id do endereço (optional) + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ - enderecoId?: number; + nomeEndereco?: string; /** - * Id do cartão de crédito do usuário (optional) + * Nome da rua (Max Length: 500) */ - usuarioCartaoCreditoId?: number; + rua?: string; /** - * Período Recorrência (optional) + * Número do local (Max Length: 50) */ - periodoRecorrencia?: string; + numero?: string; /** - * Situação da Assinatura (optional) + * Complemento (Max Length: 250) (optional) */ - situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; + complemento?: string; /** - * Cupom (optional) + * Referência para a localização do endereço (Max Length: 500) (optional) */ - cupom?: string; + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; }; }; - /** @description Atualiza uma informação de um produto específico */ - "PUT /produtos/:identificador/informacoes/:informacaoId": { + /** @description Lista de avaliações de produtos */ + "GET /produtos/:identificador/avaliacoes": {}; + /** @description Atualiza um usuário pelo id */ + "PUT /usuarios/:usuarioId": { searchParams: { /** - * Define se o identificador informado é um sku ou um id interno. + * Tipo de pessoa */ - tipoIdentificador?: "Sku" | "ProdutoVarianteId"; - }; - body: { + tipoPessoa?: + | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } + | { + "0": "J"; + "1": "u"; + "2": "r"; + "3": "i"; + "4": "d"; + "5": "i"; + "6": "c"; + "7": "a"; + }; /** - * Titulo da informação (optional) + * Origem do contato */ - titulo?: string; + origemContato?: + | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } + | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } + | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } + | { + "0": "P"; + "1": "a"; + "2": "t"; + "3": "r"; + "4": "o"; + "5": "c"; + "6": "i"; + "7": "n"; + "8": "i"; + "9": "o"; + "10": "E"; + "11": "s"; + "12": "p"; + "13": "o"; + "14": "r"; + "15": "t"; + "16": "i"; + "17": "v"; + "18": "o"; + } + | { + "0": "R"; + "1": "e"; + "2": "c"; + "3": "o"; + "4": "m"; + "5": "e"; + "6": "n"; + "7": "d"; + "8": "a"; + "9": "c"; + "10": "a"; + "11": "o"; + "12": "A"; + "13": "l"; + "14": "g"; + "15": "u"; + "16": "e"; + "17": "m"; + } + | { + "0": "R"; + "1": "e"; + "2": "v"; + "3": "i"; + "4": "s"; + "5": "t"; + "6": "a"; + } + | { + "0": "S"; + "1": "i"; + "2": "t"; + "3": "e"; + "4": "I"; + "5": "n"; + "6": "t"; + "7": "e"; + "8": "r"; + "9": "n"; + "10": "e"; + "11": "t"; + } + | { + "0": "T"; + "1": "e"; + "2": "l"; + "3": "e"; + "4": "v"; + "5": "i"; + "6": "s"; + "7": "a"; + "8": "o"; + } + | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } + | { + "0": "U"; + "1": "s"; + "2": "u"; + "3": "a"; + "4": "r"; + "5": "i"; + "6": "o"; + "7": "I"; + "8": "m"; + "9": "p"; + "10": "o"; + "11": "r"; + "12": "t"; + "13": "a"; + "14": "d"; + "15": "o"; + "16": "V"; + "17": "i"; + "18": "a"; + "19": "A"; + "20": "d"; + "21": "m"; + "22": "i"; + "23": "n"; + } + | { + "0": "P"; + "1": "a"; + "2": "y"; + "3": "P"; + "4": "a"; + "5": "l"; + "6": "E"; + "7": "x"; + "8": "p"; + "9": "r"; + "10": "e"; + "11": "s"; + "12": "s"; + }; /** - * Texto da informação (optional) + * Tipo Sexo (optional) */ - texto?: string; + tipoSexo?: + | { + "0": "U"; + "1": "n"; + "2": "d"; + "3": "e"; + "4": "f"; + "5": "i"; + "6": "n"; + "7": "e"; + "8": "d"; + } + | { + "0": "M"; + "1": "a"; + "2": "s"; + "3": "c"; + "4": "u"; + "5": "l"; + "6": "i"; + "7": "n"; + "8": "o"; + } + | { + "0": "F"; + "1": "e"; + "2": "m"; + "3": "i"; + "4": "n"; + "5": "i"; + "6": "n"; + "7": "o"; + }; /** - * Informação se o produto variante está visível no site. + * Nome do usuário (Max Length: 100) */ - exibirSite?: boolean; + nome?: string; /** - * Tipo de informação do produto (optional) + * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) */ - tipoInformacao?: - | "Informacoes" - | "Beneficios" - | "Especificacoes" - | "DadosTecnicos" - | "Composicao" - | "ModoDeUsar" - | "Cuidados" - | "ItensInclusos" - | "Dicas" - | "Video" - | "Descricao" - | "ValorReferente" - | "PopUpReferente" - | "Prescricao" - | "TabelaDeMedidas" - | "Spot" - | "Sinopse" - | "Carrinho"; - }; - }; - /** @description Insere uma nova tabela de preços */ - "POST /tabelaPrecos": { - body: { + cpf?: string; /** - * Nome da tabela de preço + * E-mail do usuário (Max Length: 100) */ - nome?: string; + email?: string; /** - * Data que inicia a tabela de preço + * RG do usuário caso seja pessoa física (Max Length: 50) (optional) */ - dataInicial?: string; + rg?: string; /** - * Data de término da tabela de preço + * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) */ - dataFinal?: string; + telefoneResidencial?: string; /** - * Status da tabela de preço + * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) */ - ativo?: boolean; - }; - }; - /** @description Tipo evento buscado */ - "GET /tiposEvento/:tipoEventoId": { - response: { - tipoEventoId?: number; - nome?: string; - tipoEntrega?: string; - tipoDisponibilizacao?: string; - permitirRemocaoAutomaticaProdutos?: boolean; - corHexTituloInformacoes?: string; - corHexCorpoInformacoes?: string; - numeroAbasInformacoes?: number; - quantidadeDiasParaEventoExpirar?: number; - numeroLocaisEvento?: number; - ativo?: boolean; - disponivel?: boolean; - tipoBeneficiarioFrete?: string; - caminhoLogoEvento?: string; - caminhoSubTemplate?: string; - sugestaoProdutos?: { - tipoEventoId?: number; - produtoVarianteId?: number; - }[]; - }; - }; - /** @description Atualiza um novo Seller no marketplace */ - "PUT /resellers": { - searchParams: { + telefoneCelular?: string; /** - * Valor único utilizado para identificar o seller + * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) */ - resellerId?: number; - }; - body: { + telefoneComercial?: string; /** - * Razão Social/Nome do Reseller + * Data de nascimento (optional) + */ + dataNascimento?: string; + /** + * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) */ razaoSocial?: string; /** - * CNPJ do Seller + * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) */ cnpj?: string; /** - * Inscrição Estadual do Seller + * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) */ inscricaoEstadual?: string; /** - * Seller isento de inscrição estadual - */ - isento?: boolean; - /** - * Email de contato do Seller + * Responsável(Max Length: 100) (optional) */ - email?: string; + responsavel?: string; /** - * Telefone de contato do seller com ddd (xx) xxxx-xxxx + * Data de criação do cadastro (optional) */ - telefone?: string; + dataCriacao?: string; /** - * Tipo de autonomia do vendedor + * Data de atualização do cadastro (optional) */ - tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; + dataAtualizacao?: string; /** - * Seller Ativo + * Se o usuário é revendedor (optional) */ - ativo?: boolean; + revendedor?: boolean; /** - * Se irá ter Split de frete boolean. Default:false + * Informação cadastral (optional) */ - split?: boolean; + listaInformacaoCadastral?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; /** - * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, + * Avatar (Max Length: 50) (optional) */ - buyBox?: boolean; + avatar?: string; /** - * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, + * IP do usuário (Max Length: 20) (optional) */ - ativacaoAutomaticaProdutos?: boolean; + ip?: string; /** - * Cep do Seller (utilizado para o calculo de frete) + * Seta ou retorna o valor de Aprovado (optional) */ - cep?: string; + aprovado?: boolean; }; }; - /** @description Gera um novo pedido para a assinatura */ - "POST /assinaturas/:assinaturaId/pedido": {}; - /** @description Xml com os dados das mídias entre duas datas */ - "GET /midias": { + /** @description Liberar reservas de pedidos */ + "POST /pedidos/liberarReservas": { searchParams: { /** - * Data inicial (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final (aaaa-mm-dd) + * Números dos pedidos que se deseja buscar */ - dataFinal?: string; + RAW_BODY?: number[]; }; }; - /** @description Relatório de ticket médio de um determinado período */ - "GET /dashboard/ticketMedio": { + /** @description Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição */ + "PUT /produtos/precos/lote": { searchParams: { /** - * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) - */ - dataInicial?: string; - /** - * Data final dos pedidos que deverão retornar (aaaa-mm-dd) - */ - dataFinal?: string; - /** - * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + * Lista com os dados da atualização do preço por lote */ - tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; - }; - response: { - tipoAgrupamento?: string; - dados?: { - data?: string; - pedidosCaptados?: number; - pedidosPagos?: number; - pedidosEnviados?: number; - pedidosCancelados?: number; + RAW_BODY?: { + /** + * Identificador do produto (SKU) + */ + sku?: string; + /** + * Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional) + */ + precoCusto?: number; + /** + * "PrecoDe" do produto variante + */ + precoDe?: number; + /** + * "PrecoPor" do produto variante + */ + precoPor?: number; + /** + * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) + */ + fatorMultiplicadorPreco?: number; }[]; }; }; - /** @description Objeto com as cotações de frete */ - "GET /fretes/pedidos/:pedidoId/cotacoes": { + /** @description Atualiza a exibição do banner em parceiros, se deve ser em todos ou não */ + "PUT /banners/:bannerId/Parceiros": { searchParams: { /** - * Força cotação de todos os CD's. + * Exibição do banner em parceiros */ - forcarCotacaoTodosCDs?: boolean; + exibirEmTodosParceiros?: boolean; }; - response: { - id?: string; - nome?: string; - prazo?: number; - tabelaFreteId?: string; - tipo?: string; - valor?: number; - centroDistribuicao?: number; - produtos?: { - produtoVarianteId?: number; - valor?: number; - centroDistribuicaoId?: number; - }[]; - }[]; }; - /** @description Deleta o vinculo de um ou mais parceiros com um banner específico */ - "DELETE /banners/:bannerId/parceiros": { - body: { + /** @description Retorna lista contendo os Id's dos pedidos do usuário */ + "GET /usuarios/documento/:documento/pedidos": {}; + /** @description Objeto com o precoDe e precoPor de um produto variante */ + "GET /produtos/:identificador/preco": {}; + /** @description Campo atualizado com sucesso */ + "PUT /usuarios/bloquear": { + searchParams: { /** - * Lista de identificadores de parceiros para desvincular do banner + * Usuários (optional) */ - listaParceiros?: { + RAW_BODY?: { /** - * Id do parceiro (optional) + * E-mail do usuário */ - parceiroId?: number; + email?: string; + /** + * Status do usuário + */ + bloqueado?: boolean; }[]; }; }; + /** @description Frete atualizado com sucesso */ + "PUT /fretes/:freteId/Ativo": { + searchParams: { + /** + * Status para atualização do contrato de frete + */ + ativo?: boolean; + }; + }; + /** @description Gera um novo pedido para a assinatura */ + "POST /assinaturas/:assinaturaId/pedido": {}; + /** @description Xml com os dados das mídias entre duas datas */ + "GET /midias": {}; + /** @description Relatório de ticket médio de um determinado período */ + "GET /dashboard/ticketMedio": {}; + /** @description Objeto com as cotações de frete */ + "GET /fretes/pedidos/:pedidoId/cotacoes": {}; } diff --git a/wake/utils/openapi/wake.openapi.json b/wake/utils/openapi/wake.openapi.json new file mode 100644 index 000000000..53f2c4e80 --- /dev/null +++ b/wake/utils/openapi/wake.openapi.json @@ -0,0 +1,45132 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/pedidos": { + "get": { + "summary": "Retorna uma listagem com os últimos dez pedidos da loja", + "description": "Últimos Pedidos", + "operationId": "retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"situacaoNome\": \"string\",\n \"data\": \"2022-06-15T13:26:37.804Z\",\n \"dataFormatado\": \"string\",\n \"hora\": \"string\",\n \"valorTotal\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoNome": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-15T13:26:37.804Z" + }, + "dataFormatado": { + "type": "string", + "example": "string" + }, + "hora": { + "type": "string", + "example": "string" + }, + "valorTotal": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}/hotsites": { + "put": { + "summary": "Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não", + "description": "", + "operationId": "atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Id do banner", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Exibição do banner nos hotsites" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca os hotsites vinculados de um banner específico", + "description": "Lista de hotsites vinculados ao banner", + "operationId": "busca-os-hotsites-vinculados-de-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve buscar os hotsites vinculados.", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula hotsites com um banner específico", + "description": "", + "operationId": "vincula-hotsites-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve vincular os hotsites", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "lista de identificadores de hotsites a serem vinculados ao banner", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deleta o vinculo de um ou mais hotsites com um banner específico", + "description": "", + "operationId": "deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve desvincular os hotsites desejados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "listaHotsites": { + "type": "object", + "description": "Lista de identificadores de hotsites para desvincular do banner (optional)", + "properties": { + "hotSiteId": { + "type": "array", + "description": "Id do hotsite para vinculo com banner", + "items": { + "properties": { + "hotSiteId": { + "type": "array", + "description": "Id do hotsite para vinculo com banner", + "default": [] + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/comunicacao": { + "get": { + "summary": "Retorna se o usuário ativou o recebimento de newsletter", + "description": "Retorna se o usuário ativou o recebimento de newsletter", + "operationId": "retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"recebimentoNewsletter\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "recebimentoNewsletter": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza a comunicação de um usuário via newsletter", + "description": "", + "operationId": "atualiza-a-comunicacao-de-um-usuario-via-newsletter", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "recebimentoNewsletter": { + "type": "boolean", + "description": "Novo status da comunicação via new ajuste realisletter" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autores/{autorId}": { + "put": { + "summary": "Atualizar autor", + "description": "", + "operationId": "atualizar-autor", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Autor" + }, + "ativo": { + "type": "boolean", + "description": "Status do autor" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Buscar autor por id", + "description": "", + "operationId": "buscar-autor-por-id", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deletar autor", + "description": "", + "operationId": "deletar-autor", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/pedidos": { + "get": { + "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", + "description": "Retorna lista contendo os Id's dos pedidos do usuário", + "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "string" + }, + "rel": { + "type": "string", + "example": "string" + }, + "method": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/cpf/{cpf}": { + "get": { + "summary": "Retorna um usuário específico pelo cpf", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-cpf", + "parameters": [ + { + "name": "cpf", + "in": "path", + "description": "CPF do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.473Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.473Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.473Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/lojasFisicas/{lojaFisicaId}": { + "get": { + "summary": "Retorna Loja Física pelo Id", + "description": "Loja Física", + "operationId": "retorna-loja-fisica-pelo-id", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ddd": { + "type": "integer", + "example": 0, + "default": 0 + }, + "telefone": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoMaximoRetirada": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "textoComplementar": { + "type": "string", + "example": "string" + }, + "retirarNaLoja": { + "type": "boolean", + "example": true, + "default": true + }, + "latitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "longitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza uma Loja Física", + "description": "", + "operationId": "atualiza-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "description": "Id da loja (optional)", + "format": "int32" + }, + "nome": { + "type": "string", + "description": "Nome da loja (optional)" + }, + "ddd": { + "type": "integer", + "description": "DDD da localidade de destino da loja (optional)", + "format": "int32" + }, + "telefone": { + "type": "string", + "description": "Telefone da loja (optional)" + }, + "email": { + "type": "string", + "description": "E-mail de contato da loja (optional)" + }, + "cep": { + "type": "string", + "description": "CEP do endereço da loja (optional)" + }, + "logradouro": { + "type": "string", + "description": "Logradouro do endereço da loja (optional)" + }, + "numero": { + "type": "string", + "description": "Número de localização do endereço da loja (optional)" + }, + "complemento": { + "type": "string", + "description": "Complemento para localização da loja (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço do loja (optional)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que a loja se encontra (optional)" + }, + "estadoId": { + "type": "integer", + "description": "Id do estado em que a loja se encontra (optional)", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega (optional)", + "format": "int32" + }, + "prazoMaximoRetirada": { + "type": "integer", + "description": "Prazo máximo para retirada (optional)", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Status da loja (optional)" + }, + "valido": { + "type": "boolean", + "description": "Valido (optional)" + }, + "textoComplementar": { + "type": "string", + "description": "Informações complementares da loja (optional)" + }, + "retirarNaLoja": { + "type": "boolean", + "description": "Se a retirada na loja será ativada (optional)" + }, + "latitude": { + "type": "number", + "description": "Latitude (optional)", + "format": "double" + }, + "longitude": { + "type": "number", + "description": "Longitude (optional)", + "format": "double" + }, + "centroDistribuicao": { + "type": "array", + "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Remove uma Loja Física", + "description": "", + "operationId": "remove-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/atributos/{nome}": { + "get": { + "summary": "Retorna um atributo específico", + "description": "Atributo encontrado", + "operationId": "retorna-um-atributo-especifico", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "Selecao" + }, + "tipoExibicao": { + "type": "string", + "example": "Combo" + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um atributo", + "description": "", + "operationId": "atualiza-um-atributo", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do atributo (optional)" + }, + "tipo": { + "type": "string", + "description": "Tipo do atributo (optional)", + "enum": [ + "Selecao", + "Filtro", + "Comparacao", + "Configuracao", + "ExclusivoGoogle" + ] + }, + "tipoExibicao": { + "type": "string", + "description": "Tipo de exibição (optional)", + "enum": [ + "Combo", + "Div", + "DivComCor", + "DivComFotoDoProdutoVariante", + "Javascript" + ] + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do atributo (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deleta um atributo", + "description": "", + "operationId": "deleta-um-atributo", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers": { + "get": { + "summary": "Retorna todos os Sellers da loja", + "description": "Lista de resellers", + "operationId": "retorna-todos-os-sellers-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um novo Seller no marketplace", + "description": "", + "operationId": "insere-um-novo-seller-no-marketplace", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "razaoSocial": { + "type": "string", + "description": "Razão Social/Nome do Reseller" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do Seller" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição Estadual do Seller" + }, + "isento": { + "type": "boolean", + "description": "Seller isento de inscrição estadual" + }, + "email": { + "type": "string", + "description": "Email de contato do Seller" + }, + "telefone": { + "type": "string", + "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" + }, + "tipoAutonomia": { + "type": "string", + "description": "Tipo de autonomia do vendedor", + "enum": [ + "ComAutonomia", + "SemAutonomia" + ] + }, + "ativo": { + "type": "boolean", + "description": "Seller Ativo" + }, + "split": { + "type": "boolean", + "description": "Se irá ter Split de frete boolean. Default:false" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," + }, + "cep": { + "type": "string", + "description": "Cep do Seller (utilizado para o calculo de frete)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um novo Seller no marketplace", + "description": "", + "operationId": "atualiza-um-novo-seller-no-marketplace", + "parameters": [ + { + "name": "resellerId", + "in": "query", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "razaoSocial": { + "type": "string", + "description": "Razão Social/Nome do Reseller" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do Seller" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição Estadual do Seller" + }, + "isento": { + "type": "boolean", + "description": "Seller isento de inscrição estadual" + }, + "email": { + "type": "string", + "description": "Email de contato do Seller" + }, + "telefone": { + "type": "string", + "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" + }, + "tipoAutonomia": { + "type": "string", + "description": "Tipo de autonomia do vendedor", + "enum": [ + "ComAutonomia", + "SemAutonomia" + ] + }, + "ativo": { + "type": "boolean", + "description": "Seller Ativo" + }, + "split": { + "type": "boolean", + "description": "Se irá ter Split de frete boolean. Default:false" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," + }, + "cep": { + "type": "string", + "description": "Cep do Seller (utilizado para o calculo de frete)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/{resellerId}": { + "get": { + "summary": "Retorna um Seller específico da loja", + "description": "Reseller específico", + "operationId": "retorna-um-seller-especifico-da-loja-1", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos": { + "post": { + "summary": "Adiciona novo produto", + "description": "Método que insere um produto na base", + "operationId": "adiciona-novo-produto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idPaiExterno": { + "type": "string", + "description": "Representa o ProdutoId agrupador por variante (optional)" + }, + "idVinculoExterno": { + "type": "string", + "description": "Representa o ParentId agrupador por parent (optional)" + }, + "sku": { + "type": "string", + "description": "(Max Length: 50) Sku do produto" + }, + "nome": { + "type": "string", + "description": "(Max Length: 300) Nome do produto variante" + }, + "nomeProdutoPai": { + "type": "string", + "description": "Nome do produto (pai do variante) (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Tipo de exibição da matriz de atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "contraProposta": { + "type": "boolean", + "description": "Se o produto aceita contra proposta (optional)" + }, + "fabricante": { + "type": "string", + "description": "(Max Length: 100) Nome do fabricante" + }, + "autor": { + "type": "string", + "description": "(Max Length: 500) Nome do autor (optional)" + }, + "editora": { + "type": "string", + "description": "(Max Length: 100) Nome da editora (optional)" + }, + "colecao": { + "type": "string", + "description": "(Max Length: 100) Nome da coleção (optional)" + }, + "genero": { + "type": "string", + "description": "(Max Length: 100) Nome do gênero (optional)" + }, + "precoCusto": { + "type": "number", + "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto variante (optional)", + "format": "int32" + }, + "valido": { + "type": "boolean", + "description": "Define se um produto variante é valido ou não" + }, + "exibirSite": { + "type": "boolean", + "description": "Define se um produto deve ser exibido no site" + }, + "freteGratis": { + "type": "string", + "description": "Define a qual regra de calculo de frete o produto vai pertencer", + "enum": [ + "Sempre", + "Nunca", + "Neutro", + "Desconsiderar_Regras" + ] + }, + "trocaGratis": { + "type": "boolean", + "description": "Define se o produto variante tem troca grátis (optional)" + }, + "peso": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g).", + "format": "double" + }, + "altura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", + "format": "double" + }, + "comprimento": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", + "format": "double" + }, + "largura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", + "format": "double" + }, + "garantia": { + "type": "integer", + "description": "Define se o produto variante tem garantia (optional)", + "format": "int32" + }, + "isTelevendas": { + "type": "boolean", + "description": "Define se o produto contém televendas (optional)" + }, + "ean": { + "type": "string", + "description": "(Max Length: 25) EAN do produto variante (optional)" + }, + "localizacaoEstoque": { + "type": "string", + "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" + }, + "listaAtacado": { + "type": "array", + "description": "Dados de atacado do produto variante (optional)", + "items": { + "properties": { + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade para compra de atacado", + "format": "int32" + } + }, + "type": "object" + } + }, + "estoque": { + "type": "array", + "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + }, + "listaAtributos": { + "type": "array", + "description": "Lista de atributos do produto", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "(Max Length: 100) - Define o nome do atributo" + }, + "valor": { + "type": "string", + "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" + }, + "exibir": { + "type": "boolean", + "description": "Define se o atributo deverá ser exibido" + } + }, + "type": "object" + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Quantidade máxima de compra do produto variante (optional)", + "format": "int32" + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "description": "Quantidade mínima de compra do produto variante (optional)", + "format": "int32" + }, + "condicao": { + "type": "string", + "description": "Condição do produto variante (optional)", + "enum": [ + "Novo", + "Usado", + "Renovado", + "Danificado" + ] + }, + "urlVideo": { + "type": "string", + "description": "Url do vídeo do Produto (optional)" + }, + "spot": { + "type": "boolean", + "description": "Se o produto aparece no Spot (optional)" + }, + "paginaProduto": { + "type": "boolean", + "description": "Se o produto aparece na Url (optional)" + }, + "marketplace": { + "type": "boolean", + "description": "Se o produto aparece no Marketplace (optional)" + }, + "somenteParceiros": { + "type": "boolean", + "description": "Se o produto aparece somente nos Parceiros (optional)" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deve ser agrupado pelo EAN (optional)" + }, + "prazoValidade": { + "type": "integer", + "description": "Prazo de validade ou consumo do produto (optional)", + "format": "int32" + }, + "consumo": { + "type": "object", + "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail.", + "properties": { + "quantidadeDias": { + "type": "integer", + "description": "Quantidade de Dias (optional)", + "format": "int32" + }, + "enviarEmail": { + "type": "boolean", + "description": "Enviar e-mail (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do produto variante gerado": { + "value": "Id do produto variante gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todos os produtos", + "description": "Lista de produtos", + "operationId": "retorna-todos-os-produtos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "categorias", + "in": "query", + "description": "Lista de categorias que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as categorias", + "schema": { + "type": "string" + } + }, + { + "name": "fabricantes", + "in": "query", + "description": "Lista de fabricantes que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "centrosDistribuicao", + "in": "query", + "description": "Lista de centros de distribuição que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará produtos de todos os cd's", + "schema": { + "type": "string" + } + }, + { + "name": "alteradosPartirDe", + "in": "query", + "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "somenteValidos", + "in": "query", + "description": "Retorna apenas os produtos que estão marcados como válido", + "schema": { + "type": "boolean" + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.472Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.472Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}\n ]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.472Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.472Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "consumo": { + "type": "object", + "properties": { + "quantidadeDias": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enviarEmail": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "prazoValidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tabelaPrecos/{tabelaPrecoId}/{sku}": { + "delete": { + "summary": "Remove um produto de uma tabela de preço", + "description": "", + "operationId": "remove-um-produto-de-uma-tabela-de-preco", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "sku", + "in": "path", + "description": "SKU do produto", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/changeseller": { + "put": { + "summary": "Atualiza o frete de todos os produtos de um pedido", + "description": "", + "operationId": "atualiza-o-frete-de-todos-os-produtos-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados de cotação e responsável", + "properties": { + "cotacao": { + "type": "string", + "description": "ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes" + }, + "responsavel": { + "type": "string", + "description": "Responsável pela cotação" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}": { + "get": { + "summary": "Buscar banner por Id", + "description": "Objeto do banner", + "operationId": "buscar-banner-por-id", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve ser buscado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-10T13:20:59.150Z\",\n \"dataFim\": \"2022-06-10T13:20:59.150Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-10T13:20:59.150Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-10T13:20:59.150Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhe": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlBanner": { + "type": "string", + "example": "string" + }, + "imagemBanner": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "base64": { + "type": "string", + "example": "string" + }, + "formato": { + "type": "string", + "example": "PNG" + } + } + }, + "ordemExibicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "abrirBannerNovaAba": { + "type": "boolean", + "example": true, + "default": true + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "title": { + "type": "string", + "example": "string" + }, + "urlClique": { + "type": "string", + "example": "string" + }, + "urlBannerAlternativo": { + "type": "string", + "example": "string" + }, + "titleAlternativo": { + "type": "string", + "example": "string" + }, + "diasExibicao": { + "type": "object", + "properties": { + "todosDias": { + "type": "boolean", + "example": true, + "default": true + }, + "domingo": { + "type": "boolean", + "example": true, + "default": true + }, + "segunda": { + "type": "boolean", + "example": true, + "default": true + }, + "terca": { + "type": "boolean", + "example": true, + "default": true + }, + "quarta": { + "type": "boolean", + "example": true, + "default": true + }, + "quinta": { + "type": "boolean", + "example": true, + "default": true + }, + "sexta": { + "type": "boolean", + "example": true, + "default": true + }, + "sabado": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "textoAlternativo": { + "type": "string", + "example": "string" + } + } + }, + "apresentacao": { + "type": "object", + "properties": { + "exibirNoSite": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibirEmBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "termosBusca": { + "type": "string", + "example": "string" + }, + "listaHotsites": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "example": true, + "default": true + }, + "listaParceiros": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "parceiros": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deleta um banner existente", + "description": "", + "operationId": "deleta-um-banner-existente", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve ser deletado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um banner existente", + "description": "", + "operationId": "atualiza-um-banner-existente", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do banner" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do banner", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de termino de exibição do banner (optional)", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Banner ativo/inativo (optional)" + }, + "detalhe": { + "type": "object", + "description": "Detalhes do banner", + "properties": { + "posicionamentoId": { + "type": "integer", + "description": "Local de posicionamento do banner", + "format": "int32" + }, + "imagemBanner": { + "type": "object", + "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + }, + "urlBanner": { + "type": "string", + "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" + }, + "ordemExibicao": { + "type": "integer", + "description": "Ordem de exibição do banner (optional)", + "format": "int32" + }, + "abrirLinkNovaAba": { + "type": "boolean", + "description": "Se o banner deve ou não abrir em nova aba (optional)" + }, + "largura": { + "type": "integer", + "description": "Largura do banner em pixels (optional)", + "format": "int32" + }, + "altura": { + "type": "integer", + "description": "Altura do banner em pixels (optional)", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Title da imagem do banner (optional)" + }, + "urlClique": { + "type": "string", + "description": "Url de destino para quando o usuário clicar no Banner (optional)" + }, + "urlBannerAlternativo": { + "type": "string", + "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" + }, + "textoAlternativo": { + "type": "string", + "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" + } + } + }, + "diasExibicao": { + "type": "object", + "description": "Dias da semana que o banner deverá ser exibido (optional)", + "properties": { + "todosDias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" + }, + "domingo": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no domingo" + }, + "segunda": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na segunda" + }, + "terca": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na terça" + }, + "quarta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quarta" + }, + "quinta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quinta" + }, + "sexta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na sexta" + }, + "sabado": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no sábado" + } + } + }, + "apresentacao": { + "type": "object", + "description": "Apresentação do banner (optional)", + "properties": { + "exibirNoSite": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todo o site" + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas as buscas" + }, + "naoExibirEmBuscas": { + "type": "boolean", + "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "termosBusca": { + "type": "string", + "description": "Termos que o banner será exibido na busca" + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "listaHotsites": { + "type": "object", + "description": "Em quais hotsites o banner deve ser exibido", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" + }, + "hotsites": { + "type": "array", + "description": "Lista de hotsite's que o banner será exibido", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + }, + "listaParceiros": { + "type": "object", + "description": "Em quais parceiros o banner deve ser exibido", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" + }, + "parceiros": { + "type": "array", + "description": "Lista de parceiros que o banner será exibido", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/produtos/{assinaturaProdutoId}/Alterar": { + "put": { + "summary": "Atualiza um produto em uma assinatura", + "description": "", + "operationId": "atualiza-um-produto-em-uma-assinatura", + "parameters": [ + { + "name": "assinaturaProdutoId", + "in": "path", + "description": "Id do Produto dentro de uma assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "number", + "description": "Novo valor do produto na assinatura (optional)", + "format": "double" + }, + "removido": { + "type": "boolean", + "description": "Se o produto será considerado removido ou não da assinatura (optional)" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto na assinatura (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Produto foi alterado na assinatura": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros/{parceiroId}": { + "get": { + "summary": "Retorna o parceiro pelo id", + "description": "Parceiro encontrado", + "operationId": "retorna-o-parceiro-pelo-id", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Exclui um parceiro", + "description": "Parceiro excluído com sucesso", + "operationId": "exclui-um-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um parceiro", + "description": "Parceiro atualizado com sucesso", + "operationId": "atualiza-um-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro" + }, + "tabelaPrecoId": { + "type": "integer", + "description": "Id da tabela de preço (optional)", + "format": "int32" + }, + "portfolioId": { + "type": "integer", + "description": "Id do portfolio (optional)", + "format": "int32" + }, + "tipoEscopo": { + "type": "string", + "description": "Tipo de escopo", + "enum": [ + "Aberto\"", + "Fechado", + "PorCliente" + ] + }, + "ativo": { + "type": "boolean", + "description": "Status do parceiro" + }, + "isMarketPlace": { + "type": "boolean", + "description": "Se o parceiro é marketplace (optional)" + }, + "origem": { + "type": "string", + "description": "Origem (optional)" + }, + "alias": { + "type": "string", + "description": "alias (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "[\n {\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros": { + "get": { + "summary": "Retorna todos os parceiros", + "description": "Lista de parceiros", + "operationId": "retorna-todos-os-parceiros", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um novo parceiro", + "description": "", + "operationId": "insere-um-novo-parceiro", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro" + }, + "tabelaPrecoId": { + "type": "integer", + "description": "Id da tabela de preço (optional)", + "format": "int32" + }, + "portfolioId": { + "type": "integer", + "description": "Id do portfolio (optional)", + "format": "int32" + }, + "tipoEscopo": { + "type": "string", + "description": "Tipo de escopo", + "enum": [ + "Aberto\"", + "Fechado", + "PorCliente" + ] + }, + "ativo": { + "type": "boolean", + "description": "Status do parceiro" + }, + "isMarketPlace": { + "type": "boolean", + "description": "Se o parceiro é marketplace (optional)" + }, + "origem": { + "type": "string", + "description": "Origem (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do parceiro gerado": { + "value": "\tId do parceiro gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tiposEvento": { + "post": { + "summary": "Insere um novo tipo de evento", + "description": "", + "operationId": "insere-um-novo-tipo-de-evento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Tipo de Evento" + }, + "tipoEntrega": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "tipoDisponibilizacao": { + "type": "string", + "description": "Disponibilização do Tipo de Evento", + "enum": [ + "DisponibilizacaoDeCreditos", + "DisponibilizacaoDeProdutos", + "Todos" + ] + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "description": "Permissão para remoção automática de produtos" + }, + "corHexTituloInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o titulo de informações" + }, + "corHexCorpoInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o corpo de informações" + }, + "numeroAbasInformacoes": { + "type": "integer", + "description": "Número de abas de informações, podendo ser de 1 a 2", + "format": "int32" + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "description": "Quantidade de dias para que o evento expire", + "format": "int32" + }, + "numeroLocaisEvento": { + "type": "integer", + "description": "Quantidade de locais do evento", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Informa se o evento está ativo ou inativo" + }, + "disponivel": { + "type": "boolean", + "description": "Informa a disponibilidade do evento" + }, + "tipoBeneficiarioFrete": { + "type": "string", + "description": "O beneficiário do frete", + "enum": [ + "DonodaLista", + "Convidado" + ] + }, + "imagemLogoEvento": { + "type": "string", + "description": "Imagem da logo do evento em base64" + }, + "sugestaoProdutos": { + "type": "array", + "description": "Produtos Sugeridos para este evento (optional)", + "items": { + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Id do tipo de evento", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todos os tipos de eventos", + "description": "Lista de tipos de evento", + "operationId": "retorna-todos-os-tipos-de-eventos", + "parameters": [ + { + "name": "ativo", + "in": "query", + "description": "Status do tipo de evento", + "schema": { + "type": "boolean" + } + }, + { + "name": "disponivel", + "in": "query", + "description": "Se o tipo de evento está disponível", + "schema": { + "type": "boolean" + } + }, + { + "name": "nome", + "in": "query", + "description": "Nome do tipo de evento", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipoEntrega": { + "type": "string", + "example": "EntregaAgendada" + }, + "tipoDisponibilizacao": { + "type": "string", + "example": "DisponibilizacaoDeCreditos" + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "corHexTituloInformacoes": { + "type": "string", + "example": "string" + }, + "corHexCorpoInformacoes": { + "type": "string", + "example": "string" + }, + "numeroAbasInformacoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroLocaisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "tipoBeneficiarioFrete": { + "type": "string", + "example": "DonodaLista" + }, + "caminhoLogoEvento": { + "type": "string", + "example": "string" + }, + "caminhoSubTemplate": { + "type": "string", + "example": "string" + }, + "sugestaoProdutos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/alteracoes": { + "get": { + "summary": "Retorna todos os produtos", + "description": "Lista de preços e estoque de produtos que sofreram alterações", + "operationId": "retorna-todos-os-produtos-1", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "alteradosPartirDe", + "in": "query", + "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"disponivel\": true,\n \"valido\": true,\n \"exibirSite\": true,\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/situacaoReseller": { + "get": { + "summary": "Retorna a situação reseller de um produto", + "description": "", + "operationId": "retorna-a-situacao-reseller-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/atributos": { + "get": { + "summary": "Retorna todos os atributos", + "description": "Lista de atributos", + "operationId": "retorna-todos-os-atributos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "Selecao" + }, + "tipoExibicao": { + "type": "string", + "example": "Combo" + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um novo atributo", + "description": "", + "operationId": "insere-um-novo-atributo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do atributo (optional)" + }, + "tipo": { + "type": "string", + "description": "Tipo do atributo (optional)", + "enum": [ + "Selecao", + "Filtro", + "Comparacao", + "Configuracao", + "ExclusivoGoogle" + ] + }, + "tipoExibicao": { + "type": "string", + "description": "Tipo de exibição (optional)", + "enum": [ + "Combo", + "Div", + "DivComCor", + "DivComFotoDoProdutoVariante", + "Javascript" + ] + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do atributo (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "501": { + "description": "501", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/webhook/inscricao/{inscricaoId}": { + "get": { + "summary": "Busca a inscrição por seu identificador", + "description": "Inscrição", + "operationId": "busca-a-inscricao-por-seu-identificador", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "inscricaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "appUrl": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "emailResponsavel": { + "type": "string", + "example": "string" + }, + "topico": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuario": { + "type": "string", + "example": "string" + }, + "header": { + "type": "array", + "items": { + "type": "object", + "properties": { + "headerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza uma inscrição", + "description": "", + "operationId": "atualiza-uma-inscricao", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "topicos" + ], + "properties": { + "nome": { + "type": "string", + "description": "Nome da inscrição" + }, + "appUrl": { + "type": "string", + "description": "Url para qual deve ser enviada as notificações" + }, + "topicos": { + "type": "array", + "description": "Tópicos em que deseja se inscrever", + "items": { + "type": "string" + } + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a inscrição" + }, + "ativo": { + "type": "boolean", + "description": "Status da inscrição, se ativada ou desativada" + }, + "emailResponsavel": { + "type": "string", + "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" + }, + "headers": { + "type": "array", + "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave do header, por exemplo: 'Authorization'" + }, + "valor": { + "type": "string", + "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/{assinaturaId}/produtos": { + "post": { + "summary": "Insere um novo produto na assinatura", + "description": "", + "operationId": "insere-um-novo-produto-na-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id de uma assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Produto Variante que será incluído na assinatura", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto que será inserido na assinatura", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Produto foi adicionado na assinatura": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna os produtos de uma assinatura específica", + "description": "Produtos de uma assinatura", + "operationId": "retorna-os-produtos-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/categorias/{id}": { + "put": { + "summary": "Atualiza uma categoria", + "description": "", + "operationId": "atualiza-uma-categoria", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Exclui uma categoria", + "description": "", + "operationId": "exclui-uma-categoria", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma categoria específica", + "description": "Categoria encontrada", + "operationId": "retorna-uma-categoria-especifica", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + }, + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/relacionados": { + "get": { + "summary": "Busca os produtos relacionados", + "description": "Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado", + "operationId": "busca-os-produtos-relacionados", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + }, + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"parentId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "parentId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/valoresdefinidoscadastropersonalizado/{valoresDefinidosCampoGrupoInformacaoId}": { + "put": { + "summary": "Atualiza um valor pré definido pelo id", + "description": "", + "operationId": "atualiza-um-valor-pre-definido-pelo-id", + "parameters": [ + { + "name": "valoresDefinidosCampoGrupoInformacaoId", + "in": "path", + "description": "Id dos valores definidos no campo grupo informação", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "string", + "description": "Valor para o campo (optional)" + }, + "ordem": { + "type": "integer", + "description": "Ordem (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Remove um valor pré definido", + "description": "", + "operationId": "remove-um-valor-pre-definido", + "parameters": [ + { + "name": "valoresDefinidosCampoGrupoInformacaoId", + "in": "path", + "description": "Id dos valores definidos no campo grupo informação", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners": { + "post": { + "summary": "Insere um novo banner", + "description": "", + "operationId": "insere-um-novo-banner", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do banner" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do banner", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de termino de exibição do banner (optional)", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Banner ativo/inativo (optional)" + }, + "detalhe": { + "type": "object", + "description": "Detalhes do banner", + "properties": { + "posicionamentoId": { + "type": "integer", + "description": "Local de posicionamento do banner", + "format": "int32" + }, + "imagemBanner": { + "type": "object", + "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + }, + "urlBanner": { + "type": "string", + "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" + }, + "ordemExibicao": { + "type": "integer", + "description": "Ordem de exibição do banner (optional)", + "format": "int32" + }, + "abrirLinkNovaAba": { + "type": "boolean", + "description": "Se o banner deve ou não abrir em nova aba (optional)" + }, + "largura": { + "type": "integer", + "description": "Largura do banner em pixels (optional)", + "format": "int32" + }, + "altura": { + "type": "integer", + "description": "Altura do banner em pixels (optional)", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Title da imagem do banner (optional)" + }, + "urlClique": { + "type": "string", + "description": "Url de destino para quando o usuário clicar no Banner (optional)" + }, + "urlBannerAlternativo": { + "type": "string", + "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" + }, + "textoAlternativo": { + "type": "string", + "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" + } + } + }, + "diasExibicao": { + "type": "object", + "description": "Dias da semana que o banner deverá ser exibido (optional)", + "properties": { + "todosDias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" + }, + "domingo": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no domingo" + }, + "segunda": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na segunda" + }, + "terca": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na terça" + }, + "quarta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quarta" + }, + "quinta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quinta" + }, + "sexta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na sexta" + }, + "sabado": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no sábado" + } + } + }, + "apresentacao": { + "type": "object", + "description": "Detalhes de apresentação do banner (optional)", + "properties": { + "exibirNoSite": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todo o site" + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas as buscas" + }, + "naoExibirEmBuscas": { + "type": "boolean", + "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "termosBusca": { + "type": "string", + "description": "Termos que o banner será exibido na busca" + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "listaHotsites": { + "type": "object", + "description": "Em quais hotsites o banner deve ser exibido", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" + }, + "hotsites": { + "type": "array", + "description": "Lista de hotsite's que o banner será exibido", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + }, + "listaParceiros": { + "type": "object", + "description": "Em quais parceiros o banner deve ser exibido", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" + }, + "parceiros": { + "type": "array", + "description": "Lista de parceiros que o banner será exibido", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca todos banners", + "description": "Lista de banners", + "operationId": "busca-todos-banners", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-13T11:13:55.299Z\",\n \"dataFim\": \"2022-06-13T11:13:55.299Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-13T11:13:55.299Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-13T11:13:55.299Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhe": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlBanner": { + "type": "string", + "example": "string" + }, + "imagemBanner": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "base64": { + "type": "string", + "example": "string" + }, + "formato": { + "type": "string", + "example": "PNG" + } + } + }, + "ordemExibicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "abrirBannerNovaAba": { + "type": "boolean", + "example": true, + "default": true + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "title": { + "type": "string", + "example": "string" + }, + "urlClique": { + "type": "string", + "example": "string" + }, + "urlBannerAlternativo": { + "type": "string", + "example": "string" + }, + "titleAlternativo": { + "type": "string", + "example": "string" + }, + "diasExibicao": { + "type": "object", + "properties": { + "todosDias": { + "type": "boolean", + "example": true, + "default": true + }, + "domingo": { + "type": "boolean", + "example": true, + "default": true + }, + "segunda": { + "type": "boolean", + "example": true, + "default": true + }, + "terca": { + "type": "boolean", + "example": true, + "default": true + }, + "quarta": { + "type": "boolean", + "example": true, + "default": true + }, + "quinta": { + "type": "boolean", + "example": true, + "default": true + }, + "sexta": { + "type": "boolean", + "example": true, + "default": true + }, + "sabado": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "textoAlternativo": { + "type": "string", + "example": "string" + } + } + }, + "apresentacao": { + "type": "object", + "properties": { + "exibirNoSite": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibirEmBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "termosBusca": { + "type": "string", + "example": "string" + }, + "listaHotsites": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "example": true, + "default": true + }, + "listaParceiros": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "parceiros": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/avatar": { + "delete": { + "summary": "Deleta um avatar de um usuário", + "description": "", + "operationId": "deleta-um-avatar-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um novo avatar para o usuário", + "description": "", + "operationId": "insere-um-novo-avatar-para-o-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "base64": { + "type": "string", + "description": "Imagem do avatar em base64 (optional)" + }, + "formato": { + "type": "string", + "description": "Formato da imagem (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Nome do arquivo gerado": { + "value": "{\n \"urlAvatar\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "urlAvatar": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna a url do avatar de um usuário", + "description": "Avatar do usuário encontrado", + "operationId": "retorna-a-url-do-avatar-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"urlAvatar\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "urlAvatar": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fabricantes/{fabricanteId}": { + "delete": { + "summary": "Exclui um fabricante", + "description": "", + "operationId": "exclui-um-fabricante", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna um fabricante específico pelo id", + "description": "Fabricante encontrado", + "operationId": "retorna-um-fabricante-especifico-pelo-id", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um fabricante", + "description": "", + "operationId": "atualiza-um-fabricante", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do fabricante (optional)" + }, + "urlLogoTipo": { + "type": "string", + "description": "URL tipo logo (optional)" + }, + "urlLink": { + "type": "string", + "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" + }, + "urlCarrossel": { + "type": "string", + "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/posicionamentos": { + "get": { + "summary": "Busca os possíveis posicionamentos para o banner", + "description": "Lista de posicionamentos do banner", + "operationId": "busca-os-possiveis-posicionamentos-para-o-banner", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"posicionamentoId\": 0,\n \"descricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/precos": { + "get": { + "summary": "Retorna todos os preços referente ao produto variante, incluindo os preços de tabela de preço", + "description": "Preços do produto variante informado", + "operationId": "retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"precosTabelaPreco\": [\n {\n \"produtoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precosTabelaPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/{resellerId}/autonomia": { + "put": { + "summary": "Atualiza a autonomia de um Seller", + "description": "", + "operationId": "atualiza-a-autonomia-de-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status da autonomia do seller" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/eventos/{eventoId}/produtos": { + "get": { + "summary": "Busca produtos vinculados a um evento", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "busca-produtos-vinculados-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request", + "description": "", + "operationId": "atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtosVariante": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente", + "description": "", + "operationId": "vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtosVariante": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/hotsites/{hotsiteId}/status": { + "put": { + "summary": "Atualiza o status do hotsite, sendo ativo (true) ou inativo (false)", + "description": "", + "operationId": "atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser atualizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status para qual o hotsite indicado deve ir" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autenticacao/login": { + "post": { + "summary": "Realiza a autenticação de usuário no IDM (Identity Manager)", + "description": "Autenticação realizada com sucesso", + "operationId": "realiza-a-autenticacao-de-usuario-no-idm-identity-manager", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "Login do usuário (optional)" + }, + "senha": { + "type": "string", + "description": "Senha do usuário (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "401": { + "description": "401", + "content": { + "application/json": { + "examples": { + "Usuário não autorizado": { + "value": "" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros/{nome}": { + "get": { + "summary": "Retorna o parceiro pelo nome", + "description": "Parceiro encontrado", + "operationId": "retorna-o-parceiro-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do parceiro", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/situacao": { + "put": { + "summary": "Seta status ativo/inativo do produto variante", + "description": "Seta status do produto variante como ativo ou inativo", + "operationId": "seta-status-ativoinativo-do-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Define se o produto variante informado será ativo ou inativo" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/grupospersonalizacao": { + "get": { + "summary": "Retorna uma lista de Grupos de Personalização", + "description": "Lista de Grupos de Personalização", + "operationId": "retorna-uma-lista-de-grupos-de-personalizacao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"grupoPersonalizacaoId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"obrigatorio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoPersonalizacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "obrigatorio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/contascorrentes/{email}": { + "get": { + "summary": "Retorna o saldo de um usuário", + "description": "", + "operationId": "retorna-o-saldo-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Realiza um novo lançamento na conta corrente do cliente", + "description": "", + "operationId": "realiza-um-novo-lancamento-na-conta-corrente-do-cliente", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "number", + "description": "Valor da conta corrente (optional)", + "format": "double" + }, + "tipoLancamento": { + "type": "string", + "description": "Tipo de Lançamento (optional)", + "enum": [ + "Credito", + "Debito" + ] + }, + "observacao": { + "type": "string", + "description": "Observação (optional)" + }, + "visivelParaCliente": { + "type": "boolean", + "description": "Se será visível para o cliente (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da conta corrente gerada": { + "value": "\tId da conta corrente gerada" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/produtos/{identificador}": { + "get": { + "summary": "Retorna produtos por Seller", + "description": "Lista de produtos", + "operationId": "retorna-produtos-por-seller", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o reseller", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller", + "schema": { + "type": "string", + "enum": [ + "ResellerId", + "RazaoSocial" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "somenteValidos", + "in": "query", + "description": "Se deve retornar apenas produtos válidos (padrão: false)", + "schema": { + "type": "boolean" + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-18T11:04:10.596Z\",\n \"dataAtualizacao\": \"2022-07-18T11:04:10.596Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-18T11:04:10.596Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-18T11:04:10.596Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/formaPagamento/{formasPagamento}": { + "get": { + "summary": "Retorna uma lista de pedido baseado nas formas de pagamento", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento", + "parameters": [ + { + "name": "formasPagamento", + "in": "path", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3)", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "situacoesPedido", + "in": "query", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.169Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.169Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.169Z\",\n \"ate\": \"2022-06-28T11:18:19.169Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.169Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos": { + "post": { + "summary": "Insere um novo pedido", + "description": "Caso a loja utilize as formas de pagamento do gateway o campo \"formaPagamentoId\" do objeto \"pagamento\" deverá conter o valor \"200\".", + "operationId": "insere-um-novo-pedido", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional)", + "format": "int32" + }, + "carrinhoId": { + "type": "string", + "description": "Id do carrinho que foi utilizado no pedido (optional)" + }, + "situacaoPedidoId": { + "type": "integer", + "description": "Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido", + "format": "int32" + }, + "data": { + "type": "string", + "description": "Data em que o pedido foi realizado", + "format": "date" + }, + "valorTotal": { + "type": "number", + "description": "Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional)", + "format": "double" + }, + "valorJuros": { + "type": "number", + "description": "Informação do juros do pedido", + "format": "double" + }, + "valorDesconto": { + "type": "number", + "description": "Informação de desconto do pedido", + "format": "double" + }, + "usuarioId": { + "type": "integer", + "description": "Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios", + "format": "int32" + }, + "enderecoId": { + "type": "integer", + "description": "Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos", + "format": "int32" + }, + "isMobile": { + "type": "boolean", + "description": "Define se o pedido foi feito através de um dispositivo móvel ou não" + }, + "eventoId": { + "type": "integer", + "description": "Id do evento ao qual o pedido está vinculado (opcional)", + "format": "int32" + }, + "produtos": { + "type": "array", + "description": "Lista contendo os produtos do pedido", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante que está vinculado a esse pedido.", + "format": "int32" + }, + "quantidade": { + "type": "object", + "description": "Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição", + "properties": { + "quantidadeTotal": { + "type": "integer", + "description": "Quantidade por centro de distribuição", + "format": "int32" + }, + "quantidadePorCentroDeDistribuicao": { + "type": "array", + "description": "Quantidade (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "precoVenda": { + "type": "number", + "description": "Preço de venda do produto, sem adição ou subtração de valores.", + "format": "double" + }, + "isBrinde": { + "type": "boolean", + "description": "Define se esse produto é um brinde ou não" + }, + "ajustes": { + "type": "array", + "description": "Lista contendo todos os ajustes de preço do produto", + "items": { + "properties": { + "tipo": { + "type": "string", + "description": "Define o tipo do ajuste de valor de um produto contido em um pedido. = ['Frete', 'Pricing', 'Atacarejo', 'Personalizacao', 'Embalagem', 'Promocao', 'PromocaoFrete', 'ContaCorrente', 'FormaPagamento', 'PromocaoProduto', 'TipoFreteProduto', 'Formula']stringEnum:\"Frete\", \"Pricing\", \"Atacarejo\", \"Personalizacao\", \"Embalagem\", \"Promocao\", \"PromocaoFrete\", \"ContaCorrente\", \"FormaPagamento\", \"PromocaoProduto\", \"TipoFreteProduto\", \"Formula\"" + }, + "valor": { + "type": "number", + "description": "Define o valor do ajuste a ser aplicado no produto. O valor pode ser positivo ou negativo", + "format": "double" + }, + "observacao": { + "type": "string", + "description": "Observação (optional)" + }, + "nome": { + "type": "string", + "description": "Nome (optional)" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + }, + "fretes": { + "type": "array", + "description": "Informações de frete do pedido", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Identificador do centro de distribuição de origem", + "format": "int32" + }, + "freteContratoId": { + "type": "integer", + "description": "Identificador do contrato de frete (optional)", + "format": "int32" + }, + "peso": { + "type": "number", + "description": "Peso em gramas (g) do frete calculado (optional)", + "format": "double" + }, + "pesoCobrado": { + "type": "number", + "description": "Peso em gramas cobrado do cliente (optional)", + "format": "double" + }, + "volume": { + "type": "number", + "description": "Volume em metro cúbico (m³) calculado (optional)", + "format": "double" + }, + "volumeCobrado": { + "type": "number", + "description": "Volume em metro cúbico (m³) cobrado do cliente (optional)", + "format": "double" + }, + "prazoEnvio": { + "type": "integer", + "description": "Prazo do envio do frete em dias úteis", + "format": "int32" + }, + "valorFreteEmpresa": { + "type": "number", + "description": "Valor do frete (optional)", + "format": "double" + }, + "valorFreteCliente": { + "type": "number", + "description": "Valor do frete cobrado do cliente", + "format": "double" + }, + "dataEntrega": { + "type": "string", + "description": "Data estimada da entrega do produto (optional)", + "format": "date" + }, + "informacoesAdicionais": { + "type": "array", + "description": "Informações adicionais do frete", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + }, + "pagamento": { + "type": "object", + "description": "Informações de pagamento do pedido", + "properties": { + "formaPagamentoId": { + "type": "integer", + "description": "Id da forma de pagamento", + "format": "int32" + }, + "numeroParcelas": { + "type": "integer", + "description": "Número parcelas", + "format": "int32" + }, + "valorParcela": { + "type": "number", + "description": "Valor da parcela", + "format": "double" + }, + "informacaoAdicional": { + "type": "array", + "description": "Informações adicionais de pagamento (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + } + } + }, + "canalId": { + "type": "integer", + "description": "ParceiroId vinculado ao pedido (optional)", + "format": "int32" + }, + "omniChannel": { + "type": "object", + "description": "Dados do pedido no marketplace (optional)", + "properties": { + "pedidoIdPublico": { + "type": "string", + "description": "Id do pedido que o cliente vê no momento que fecha a compra" + }, + "pedidoIdPrivado": { + "type": "string", + "description": "Id interno do marketplace" + }, + "integrador": { + "type": "object", + "description": "Dados do pedido no integrador", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro integrador" + }, + "pedidoId": { + "type": "string", + "description": "Numero do pedido dentro do integrador" + }, + "pedidoUrl": { + "type": "string", + "description": "Url do pedido dentro painel do integrador" + } + } + } + } + }, + "transacaoId": { + "type": "integer", + "description": "Id da transação (optional)", + "format": "int32" + }, + "observacao": { + "type": "string", + "description": "Observação do pedido (optional)" + }, + "valido": { + "type": "boolean", + "description": "Se um pedido é valido (optional)" + }, + "cupomDesconto": { + "type": "string", + "description": "Cupom de desconto (optional)" + }, + "ip": { + "type": "string", + "description": "IP da criação do pedido (optional)" + }, + "usuarioMaster": { + "type": "integer", + "description": "ID do usuário master que realizou o pedido, se houver (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do pedido gerado": { + "value": "Id do pedido gerado" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "situacoesPedido", + "in": "query", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "formasPagamento", + "in": "query", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "email", + "in": "query", + "description": "Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado", + "schema": { + "type": "string" + } + }, + { + "name": "valido", + "in": "query", + "description": "Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado)", + "schema": { + "type": "boolean" + } + }, + { + "name": "sku", + "in": "query", + "description": "Deverá retornar apenas pedidos que o produto de determinado sku foi comprado", + "schema": { + "type": "string" + } + }, + { + "name": "apenasAssinaturas", + "in": "query", + "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.095Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.095Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.095Z\",\n \"ate\": \"2022-06-28T11:18:19.095Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.095Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/portfolios": { + "get": { + "summary": "Retorna todos os portfolios", + "description": "Lista de portfolios", + "operationId": "retorna-todos-os-portfolios", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um novo portfolio", + "description": "", + "operationId": "insere-um-novo-portfolio", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do portfolio" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do portfolio gerado": { + "value": "Id do portfolio gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/imagens": { + "get": { + "summary": "Retorna uma lista de imagens de um produto", + "description": "Lista de imagens vinculadas a um produtos", + "operationId": "retorna-uma-lista-de-imagens-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtosIrmaos", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"idImagem\": 0,\n \"nomeArquivo\": \"string\",\n \"url\": \"string\",\n \"ordem\": 0,\n \"estampa\": true,\n \"exibirMiniatura\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "idImagem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeArquivo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estampa": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMiniatura": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Adiciona uma nova imagem vinculada a um produto", + "description": "", + "operationId": "adiciona-uma-nova-imagem-vinculada-a-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "tipoRetorno", + "in": "query", + "description": "Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", + "schema": { + "type": "string", + "enum": [ + "ListaIds", + "Booleano" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com as imagens do produto no formato base 64 (optional)", + "items": { + "properties": { + "base64": { + "type": "string", + "description": "Imagem do produto em base64" + }, + "formato": { + "type": "string", + "description": "JPG ou PNG" + }, + "exibirMiniatura": { + "type": "boolean", + "description": "Se a imagem será apresentada como miniatura" + }, + "estampa": { + "type": "boolean", + "description": "Se a imagem será apresentada como estampa" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação da imagem", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/limiteCreditoPorUsuarioId/{usuarioId}": { + "get": { + "summary": "Retorna o limite de crédito de um usuário específico", + "description": "Limite de crédito de um usuário específico", + "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/seo": { + "delete": { + "summary": "Deleta o SEO de um produto específico", + "description": "", + "operationId": "deleta-o-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um SEO para um produto específico", + "description": "", + "operationId": "insere-um-seo-para-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" + }, + "title": { + "type": "string", + "description": "Informe o title da página do produto (optional)" + }, + "metaTags": { + "type": "array", + "description": "Informe os dados da Meta Tag (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca o SEO de um produto específico", + "description": "SEO do produto informado", + "operationId": "busca-o-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tagCanonical\": \"string\",\n \"title\": \"string\",\n \"metatags\": [\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "example": "string" + }, + "title": { + "type": "string", + "example": "string" + }, + "metatags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um SEO de um produto específico", + "description": "", + "operationId": "atualiza-um-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" + }, + "title": { + "type": "string", + "description": "Informe o title da página do produto (optional)" + }, + "metaTags": { + "type": "array", + "description": "Informe os dados da Meta Tag (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/parceiro": { + "post": { + "summary": "Adiciona um vínculo entre usuário e parceiro", + "description": "", + "operationId": "adiciona-um-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja vincular", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + }, + "vinculoVitalicio": { + "type": "boolean", + "description": "Vinculo vitalício (optional)" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do vinculo entre usuário e parceiro (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do vinculo entre usuário e parceiro (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Usuário vinculado com o parceiro com sucesso": { + "value": "Usuário vinculado com o parceiro com sucesso" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um vínculo entre usuário e parceiro", + "description": "", + "operationId": "atualiza-um-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja vincular", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vinculoVitalicio": { + "type": "boolean", + "description": "Vinculo vitalício (optional)" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do vinculo entre usuário e parceiro (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do vinculo entre usuário e parceiro (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Remove o vínculo entre usuário e parceiro", + "description": "", + "operationId": "remove-o-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "description": "Número identificador do parceiro (Max Length: 4)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/enderecos": { + "get": { + "summary": "Retorna uma lista de endereços de um usuário pelo e-mail do usuário", + "description": "Retorna usuário encontrado", + "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeEndereco": { + "type": "string", + "example": "string" + }, + "rua": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "utilizadoUltimoPedido": { + "type": "boolean", + "example": true, + "default": true + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um endereço para um usuário pelo e-mail", + "description": "", + "operationId": "insere-um-endereço-para-um-usuario-pelo-e-mail", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/gestorscripts/scripts/{scriptId}": { + "delete": { + "summary": "Exclui um Script", + "description": "", + "operationId": "exclui-um-script", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um script existente", + "description": "", + "operationId": "atualiza-um-script-existente", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do script" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do script", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do script", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Informe se o script está ativo ou não" + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do script", + "format": "int32" + }, + "posicao": { + "type": "string", + "description": "Posição do script", + "enum": [ + "HeaderPrimeiraLinha", + "HeaderUltimaLinha", + "BodyPrimeiraLinha", + "BodyUltimaLinha", + "FooterPrimeiraLinha", + "FooterUltimeLinha" + ] + }, + "tipoPagina": { + "type": "string", + "description": "Tipo da página do script", + "enum": [ + "Todas", + "Home", + "Busca", + "Categoria", + "Fabricante", + "Estaticas", + "Produto", + "Carrinho" + ] + }, + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{usuarioId}/enderecos/{enderecoId}/ativar": { + "put": { + "summary": "Ativa ou desativa um endereço de um usuário com base no id do usuário", + "description": "", + "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status do endereço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/{resellerId}/status": { + "put": { + "summary": "Ativa ou desativa um Seller", + "description": "", + "operationId": "ativa-ou-desativa-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status do seller (ativo / inativo)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { + "delete": { + "summary": "Remove um Atacarejo", + "description": "", + "operationId": "remove-um-atacarejo", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um Atacarejo", + "description": "", + "operationId": "atualiza-um-atacarejo", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "SKU ou Id do Produto Variante", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "precoAtacado": { + "type": "number", + "description": "Preço atacado (optional)", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Resultado da Atualização do Atacarejo": { + "value": "Resultado da Atualização do Atacarejo" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna um Atacarejo pelo Id", + "description": "Atacarejo", + "operationId": "retorna-um-atacarejo-pelo-id", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autores": { + "post": { + "summary": "Inserir autor", + "description": "", + "operationId": "inserir-autor", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Autor" + }, + "ativo": { + "type": "boolean", + "description": "Status do autor" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Buscar todos os autores", + "description": "", + "operationId": "buscar-todos-os-autores", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + } + }, + "deprecated": false + } + }, + "/lojasFisicas/estados": { + "get": { + "summary": "Busca os estados", + "description": "Lista dos estados", + "operationId": "busca-os-estados", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"estadoId\": 0,\n \"nome\": \"string\",\n \"sigla\": \"string\",\n \"regiao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "sigla": { + "type": "string", + "example": "string" + }, + "regiao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}": { + "get": { + "summary": "Retorna um produto buscando pelo seu identificador", + "description": "Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais.", + "operationId": "retorna-um-produto-buscando-pelo-seu-identificador", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "consumo": { + "type": "object", + "properties": { + "quantidadeDias": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enviarEmail": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "prazoValidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "\tProduto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um produto", + "description": "Atualiza um produto com base nos dados enviados", + "operationId": "atualiza-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idPaiExterno": { + "type": "string", + "description": "Representa o ProdutoId agrupador por variante (optional)" + }, + "idVinculoExterno": { + "type": "string", + "description": "Representa o ParentId agrupador por parent (optional)" + }, + "sku": { + "type": "string", + "description": "(Max Length: 50) Sku do produto" + }, + "nome": { + "type": "string", + "description": "(Max Length: 300) Nome do produto variante" + }, + "nomeProdutoPai": { + "type": "string", + "description": "Nome do produto (pai do variante) (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Tipo de exibição da matriz de atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "contraProposta": { + "type": "boolean", + "description": "Se o produto aceita contra proposta (optional)" + }, + "fabricante": { + "type": "string", + "description": "(Max Length: 100) Nome do fabricante" + }, + "autor": { + "type": "string", + "description": "(Max Length: 500) Nome do autor (optional)" + }, + "editora": { + "type": "string", + "description": "(Max Length: 100) Nome da editora (optional)" + }, + "colecao": { + "type": "string", + "description": "(Max Length: 100) Nome da coleção (optional)" + }, + "genero": { + "type": "string", + "description": "(Max Length: 100) Nome do gênero (optional)" + }, + "precoCusto": { + "type": "number", + "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto variante (optional)", + "format": "int32" + }, + "valido": { + "type": "boolean", + "description": "Define se um produto variante é valido ou não (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Define se um produto deve ser exibido no site (optional)" + }, + "freteGratis": { + "type": "string", + "description": "Define a qual regra de calculo de frete o produto vai pertencer", + "enum": [ + "Sempre", + "Nunca", + "Neutro", + "Desconsiderar_Regras" + ] + }, + "trocaGratis": { + "type": "boolean", + "description": "Define se o produto variante tem troca grátis (optional)" + }, + "peso": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g)", + "format": "double" + }, + "altura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", + "format": "double" + }, + "comprimento": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", + "format": "double" + }, + "largura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", + "format": "double" + }, + "garantia": { + "type": "integer", + "description": "Define se o produto variante tem garantia (optional)", + "format": "int32" + }, + "isTelevendas": { + "type": "boolean", + "description": "Define se o produto contém televendas (optional)" + }, + "ean": { + "type": "string", + "description": "(Max Length: 25) EAN do produto variante (optional)" + }, + "localizacaoEstoque": { + "type": "string", + "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" + }, + "listaAtacado": { + "type": "array", + "description": "Dados de atacado do produto variante (optional)", + "items": { + "properties": { + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade para compra de atacado", + "format": "int32" + } + }, + "type": "object" + } + }, + "estoque": { + "type": "array", + "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + }, + "listaAtributos": { + "type": "array", + "description": "Lista de atributos do produto", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "(Max Length: 100) - Define o nome do atributo" + }, + "valor": { + "type": "string", + "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" + }, + "exibir": { + "type": "boolean", + "description": "Define se o atributo deverá ser exibido" + } + }, + "type": "object" + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Quantidade máxima de compra do produto variante (optional)", + "format": "int32" + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "description": "Quantidade mínima de compra do produto variante (optional)", + "format": "int32" + }, + "condicao": { + "type": "string", + "description": "Condição do produto variante (optional)", + "enum": [ + "Novo", + "Usado", + "Renovado", + "Danificado" + ] + }, + "urlVideo": { + "type": "string", + "description": "Url do vídeo do Produto (optional)" + }, + "spot": { + "type": "boolean", + "description": "Se o produto aparece no Spot (optional)" + }, + "paginaProduto": { + "type": "boolean", + "description": "Se o produto aparece na Url (optional)" + }, + "marketplace": { + "type": "boolean", + "description": "Se o produto aparece no Marketplace (optional)" + }, + "somenteParceiros": { + "type": "boolean", + "description": "Se o produto aparece somente nos Parceiros" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deve ser agrupado pelo EAN (optional)" + }, + "prazoValidade": { + "type": "integer", + "description": "Prazo de validade ou consumo do produto (optional)", + "format": "int32" + }, + "consumo": { + "type": "object", + "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional)", + "properties": { + "quantidadeDias": { + "type": "integer", + "description": "Quantidade de Dias (optional)", + "format": "int32" + }, + "enviarEmail": { + "type": "boolean", + "description": "Enviar e-mail (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/gestorscripts/scripts/{scriptId}/versoes": { + "get": { + "summary": "Busca todas as versões de um script", + "description": "Lista de versões", + "operationId": "busca-todas-as-versoes-de-um-script", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"versaoId\": 0,\n \"scriptId\": 0,\n \"dataCadastro\": \"2022-06-23T11:17:57.658Z\",\n \"identificadorPagina\": \"string\",\n \"publicado\": true,\n \"usuario\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "versaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataCadastro": { + "type": "string", + "example": "2022-06-23T11:17:57.658Z" + }, + "identificadorPagina": { + "type": "string", + "example": "string" + }, + "publicado": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere uma versão para um script existente", + "description": "", + "operationId": "insere-uma-versao-para-um-script-existente", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/token": { + "get": { + "summary": "Retorna um Seller específico da loja", + "description": "Reseller específico", + "operationId": "retorna-um-seller-especifico-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/categorias/erp/{id}": { + "put": { + "summary": "Atualiza uma categoria utilizando o id do erp como identificador", + "description": "", + "operationId": "atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Exclui uma categoria utilizando o id do erp como identificador", + "description": "Categoria excluída com sucesso", + "operationId": "exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma categoria específica utilizando o id do erp como identificador", + "description": "Categoria encontrada", + "operationId": "retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + }, + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/templates": { + "get": { + "summary": "Templates", + "description": "", + "operationId": "templates", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios": { + "post": { + "summary": "Insere um novo usuário", + "description": "", + "operationId": "insere-um-novo-usuario", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do usuário gerado": { + "value": "Id do usuário gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todos os usuários", + "description": "Lista de usuários", + "operationId": "retorna-todos-os-usuarios", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro de data", + "schema": { + "type": "string", + "enum": [ + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "aprovado", + "in": "query", + "description": "Status de aprovação", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:16:24.396Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:16:24.396Z\",\n \"dataAtualizacao\": \"2022-07-20T17:16:24.396Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/loja": { + "get": { + "summary": "Retorna dados da loja", + "description": "Dados da loja", + "operationId": "retorna-dados-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"nome\": \"string\",\n \"urlSite\": \"string\",\n \"urlCarrinho\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "urlSite": { + "type": "string", + "example": "string" + }, + "urlCarrinho": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/faturamento": { + "get": { + "summary": "Retorna indicadores de faturamento (receita, ticket médio e número de pedidos) da loja", + "description": "Indicadores de Faturamento", + "operationId": "retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataInicialComparativo", + "in": "query", + "description": "Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalComparativo", + "in": "query", + "description": "Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorReceita\": 0,\n \"indicadorPedido\": 0,\n \"indicadorTicketMedio\": 0,\n \"indicadorReceitaComparativo\": 0,\n \"indicadorPedidoComparativo\": 0,\n \"indicadorTicketMedioComparativo\": 0,\n \"indicadorReceitaFormatado\": \"string\",\n \"indicadorPedidoFormatado\": \"string\",\n \"indicadorTicketMedioFormatado\": \"string\",\n \"indicadorReceitaComparativoFormatado\": \"string\",\n \"indicadorPedidoComparativoFormatado\": \"string\",\n \"indicadorTicketMedioComparativoFormatado\": \"string\",\n \"indicadorReceitaPorcentagem\": \"string\",\n \"indicadorPedidoPorcentagem\": \"string\",\n \"indicadorTicketMedioPorcentagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorReceita": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorTicketMedio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorReceitaComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorPedidoComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorTicketMedioComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorReceitaFormatado": { + "type": "string", + "example": "string" + }, + "indicadorPedidoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioFormatado": { + "type": "string", + "example": "string" + }, + "indicadorReceitaComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorPedidoComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorReceitaPorcentagem": { + "type": "string", + "example": "string" + }, + "indicadorPedidoPorcentagem": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioPorcentagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/grupoassinatura": { + "get": { + "summary": "Retorna os dados de um grupo de assinatura de uma loja", + "description": "Grupo de assinatura", + "operationId": "retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"grupoAssinaturaId\": 0,\n \"nome\": \"string\",\n \"recorrencias\": [\n {\n \"recorrenciaId\": 0,\n \"nome\": \"string\",\n \"dias\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "recorrencias": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recorrenciaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dias": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/rastreamento": { + "get": { + "summary": "Retorna os dados de rastreamento/nf de um pedido", + "description": "Lista de pedidos", + "operationId": "retorna-os-dados-de-rastreamentonf-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoRastreamentoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.200Z\",\n \"notaFiscal\": \"string\",\n \"serieNF\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.200Z\",\n \"urlNFE\": \"string\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.200Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoRastreamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "serieNF": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + }, + "urlNFE": { + "type": "string", + "example": "string" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza a data de entrega do pedido", + "description": "", + "operationId": "atualiza-a-data-de-entrega-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados do rastreamento", + "properties": { + "rastreamento": { + "type": "string", + "description": "Código de verificação do transporte do produto" + }, + "dataEntrega": { + "type": "string", + "description": "Data que a entrega foi realizada" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um rastreamento e status a um pedido", + "description": "", + "operationId": "insere-um-rastreamento-e-status-a-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do Pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "dataEvento": { + "type": "string", + "description": "Data do pedido (optional)", + "format": "date" + }, + "numeroNotaFiscal": { + "type": "string", + "description": "Número da nota fiscal (optional)" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave acesso NFE (optional)" + }, + "urlNFE": { + "type": "string", + "description": "URL NFE (optional)" + }, + "serieNFE": { + "type": "string", + "description": "Serie NFE (optional)" + }, + "cfop": { + "type": "string", + "description": "CFOP (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL Rastreamento (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}": { + "put": { + "summary": "Atualiza rastreamento de produto completo (com os dados da N.F.)", + "description": "", + "operationId": "atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notaFiscal": { + "type": "string", + "description": "Nota Fiscal" + }, + "cfop": { + "type": "integer", + "description": "CFOP", + "format": "int32" + }, + "dataEnviado": { + "type": "string", + "description": "Data Enviado", + "format": "date" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de acesso NFE" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + }, + "transportadora": { + "type": "string", + "description": "Transportadora (optional)" + }, + "dataEntrega": { + "type": "string", + "description": "Data da entrega (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna um rastreamento de produto", + "description": "Rastreamento de produto encontrado", + "operationId": "retorna-um-rastreamento-de-produto", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoRastreamentoProdutoId\": 0,\n \"pedidoId\": 0,\n \"produtoVarianteId\": 0,\n \"pedidoProdutoId\": 0,\n \"dataInclusao\": \"2022-06-28T11:18:19.225Z\",\n \"dataAlteracao\": \"2022-06-28T11:18:19.225Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.225Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"quantidade\": 0,\n \"urlNFE\": \"string\",\n \"serieNFE\": \"string\",\n \"tipoPostagem\": \"string\",\n \"centroDistribuicao\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.225Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoRastreamentoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataInclusao": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "dataAlteracao": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlNFE": { + "type": "string", + "example": "string" + }, + "serieNFE": { + "type": "string", + "example": "string" + }, + "tipoPostagem": { + "type": "string", + "example": "string" + }, + "centroDistribuicao": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes/{freteId}/detalhes": { + "post": { + "summary": "Insere um novo detalhe de frete vinculado a um contrato de frete", + "description": "", + "operationId": "insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cepInicial": { + "type": "integer", + "description": "Informe o cep inicial (optional)", + "format": "int32" + }, + "cepFinal": { + "type": "integer", + "description": "Informe o cep final (optional)", + "format": "int32" + }, + "variacoesFreteDetalhe": { + "type": "array", + "description": "Variações de detalhe do frete (optional)", + "items": { + "properties": { + "pesoInicial": { + "type": "number", + "description": "Informe o peso inicial", + "format": "double" + }, + "pesoFinal": { + "type": "number", + "description": "Informe o peso final", + "format": "double" + }, + "valorFrete": { + "type": "number", + "description": "Informe o valor do frete", + "format": "double" + }, + "prazoEntrega": { + "type": "number", + "description": "Informe o prazo de entrega", + "format": "double" + }, + "valorPreco": { + "type": "number", + "description": "Informe o valor preço", + "format": "double" + }, + "valorPeso": { + "type": "number", + "description": "Informe o valor peso", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Detalhes de frete inserido com sucesso": { + "value": "Detalhes de frete inserido com sucesso" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Exclui os detalhes de um contrato de frete", + "description": "", + "operationId": "exclui-os-detalhes-de-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma lista de detalhes de um contrato de frete", + "description": "Lista de detalhes de frete", + "operationId": "retorna-uma-lista-de-detalhes-de-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"freteId\": 0,\n \"cepInicial\": 0,\n \"cepFinal\": 0,\n \"variacoesFreteDetalhe\": [\n {\n \"pesoInicial\": 0,\n \"pesoFinal\": 0,\n \"valorFrete\": 0,\n \"prazoEntrega\": 0,\n \"valorPreco\": 0,\n \"valorPeso\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cepInicial": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cepFinal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "variacoesFreteDetalhe": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pesoInicial": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoFinal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPeso": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}": { + "get": { + "summary": "Retorna um pedido especifico", + "description": "Pedido encontrado", + "operationId": "retorna-um-pedido-especifico", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-17T11:14:39.010Z\",\n \"dataPagamento\": \"2022-06-17T11:14:39.010Z\",\n \"dataUltimaAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-17T11:14:39.010Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-17T11:14:39.010Z\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-17T11:14:39.011Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-17T11:14:39.011Z\",\n \"ate\": \"2022-06-17T11:14:39.011Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.011Z\",\n \"dataUltimoStatus\": \"2022-06-17T11:14:39.011Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-17T11:14:39.011Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "ate": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/hotsites/{hotsiteId}/conteudos": { + "get": { + "summary": "Busca os conteúdos vinculados a um hotsite específico", + "description": "Lista de identificadores de conteúdos vinculados ao hotsite", + "operationId": "busca-os-conteudos-vinculados-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscados os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"conteudoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Desvincula um ou mais conteúdos de um hotsite específico", + "description": "", + "operationId": "desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser desvinculado os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem desvinculados", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula um ou mais conteúdos a um hotsite específico", + "description": "", + "operationId": "vincula-um-ou-mais-conteudos-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser vinculado os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/camposcadastropersonalizado/{camposcadastropersonalizadoId}": { + "put": { + "summary": "Atualiza um campo de cadastro personalizado pelo id", + "description": "", + "operationId": "atualiza-um-campo-de-cadastro-personalizado-pelo-id", + "parameters": [ + { + "name": "camposcadastropersonalizadoId", + "in": "path", + "description": "Id do campo de cadastro personalizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do campo (optional)" + }, + "obrigatorio": { + "type": "boolean", + "description": "Se o campo será obrigatório (optional)" + }, + "ordem": { + "type": "integer", + "description": "Ordem (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Remove um campo de cadastro personalizado", + "description": "", + "operationId": "remove-um-campo-de-cadastro-personalizado", + "parameters": [ + { + "name": "camposcadastropersonalizadoId", + "in": "path", + "description": "Id do campo de cadastro personalizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/frete": { + "get": { + "summary": "Retorna os detalhes do serviço de frete", + "description": "Dados do serviço de frete do pedido", + "operationId": "retorna-os-detalhes-do-servico-de-frete", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar os dados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tabelaPrecos/{tabelaPrecoId}": { + "put": { + "summary": "Atualiza uma tabela de preços", + "description": "", + "operationId": "atualiza-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da tabela de preço" + }, + "dataInicial": { + "type": "string", + "description": "Data que inicia a tabela de preço", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data de término da tabela de preço", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Status da tabela de preço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Exclui uma tabela de preços", + "description": "", + "operationId": "exclui-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma tabela de preços", + "description": "Tabela de preços específica", + "operationId": "retorna-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.627Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.627Z\",\n \"ativo\": true,\n \"isSite\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicial": { + "type": "string", + "example": "2022-07-19T11:05:47.627Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-07-19T11:05:47.627Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isSite": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/status": { + "put": { + "summary": "Atualiza a situação do status do pedido", + "description": "", + "operationId": "atualiza-a-situacao-do-status-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do Pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Id da situação do pedido", + "properties": { + "id": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna o último status de um pedido", + "description": "Último status do pedido", + "operationId": "retorna-o-ultimo-status-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"situacaoPedidoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.193Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.193Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"nomeTransportadora\": \"string\",\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"situacaoProdutoId\": 0,\n \"quantidade\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.193Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.193Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "nomeTransportadora": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/webhook/Topicos": { + "get": { + "summary": "Busca os tópicos disponíveis para inscrição", + "description": "Lista de Tópicos", + "operationId": "busca-os-topicos-disponiveis-para-inscricao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"payload\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + }, + "payload": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/complete": { + "post": { + "summary": "Seta o pedido como integrado", + "description": "", + "operationId": "seta-o-pedido-como-integrado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Pedido que se deseja inserir o \"complete\"", + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/portfolios/{portfolioId}": { + "delete": { + "summary": "Deleta um portfolio", + "description": "", + "operationId": "deleta-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja excluir", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um portfolio", + "description": "", + "operationId": "atualiza-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do portfolio" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna o portfolio pelo id", + "description": "Portfolio encontrado", + "operationId": "retorna-o-portfolio-pelo-id", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/disponibilidade": { + "get": { + "summary": "Retorna se o produto variante está disponível ou não", + "description": "", + "operationId": "retorna-se-o-produto-variante-esta-disponivel-ou-nao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/formasPagamento": { + "get": { + "summary": "Retorna todas as formas de pagamento da loja", + "description": "Lista de formas de pagamento", + "operationId": "retorna-todas-as-formas-de-pagamento-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"formaPagamentoId\": 0,\n \"nome\": \"string\",\n \"nomeExibicao\": \"string\",\n \"descricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeExibicao": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/rastreamento/produtos": { + "get": { + "summary": "Retorna os dados de rastreamento/nf dos produtos de um pedido", + "description": "Lista de pedidos", + "operationId": "retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"rastreamentos\": [\n {\n \"pedidoRastreamentoProdutoId\": 0,\n \"quantidade\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.238Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.238Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"dataEntrega\": \"2022-06-28T11:18:19.238Z\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "rastreamentos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoRastreamentoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/portfolios/{portfolioId}/status": { + "put": { + "summary": "Altera o status de um portfolio", + "description": "", + "operationId": "altera-o-status-de-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Status do portfolio: true ou false", + "properties": { + "ativo": { + "type": "boolean", + "description": "Novo status do portfolio" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/limiteCredito": { + "get": { + "summary": "Retorna uma lista de usuários com o limite de credito de cada um", + "description": "Limite de crédito que estão vinculados aos usuários", + "operationId": "retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/imagens/{id}": { + "delete": { + "summary": "Exclui uma imagem de um produto", + "description": "", + "operationId": "exclui-uma-imagem-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "id", + "in": "path", + "description": "Id da imagem do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/contascorrentes/{email}/extrato": { + "get": { + "summary": "Busca todas as movimentações de conta corrente de um usuário", + "description": "Extrato retornado com sucesso", + "operationId": "busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data Inicial para verificar extrato", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data Final para verificar extrato", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"data\": \"2022-06-15T13:26:37.748Z\",\n \"historico\": \"string\",\n \"valor\": 0,\n \"tipoLancamento\": \"Credito\",\n \"observacao\": \"string\",\n \"visivelParaCliente\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-15T13:26:37.748Z" + }, + "historico": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoLancamento": { + "type": "string", + "example": "Credito" + }, + "observacao": { + "type": "string", + "example": "string" + }, + "visivelParaCliente": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/observacao": { + "post": { + "summary": "Insere uma observação a um pedido", + "description": "", + "operationId": "inseri-uma-observacao-a-um-pedido-1", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados da observação (optional)", + "properties": { + "observacao": { + "type": "string", + "description": "Texto da observação" + }, + "usuario": { + "type": "string", + "description": "Nome do usuário que está inserindo a observação" + }, + "publica": { + "type": "boolean", + "description": "Se a observação é publica ou privada" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna a observação de um pedido", + "description": "Lista de observações de um pedido", + "operationId": "inseri-uma-observacao-a-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"publica\": true,\n \"data\": \"2022-06-28T11:18:19.263Z\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.263Z" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/centrosdistribuicao": { + "get": { + "summary": "Retorna todos os centros de distribuição", + "description": "Lista de centros de distribuição", + "operationId": "retorna-todos-os-centros-de-distribuicao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"cep\": 0,\n \"padrao\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "integer", + "example": 0, + "default": 0 + }, + "padrao": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtoavaliacao": { + "get": { + "summary": "Retorna todas as avaliações dos produtos variantes da loja", + "description": "Lista de avaliações de produtos", + "operationId": "retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Referente ao status que libera a visualização da avaliação no site", + "schema": { + "type": "string", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-14T19:01:50.098Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoAvaliacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comentario": { + "type": "string", + "example": "string" + }, + "avaliacao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAvaliacao": { + "type": "string", + "example": "2022-07-14T19:01:50.098Z" + }, + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "status": { + "type": "string", + "example": "Pendente" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/conteudos/{conteudoId}": { + "get": { + "summary": "Busca o conteúdo pelo seu id", + "description": "Conteúdo encontrado", + "operationId": "busca-o-conteudo-pelo-seu-id", + "parameters": [ + { + "name": "conteudoId", + "in": "path", + "description": "Identificador do conteúdo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um conteúdo", + "description": "", + "operationId": "atualiza-um-conteudo", + "parameters": [ + { + "name": "conteudoId", + "in": "path", + "description": "Identificador do conteúdo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo do conteúdo" + }, + "ativo": { + "type": "boolean", + "description": "Conteúdo ativo/inativo" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do conteúdo (optional)", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de final de exibição do conteúdo (optional)", + "format": "date" + }, + "posicionamento": { + "type": "string", + "description": "Posicionamento do conteúdo", + "enum": [ + "Topo", + "Centro", + "Rodape", + "LateralDireita", + "LateralEsquerda", + "MobileTopo", + "MobileRodape" + ] + }, + "conteudo": { + "type": "string", + "description": "Informações do conteúdo" + }, + "termoBusca": { + "type": "string", + "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" + }, + "exibeTodasBuscas": { + "type": "boolean", + "description": "Exibição do conteúdo nas buscas" + }, + "naoExibeBuscas": { + "type": "boolean", + "description": "Não exibição do conteúdo nas buscas" + }, + "exibeTodosHotsites": { + "type": "boolean", + "description": "Exibição do conteúdo nos hotsites" + }, + "hotsiteId": { + "type": "array", + "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tiposEvento/{tipoEventoId}/AlterarStatus": { + "put": { + "summary": "Atualiza o status do tipo de evento, ativando-o ou inativando-o", + "description": "", + "operationId": "atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tiposEvento/{tipoEventoId}/produtos": { + "get": { + "summary": "Busca os produtos sugeridos para a lista de evento", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "busca-os-produtos-sugeridos-para-a-lista-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tipoEventoId\": 0,\n \"produtoVariantePrincipalId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVariantePrincipalId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula um ou mais produtos como sugestão para um tipo de evento", + "description": "Lista de resposta para cada produto vinculado", + "operationId": "vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtos": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"sugestaoProdutosInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosNaoInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sugestaoProdutosInseridos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosNaoInseridos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza os produtos sugeridos de um tipo de evento", + "description": "", + "operationId": "atualiza-os-produtos-sugeridos-de-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtos": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/resellers/{resellerId}/ativacaoAutomaticaProdutos": { + "put": { + "summary": "Atualiza a ativação automática de produtos de um Seller", + "description": "", + "operationId": "atualiza-a-ativacao-automatica-de-produtos-de-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status da ativação automática de produtos" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/graficoformapagamento": { + "get": { + "summary": "Retorna dados para alimentar o gráfico forma de pagamento", + "description": "Gráfico Forma de Pagamento", + "operationId": "retorna-dados-para-alimentar-o-grafico-forma-de-pagamento", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"cor\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/naoIntegrados": { + "get": { + "summary": "Busca pedidos que ainda não foram setado o complete", + "description": "Lista de números de pedidos ainda não integrados", + "operationId": "busca-pedidos-que-ainda-nao-foram-setado-o-complete", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{usuarioId}/listaDesejos": { + "get": { + "summary": "Retorna os dados da lista de desejos de um usuário", + "description": "Dados da lista de desejos de um usuário", + "operationId": "retorna-os-dados-da-lista-de-desejos-de-um-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"dataAdicao\": \"2022-07-25T11:26:13.971Z\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAdicao": { + "type": "string", + "example": "2022-07-25T11:26:13.971Z" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros/{nome}/usuarios": { + "get": { + "summary": "Retorna os usuários pelo nome do parceiro", + "description": "Usuários encontrados", + "operationId": "retorna-os-usuarios-pelo-nome-do-parceiro", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do parceiro", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.778Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.778Z\",\n \"vinculoVitalicio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "email": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicial": { + "type": "string", + "example": "2022-06-30T11:24:34.778Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-30T11:24:34.778Z" + }, + "vinculoVitalicio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/novoscompradores": { + "get": { + "summary": "Indicador dos Novos Compradores", + "description": "Indicador dos Novos Compradores", + "operationId": "indicador-dos-novos-compradores", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos novos compradores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorComprador\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorComprador": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/eventos": { + "get": { + "summary": "Retorna lista de eventos", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "retorna-lista-de-eventos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data de inicio do evento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data do termino do evento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "disponivel", + "in": "query", + "description": "Status do evento", + "schema": { + "type": "boolean" + } + }, + { + "name": "titulo", + "in": "query", + "description": "Titulo do evento", + "schema": { + "type": "string" + } + }, + { + "name": "usuarioEmail", + "in": "query", + "description": "Email do Usuário", + "schema": { + "type": "string" + } + }, + { + "name": "tipoEventoId", + "in": "query", + "description": "Identificador do Tipo de Evento", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.747Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.747Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "userId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enderecoEntregaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.747Z" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:38.747Z" + }, + "titulo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "diasDepoisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "diasAntesEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlLogoEvento": { + "type": "string", + "example": "string" + }, + "urlCapaEvento": { + "type": "string", + "example": "string" + }, + "proprietarioEvento": { + "type": "string", + "example": "string" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo01": { + "type": "string", + "example": "string" + }, + "conteudoInfo01": { + "type": "string", + "example": "string" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo02": { + "type": "string", + "example": "string" + }, + "conteudoInfo02": { + "type": "string", + "example": "string" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "fotos": { + "type": "string", + "example": "string" + }, + "enumTipoListaPresenteId": { + "type": "string", + "example": "Default" + }, + "enumTipoEntregaId": { + "type": "string", + "example": "EntregaAgendada" + }, + "eventoProdutoSelecionado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "enderecoEvento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Cria um Novo Evento", + "description": "", + "operationId": "cria-um-novo-evento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Identificador do tipo de evento", + "format": "int32" + }, + "enderecoEntregaId": { + "type": "integer", + "description": "Identificador do endereço de entrega", + "format": "int32" + }, + "titulo": { + "type": "string", + "description": "Titulo do evento" + }, + "url": { + "type": "string", + "description": "URL do evento" + }, + "data": { + "type": "string", + "description": "Data do Evento", + "format": "date" + }, + "usuarioEmail": { + "type": "string", + "description": "Email do usuário" + }, + "disponivel": { + "type": "boolean", + "description": "Disponibilidade do evento (optional)" + }, + "diasAntesEvento": { + "type": "integer", + "description": "Quantos dias antes do evento ele será exibido (optional)", + "format": "int32" + }, + "diasDepoisEvento": { + "type": "integer", + "description": "Até quantos dias depois do evento ele será exibido (optional)", + "format": "int32" + }, + "urlLogo": { + "type": "string", + "description": "Url do Logo. (Base64)" + }, + "urlCapa": { + "type": "string", + "description": "Url da Capa. (Base64)" + }, + "proprietario": { + "type": "string", + "description": "Quem é o proprietário" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 01 será habilitada" + }, + "textoInfo01": { + "type": "string", + "description": "Texto para o campo informação 01 (optional)" + }, + "conteudoInfo01": { + "type": "string", + "description": "Conteúdo para o campo informação 01 (optional)" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 02 será habilitada" + }, + "textoInfo02": { + "type": "string", + "description": "Texto para o campo informação 02 (optional)" + }, + "conteudoInfo02": { + "type": "string", + "description": "Conteúdo para o campo informação 02 (optional)" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "description": "Se a aba de mensagem será habilitada (optional)" + }, + "enumTipoListaPresenteId": { + "type": "string", + "description": "Tipo de lista de presente", + "enum": [ + "ListaPronta", + "ListaManual" + ] + }, + "enumTipoEntregaId": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "eventoProdutoSelecionado": { + "type": "array", + "description": "Seleção de produto no evento", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se produto recebido fora da lista (optional)" + }, + "removido": { + "type": "boolean", + "description": "Se produto removido (optional)" + } + }, + "type": "object" + } + }, + "enderecoEvento": { + "type": "array", + "description": "Endereço do Evento", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "Nome para identificação do endereço" + }, + "endereco": { + "type": "string", + "description": "Endereço" + }, + "cep": { + "type": "string", + "description": "Cep do endereço" + }, + "numero": { + "type": "string", + "description": "Numero do endereço" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço" + }, + "cidade": { + "type": "string", + "description": "Cidade do endereço" + }, + "estado": { + "type": "string", + "description": "Estado do endereço" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/informacoes": { + "get": { + "summary": "Retorna todas as informações de um produto", + "description": "Retorna todas as informações de um produto específico", + "operationId": "retorna-todas-as-informacoes-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Adiciona uma nova informação", + "description": "", + "operationId": "adiciona-uma-nova-informacao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "tipoRetorno", + "in": "query", + "description": "Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", + "schema": { + "type": "string", + "enum": [ + "Id", + "Booleano" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo da informação (optional)" + }, + "texto": { + "type": "string", + "description": "Texto da informação (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Informação se o produto variante está visível no site." + }, + "tipoInformacao": { + "type": "string", + "description": "Tipo de informação do produto (optional)", + "enum": [ + "Informacoes", + "Beneficios", + "Especificacoes", + "DadosTecnicos", + "Composicao", + "ModoDeUsar", + "Cuidados", + "ItensInclusos", + "Dicas", + "Video", + "Descricao", + "ValorReferente", + "PopUpReferente", + "Prescricao", + "TabelaDeMedidas", + "Spot", + "Sinopse", + "Carrinho" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/carrinhoabandonado": { + "get": { + "summary": "Indicador do Carrinho Abandonado", + "description": "Indicador do Carrinho Abandonado", + "operationId": "indicador-do-carrinho-abandonado", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorCarrinhoAbandonado\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorCarrinhoAbandonado": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/seo/metaTag": { + "delete": { + "summary": "Deleta um ou mais Metatags de produto", + "description": "", + "operationId": "deleta-um-ou-mais-metatags-de-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metatags": { + "type": "array", + "description": "Lista de identificadores de metatags (optional)", + "items": { + "properties": { + "metatagId": { + "type": "integer", + "description": "Identificador do MetaTag", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um ou mais metatags para um produto", + "description": "", + "operationId": "insere-um-ou-mais-metatags-para-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metas": { + "type": "array", + "description": "Lista de metatags (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca os metatags de um produto específico", + "description": "Lista de Metatags do produto informado", + "operationId": "busca-os-metatags-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes/{freteId}": { + "get": { + "summary": "Retorna um contrato de frete", + "description": "Frete encontrado", + "operationId": "retorna-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "volumeMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "linkRastreamento": { + "type": "string", + "example": "string" + }, + "ehAssinatura": { + "type": "boolean", + "example": true, + "default": true + }, + "larguraMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alturaMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimentoMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limiteMaximoDimensoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limitePesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tempoMinimoDespacho": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoProdutos": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza um contrato de frete", + "description": "Frete atualizado com sucesso", + "operationId": "atualiza-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do contrato de frete (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Status do contrato de frete (optional)" + }, + "volumeMaximo": { + "type": "integer", + "description": "Volume máximo permitido, em metro cúbico (m³). (optional)", + "format": "int32" + }, + "pesoCubado": { + "type": "number", + "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", + "format": "double" + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "description": "Id da configuração entrega agendada (optional)", + "format": "int32" + }, + "linkRastreamento": { + "type": "string", + "description": "URL rastreamento (optional)" + }, + "ehAssinatura": { + "type": "boolean", + "description": "Contrato é exclusivo assinatura (optional)" + }, + "larguraMaxima": { + "type": "integer", + "description": "Informe a largura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "alturaMaxima": { + "type": "integer", + "description": "Informe a altura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "comprimentoMaximo": { + "type": "integer", + "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", + "format": "int32" + }, + "limiteMaximoDimensoes": { + "type": "integer", + "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", + "format": "int32" + }, + "limitePesoCubado": { + "type": "number", + "description": "Informe o limite de peso cubado, em gramas (g). (optional)", + "format": "double" + }, + "tempoMinimoDespacho": { + "type": "integer", + "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Informe o Id do centro de distribuição (optional)", + "format": "int32" + }, + "valorMinimoProdutos": { + "type": "number", + "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", + "format": "double" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/transacoes": { + "get": { + "summary": "Retorna o relatório de transações de um determinado período", + "description": "Relatório de transações de um determinado período", + "operationId": "retorna-o-relatorio-de-transacoes-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.743Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.743Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tabelaPrecos/{tabelaPrecoId}/produtos": { + "get": { + "summary": "Retorna os produtos de uma tabela de preços", + "description": "Lista de produtos de uma tabela de preços", + "operationId": "retorna-os-produtos-de-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tabelaPrecoProdutoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"sku\": \"string\",\n \"produtoVarianteId\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoProdutoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Inseri uma lista de produto variantes em uma tabela de preços", + "description": "", + "operationId": "inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de produtos variantes", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "SKU do produto" + }, + "precoDe": { + "type": "number", + "description": "Preço De do produto", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "Preço Por do produto", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Lista com o retorno do processamento dos produtos enviados": { + "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sucesso": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "erro": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza uma lista de produto variantes em uma tabela de preços", + "description": "Lista com o retorno do processamento dos produtos enviados", + "operationId": "atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de produtos variantes", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "SKU do produto" + }, + "precoDe": { + "type": "number", + "description": "Preço De do produto", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "Preço Por do produto", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sucesso": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "erro": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/gestorscripts/scripts": { + "post": { + "summary": "Insere um novo script", + "description": "", + "operationId": "insere-um-novo-script", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do script" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do script", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do script", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Informe se o script está ativo ou não" + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do script", + "format": "int32" + }, + "posicao": { + "type": "string", + "description": "Posição do script", + "enum": [ + "HeaderPrimeiraLinha", + "HeaderUltimaLinha", + "BodyPrimeiraLinha", + "BodyUltimaLinha", + "FooterPrimeiraLinha", + "FooterUltimeLinha" + ] + }, + "tipoPagina": { + "type": "string", + "description": "Tipo da página do script", + "enum": [ + "Todas", + "Home", + "Busca", + "Categoria", + "Fabricante", + "Estaticas", + "Produto", + "Carrinho" + ] + }, + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca todos os scripts inseridos", + "description": "Lista de scripts", + "operationId": "busca-todos-os-scripts-inseridos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"scriptId\": 0,\n \"nome\": \"string\",\n \"posicao\": \"HeaderPrimeiraLinha\",\n \"tipoPagina\": \"Todas\",\n \"dataInicial\": \"2022-06-23T11:17:57.626Z\",\n \"datafinal\": \"2022-06-23T11:17:57.626Z\",\n \"ativo\": true,\n \"prioridade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "posicao": { + "type": "string", + "example": "HeaderPrimeiraLinha" + }, + "tipoPagina": { + "type": "string", + "example": "Todas" + }, + "dataInicial": { + "type": "string", + "example": "2022-06-23T11:17:57.626Z" + }, + "datafinal": { + "type": "string", + "example": "2022-06-23T11:17:57.626Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/erros": { + "get": { + "summary": "Retorna as assinaturas com erros", + "description": "Assinaturas com erro na loja", + "operationId": "retorna-as-assinaturas-com-erros", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "resolvidos", + "in": "query", + "description": "Erros já resolvidos ou não", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.560Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes/cotacoes": { + "post": { + "summary": "Realiza uma cotação de frete", + "description": "Método que realiza uma cotação de frete", + "operationId": "realiza-uma-cotacao-de-frete", + "parameters": [ + { + "name": "cep", + "in": "query", + "description": "Cep de entrega", + "schema": { + "type": "string" + } + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "retiradaLoja", + "in": "query", + "description": "Define se deve retornar as opções de retirada em loja (\"False\" por padrão) (optional)", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valorTotal": { + "type": "number", + "description": "Valor total do pedido (optional)", + "format": "double" + }, + "produtos": { + "type": "array", + "description": "Lista de produtos da cotação", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Id do produto variante" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaFreteId": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/lojasFisicas/{lojaFisicaId}/rangeCep": { + "delete": { + "summary": "Remove uma lista de range de cep de uma Loja Física", + "description": "", + "operationId": "remove-uma-lista-de-range-de-cep-de-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de range de cep a serem excluídos da loja física", + "items": { + "properties": { + "rangeCepId": { + "type": "integer", + "description": "Id da faixa de cep a ser deletado", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todos ranges de cep que essa loja atende", + "description": "Lista de Ranges de Ceps de uma Loja Física", + "operationId": "retorna-todos-ranges-de-cep-que-essa-loja-atende", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"rangeCepId\": 0,\n \"nome\": \"string\",\n \"cepInicial\": \"string\",\n \"cepFinal\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rangeCepId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cepInicial": { + "type": "string", + "example": "string" + }, + "cepFinal": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere um range de cep em uma Loja Física", + "description": "", + "operationId": "insere-um-range-de-cep-em-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do range de cep" + }, + "cepInicial": { + "type": "string", + "description": "Cep inicial do range. Formato: 00.000-000" + }, + "cepFinal": { + "type": "string", + "description": "Cep final do range. Formato: 00.000-000" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{usuarioId}/enderecos": { + "post": { + "summary": "Insere um endereço para um usuário pelo id do usuário", + "description": "", + "operationId": "insere-um-endereco-para-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma lista de endereços de um usuário pelo id do usuário", + "description": "Retorna usuário encontrado", + "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeEndereco": { + "type": "string", + "example": "string" + }, + "rua": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "utilizadoUltimoPedido": { + "type": "boolean", + "example": true, + "default": true + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/parceiros": { + "get": { + "summary": "Retorna uma lista de vínculos entre usuário e parceiro", + "description": "", + "operationId": "retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/precos": { + "put": { + "summary": "Atualiza o preço de vários produtos", + "description": "Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", + "operationId": "atualiza-o-preco-de-varios-produtos", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do preço (optional)", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Identificador do produto (ProdutoVarianteId ou SKU)" + }, + "precoCusto": { + "type": "number", + "description": "Preço de custo do produto variante", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "\"PrecoDe\" do produto variante", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "\"PrecoPor\" do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão)", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/email/{email}": { + "get": { + "summary": "Retorna um usuário específico pelo e-mail", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-e-mail", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autenticacao/trocarLoja/{novaLoja}": { + "post": { + "summary": "Troca o usuário de loja e gera um novo access_token para acesso a nova loja", + "description": "Novo token gerado com sucesso", + "operationId": "troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja", + "parameters": [ + { + "name": "novaLoja", + "in": "path", + "description": "Loja para qual o usuário deseja autenticar.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.424Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojas": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "accessToken": { + "type": "string", + "example": "string" + }, + "dataExpiracaoAccessTokenUTC": { + "type": "string", + "example": "2022-06-09T11:21:37.424Z" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/camposcadastropersonalizado": { + "get": { + "summary": "Retorna os campos de cadastro personalizado existentes", + "description": "Campos de cadastro personalizado encontrados", + "operationId": "retorna-os-campos-de-cadastro-personalizado-existentes", + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"grupoInformacaoCadastralId\": 0,\n \"nome\": \"string\",\n \"tipo\": \"TextoLivre\",\n \"obrigatorio\": true,\n \"ordem\": 0,\n \"valorPreDefinido\": [\n {\n \"valoresDefinidosCampoGrupoInformacaoId\": 0,\n \"valor\": \"string\",\n \"ordem\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoInformacaoCadastralId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "TextoLivre" + }, + "obrigatorio": { + "type": "boolean", + "example": true, + "default": true + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPreDefinido": { + "type": "array", + "items": { + "type": "object", + "properties": { + "valoresDefinidosCampoGrupoInformacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "string", + "example": "string" + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/hotsites/{hotsiteId}": { + "put": { + "summary": "Atualiza os dados de um hotsite existente", + "description": "", + "operationId": "atualiza-os-dados-de-um-hotsite-existente", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser atualizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do hotsite" + }, + "dataInicio": { + "type": "string", + "description": "Data/hora em que o hotsite começará a ser exibido (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", + "format": "date" + }, + "url": { + "type": "string", + "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" + }, + "tamanhoPagina": { + "type": "integer", + "description": "Informe o número de produtos que deve ser exibido por página", + "format": "int32" + }, + "templateId": { + "type": "integer", + "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", + "format": "int32" + }, + "ordenacao": { + "type": "string", + "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", + "enum": [ + "Nenhuma", + "NomeCrescente", + "NomeDecrescente", + "Lancamento", + "MenorPreco", + "MaiorPreco", + "MaisVendidos", + "MaioresDescontos", + "Aleatorio", + "MenorEstoque", + "MaiorEstoque" + ] + }, + "listaProdutos": { + "type": "object", + "description": "Produtos que devem aparecer no hotsite", + "properties": { + "expressao": { + "type": "string", + "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" + }, + "produtos": { + "type": "array", + "description": "Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Identificador do produto a ser mostrado no hotsite", + "format": "int32" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação do produto (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "seo": { + "type": "object", + "description": "Dados de seo", + "properties": { + "titulo": { + "type": "string", + "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" + }, + "metas": { + "type": "array", + "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", + "items": { + "properties": { + "conteudo": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "nome": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "httpEquiv": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "scheme": { + "type": "string", + "description": "Informe os dados da Metatag" + } + }, + "type": "object" + } + } + } + }, + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem vinculados ao hotsite", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + }, + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + }, + "ativo": { + "type": "boolean", + "description": "Status do hotsite (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados", + "description": "", + "operationId": "deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser deletado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca um hotsite específico", + "description": "Objeto do hotsite", + "operationId": "busca-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.213Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.213Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.213Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "template": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "url": { + "type": "string", + "example": "string" + }, + "tamanhoPagina": { + "type": "integer", + "example": 0, + "default": 0 + }, + "templateId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordenacao": { + "type": "string", + "example": "Nenhuma" + }, + "listaProdutos": { + "type": "object", + "properties": { + "expressao": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "seo": { + "type": "object", + "properties": { + "seoHotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "metas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "banners": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "conteudos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas": { + "get": { + "summary": "Retorna uma lista com os dados das assinaturas", + "description": "Lista com assinaturas", + "operationId": "retorna-uma-lista-com-os-dados-das-assinaturas", + "parameters": [ + { + "name": "situacaoAssinatura", + "in": "query", + "description": "Situação da assinatura", + "schema": { + "type": "string", + "enum": [ + "Ativa", + "Pausada", + "Cancelada" + ] + } + }, + { + "name": "periodoRecorrencia", + "in": "query", + "description": "Período de recorrência", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "dataInicialProximaRecorrencia", + "in": "query", + "description": "Data inicial da próxima recorrência", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalProximaRecorrencia", + "in": "query", + "description": "Data final da próxima recorrencia", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataInicialCancelamento", + "in": "query", + "description": "Data inicial de cancelamento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalCancelamento", + "in": "query", + "description": "Data final de cancelamento", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.131Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.131Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.131Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.131Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "\t{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/categorias": { + "get": { + "summary": "Retorna todas as categorias", + "description": "Lista de categorias", + "operationId": "retorna-todas-as-categorias", + "parameters": [ + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "apenasReseller", + "in": "query", + "description": "Se será apresentado apenas Reseller", + "schema": { + "type": "boolean" + } + }, + { + "name": "apenasUltimoNivel", + "in": "query", + "description": "Se será apresentado apenas o último nível das categorias", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere uma nova categoria", + "description": "", + "operationId": "insere-uma-nova-categoria", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da categoria gerada": { + "value": "\tId da categoria gerada" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fabricantes": { + "post": { + "summary": "Insere um novo fabricante", + "description": "", + "operationId": "insere-um-novo-fabricante", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do fabricante (optional)" + }, + "urlLogoTipo": { + "type": "string", + "description": "URL tipo logo (optional)" + }, + "urlLink": { + "type": "string", + "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" + }, + "urlCarrossel": { + "type": "string", + "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do fabricante gerado": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todos os fabricantes", + "description": "Lista de fabricantes", + "operationId": "retorna-todos-os-fabricantes", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/eventos/{eventoId}/produtos/recebido": { + "put": { + "summary": "Atualiza o campo Recebido de um produto vinculado a um evento", + "description": "", + "operationId": "atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante (optional)", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se o produto foi recebido fora da lista (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tiposEvento/{tipoEventoId}": { + "put": { + "summary": "Atualiza o tipo evento", + "description": "", + "operationId": "atualiza-o-tipo-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Tipo de Evento" + }, + "tipoEntrega": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "tipoDisponibilizacao": { + "type": "string", + "description": "Disponibilização do Tipo de Evento", + "enum": [ + "DisponibilizacaoDeCreditos", + "DisponibilizacaoDeProdutos", + "Todos" + ] + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "description": "Permissão para remoção automática de produtos" + }, + "corHexTituloInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o titulo de informações" + }, + "corHexCorpoInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o corpo de informações" + }, + "numeroAbasInformacoes": { + "type": "integer", + "description": "Número de abas de informações, podendo ser de 1 a 2", + "format": "int32" + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "description": "Quantidade de dias para que o evento expire", + "format": "int32" + }, + "numeroLocaisEvento": { + "type": "integer", + "description": "Quantidade de locais do evento", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Informa se o evento está ativo ou inativo" + }, + "disponivel": { + "type": "boolean", + "description": "Informa a disponibilidade do evento" + }, + "tipoBeneficiarioFrete": { + "type": "string", + "description": "O beneficiário do frete", + "enum": [ + "DonodaLista", + "Convidado" + ] + }, + "imagemLogoEvento": { + "type": "string", + "description": "Imagem da logo do evento em base64" + }, + "sugestaoProdutos": { + "type": "array", + "description": "Produtos Sugeridos para este evento (optional)", + "items": { + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Id do tipo de evento", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna um tipo de evento especifico", + "description": "Tipo evento buscado", + "operationId": "retorna-um-tipo-de-evento-especifico", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipoEntrega": { + "type": "string", + "example": "EntregaAgendada" + }, + "tipoDisponibilizacao": { + "type": "string", + "example": "DisponibilizacaoDeCreditos" + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "corHexTituloInformacoes": { + "type": "string", + "example": "string" + }, + "corHexCorpoInformacoes": { + "type": "string", + "example": "string" + }, + "numeroAbasInformacoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroLocaisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "tipoBeneficiarioFrete": { + "type": "string", + "example": "DonodaLista" + }, + "caminhoLogoEvento": { + "type": "string", + "example": "string" + }, + "caminhoSubTemplate": { + "type": "string", + "example": "string" + }, + "sugestaoProdutos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/{email}": { + "get": { + "summary": "Retorna as assinaturas de um determinado usuário", + "description": "Produtos de uma assinatura", + "operationId": "retorna-as-assinaturas-de-um-determinado-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "e-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.170Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.170Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.170Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.170Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/eventos/{eventoId}": { + "put": { + "summary": "Atualiza um evento", + "description": "", + "operationId": "atualiza-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Identificador do tipo de evento", + "format": "int32" + }, + "enderecoEntregaId": { + "type": "integer", + "description": "Identificador do endereço de entrega", + "format": "int32" + }, + "titulo": { + "type": "string", + "description": "Titulo do evento" + }, + "url": { + "type": "string", + "description": "Atributo obsoleto - (optional)" + }, + "data": { + "type": "string", + "description": "Data do Evento", + "format": "date" + }, + "usuarioEmail": { + "type": "string", + "description": "Email do usuário" + }, + "disponivel": { + "type": "boolean", + "description": "Disponibilidade do evento (optional)" + }, + "diasAntesEvento": { + "type": "integer", + "description": "Quantos dias antes do evento ele será exibido (optional)", + "format": "int32" + }, + "diasDepoisEvento": { + "type": "integer", + "description": "Até quantos dias depois do evento ele será exibido (optional)", + "format": "int32" + }, + "urlLogo": { + "type": "string", + "description": "Url do Logo. (Base64)" + }, + "urlCapa": { + "type": "string", + "description": "Url da Capa. (Base64)" + }, + "proprietario": { + "type": "string", + "description": "Quem é o proprietário" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 01 será habilitada" + }, + "textoInfo01": { + "type": "string", + "description": "Texto para o campo informação 01 (optional)" + }, + "conteudoInfo01": { + "type": "string", + "description": "Conteúdo para o campo informação 01 (optional)" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 02 será habilitada" + }, + "textoInfo02": { + "type": "string", + "description": "Texto para o campo informação 02 (optional)" + }, + "conteudoInfo02": { + "type": "string", + "description": "Conteúdo para o campo informação 02 (optional)" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "description": "Se a aba de mensagem será habilitada (optional)" + }, + "enumTipoListaPresenteId": { + "type": "string", + "description": "Tipo de lista de presente", + "enum": [ + "ListaPronta", + "ListaManual" + ] + }, + "enumTipoEntregaId": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "eventoProdutoSelecionado": { + "type": "array", + "description": "Seleção de produto no evento", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se produto recebido fora da lista (optional)" + }, + "removido": { + "type": "boolean", + "description": "Se produto removido (optional)" + } + }, + "type": "object" + } + }, + "enderecoEvento": { + "type": "array", + "description": "Endereço do Evento", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "Nome para identificação do endereço" + }, + "endereco": { + "type": "string", + "description": "Endereço" + }, + "cep": { + "type": "string", + "description": "Cep do endereço" + }, + "numero": { + "type": "string", + "description": "Numero do endereço" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço" + }, + "cidade": { + "type": "string", + "description": "Cidade do endereço" + }, + "estado": { + "type": "string", + "description": "Estado do endereço" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna um evento especifico", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "retorna-um-evento-especifico", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.758Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.758Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "userId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enderecoEntregaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.758Z" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:38.758Z" + }, + "titulo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "diasDepoisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "diasAntesEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlLogoEvento": { + "type": "string", + "example": "string" + }, + "urlCapaEvento": { + "type": "string", + "example": "string" + }, + "proprietarioEvento": { + "type": "string", + "example": "string" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo01": { + "type": "string", + "example": "string" + }, + "conteudoInfo01": { + "type": "string", + "example": "string" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo02": { + "type": "string", + "example": "string" + }, + "conteudoInfo02": { + "type": "string", + "example": "string" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "fotos": { + "type": "string", + "example": "string" + }, + "enumTipoListaPresenteId": { + "type": "string", + "example": "Default" + }, + "enumTipoEntregaId": { + "type": "string", + "example": "EntregaAgendada" + }, + "eventoProdutoSelecionado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "enderecoEvento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/hotsites/{hotsiteId}/banners": { + "get": { + "summary": "Busca os banners vinculados a um hotsite específico", + "description": "Lista de identificadores de banners vinculados ao hotsite", + "operationId": "busca-os-banners-vinculados-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"bannerId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Desvincula um ou mais banners de um hotsite específico", + "description": "", + "operationId": "desvincula-um-ou-mais-banners-de-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser desvinculado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem desvinculados", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula um ou mais banners a um hotsite específico", + "description": "", + "operationId": "vincula-um-ou-mais-banners-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser vinculado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "banners": { + "type": "array", + "description": "Lista de identificadores de banners para vincular ao hotsite", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/estorno/{pedidoId}": { + "post": { + "summary": "Estorna total ou parcial de um pedido", + "description": "Estorna um valor menor ou igual ao total do pedido \"Pago\"", + "operationId": "estorna-total-ou-parcial-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "Valor": { + "type": "number", + "description": "Valor a ser estornado do pedido. Total ou parcial.", + "default": null, + "format": "float" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/grupoassinatura/assinatura": { + "post": { + "summary": "Cria assinatura com base em uma lista de pedidos", + "description": "Pedidos que terão vínculo com o grupo de assinatura informado.", + "operationId": "cria-assinatura-com-base-em-uma-lista-de-pedidos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pedidos": { + "type": "array", + "description": "Lista de pedidos a serem vinculados a assinatura", + "items": { + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido", + "format": "int32" + } + }, + "type": "object" + } + }, + "recorrenciaId": { + "type": "integer", + "description": "ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura", + "format": "int32" + }, + "grupoAssinaturaId": { + "type": "integer", + "description": "ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "text/plain": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + } + }, + "deprecated": false + } + }, + "/situacoesPedido": { + "get": { + "summary": "Retorna todas as situações de pedido da loja", + "description": "Lista de situações de pedido", + "operationId": "retorna-todas-as-situacoes-de-pedido-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"observacao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + }, + "observacao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/lojasFisicas": { + "post": { + "summary": "Insere uma Loja Física", + "description": "", + "operationId": "insere-uma-loja-fisica", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "description": "Id da loja (optional)", + "format": "int32" + }, + "nome": { + "type": "string", + "description": "Nome da loja (optional)" + }, + "ddd": { + "type": "integer", + "description": "DDD da localidade de destino da loja (optional)", + "format": "int32" + }, + "telefone": { + "type": "string", + "description": "Telefone da loja (optional)" + }, + "email": { + "type": "string", + "description": "E-mail de contato da loja (optional)" + }, + "cep": { + "type": "string", + "description": "CEP do endereço da loja (optional)" + }, + "logradouro": { + "type": "string", + "description": "Logradouro do endereço da loja (optional)" + }, + "numero": { + "type": "string", + "description": "Número de localização do endereço da loja (optional)" + }, + "complemento": { + "type": "string", + "description": "Complemento para localização da loja (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço do loja (optional)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que a loja se encontra (optional)" + }, + "estadoId": { + "type": "integer", + "description": "Id do estado em que a loja se encontra (optional)", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega (optional)", + "format": "int32" + }, + "prazoMaximoRetirada": { + "type": "integer", + "description": "Prazo máximo para retirada (optional)", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Status da loja (optional)" + }, + "valido": { + "type": "boolean", + "description": "Valido (optional)" + }, + "textoComplementar": { + "type": "string", + "description": "Informações complementares da loja (optional)" + }, + "retirarNaLoja": { + "type": "boolean", + "description": "Se a retirada na loja será ativada (optional)" + }, + "latitude": { + "type": "number", + "description": "Latitude (optional)", + "format": "double" + }, + "longitude": { + "type": "number", + "description": "Longitude (optional)", + "format": "double" + }, + "centroDistribuicao": { + "type": "array", + "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna todas as Lojas Físicas", + "description": "Lista de Lojas Físicas", + "operationId": "retorna-todas-as-lojas-fisicas", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ddd": { + "type": "integer", + "example": 0, + "default": 0 + }, + "telefone": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoMaximoRetirada": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "textoComplementar": { + "type": "string", + "example": "string" + }, + "retirarNaLoja": { + "type": "boolean", + "example": true, + "default": true + }, + "latitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "longitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}": { + "put": { + "summary": "Atualiza um usuário pelo email", + "description": "", + "operationId": "atualiza-um-usuario-pelo-email", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/CadastroPersonalizado": { + "post": { + "summary": "Insere um novo campo de cadastro personalizado", + "description": "", + "operationId": "insere-um-novo-campo-de-cadastro-personalizado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do campo" + }, + "tipo": { + "type": "string", + "description": "Tipo do campo", + "enum": [ + "TextoLivre", + "ValoresPredefinidos", + "RadioButton" + ] + }, + "obrigatorio": { + "type": "boolean", + "description": "Se o campo será obrigatório" + }, + "ordem": { + "type": "integer", + "description": "Ordem", + "format": "int32" + }, + "valorPreDefinido": { + "type": "array", + "description": "Informação para os campos (optional)", + "items": { + "properties": { + "valor": { + "type": "string", + "description": "Valor" + }, + "ordem": { + "type": "integer", + "description": "Ordem", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do campo de cadastro personalizado gerado": { + "value": "Id do campo de cadastro personalizado gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/principal": { + "put": { + "summary": "Seta identificador como variante principal", + "description": "Seta identificador como variante principal", + "operationId": "seta-identificador-como-variante-principal", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/webhook/inscricao": { + "post": { + "summary": "Insere uma inscrição", + "description": "", + "operationId": "insere-uma-inscricao", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "topicos" + ], + "properties": { + "nome": { + "type": "string", + "description": "Nome da inscrição" + }, + "appUrl": { + "type": "string", + "description": "Url para qual deve ser enviada as notificações" + }, + "topicos": { + "type": "array", + "description": "Tópicos em que deseja se inscrever", + "items": { + "type": "string" + } + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a inscrição" + }, + "ativo": { + "type": "boolean", + "description": "Status da inscrição, se ativada ou desativada" + }, + "emailResponsavel": { + "type": "string", + "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" + }, + "headers": { + "type": "array", + "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave do header, por exemplo: 'Authorization'" + }, + "valor": { + "type": "string", + "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca todas as inscrições inseridas", + "description": "Lista de inscrições", + "operationId": "busca-todas-as-inscricoes-inseridas", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "inscricaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "appUrl": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "emailResponsavel": { + "type": "string", + "example": "string" + }, + "topico": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuario": { + "type": "string", + "example": "string" + }, + "header": { + "type": "array", + "items": { + "type": "object", + "properties": { + "headerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { + "get": { + "summary": "Retorna uma lista de produtos vinculados a um Grupo de Personalização", + "description": "Lista de produtos de um Grupo de Personalização", + "operationId": "retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"nome\": \"string\",\n \"alias\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "alias": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Remove o vinculo de produtos de um Grupo de Personalização", + "description": "", + "operationId": "remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Vincula produtos a um Grupo de Personalização", + "description": "", + "operationId": "vincula-produtos-a-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Vinculo de produto com um Grupo de Personalização": { + "value": "Vínculo de produto com um Grupo de Personalização" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/graficofaturamento": { + "get": { + "summary": "Retorna dados para carregar o gráfico do faturamento", + "description": "Gráfico do Faturamento", + "operationId": "retorna-dados-para-carregar-o-grafico-do-faturamento", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial do faturamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final do faturamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "isLoja", + "in": "query", + "description": "Se o faturamento é somente da loja", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"parceiro\": \"string\",\n \"receitaPagos\": 0,\n \"transacoesPagos\": 0,\n \"valorMedioPagos\": 0,\n \"usuarioEnderecoEstado\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "parceiro": { + "type": "string", + "example": "string" + }, + "receitaPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "transacoesPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMedioPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioEnderecoEstado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/informacoes/{informacaoId}": { + "delete": { + "summary": "Exclui uma informação de um produto", + "description": "", + "operationId": "exclui-uma-informacao-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "informacaoId", + "in": "path", + "description": "Id da informação do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza uma informação de um produto", + "description": "Atualiza uma informação de um produto específico", + "operationId": "atualiza-uma-informacao-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "informacaoId", + "in": "path", + "description": "Id da informação do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo da informação (optional)" + }, + "texto": { + "type": "string", + "description": "Texto da informação (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Informação se o produto variante está visível no site." + }, + "tipoInformacao": { + "type": "string", + "description": "Tipo de informação do produto (optional)", + "enum": [ + "Informacoes", + "Beneficios", + "Especificacoes", + "DadosTecnicos", + "Composicao", + "ModoDeUsar", + "Cuidados", + "ItensInclusos", + "Dicas", + "Video", + "Descricao", + "ValorReferente", + "PopUpReferente", + "Prescricao", + "TabelaDeMedidas", + "Spot", + "Sinopse", + "Carrinho" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/pedido/{pedidoId}": { + "get": { + "summary": "Retorna os dados de uma assinatura a partir do id do Pedido", + "description": "Assinatura de um determinado pedido", + "operationId": "retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaPedidoId\": 0,\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"pedidoId\": 0,\n \"valor\": 0,\n \"data\": \"2022-06-08T11:32:39.571Z\",\n \"origemPedidoEnumId\": 0,\n \"produtoVarianteId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-08T11:32:39.571Z" + }, + "origemPedidoEnumId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}/parcial": { + "put": { + "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", + "description": "", + "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoId", + "in": "path", + "description": "Id do Pedido Rastreamento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento", + "properties": { + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de Rastreamento (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autenticacao/refresh": { + "post": { + "summary": "Gera um novo access token baseado em um access token expirado por data", + "description": "Access token atualizado com sucesso", + "operationId": "gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.420Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojas": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "accessToken": { + "type": "string", + "example": "string" + }, + "dataExpiracaoAccessTokenUTC": { + "type": "string", + "example": "2022-06-09T11:21:37.420Z" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/webhook/inscricao/{inscricaoId}/Ativar": { + "put": { + "summary": "Ativa ou inativa uma inscrição", + "description": "", + "operationId": "ativa-ou-inativa-uma-inscricao", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada)" + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a atualização" + }, + "observacao": { + "type": "string", + "description": "Observação que deseje fazer com relação a ativação/desativação da inscrição (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/erros/{assinaturaId}": { + "get": { + "summary": "Retorna os erros de uma assinatura especifica", + "description": "Assinatura com erro na loja", + "operationId": "retorna-os-erros-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "id da Assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.566Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaErroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "string", + "example": "string" + }, + "visualizado": { + "type": "boolean", + "example": true, + "default": true + }, + "dataErro": { + "type": "string", + "example": "2022-06-08T11:32:39.566Z" + }, + "resolvido": { + "type": "boolean", + "example": true, + "default": true + }, + "codigoAssinaturaErro": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaErroNome": { + "type": "string", + "example": "string" + }, + "assinaturaErroDescricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/limiteCreditoPorEmail/{email}": { + "get": { + "summary": "Retorna o limite de crédito de um usuário específico", + "description": "Limite de crédito de um usuário específico", + "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico-1", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/historicoSituacao": { + "get": { + "summary": "Retorna o histórico de situações de um pedido", + "description": "", + "operationId": "retorna-o-historico-de-situacoes-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Identificador do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"situacoes\": [\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"dataAtualizacao\": \"2022-09-01T13:25:07.718Z\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "situacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-09-01T13:25:07.718Z" + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/limiteCredito/{usuarioId}": { + "put": { + "summary": "Atualiza o limite de crédito para um usuário", + "description": "", + "operationId": "insere-limite-de-credito-para-um-usuario", + "parameters": [ + { + "name": "cpf_cnpj", + "in": "query", + "description": "CPF ou CNPJ do usuário", + "schema": { + "type": "string" + } + }, + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "valor", + "in": "query", + "description": "Valor do limite de crédito", + "schema": { + "type": "number", + "format": "double" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/portfolios/{portfolioId}/produtos": { + "get": { + "summary": "Retorna a lista de produtos de um portfolio", + "description": "Retorna a lista de produtos de um portfolio", + "operationId": "retorna-a-lista-de-produtos-de-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja buscar os produtos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Vinculo de produtos ao portfolio", + "description": "", + "operationId": "vinculo-de-produtos-ao-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar os produtos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista dos Id's dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento": { + "post": { + "summary": "Insere um rastreamento e status a um produto variante", + "description": "", + "operationId": "insere-um-rastreamento-e-status-a-um-produto-variante", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "dataEvento": { + "type": "string", + "description": "Data (optional)", + "format": "date" + }, + "numeroNotaFiscal": { + "type": "string", + "description": "Número da nota fiscal (optional)" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de acesso NFE (optional)" + }, + "urlNFE": { + "type": "string", + "description": "URL NFE (optional)" + }, + "serieNFE": { + "type": "string", + "description": "Serie NFE (optional)" + }, + "cfop": { + "type": "integer", + "description": "CFOP (optional)", + "format": "int32" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros/{parceiroId}/usuarios": { + "get": { + "summary": "Retorna os usuários pelo id do parceiro", + "description": "Usuários encontrados", + "operationId": "retorna-os-usuarios-pelo-id-do-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.775Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.775Z\",\n \"vinculoVitalicio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "email": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicial": { + "type": "string", + "example": "2022-06-30T11:24:34.775Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-30T11:24:34.775Z" + }, + "vinculoVitalicio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/transacoes/{transacaoId}": { + "get": { + "summary": "Retorna os detalhes da transação de um pedido", + "description": "Dados de transação do pedido", + "operationId": "retorna-os-detalhes-da-transacao-de-um-pedido", + "parameters": [ + { + "name": "transacaoId", + "in": "path", + "description": "Número da Transação que se deseja buscar os dados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/autorizar": { + "put": { + "summary": "Aprova um cadastro de usuário", + "description": "Operação realizada com ou sem sucesso para os usuários", + "operationId": "aprova-um-cadastro-de-usuario", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Tipo de Identificador", + "schema": { + "type": "string", + "enum": [ + "UsuarioId", + "Email" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Usuários", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Identificador" + }, + "aprovado": { + "type": "boolean", + "description": "Status de aprovação" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuariosAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuariosNaoAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/DataCadastro": { + "put": { + "summary": "Atualiza a data de cadastro de um produto", + "description": "Atualiza a data de cadastro um produto com base nos dados enviados", + "operationId": "atualiza-a-data-de-cadastro-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dataCadastro": { + "type": "string", + "description": "Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "\tProduto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/{produtoVarianteId}/status": { + "put": { + "summary": "Atualiza a situação do status de um produto do pedido", + "description": "", + "operationId": "atualiza-a-situacao-do-status-de-um-produto-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Dados da situação do produto (optional)", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do produto", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade de produtos do centro de distribuição", + "format": "int32" + }, + "situacaoPedidoProdutoId": { + "type": "integer", + "description": "Novo status da situação do produto (são os mesmo status do pedido)", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/produtoestoque": { + "get": { + "summary": "Indicadores dos Produtos no Estoque", + "description": "Indicadores dos Produtos no Estoque", + "operationId": "indicadores-dos-produtos-no-estoque", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorProdutoComEstoque\": \"string\",\n \"indicadorProdutoSemEstoque\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorProdutoComEstoque": { + "type": "string", + "example": "string" + }, + "indicadorProdutoSemEstoque": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/enderecos/{enderecoId}": { + "put": { + "summary": "Atualiza um endereço de um usuário pelo e-mail do usuário", + "description": "", + "operationId": "atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtoavaliacao/{produtoAvaliacaoId}/status": { + "put": { + "summary": "Atualiza o status de uma avaliação de um produto variante", + "description": "", + "operationId": "atualiza-o-status-de-uma-avaliacao-de-um-produto-variante", + "parameters": [ + { + "name": "produtoAvaliacaoId", + "in": "path", + "description": "Identificador de uma Avaliação de um produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status para a avaliação", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fabricantes/{nome}": { + "get": { + "summary": "Retorna um fabricante específico pelo nome", + "description": "Fabricante encontrado", + "operationId": "retorna-um-fabricante-especifico-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do fabricante", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}/parceiros": { + "post": { + "summary": "Vincula parceiros com um banner específico", + "description": "", + "operationId": "vincula-parceiros-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve vincular os parceiros", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos parceiros", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca os parceiros vinculados de um banner específico", + "description": "Lista de parceiros vinculados ao banner", + "operationId": "busca-os-parceiros-vinculados-de-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve buscar os parceiros vinculados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "delete": { + "summary": "Deleta o vinculo de um ou mais parceiros com um banner específico", + "description": "", + "operationId": "deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve desvincular os parceiros desejados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "listaParceiros": { + "type": "array", + "description": "Lista de identificadores de parceiros para desvincular do banner", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tabelaPrecos": { + "get": { + "summary": "Retorna todas as tabelas de preços", + "description": "Lista de tabelas de preços", + "operationId": "retorna-todas-as-tabelas-de-precos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.621Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.621Z\",\n \"ativo\": true,\n \"isSite\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicial": { + "type": "string", + "example": "2022-07-19T11:05:47.621Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-07-19T11:05:47.621Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isSite": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Insere uma nova tabela de preços", + "description": "", + "operationId": "insere-uma-nova-tabela-de-precos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da tabela de preço" + }, + "dataInicial": { + "type": "string", + "description": "Data que inicia a tabela de preço", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data de término da tabela de preço", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Status da tabela de preço" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da tabela de preços gerado": { + "value": "Id da tabela de preços gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}/Imagem": { + "put": { + "summary": "Atualiza a imagem do banner", + "description": "", + "operationId": "atualiza-a-imagem-do-banner", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Id do banner", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "urlImagem": { + "type": "string", + "description": "URL da Imagem (optional)" + }, + "Imagem": { + "type": "object", + "description": "Informações para atualizar a imagem (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/categorias/{id}": { + "delete": { + "summary": "Exclui o vínculo entre uma categoria e um produto", + "description": "", + "operationId": "exclui-o-vinculo-entre-uma-categoria-e-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "id", + "in": "path", + "description": "Id da categoria a qual o produto deverá ser desvinculado", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/midias/{identificador}": { + "get": { + "summary": "Retorna o xml com os dados de uma mídia específicas entre duas datas", + "description": "Xml com os dados de uma mídia específicas entre duas datas", + "operationId": "retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "identificador", + "in": "path", + "description": "Identificar da mídia (ex.: 7-CPA)", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"dias\": {\n \"diaMidiaApiModel\": [\n {\n \"dia\": \"2022-06-30T11:24:34.731Z\",\n \"investimento\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"pedidos\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"roi\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"receita\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"visitas\": {\n \"meta\": 0,\n \"realizado\": 0\n }\n }\n ]\n },\n \"id\": 0,\n \"nome\": \"string\",\n \"tipo\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "dias": { + "type": "object", + "properties": { + "diaMidiaApiModel": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dia": { + "type": "string", + "example": "2022-06-30T11:24:34.731Z" + }, + "investimento": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "pedidos": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "roi": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "receita": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "visitas": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/hotsites": { + "post": { + "summary": "Insere um novo hotsite", + "description": "A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos.", + "operationId": "insere-um-novo-hotsite", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do hotsite" + }, + "dataInicio": { + "type": "string", + "description": "Data/hora em que o hotsite começará a ser exibido (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", + "format": "date" + }, + "url": { + "type": "string", + "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" + }, + "tamanhoPagina": { + "type": "integer", + "description": "Informe o número de produtos que deve ser exibido por página", + "format": "int32" + }, + "templateId": { + "type": "integer", + "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", + "format": "int32" + }, + "ordenacao": { + "type": "string", + "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", + "enum": [ + "Nenhuma", + "NomeCrescente", + "NomeDecrescente", + "Lancamento", + "MenorPreco", + "MaiorPreco", + "MaisVendidos", + "MaioresDescontos", + "Aleatorio", + "MenorEstoque", + "MaiorEstoque" + ] + }, + "listaProdutos": { + "type": "object", + "description": "Produtos que devem aparecer no hotsite", + "properties": { + "expressao": { + "type": "string", + "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" + }, + "produtos": { + "type": "array", + "description": "Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Identificador do produto a ser mostrado no hotsite", + "format": "int32" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação do produto (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "seo": { + "type": "object", + "description": "Dados de seo (optional)", + "properties": { + "titulo": { + "type": "string", + "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" + }, + "metas": { + "type": "array", + "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", + "items": { + "properties": { + "conteudo": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "nome": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "httpEquiv": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "scheme": { + "type": "string", + "description": "Informe os dados da Metatag" + } + }, + "type": "object" + } + } + } + }, + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem vinculados ao hotsite (optional)", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + }, + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + }, + "ativo": { + "type": "boolean", + "description": "Status do hotsite (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca todos os hotsites inseridos", + "description": "Lista de hotsites", + "operationId": "busca-todos-os-hotsites-inseridos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.198Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.198Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.198Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "template": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "url": { + "type": "string", + "example": "string" + }, + "tamanhoPagina": { + "type": "integer", + "example": 0, + "default": 0 + }, + "templateId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordenacao": { + "type": "string", + "example": "Nenhuma" + }, + "listaProdutos": { + "type": "object", + "properties": { + "expressao": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "seo": { + "type": "object", + "properties": { + "seoHotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "metas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "banners": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "conteudos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/situacaoPedido/{situacoesPedido}": { + "get": { + "summary": "Retorna uma lista de pedido baseado nas situações de pedidos", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "formasPagamento", + "in": "query", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "situacoesPedido", + "in": "path", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "apenasAssinaturas", + "in": "query", + "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.146Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.146Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.146Z\",\n \"ate\": \"2022-06-28T11:18:19.146Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.146Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/portfolios/{nome}": { + "get": { + "summary": "Retorna o portfolio pelo nome", + "description": "Portfolio encontrado", + "operationId": "retorna-o-portfolio-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do portfolio que se deseja buscar", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/categorias": { + "get": { + "summary": "Retorna todas as categorias de um produto", + "description": "Lista de categorias de um produto", + "operationId": "retorna-todas-as-categorias-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\",\n \"caminhoHierarquia\": \"string\",\n \"categoriaPrincipal\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + }, + "caminhoHierarquia": { + "type": "string", + "example": "string" + }, + "categoriaPrincipal": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Adiciona o vínculo entre um produto e uma categoria", + "description": "Adiciona o vínculo entre um produto e uma categoria com base na lista enviada", + "operationId": "adiciona-o-vinculo-entre-um-produto-e-uma-categoria", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "categoriaPrincipalId": { + "type": "integer", + "description": "Id da Categoria Principal (optional)", + "format": "int32" + }, + "listaCategoriaId": { + "type": "array", + "description": "Id da categoria a qual o produto deverá ser vinculado (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/atacarejo": { + "get": { + "summary": "Retorna Lista de Atacarejos do Produto Variante", + "description": "Lista de Atacarejos", + "operationId": "retorna-lista-de-atacarejos-do-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "post": { + "summary": "Adiciona novos Atacarejos", + "description": "", + "operationId": "adiciona-novos-atacarejos", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Atacarejos (optional)", + "items": { + "properties": { + "precoAtacado": { + "type": "number", + "description": "Preço atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/recorrencias": { + "get": { + "summary": "Retorna as recorrências cadastradas na loja", + "description": "Recorrências cadastradas na loja", + "operationId": "retorna-as-recorrencias-cadastradas-na-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"recorrencias\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "recorrencias": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}": { + "put": { + "summary": "Atualiza rastreamento completo (com os dados da N.F.)", + "description": "", + "operationId": "atualiza-rastreamento-completo-com-os-dados-da-nf", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoId", + "in": "path", + "description": "Id do Pedido Rastreamento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento", + "properties": { + "notaFiscal": { + "type": "string", + "description": "Número da nota fiscal" + }, + "cfop": { + "type": "integer", + "description": "Código Fiscal de Operações e Prestações", + "format": "int32" + }, + "dataEnviado": { + "type": "string", + "description": "Data Envio" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de Acesso NFE" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + }, + "transportadora": { + "type": "string", + "description": "Transportadora (optional)" + }, + "dataEntrega": { + "type": "string", + "description": "Data da entrega (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/centrosdistribuicao/{centroDistribuicaoId}/prioridade": { + "put": { + "summary": "Executa uma atualizacao da prioridade do centro de distribuicao", + "description": "Atualiza a prioridade de um centro de distribuição", + "operationId": "executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1", + "parameters": [ + { + "name": "centroDistribuicaoId", + "in": "path", + "description": "Id do centro de distribuição", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "incrementoOrdem": { + "type": "integer", + "description": "(optional)", + "format": "int32" + }, + "desativarPriorizacao": { + "type": "boolean", + "description": "(optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no Processamento da Operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no Processamento da Operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/conteudos": { + "post": { + "summary": "Insere um novo conteúdo na loja", + "description": "", + "operationId": "insere-um-novo-conteudo-na-loja", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo do conteúdo" + }, + "ativo": { + "type": "boolean", + "description": "Conteúdo ativo/inativo" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do conteúdo (optional)", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data final de exibição do conteúdo (optional)", + "format": "date" + }, + "posicionamento": { + "type": "string", + "description": "Posicionamento do conteúdo", + "enum": [ + "Topo", + "Centro", + "Rodape", + "LateralDireita", + "LateralEsquerda", + "MobileTopo", + "MobileRodape" + ] + }, + "conteudo": { + "type": "string", + "description": "Informações do conteúdo" + }, + "termoBusca": { + "type": "string", + "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" + }, + "exibeTodasBuscas": { + "type": "boolean", + "description": "Exibição do conteúdo nas buscas" + }, + "naoExibeBuscas": { + "type": "boolean", + "description": "Não exibição do conteúdo nas buscas" + }, + "exibeTodosHotsites": { + "type": "boolean", + "description": "Exibição do conteúdo nos hotsites" + }, + "hotsitesId": { + "type": "array", + "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Busca todos os conteúdos", + "description": "Conteúdos encontrados", + "operationId": "busca-todos-os-conteudos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"conteudoId\": 0,\n \"titulo\": \"string\",\n \"ativo\": true,\n \"dataInicio\": \"2022-06-13T11:13:55.432Z\",\n \"dataFim\": \"2022-06-13T11:13:55.432Z\",\n \"posicionamento\": \"Topo\",\n \"codigoFonte\": \"string\",\n \"termoBusca\": \"string\",\n \"exibeTodasBuscas\": true,\n \"naoExibeBuscas\": true,\n \"exibeTodosHotsites\": true,\n \"hotsitesId\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicio": { + "type": "string", + "example": "2022-06-13T11:13:55.432Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-13T11:13:55.432Z" + }, + "posicionamento": { + "type": "string", + "example": "Topo" + }, + "codigoFonte": { + "type": "string", + "example": "string" + }, + "termoBusca": { + "type": "string", + "example": "string" + }, + "exibeTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibeBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "exibeTodosHotsites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotsitesId": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/imagens/estampa": { + "put": { + "summary": "Atualiza a imagem de estampa do produto", + "description": "", + "operationId": "atualiza-a-imagem-de-estampa-do-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idImagem": { + "type": "integer", + "description": "Id da imagem que será marcada como estampa", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/newsletter": { + "get": { + "summary": "Retorna lista de usuários cadastrados/descadastrados na newsletter", + "description": "Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página)", + "operationId": "retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter", + "parameters": [ + { + "name": "ordenarPor", + "in": "query", + "description": "Tipo de ordenação", + "schema": { + "type": "string", + "enum": [ + "DataCadastro", + "DataAtualizacao" + ] + } + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "status", + "in": "query", + "description": "Status do usuário", + "schema": { + "type": "boolean" + } + }, + { + "name": "doubleOptIn", + "in": "query", + "description": "DoubleOptIn aceito (verificar estado da configuração)", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"nome\": \"string\",\n \"email\": \"string\",\n \"sexo\": \"string\",\n \"status\": true,\n \"grupoInformacao\": [\n {\n \"nome\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "sexo": { + "type": "string", + "example": "string" + }, + "status": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{email}/enderecos/{enderecoId}/ativar": { + "put": { + "summary": "Ativa ou desativa um endereço de um usuário com base no e-mail do usuário", + "description": "", + "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja alterar o status do endereço", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço que se deseja alterar o status", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status do endereço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtoavaliacao/{identificador}": { + "post": { + "summary": "Insere uma avaliação para um produto variante", + "description": "", + "operationId": "insere-uma-avaliacao-para-um-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "comentario": { + "type": "string", + "description": "Texto referente a avaliação do produto" + }, + "avaliacao": { + "type": "integer", + "description": "Escala de 1 a 5 para avaliar o produto", + "format": "int32" + }, + "usuarioId": { + "type": "integer", + "description": "Identificado do usuário", + "format": "int32" + }, + "dataAvaliacao": { + "type": "string", + "description": "Referente a data que a avaliação foi criada", + "format": "date" + }, + "nome": { + "type": "string", + "description": "Nome do usuário que avaliou" + }, + "email": { + "type": "string", + "description": "Email do usuário que avaliou" + }, + "status": { + "type": "string", + "description": "Referente ao status que libera a visualização da avaliação no site", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/receita": { + "get": { + "summary": "Retorna o relatório de receitas de um determinado período", + "description": "Relatório de receitas de um determinado período", + "operationId": "retorna-o-relatorio-de-receitas-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.736Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.736Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes": { + "post": { + "summary": "Insere um novo contrato de frete", + "description": "", + "operationId": "insere-um-novo-contrato-de-frete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do contrato de frete (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Status do contrato de frete (optional)" + }, + "volumeMaximo": { + "type": "integer", + "description": "Volume máximo permitido , em metro cúbico (m³). (optional)", + "format": "int32" + }, + "pesoCubado": { + "type": "number", + "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", + "format": "double" + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "description": "Id da configuração entrega agendada (optional)", + "format": "int32" + }, + "linkRastreamento": { + "type": "string", + "description": "URL rastreamento (optional)" + }, + "ehAssinatura": { + "type": "boolean", + "description": "Contrato é exclusivo assinatura (optional)" + }, + "larguraMaxima": { + "type": "integer", + "description": "Informe a largura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "alturaMaxima": { + "type": "integer", + "description": "Informe a altura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "comprimentoMaximo": { + "type": "integer", + "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", + "format": "int32" + }, + "limiteMaximoDimensoes": { + "type": "integer", + "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", + "format": "int32" + }, + "limitePesoCubado": { + "type": "number", + "description": "Informe o limite de peso cubado, em gramas (g). (optional)", + "format": "double" + }, + "tempoMinimoDespacho": { + "type": "integer", + "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Informe o Id do centro de distribuição (optional)", + "format": "int32" + }, + "valorMinimoProdutos": { + "type": "number", + "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", + "format": "double" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do frete gerado": { + "value": "Id do frete gerado" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "get": { + "summary": "Retorna uma lista de fretes", + "description": "Lista de fretes", + "operationId": "retorna-uma-lista-de-fretes", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "volumeMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "linkRastreamento": { + "type": "string", + "example": "string" + }, + "ehAssinatura": { + "type": "boolean", + "example": true, + "default": true + }, + "larguraMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alturaMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimentoMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limiteMaximoDimensoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limitePesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tempoMinimoDespacho": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoProdutos": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/{assinaturaId}": { + "get": { + "summary": "Retorna os dados de uma assinatura específica", + "description": "Detalhes de uma assinatura", + "operationId": "retorna-os-dados-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.154Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.154Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.154Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.154Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + }, + "put": { + "summary": "Atualiza a situação de uma assinatura específica", + "description": "", + "operationId": "atualiza-a-situacao-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "description": "Id do endereço (optional)", + "format": "int32" + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "description": "Id do cartão de crédito do usuário (optional)", + "format": "int32" + }, + "periodoRecorrencia": { + "type": "string", + "description": "Período Recorrência (optional)" + }, + "situacaoAssinatura": { + "type": "string", + "description": "Situação da Assinatura (optional)", + "enum": [ + "Ativa", + "Pausada", + "Cancelada" + ] + }, + "cupom": { + "type": "string", + "description": "Cupom (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/autores/{nomeAutor}": { + "get": { + "summary": "Buscar autor pelo nome", + "description": "", + "operationId": "buscar-autor-pelo-nome", + "parameters": [ + { + "name": "nomeAutor", + "in": "path", + "description": "Nome do autor", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/gestorscripts/scripts/{scriptId}/versao/{versaoId}/conteudo": { + "get": { + "summary": "Busca o conteúdo de uma versão", + "description": "Lista o conteúdo de uma versão", + "operationId": "busca-o-conteudo-de-uma-versao", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "versaoId", + "in": "path", + "description": "Id da versão", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"scriptId\": 0,\n \"versaoId\": 0,\n \"conteudo\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "versaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "conteudo": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/{assinaturaId}/proximaRecorrencia": { + "put": { + "summary": "Altera a data de recorrência de uma assinatura", + "description": "", + "operationId": "altera-a-data-de-recorrencia-de-uma-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Identificador da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "proximaRecorrencia": { + "type": "string", + "description": "Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/parceiros/comPedidos": { + "get": { + "summary": "Retorna todos os parceiros com pedidos", + "description": "Lista de parceiros com pedidos", + "operationId": "retorna-todos-os-parceiros-com-pedidos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/cnpj/{cnpj}": { + "get": { + "summary": "Retorna um usuário específico pelo cnpj", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-cnpj", + "parameters": [ + { + "name": "cnpj", + "in": "path", + "description": "CNPJ do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.476Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.476Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.476Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/tiposEvento/{tipoEventoId}/produto/{produtoVarianteId}": { + "delete": { + "summary": "Deleta um produto da lista de sugestões de produtos de um tipo de evento", + "description": "", + "operationId": "deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Identificador do variante do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/eventos/{eventoId}/produto/{produtoVarianteId}": { + "delete": { + "summary": "Deleta o vinculo de um produto a um evento", + "description": "", + "operationId": "deleta-o-vinculo-de-um-produto-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Identificador do variante do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "\"Produto desvinculado com sucesso!\"": { + "value": "\"Produto desvinculado com sucesso!\"" + } + }, + "schema": { + "type": "string", + "example": "Produto desvinculado com sucesso!" + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/categoriaPrincipal": { + "put": { + "summary": "Define uma categoria de um produto como principal", + "description": "", + "operationId": "define-uma-categoria-de-um-produto-como-principal", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "categoriaId": { + "type": "integer", + "description": "Id da categoria", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/estoques": { + "put": { + "summary": "Atualiza o estoque de vários produtos", + "description": "Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", + "operationId": "atualiza-o-estoque-de-varios-produtos", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do estoque (optional)", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Valor único utilizado para identificar o produto" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto", + "format": "int32" + }, + "listaEstoque": { + "type": "array", + "description": "Lista com os dados da atualização do estoque", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/estoque": { + "get": { + "summary": "Retorna o estoque total e o estoque por centro de distribuição", + "description": "Objeto com o estoque total e o estoque por centro de distribuição de um produto variante", + "operationId": "retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"listProdutoVarianteCentroDistribuicaoEstoque\": [\n {\n \"centroDistribuicaoId\": 0,\n \"nome\": \"string\",\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "listProdutoVarianteCentroDistribuicaoEstoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/usuarioId/{usuarioId}": { + "get": { + "summary": "Retorna um usuário específico pelo id", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-id", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/produtos": { + "get": { + "summary": "Retorna uma listagem com dados dos produtos mais vendidos pela loja ou parceiro", + "description": "Produtos Mais Vendidos", + "operationId": "retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"nomeProduto\": \"string\",\n \"sku\": \"string\",\n \"quantidade\": 0,\n \"receita\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeProduto": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "receita": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}/parcial": { + "put": { + "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", + "description": "", + "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento Produto", + "properties": { + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de Rastreamento (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}/status": { + "put": { + "summary": "Atualiza o status do banner pelo id", + "description": "", + "operationId": "atualiza-o-status-do-banner-pelo-id", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status para qual deve ir o baner: Ativo (true) ou Inativo (false)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{usuarioId}/enderecos/{enderecoId}": { + "put": { + "summary": "Atualiza um endereço de um usuário pelo id do usuário", + "description": "", + "operationId": "atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/avaliacoes": { + "get": { + "summary": "Retorna uma lista de avaliações referente ao identificador informado", + "description": "Lista de avaliações de produtos", + "operationId": "retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "status", + "in": "query", + "description": "Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado']", + "schema": { + "type": "string", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-05T11:54:29.823Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoAvaliacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comentario": { + "type": "string", + "example": "string" + }, + "avaliacao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAvaliacao": { + "type": "string", + "example": "2022-07-05T11:54:29.823Z" + }, + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "status": { + "type": "string", + "example": "Pendente" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/{usuarioId}": { + "put": { + "summary": "Atualiza um usuário pelo id", + "description": "", + "operationId": "atualiza-um-usuario-pelo-id", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/pedidos/liberarReservas": { + "post": { + "summary": "Liberar reservas de pedidos", + "description": "", + "operationId": "liberar-reservas-de-pedidos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Números dos pedidos que se deseja buscar", + "items": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/precos/lote": { + "put": { + "summary": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado", + "description": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição", + "operationId": "atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do preço por lote", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "Identificador do produto (SKU)" + }, + "precoCusto": { + "type": "number", + "description": "Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "\"PrecoDe\" do produto variante", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "\"PrecoPor\" do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/banners/{bannerId}/Parceiros": { + "put": { + "summary": "Atualiza a exibição do banner em parceiros, se deve ser em todos ou não", + "description": "", + "operationId": "atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Exibição do banner em parceiros" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/documento/{documento}/pedidos": { + "get": { + "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", + "description": "Retorna lista contendo os Id's dos pedidos do usuário", + "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1", + "parameters": [ + { + "name": "documento", + "in": "path", + "description": "Documento (CPF ou CNPJ) do usuário cujos pedidos devem ser selecionados. Utilizar apenas números, sem caracteres especiais", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoDocumento", + "in": "query", + "description": "Define se o documento informado é um CPF ou um CNPJ", + "schema": { + "type": "string", + "enum": [ + "Cpf", + "Cnpj" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "string" + }, + "rel": { + "type": "string", + "example": "string" + }, + "method": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/produtos/{identificador}/preco": { + "get": { + "summary": "Retorna o precoDe e precoPor de um produto", + "description": "Objeto com o precoDe e precoPor de um produto variante", + "operationId": "retorna-o-precode-e-precopor-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/usuarios/bloquear": { + "put": { + "summary": "Bloqueia ou desbloqueia usuários", + "description": "Campo atualizado com sucesso", + "operationId": "bloqueia-ou-desbloqueia-usuarios", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Usuários (optional)", + "items": { + "properties": { + "email": { + "type": "string", + "description": "E-mail do usuário" + }, + "bloqueado": { + "type": "boolean", + "description": "Status do usuário" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuariosAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuariosNaoAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes/{freteId}/Ativo": { + "put": { + "summary": "Ativa ou Desativa um frete", + "description": "Frete atualizado com sucesso", + "operationId": "ativa-ou-desativa-um-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status para atualização do contrato de frete" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/assinaturas/{assinaturaId}/pedido": { + "post": { + "summary": "Gera um novo pedido para a assinatura", + "description": "", + "operationId": "gera-um-novo-pedido-para-a-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Identificador da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/midias": { + "get": { + "summary": "Retorna o xml com os dados de todas as mídias entre duas datas", + "description": "Xml com os dados das mídias entre duas datas", + "operationId": "retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/dashboard/ticketMedio": { + "get": { + "summary": "Retorna o relatório de ticket médio de um determinado período", + "description": "Relatório de ticket médio de um determinado período", + "operationId": "retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.739Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.739Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + }, + "/fretes/pedidos/{pedidoId}/cotacoes": { + "get": { + "summary": "Retorna uma cotação de frete para o carrinho do pedido", + "description": "Objeto com as cotações de frete", + "operationId": "retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "forcarCotacaoTodosCDs", + "in": "query", + "description": "Força cotação de todos os CD's.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"centroDistribuicao\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaFreteId": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7691a93536400345f5633" +} \ No newline at end of file From d958bca7bf33e21475dbb702a9324a2026300bb4 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 00:13:37 -0300 Subject: [PATCH 02/21] migrate wake/vnda --- scripts/start.ts | 167 +- utils/fetch.ts | 4 + vnda/actions/cart/addItem.ts | 3 +- vnda/actions/cart/updateCart.ts | 3 +- vnda/actions/cart/updateItem.ts | 3 +- vnda/hooks/context.ts | 4 +- vnda/hooks/useCart.ts | 38 +- vnda/loaders/cart.ts | 11 +- vnda/loaders/productDetailsPage.ts | 8 +- vnda/loaders/productList.ts | 7 +- vnda/loaders/productListingPage.ts | 15 +- vnda/mod.ts | 6 +- vnda/utils/client/client.ts | 114 - vnda/utils/openapi/vnda.openapi.gen.ts | 6633 ++++++++++++----- vnda/utils/openapi/vnda.openapi.json | 77 +- vnda/utils/transform.ts | 66 +- wake/actions/cart/addCoupon.ts | 2 +- wake/actions/cart/addItem.ts | 2 +- wake/actions/cart/removeCoupon.ts | 2 +- wake/actions/cart/updateItemQuantity.ts | 2 +- wake/mod.ts | 6 +- wake/utils/openapi/wake.openapi.gen.ts | 8903 ++++++++++++++--------- wake/utils/transform.ts | 2 +- 23 files changed, 10675 insertions(+), 5403 deletions(-) delete mode 100644 vnda/utils/client/client.ts diff --git a/scripts/start.ts b/scripts/start.ts index bf3f96340..d006ed853 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -2,11 +2,9 @@ import "npm:@graphql-codegen/typescript"; import "npm:@graphql-codegen/typescript-operations"; import { CodegenConfig, generate } from "npm:@graphql-codegen/cli"; -import { - compile, - Options as CompileOptions, -} from "npm:json-schema-to-typescript"; +import { compile } from "npm:json-schema-to-typescript"; import { OpenAPIV3 } from "npm:openapi-types"; +import camel from "npm:camelcase"; import { walk } from "std/fs/mod.ts"; import { dirname, join } from "std/path/mod.ts"; import { basename } from "std/path/win32.ts"; @@ -32,7 +30,13 @@ const toOutfile = (path: string) => path.replace(".json", ".gen.ts"); // transforms: /a/{b}/c => /a/:b/c const toPathTemplate = (path: string) => - path.replace(/{/g, ":").replace(/}/g, ""); + path + .split("/") + .map((segment) => { + const param = segment.replace(/{/g, ":").replace(/}/g, ""); + + return param.startsWith(":") ? camel(param) : param; + }).join("/"); const generateOpenAPI = async () => { const isOpenAPIv3 = (x: any): x is OpenAPIV3.Document => @@ -41,62 +45,36 @@ const generateOpenAPI = async () => { const isReferenceObject = (x: any): x is OpenAPIV3.ReferenceObject => Boolean(x?.$ref); - const BANNER_COMMENT = ` -// DO NOT EDIT. This file is generated by deco. -// This file SHOULD be checked into source version control. -// To generate this file: deno run -A scripts/openAPI.ts - -`; - const HTTP_VERBS = ["get", "post", "put", "delete", "patch", "head"] as const; - const COMPILE_OPTIONS: Partial = { - bannerComment: "", - unknownAny: true, - additionalProperties: false, - format: true, - }; - const MEDIA_TYPE_JSON = "application/json"; - const AUTOGEN_TYPE_NAME = "Autogen"; - for (const path of allOpenAPIPaths) { const outfile = toOutfile(path); - const types = []; console.info(`Generating OpenAPI types for specs at ${path}`); const document = JSON.parse(await Deno.readTextFile(path)); - const derrefObject = ( - obj: T | OpenAPIV3.ReferenceObject, - ): T | null => { - if (isReferenceObject(obj)) { - return obj.$ref.split("/").slice(1).reduce( - (acc: any, curr) => acc?.[curr], - document, - ) as T; - } + if (!isOpenAPIv3(document)) { + throw new Error("Only OpenAPI@3x is supported"); + } - if (!obj) return null; + const resolve = (obj: any) => { + if (!isReferenceObject(obj)) return obj; - const ret: any = {}; - for (const [key, value] of Object.entries(obj)) { - if (typeof value !== "object" && typeof value !== "symbol") { - ret[key] = value; - } else if (Array.isArray(value)) { - ret[key] = value.map(derrefObject); - } else { - ret[key] = derrefObject(value); - } - } + const schema = { ...obj, ...document }; - return ret; + return schema.$ref.split("/").slice(1).reduce( + (acc: any, curr) => acc?.[curr], + schema, + ); }; - if (!isOpenAPIv3(document)) { - throw new Error("Only OpenAPI@3x is supported"); - } + const finalSchema: OpenAPIV3.SchemaObject = { + type: "object", + properties: {}, + required: [], + }; for (const [path, pathItem] of Object.entries(document.paths)) { const pathTemplate = toPathTemplate(path); @@ -112,14 +90,24 @@ const generateOpenAPI = async () => { parameters = [], requestBody, responses, - summary, - description, } = item; - const paramsSchema = parameters - .map((item) => isReferenceObject(item) ? derrefObject(item) : item) + const schema: OpenAPIV3.SchemaObject = { + type: "object", + externalDocs: item.externalDocs, + deprecated: item.deprecated, + description: item.description || item.summary, + properties: {}, + required: [], + }; + + let hasParams = false; + const searchParams = parameters + .map(resolve) .reduce((schema, item) => { - if (item.schema && item.in === "query") { + if (item?.schema && item.in === "query") { + hasParams = true; + schema.properties[item.name] = { description: item.description, ...item.schema, @@ -137,55 +125,56 @@ const generateOpenAPI = async () => { properties: {} as Record, }); - const bodySchema = derrefObject( - derrefObject(requestBody)?.content[MEDIA_TYPE_JSON]?.schema, - ); + if (hasParams) { + schema.required?.push("searchParams"); + schema.properties!["searchParams"] = searchParams; + } + + const body = resolve(requestBody) + ?.content[MEDIA_TYPE_JSON]?.schema; + + if (body) { + schema.required?.push("body"); + schema.properties!["body"] = body; + } const ok = responses?.["200"] || responses?.["201"] || responses?.["206"]; - const responseSchema = derrefObject( - derrefObject(ok)?.content?.[MEDIA_TYPE_JSON].schema, - ); - - console.info(bodySchema); - - const [searchParams, body, response] = await Promise.all( - [ - // Object.keys(paramsSchema.properties).length > 0 && paramsSchema, - bodySchema, - // responseSchema, - ] - .map((schema) => - schema && compile(schema, AUTOGEN_TYPE_NAME, COMPILE_OPTIONS) - ), - ); - - const docs = (description || summary) && - `/** @description ${description || summary} */`; - - const typed = `${docs}\n "${verb.toUpperCase()} ${pathTemplate}": { - ${ - Object.entries({ searchParams, body, response }) - .filter((e) => Boolean(e[1])) - .map(([key, value]) => - `${key}: ${ - value!.replace(`export interface ${AUTOGEN_TYPE_NAME}`, "") - .replace(`export type ${AUTOGEN_TYPE_NAME} = `, "") - }` - ) + const response = resolve(ok)?.content?.[MEDIA_TYPE_JSON].schema; + + if (response) { + schema.required?.push("response"); + schema.properties!["response"] = response; } - }`; - types.push(typed); + const type = `${verb.toUpperCase()} ${pathTemplate}`; + finalSchema.required?.push(type); + finalSchema.properties![type] = schema; } } - await Deno.writeTextFile( - outfile, - `${BANNER_COMMENT}export interface API {\n${types.join("\n")}\n}`, + const final = await compile( + { + ...finalSchema, + ...document, + }, + "OpenAPI", + { + unknownAny: false, + additionalProperties: false, + format: false, + bannerComment: ` +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno task start + +`, + }, ); + await Deno.writeTextFile(outfile, final); + // Format using deno const fmt = new Deno.Command(Deno.execPath(), { args: ["fmt", outfile] }); await fmt.output(); diff --git a/utils/fetch.ts b/utils/fetch.ts index dae2d5e63..015da32d7 100644 --- a/utils/fetch.ts +++ b/utils/fetch.ts @@ -60,3 +60,7 @@ export const fetchAPI = async ( return response.json(); }; + +export const STALE = { + deco: { cache: "stale-while-revalidate" }, +} as const; diff --git a/vnda/actions/cart/addItem.ts b/vnda/actions/cart/addItem.ts index cc3234c5d..2b490ae5a 100644 --- a/vnda/actions/cart/addItem.ts +++ b/vnda/actions/cart/addItem.ts @@ -1,8 +1,7 @@ import { HttpError } from "../../../utils/http.ts"; -import cartLoader from "../../loaders/cart.ts"; +import cartLoader, { Cart } from "../../loaders/cart.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie } from "../../utils/cart.ts"; -import type { Cart } from "../../utils/client/types.ts"; export interface Props { itemId: string; diff --git a/vnda/actions/cart/updateCart.ts b/vnda/actions/cart/updateCart.ts index a5f028499..39bb91f52 100644 --- a/vnda/actions/cart/updateCart.ts +++ b/vnda/actions/cart/updateCart.ts @@ -1,8 +1,7 @@ import { HttpError } from "../../../utils/http.ts"; -import cartLoader from "../../loaders/cart.ts"; +import cartLoader, { Cart } from "../../loaders/cart.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie } from "../../utils/cart.ts"; -import type { Cart } from "../../utils/client/types.ts"; export interface Props { agent?: string; diff --git a/vnda/actions/cart/updateItem.ts b/vnda/actions/cart/updateItem.ts index d2def4b1e..3cda16269 100644 --- a/vnda/actions/cart/updateItem.ts +++ b/vnda/actions/cart/updateItem.ts @@ -1,8 +1,7 @@ import { HttpError } from "../../../utils/http.ts"; -import cartLoader from "../../loaders/cart.ts"; +import cartLoader, { Cart } from "../../loaders/cart.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie } from "../../utils/cart.ts"; -import type { Cart } from "../../utils/client/types.ts"; export interface Props { itemId: number | string; diff --git a/vnda/hooks/context.ts b/vnda/hooks/context.ts index c8feec60b..6e0ac94d0 100644 --- a/vnda/hooks/context.ts +++ b/vnda/hooks/context.ts @@ -1,9 +1,9 @@ import { IS_BROWSER } from "$fresh/runtime.ts"; import { signal } from "@preact/signals"; import { invoke } from "../runtime.ts"; -import { Cart } from "../utils/client/types.ts"; +import type { Cart } from "../loaders/cart.ts"; -interface Context { +export interface Context { cart: Cart; } diff --git a/vnda/hooks/useCart.ts b/vnda/hooks/useCart.ts index ee9768016..c1678dc23 100644 --- a/vnda/hooks/useCart.ts +++ b/vnda/hooks/useCart.ts @@ -1,9 +1,8 @@ -import type { InvocationFuncFor } from "deco/clients/withManifest.ts"; import type { AnalyticsItem } from "../../commerce/types.ts"; import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; -import type { Cart, Item } from "../utils/client/types.ts"; -import { state as storeState } from "./context.ts"; +import type { Item } from "../utils/client/types.ts"; +import { Context, state as storeState } from "./context.ts"; const { cart, loading } = storeState; @@ -23,30 +22,25 @@ export const itemToAnalyticsItem = ( quantity: item.quantity, }); -type PropsOf = T extends (props: infer P, r: any, ctx: any) => any ? P - : T extends (props: infer P, r: any) => any ? P - : T extends (props: infer P) => any ? P - : never; +type EnqueuableActions< + K extends keyof Manifest["actions"], +> = Manifest["actions"][K]["default"] extends + (...args: any[]) => Promise ? K : never; -type Actions = - | "vnda/actions/cart/addItem.ts" - | "vnda/actions/cart/updateCart.ts" - | "vnda/actions/cart/updateItem.ts"; - -const action = - (key: Actions) => (props: PropsOf>) => - storeState.enqueue((signal) => - invoke({ cart: { key, props } }, { signal }) satisfies Promise< - { cart: Cart } - > - ); +const enqueue = < + K extends keyof Manifest["actions"], +>(key: EnqueuableActions) => +(props: Parameters[0]) => + storeState.enqueue((signal) => + invoke({ cart: { key, props } } as any, { signal }) as any + ); const state = { cart, loading, - update: action("vnda/actions/cart/updateCart.ts"), - addItem: action("vnda/actions/cart/addItem.ts"), - updateItem: action("vnda/actions/cart/updateItem.ts"), + update: enqueue("vnda/actions/cart/updateCart.ts"), + addItem: enqueue("vnda/actions/cart/addItem.ts"), + updateItem: enqueue("vnda/actions/cart/updateItem.ts"), }; export const useCart = () => state; diff --git a/vnda/loaders/cart.ts b/vnda/loaders/cart.ts index c794d0b29..174ad9a72 100644 --- a/vnda/loaders/cart.ts +++ b/vnda/loaders/cart.ts @@ -1,6 +1,11 @@ import { AppContext } from "../mod.ts"; import { getCartCookie, setCartCookie } from "../utils/cart.ts"; -import type { Cart } from "../utils/client/types.ts"; +import { OpenAPI } from "../utils/openapi/vnda.openapi.gen.ts"; + +export type Cart = { + orderForm?: OpenAPI["POST /api/v2/carts"]["response"]; + relatedItems?: []; +}; /** * @title VNDA Integration @@ -17,7 +22,9 @@ const loader = async ( const orderForm = cartId ? await api["GET /api/v2/carts/:cartId"]({ cartId }) .then((res) => res.json()) - : await api["POST /api/v2/carts"]({}).then((res) => res.json()); + : await api["POST /api/v2/carts"]({}, { body: {} }).then((res) => + res.json() + ); setCartCookie(ctx.response.headers, orderForm.id.toString()); diff --git a/vnda/loaders/productDetailsPage.ts b/vnda/loaders/productDetailsPage.ts index 97f704de9..0f2765708 100644 --- a/vnda/loaders/productDetailsPage.ts +++ b/vnda/loaders/productDetailsPage.ts @@ -1,4 +1,5 @@ import type { ProductDetailsPage } from "../../commerce/types.ts"; +import { STALE } from "../../utils/fetch.ts"; import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; import { AppContext } from "../mod.ts"; import { getSEOFromTag, parseSlug, toProduct } from "../utils/transform.ts"; @@ -26,14 +27,13 @@ async function loader( const { id } = parseSlug(slug); const [maybeProduct, seo] = await Promise.all([ - api["GET /api/v2/products/:id"]({ id, include_images: true }, { - deco: { cache: "stale-while-revalidate" }, - }).then((r) => r.json()).catch(() => null), + api["GET /api/v2/products/:id"]({ id, include_images: "true" }, STALE) + .then((r) => r.json()).catch(() => null), api["GET /api/v2/seo_data"]({ resource_type: "Product", resource_id: id, type: "category", - }, { deco: { cache: "stale-while-revalidate" } }).then((res) => res.json()), + }, STALE).then((res) => res.json()), ]); // 404: product not found diff --git a/vnda/loaders/productList.ts b/vnda/loaders/productList.ts index c4c0961cb..d9eddcdf7 100644 --- a/vnda/loaders/productList.ts +++ b/vnda/loaders/productList.ts @@ -1,4 +1,5 @@ import type { Product } from "../../commerce/types.ts"; +import { STALE } from "../../utils/fetch.ts"; import type { AppContext } from "../mod.ts"; import { toProduct } from "../utils/transform.ts"; @@ -37,14 +38,14 @@ const productListLoader = async ( sort: props?.sort, per_page: props?.count, "tags[]": props?.tags, - }, { deco: { cache: "stale-while-revalidate" } }).then((res) => res.json()); + }, STALE).then((res) => res.json()); - return search.results.map((product) => + return search.results?.map((product) => toProduct(product, null, { url, priceCurrency: "BRL", }) - ); + ) ?? null; }; export default productListLoader; diff --git a/vnda/loaders/productListingPage.ts b/vnda/loaders/productListingPage.ts index e7bae49bb..0f35c7427 100644 --- a/vnda/loaders/productListingPage.ts +++ b/vnda/loaders/productListingPage.ts @@ -1,5 +1,6 @@ import type { ProductListingPage } from "../../commerce/types.ts"; import { SortOption } from "../../commerce/types.ts"; +import { STALE } from "../../utils/fetch.ts"; import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; import type { AppContext } from "../mod.ts"; import { ProductSearchResult, Sort } from "../utils/client/types.ts"; @@ -70,9 +71,7 @@ const searchLoader = async ( "tags[]": props.tags, wildcard: true, ...Object.fromEntries(typeTags.map(({ key, value }) => [key, value])), - }, { - deco: { cache: "stale-while-revalidate" }, - }); + }, STALE); const pagination = JSON.parse( response.headers.get("x-pagination") ?? "null", ) as ProductSearchResult["pagination"] | null; @@ -84,17 +83,15 @@ const searchLoader = async ( resource_type: "Tag", code: categoryTagName, type: "category", - }, { - deco: { cache: "stale-while-revalidate" }, - }).then((res) => res.json()), + }, STALE).then((res) => res.json()), isSearchPage - ? api["GET /api/v2/tags/:name"]({ name: categoryTagName }) + ? api["GET /api/v2/tags/:name"]({ name: categoryTagName }, STALE) .then((res) => res.json()).catch(() => undefined) : undefined, ]); const { results: searchResults } = search; - const products = searchResults.map((product) => + const products = searchResults?.map((product) => toProduct(product, null, { url, priceCurrency: "BRL", @@ -126,7 +123,7 @@ const searchLoader = async ( numberOfItems: 0, }, filters: toFilters(search.aggregations, typeTags, cleanUrl), - products: products, + products: products ?? [], pageInfo: { nextPage: pagination?.next_page ? `?${nextPage}` : undefined, previousPage: pagination?.prev_page ? `?${previousPage}` : undefined, diff --git a/vnda/mod.ts b/vnda/mod.ts index 2b2bc17a4..e88aff54c 100644 --- a/vnda/mod.ts +++ b/vnda/mod.ts @@ -1,7 +1,7 @@ import type { App, FnContext } from "deco/mod.ts"; import { createHttpClient } from "../utils/http.ts"; import manifest, { Manifest } from "./manifest.gen.ts"; -import { API } from "./utils/client/client.ts"; +import { OpenAPI } from "./utils/openapi/vnda.openapi.gen.ts"; export type AppContext = FnContext; @@ -39,7 +39,7 @@ export interface Props { } export interface State extends Props { - api: ReturnType>; + api: ReturnType>; } /** @@ -47,7 +47,7 @@ export interface State extends Props { */ export default function App(props: Props): App { const { authToken, publicUrl, sandbox } = props; - const api = createHttpClient({ + const api = createHttpClient({ headers: new Headers({ "User-Agent": "decocx/1.0", "X-Shop-Host": publicUrl, diff --git a/vnda/utils/client/client.ts b/vnda/utils/client/client.ts deleted file mode 100644 index e96ec9177..000000000 --- a/vnda/utils/client/client.ts +++ /dev/null @@ -1,114 +0,0 @@ -import { - Item, - OrderForm, - ProductGroup, - ProductSearchResult, - RelatedItemTag, - SEO, - Sort, - TagsSearchParams, -} from "./types.ts"; - -export interface API { - /** @docs https://developers.vnda.com.br/reference/get-api-v2-products-id */ - "GET /api/v2/products/:id": { - response: ProductGroup; - searchParams: { include_images: boolean }; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-banners */ - "GET /api/v2/banners": { - searchParams: { - only_valid: boolean; - tag: "listagem-banner-principal"; - }; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-tags-name */ - "GET /api/v2/tags/:name": { - response: RelatedItemTag; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-tags */ - "GET /api/v2/tags": { - response: RelatedItemTag[]; - searchParams: TagsSearchParams; - }; - - "GET /api/v2/seo_data": { - response: SEO[]; - searchParams: { - resource_type: "Product" | "Page"; - resource_id: string | number; - type: "category"; - } | { - resource_type: "Tag"; - code: string; - type: "category"; - }; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-products-search */ - "GET /api/v2/products/search": { - response: Omit; - searchParams: { - term?: string | undefined; - page?: number; - "tags[]"?: string[]; - sort?: Sort; - per_page?: number; - wildcard?: boolean; - } & { [x: string]: unknown }; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-carts-id */ - "GET /api/v2/carts/:cartId": { - response: OrderForm; - }; - - /** @docs https://developers.vnda.com.br/reference/post-api-v2-carts */ - "POST /api/v2/carts": { - response: OrderForm; - }; - - /** @docs https://developers.vnda.com.br/reference/get-api-v2-carts-id */ - "PATCH /api/v2/carts/:cartId": { - response: OrderForm; - body: { - agent?: string; - zip?: string; - client_id?: number; - coupon_code?: string; - rebate_token?: string; - }; - }; - - /** @docs https://developers.vnda.com.br/reference/post-api-v2-carts-cart_id-items */ - "POST /api/v2/carts/:cartId/items": { - response: Item; - body: { - sku: string; - quantity: number; - place_id?: number; - store_coupon_code?: string; - customizations?: Record; - extra?: Record; - }; - }; - - /** @docs https://developers.vnda.com.br/reference/patch-api-v2-carts-cart_id-items-id */ - "PATCH /api/v2/carts/:cartId/items/:itemId": { - response: Item; - body: { - sku?: string; - quantity: number; - place_id?: number; - store_coupon_code?: string; - customizations?: Record; - extra?: Record; - }; - }; - - /** @docs https://developers.vnda.com.br/reference/delete-api-v2-carts-cart_id-items-id */ - "DELETE /api/v2/carts/:cartId/items/:itemId": {}; -} diff --git a/vnda/utils/openapi/vnda.openapi.gen.ts b/vnda/utils/openapi/vnda.openapi.gen.ts index 36edff818..7ef64f76a 100644 --- a/vnda/utils/openapi/vnda.openapi.gen.ts +++ b/vnda/utils/openapi/vnda.openapi.gen.ts @@ -1,1844 +1,4830 @@ - // DO NOT EDIT. This file is generated by deco. // This file SHOULD be checked into source version control. -// To generate this file: deno run -A scripts/openAPI.ts - -export interface API { -/** @description Permite autorizar operações usando o access_token e a senha do usuário */ - "POST /api/v2/users/authorize": { - searchParams: { - access_token?: string; - password?: string; -} +// To generate this file: deno task start - } -/** @description Realiza o login do usuário a partir do email e da senha */ - "POST /api/v2/users/login": { - searchParams: { - email?: string; - password?: string; -} - - } -/** @description Realiza o logout do usuário a partir do access_token do mesmo */ - "POST /api/v2/users/logout": { - searchParams: { +export interface OpenAPI { + "GET /api/v2/seo_data": { + searchParams: { + resource_type?: string; + resource_id?: number; + type?: string; + code?: string; + }; + response: { + id: number; + title?: string; + description?: string; + resource_type: string; + resource_id: number; + parent_id: number; + }[]; + }; /** - * Token de validação de usuário logado - * - * O `access_token` é gerado quando o usuário loga no Admin + * Permite autorizar operações usando o access_token e a senha do usuário */ - access_token?: string; -} - - } -/** @description Retorna os dados de um usuário pelo seu ID */ - "GET /api/v2/users/:id": { - - } -/** @description Atualiza um usuário */ - "PUT /api/v2/users/:id": { - searchParams: { - email?: string; - name?: string; - role_name?: - | {"0": "A"; "1": "g"; "2": "e"; "3": "n"; "4": "t"; "5": "e"} - | {"0": "G"; "1": "e"; "2": "s"; "3": "t"; "4": "o"; "5": "r"} - | {"0": "L"; "1": "o"; "2": "c"; "3": "a"; "4": "l"}; - password?: string; - password_confirmation?: string; - external_code?: string; - phone_area?: string; - phone?: string; - tags?: string[]; -} - - } -/** @description Retorna as versões da regra de bônus cadastrada */ - "GET /api/v2/credits/rules/versions": { - - } -/** @description Retorna as regras de bônus cadastradas */ - "GET /api/v2/credits/rules": { - - } -/** @description Permite atualizar as regras de bônus */ - "PUT /api/v2/credits/rules": { - searchParams: { + "POST /api/v2/users/authorize": { + body: { + access_token: string; + password: string; + }; + }; /** - * Percentual em cima do total do pedido que vai ser dado de bônus para o cliente + * Realiza o login do usuário a partir do email e da senha */ - bonus?: number; + "POST /api/v2/users/login": { + body: { + email: string; + password: string; + }; + response: User; + }; + /** + * Realiza o logout do usuário a partir do access_token do mesmo + */ + "POST /api/v2/users/logout": { + body: { + /** + * Token de validação de usuário logado + * + * O `access_token` é gerado quando o usuário loga no Admin + */ + access_token?: string; + }; + }; /** - * Número de dias em que o crédito começa a valer + * Retorna os dados de um usuário pelo seu ID */ - valid_in?: number; + "GET /api/v2/users/:id": { + response: User; + }; + /** + * Atualiza um usuário + */ + "PUT /api/v2/users/:id": { + body: { + email?: string; + name?: string; + role_name?: "Agente" | "Gestor" | "Local"; + password?: string; + password_confirmation?: string; + external_code?: string; + phone_area?: string; + phone?: string; + tags?: string[]; + }; + }; + /** + * Retorna as versões da regra de bônus cadastrada + */ + "GET /api/v2/credits/rules/versions": { + response: { + event?: string; + author?: string; + created_at?: string; + ip?: string; + user_agent?: string; + cart_id?: string; + object_changes?: string; + }; + }; + /** + * Retorna as regras de bônus cadastradas + */ + "GET /api/v2/credits/rules": { + response: { + active: boolean; + minimum_subtotal: number; + bonus: number; + delayed_for: number; + valid_for: number; + maximum_usage_factor: number; + }; + }; /** - * Número de dias para a expiração do crédito + * Permite atualizar as regras de bônus + */ + "PUT /api/v2/credits/rules": { + body: { + /** + * Percentual em cima do total do pedido que vai ser dado de bônus para o cliente + */ + bonus: number; + /** + * Número de dias em que o crédito começa a valer + */ + valid_in: number; + /** + * Número de dias para a expiração do crédito + */ + valid_for: number; + /** + * Valor mínimo do pedido para que o bônus possa ser transferido para o cliente + */ + minimum_subtotal?: number; + /** + * Percentual do subtotal do pedido que pode ser pago com o bônus + */ + maximum_usage_factor?: number; + }; + }; + /** + * Permite remover as regras de bônus, desativando o recurso */ - valid_for?: number; + "DELETE /api/v2/credits/rules": {}; /** - * Valor mínimo do pedido para que o bônus possa ser transferido para o cliente + * Retorna os dados de um pedido usando o `code` ou `token` */ - minimum_subtotal?: number; + "GET /api/v2/orders/:code": { + searchParams: { + /** + * Retorna as formas de entrega do pedido + */ + include_shipping_address?: boolean; + }; + response: Order; + }; + /** + * Retorna uma lista de pedidos + */ + "GET /api/v2/orders": { + searchParams: { + /** + * Retorna os resultados a partir desta data, no formato 'yyyy-mm-dd' + */ + start?: string; + /** + * Retorna os resultados até esta data, no formato 'yyyy-mm-dd' + */ + finish?: string; + /** + * Se "true" retorna somente os pedidos que tenham nota fiscal. Se "false" retorna somente os pedidos que não tenham nota fiscal + */ + invoiced?: boolean; + /** + * Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação + */ + page?: number; + /** + * Número máximo de registros que deve ser retornado por página + */ + per_page?: number; + /** + * Array com os códigos de cupons + */ + coupon_codes?: string[]; + /** + * Se "true" inclui o preço dos produtos customizados no total do pedido. Se "false" retorna o total do pedido sem a somatória do preço de produtos customizados. + */ + include_customizations_in_total?: boolean; + }; + response: Order[]; + }; /** - * Percentual do subtotal do pedido que pode ser pago com o bônus + * Faz a captura do pagamento no adquirente + * Apenas para pedidos pagos com cartão de crédito */ - maximum_usage_factor?: number; -} - - } -/** @description Permite remover as regras de bônus, desativando o recurso */ - "DELETE /api/v2/credits/rules": { - - } -/** @description Retorna os dados de um pedido usando o `code` ou `token` */ - "GET /api/v2/orders/:code": { - - } -/** @description Retorna uma lista de pedidos */ - "GET /api/v2/orders": { - - } -/** @description Faz a captura do pagamento no adquirente -Apenas para pedidos pagos com cartão de crédito */ - "POST /api/v2/orders/:code/capture": { - - } -/** @description Altera o status do pedido para "confirmado" */ - "POST /api/v2/orders/:code/confirm": { - searchParams: { - /** - * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/capture" - */ - confirmation_data?: string; -} - - } -/** @description Faz o estorno do pagamento no adquirente -Apenas para pedidos pagos com cartão de crédito */ - "POST /api/v2/orders/:code/chargeback": { - - } -/** @description Altera o status do pedido para "cancelado" */ - "POST /api/v2/orders/:code/cancel": { - searchParams: { - /** - * Deve ser enviado algo que comprove que o pagamento foi devolvido. - * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/chargeback" - */ - cancelation_data?: string; -} - - } -/** @description Altera o status do pacote para "enviado" */ - "PATCH /api/v2/orders/:order_code/packages/:package_code/ship": { - - } -/** @description Altera o pacote para "entregue" */ - "PATCH /api/v2/orders/:order_code/packages/:package_code/deliver": { - - } -/** @description Recebe uma lista JSON com os SKUs que devem ser atualizados. A atualização será executada em segundo plano em aproximadamente 1 minuto */ - "POST /api/v2/variants/quantity": { - searchParams: { - sku?: string; - quantity?: number; + "POST /api/v2/orders/:code/capture": { + response: {}; + }; /** - * Informe somente para atualizar o estoque de um local específico + * Altera o status do pedido para "confirmado" */ - place_id?: number; -}[]; - - } -/** @description Atualiza o estoque de uma variante de um produto */ - "POST /api/v2/variants/:sku/quantity": { - - } -/** @description Atualiza o estoque específico de um local */ - "PATCH /api/v2/variants/:sku/inventories/:place_id": { - - } -/** @description Permite listar as variantes de um produto */ - "GET /api/v2/products/:product_id/variants": { - - } -/** @description Permite criar uma variante */ - "POST /api/v2/products/:product_id/variants": { - searchParams: { - sku?: string; - name?: string; - quantity?: number; - main?: boolean; + "POST /api/v2/orders/:code/confirm": { + body: { + /** + * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/capture" + */ + confirmation_data?: string; + }; + }; /** - * Largura do produto, em centímetros + * Faz o estorno do pagamento no adquirente + * Apenas para pedidos pagos com cartão de crédito */ - width?: number; + "POST /api/v2/orders/:code/chargeback": {}; /** - * Altura do produto, em centímetros + * Altera o status do pedido para "cancelado" */ - height?: number; + "POST /api/v2/orders/:code/cancel": { + body: { + /** + * Deve ser enviado algo que comprove que o pagamento foi devolvido. + * Para cartão de crédito deve ser enviado OBRIGATORIAMENTE o retorno da requisição para "/api/v2/orders/{code}/chargeback" + */ + cancelation_data?: string; + }; + response: {}; + }; /** - * Comprimento do produito, em centímetros + * Altera o status do pacote para "enviado" */ - length?: number; + "PATCH /api/v2/orders/:orderCode/packages/:packageCode/ship": {}; /** - * Massa do produto, em gramas + * Altera o pacote para "entregue" */ - weight?: number; + "PATCH /api/v2/orders/:orderCode/packages/:packageCode/deliver": {}; /** - * Dias de manuseio da variante + * Recebe uma lista JSON com os SKUs que devem ser atualizados. A atualização será executada em segundo plano em aproximadamente 1 minuto */ - handling_days?: number; - price?: number; + "POST /api/v2/variants/quantity": { + body: { + sku: string; + quantity: number; + /** + * Informe somente para atualizar o estoque de um local específico + */ + place_id?: number; + }[]; + }; /** - * Customização da variante + * Atualiza o estoque de uma variante de um produto */ - custom_attributes?: {}; - min_quantity?: number; - norder?: number; - property1?: string; - property2?: string; - property3?: string; - barcode?: string; -} - - } -/** @description Permite remover uma variante */ - "DELETE /api/v2/products/:product_id/variants/:id": { - - } -/** @description Permite atualizar uma variante */ - "PATCH /api/v2/products/:product_id/variants/:id": { - searchParams: { - sku?: string; - name?: string; - quantity?: number; - main?: boolean; - width?: number; - height?: number; - length?: number; - weight?: number; - handling_days?: number; - price?: number; - custom_attributes?: {}; - min_quantity?: number; - norder?: number; - property1?: string; - property2?: string; - property3?: string; - barcode?: string; - quantity_sold?: number; -} - - } -/** @description Permite determinar a ordem das variantes dentro de cada produto */ - "POST /api/v2/variants/reorder": { - searchParams: { + "POST /api/v2/variants/:sku/quantity": { + searchParams: { + quantity: number; + }; + response: { + status?: string; + }; + }; /** - * A ordem dos elementos será replicada para as variantes + * Atualiza o estoque específico de um local */ - ids?: number[]; -} - - } -/** @description Retorna um template usando o path dele */ - "GET /api/v2/templates/:path": { - - } -/** @description Remove um template usando o path dele */ - "DELETE /api/v2/templates/:path": { - - } -/** @description Atualiza o conteúdo de um template usando o path dele */ - "PATCH /api/v2/templates/:path": { - searchParams: { - body?: string; -} - - } -/** @description Retorna uma lista de templates */ - "GET /api/v2/templates": { - - } -/** @description Cria um novo template */ - "POST /api/v2/templates": { - searchParams: { - path?: string; - body?: string; -} - - } -/** @description Reativa um usuário que estiver desativado */ - "POST /api/v2/users/:id/activate": { - - } -/** @description Desativa um usuário */ - "POST /api/v2/users/:id/deactivate": { - - } -/** @description Lista os usuários */ - "GET /api/v2/users": { - - } -/** @description Cria um usuário */ - "POST /api/v2/users": { - searchParams: { - email?: string; - name?: string; - role_name?: - | {"0": "A"; "1": "g"; "2": "e"; "3": "n"; "4": "t"; "5": "e"} - | {"0": "G"; "1": "e"; "2": "s"; "3": "t"; "4": "o"; "5": "r"} - | {"0": "L"; "1": "o"; "2": "c"; "3": "a"; "4": "l"}; - password?: string; - password_confirmation?: string; - external_code?: string; - phone_area?: string; - phone?: string; - tags?: string[]; -} - - } -/** @description Lista os usuários */ - "GET /api/v2/users/tags": { - - } -/** @description Retorna a lista de carrinhos ativos nos últimos 60 dias */ - "GET /api/v2/carts": { - - } -/** @description Permite criar um carrinho */ - "POST /api/v2/carts": { - searchParams: /** - * Parâmetros criação e atualização de carrinho - */ -export interface ParametrosDeCarrinhoResumido { + "PATCH /api/v2/variants/:sku/inventories/:placeId": { + searchParams: { + quantity?: number; + }; + response: { + status?: string; + }; + }; /** - * Agente que criou o carrinho + * Permite listar as variantes de um produto */ - agent?: string; + "GET /api/v2/products/:productId/variants": { + response: Variant[]; + }; /** - * Código de Endereçamento Postal (CEP) do destinatário do pedido + * Permite criar uma variante + */ + "POST /api/v2/products/:productId/variants": { + body: { + sku: string; + name?: string; + quantity: number; + main?: boolean; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + price: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: string; + property2?: string; + property3?: string; + barcode?: string; + }; + response: { + id?: number; + main?: boolean; + available?: boolean; + sku?: string; + name?: string; + slug?: string; + min_quantity?: number; + quantity?: number; + /** + * Quantidade de itens disponíveis + */ + stock?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + properties?: {}; + /** + * Data e horário da última atualização + */ + updated_at?: string; + price?: number; + installments?: number[]; + available_quantity?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + inventories?: VariantInventory[]; + sale_price?: number; + image_url?: string; + product_id?: number; + norder?: number; + }; + }; + /** + * Permite remover uma variante */ - zip?: string; + "DELETE /api/v2/products/:productId/variants/:id": {}; /** - * Código identificador `ID` do cliente + * @deprecated + * Permite atualizar uma variante + */ + "PATCH /api/v2/products/:productId/variants/:id": { + body: { + sku: string; + name?: string; + quantity: number; + main?: boolean; + width?: number; + height?: number; + length?: number; + weight?: number; + handling_days?: number; + price: number; + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: string; + property2?: string; + property3?: string; + barcode?: string; + quantity_sold?: number; + }; + }; + /** + * Permite determinar a ordem das variantes dentro de cada produto */ - client_id?: number; + "POST /api/v2/variants/reorder": { + body: { + /** + * A ordem dos elementos será replicada para as variantes + */ + ids: number[]; + }; + }; /** - * Código identificador `ID` do desconto do carrinho + * Retorna um template usando o path dele */ - coupon_code?: string; + "GET /api/v2/templates/:path": { + response: Template; + }; /** - * @deprecated - * Email do cliente + * Remove um template usando o path dele */ - email?: string; + "DELETE /api/v2/templates/:path": {}; /** - * Token do desconto + * Atualiza o conteúdo de um template usando o path dele */ - rebate_token?: string; -} - - } -/** @description Permite retornar um carrinho */ - "GET /api/v2/carts/:id": { - - } -/** @description Permite criar um carrinho */ - "POST /api/v2/carts/:id": { - searchParams: { - agent?: string; - zip?: string; - client_id?: number; - coupon_code?: string; + "PATCH /api/v2/templates/:path": { + body: { + body?: string; + }; + }; /** - * DEPRECATED: enviar o `client_id` + * Retorna uma lista de templates */ - email?: string; - rebate_token?: string; -} - - } -/** @description Permite excluir um carrinho */ - "DELETE /api/v2/carts/:id": { - - } -/** @description Permite atualizar os atributos de um carrinho */ - "PATCH /api/v2/carts/:id": { - searchParams: { - agent?: string; - zip?: string; - client_id?: number; + "GET /api/v2/templates": { + response: Template[]; + }; /** - * DEPRECATED: enviar o `client_id` + * Cria um novo template */ - email?: string; - rebate_token?: string; -} - - } -/** @description Permite calcular as parcelas referentes ao total do carrinho */ - "GET /api/v2/carts/:id/installments": { - - } -/** @description Lista os locais */ - "GET /api/v2/places": { - - } -/** @description Cria um local */ - "POST /api/v2/places": { - searchParams: { - name?: string; - address_line_1?: string; - address_line_2?: string; - city?: string; - neighborhood?: string; - zip?: string; - home_page?: string; - latitude?: number; - longitude?: number; - images?: string[]; - description?: string; - email?: string; - first_phone?: string; - second_phone?: string; - mobile_phone?: string; - only_cash?: boolean; - categories?: string[]; - marker_url?: string; - state?: string; - opening_hours?: string; - warehouse?: boolean; - legal_name?: string; - cnpj?: string; -} - - } -/** @description Remove um local */ - "DELETE /api/v2/places/:id": { - - } -/** @description Atualiza um local */ - "PATCH /api/v2/places/:id": { - searchParams: { - name?: string; - address_line_1?: string; - address_line_2?: string; - city?: string; - neighborhood?: string; - zip?: string; - home_page?: string; - latitude?: number; - longitude?: number; - images?: string[]; - description?: string; - email?: string; - first_phone?: string; - second_phone?: string; - mobile_phone?: string; - only_cash?: boolean; - categories?: string[]; - marker_url?: string; - state?: string; - opening_hours?: string; - warehouse?: boolean; - legal_name?: string; - cnpj?: string; -} - - } -/** @description Lista as notas fiscais */ - "GET /api/v2/orders/:code/packages/:package_code/invoices": { - - } -/** @description Cria uma nota fiscal */ - "POST /api/v2/orders/:code/packages/:package_code/invoices": { - searchParams: { - number?: number; - series?: number; - issued_at?: string; - key?: string; - volumes?: number; -} - - } -/** @description Remove uma nota fiscal */ - "DELETE /api/v2/orders/:code/packages/:package_code/invoices/:number": { - - } -/** @description Atualiza uma nota fiscal */ - "PATCH /api/v2/orders/:code/packages/:package_code/invoices/:number": { - searchParams: { - number?: number; - series?: number; - issued_at?: string; - key?: string; - volumes?: number; -} - - } -/** @description Será enviado por email um link para o cadastro da nova senha -O link tem validade de 24 horas */ - "POST /api/v2/users/reset_password": { - searchParams: { - email?: string; -} - - } -/** @description Cadastra a nova senha */ - "PATCH /api/v2/users/reset_password": { - searchParams: { + "POST /api/v2/templates": { + body: { + path: string; + body?: string; + }; + response: Template; + }; + /** + * Reativa um usuário que estiver desativado + */ + "POST /api/v2/users/:id/activate": {}; + /** + * Desativa um usuário + */ + "POST /api/v2/users/:id/deactivate": {}; + /** + * Lista os usuários + */ + "GET /api/v2/users": { + searchParams: { + /** + * Incluir usuários desativados? + */ + include_inactive?: boolean; + /** + * Incluir todas as imagens dos produtos? + */ + include_images?: boolean; + /** + * Exibe somente os usuários com o código externo indicado + */ + external_code?: string; + /** + * Exibe somente os usuários com a função indicada + */ + role_name?: "Agente" | "Gestor" | "Local"; + /** + * Filtra usuários que contenham o valor indicado no nome, telefone, email ou código externo + */ + term?: string; + }; + response: User1[]; + }; + /** + * Cria um usuário + */ + "POST /api/v2/users": { + body: { + email?: string; + name?: string; + role_name?: "Agente" | "Gestor" | "Local"; + password?: string; + password_confirmation?: string; + external_code?: string; + phone_area?: string; + phone?: string; + tags?: string[]; + }; + response: User; + }; + /** + * Lista os usuários + */ + "GET /api/v2/users/tags": { + searchParams: { + /** + * Exibe somente os usuários com a função indicada + */ + role_names?: "Agente" | "Gestor" | "Local" | "Agente Social Selling"; + }; + response: { + tags?: string[]; + }; + }; + /** + * Retorna a lista de carrinhos ativos nos últimos 60 dias + */ + "GET /api/v2/carts": { + searchParams: { + /** + * Número da página + */ + page?: number; + /** + * Quantidade de produtos por página + */ + per_page?: number; + /** + * Inclui os carrinhos sem telefone (não enviar o campo para não incluir) + */ + without_phones?: boolean; + /** + * Filtra os carrinhos que possuem tentativa de pagamento + */ + with_payments?: boolean; + }; + response: Cart[]; + }; /** - * Token pare renovação de senha enviado por email + * Permite criar um carrinho */ - token?: string; + "POST /api/v2/carts": { + body: ParametrosDeCarrinhoResumido; + response: Cart1; + }; /** - * Nova senha para o usuário + * Permite retornar um carrinho */ - password?: string; + "GET /api/v2/carts/:id": { + response: Cart1; + }; + /** + * Permite criar um carrinho + */ + "POST /api/v2/carts/:id": { + body: { + agent?: string; + zip?: string; + client_id?: number; + coupon_code?: string; + /** + * DEPRECATED: enviar o `client_id` + */ + email?: string; + rebate_token?: string; + }; + response: Cart1; + }; /** - * Confirmação da nova senha do usuário + * Permite excluir um carrinho */ - password_confirmation?: string; -} - - } -/** @description Retorna o endereço de entrega */ - "GET /api/v2/orders/:code/shipping_address": { - - } -/** @description Lista os recebedores */ - "GET /api/v2/payment_recipients": { - - } -/** @description Cria um recebedor */ - "POST /api/v2/payment_recipients": { - searchParams: { - tag_id?: number; - recipient_id?: number; - percentage?: number; - active?: boolean; - charge_processing_fee?: boolean; - liable?: boolean; - code?: string; - place_id?: number; - user_id?: number; + "DELETE /api/v2/carts/:id": {}; /** - * Indica se o frete deve ser incluído no split do pagamento + * Permite atualizar os atributos de um carrinho */ - include_shipping?: boolean; -} - - } -/** @description Retorna um recebedor */ - "GET /api/v2/payment_recipients/:id": { - - } -/** @description Remove um recebedor */ - "DELETE /api/v2/payment_recipients/:id": { - - } -/** @description Atualiza um recebedor */ - "PATCH /api/v2/payment_recipients/:id": { - searchParams: { - tag_id?: number; - recipient_id?: number; - percentage?: number; - active?: boolean; - charge_processing_fee?: boolean; - liable?: boolean; - code?: string; - place_id?: number; - user_id?: number; + "PATCH /api/v2/carts/:id": { + body: { + agent?: string; + zip?: string; + client_id?: number; + /** + * DEPRECATED: enviar o `client_id` + */ + email?: string; + rebate_token?: string; + }; + }; /** - * Indica se o frete deve ser incluído no split do pagamento + * Permite calcular as parcelas referentes ao total do carrinho */ - include_shipping?: boolean; -} - - } -/** @description Permite a listagem de recebíveis do usuário */ - "GET /api/v2/users/:user_id/payables": { - - } -/** @description Lista os membros da audiência */ - "GET /api/v2/audience_members": { - - } -/** @description Permite criar um membro da audiência */ - "POST /api/v2/audience_members": { - searchParams: { - first_name?: string; - last_name?: string; - email?: string; - phone_area?: string; - phone?: string; - tags?: string[]; -} - - } -/** @description Permite remover um membro da audiência */ - "DELETE /api/v2/audience_members/:id": { - - } -/** @description Permite alterar um membro da audiência */ - "PATCH /api/v2/audience_members/:id": { - searchParams: { - first_name?: string; - last_name?: string; - email?: string; - phone_area?: string; - phone?: string; - tags?: string[]; -} - - } -/** @description Lista os rastreios de um pacote de um pedido */ - "GET /api/v2/orders/:order_code/packages/:package_code/trackings": { - - } -/** @description Adiciona um rastreio para um pacote de um pedido */ - "POST /api/v2/orders/:order_code/packages/:package_code/trackings": { - searchParams: { + "GET /api/v2/carts/:id/installments": { + response: CartInstallment1[]; + }; + /** + * Lista os locais + */ + "GET /api/v2/places": { + searchParams: { + /** + * Filtra os locais for nome + */ + names?: string[]; + /** + * Filtra os locais que são/não são warehouse + */ + warehouse?: boolean; + /** + * Filtra os locais que contenham determinada categoria + */ + category?: string; + /** + * As lojas mais próximas da coordenada informada serão exibidas primeiro + */ + coordinates?: string; + /** + * As lojas mais próximas do CEP informado serão exibidas primeiro + */ + origin_zip_code?: string; + }; + response: Place[]; + }; /** - * Código de rastreio + * Cria um local + */ + "POST /api/v2/places": { + body: { + name: string; + address_line_1: string; + address_line_2?: string; + city: string; + neighborhood?: string; + zip?: string; + home_page?: string; + latitude?: number; + longitude?: number; + images?: string[]; + description?: string; + email: string; + first_phone?: string; + second_phone?: string; + mobile_phone?: string; + only_cash?: boolean; + categories?: string[]; + marker_url?: string; + state?: string; + opening_hours?: string; + warehouse?: boolean; + legal_name?: string; + cnpj?: string; + }; + response: Place; + }; + /** + * Remove um local + */ + "DELETE /api/v2/places/:id": {}; + /** + * Atualiza um local + */ + "PATCH /api/v2/places/:id": { + body: { + name: string; + address_line_1: string; + address_line_2?: string; + city: string; + neighborhood?: string; + zip?: string; + home_page?: string; + latitude?: number; + longitude?: number; + images?: string[]; + description?: string; + email: string; + first_phone?: string; + second_phone?: string; + mobile_phone?: string; + only_cash?: boolean; + categories?: string[]; + marker_url?: string; + state?: string; + opening_hours?: string; + warehouse?: boolean; + legal_name?: string; + cnpj?: string; + }; + }; + /** + * Lista as notas fiscais */ - code?: string; + "GET /api/v2/orders/:code/packages/:packageCode/invoices": { + response: Invoice[]; + }; /** - * Transportadora + * Cria uma nota fiscal + */ + "POST /api/v2/orders/:code/packages/:packageCode/invoices": { + body: { + number: number; + series?: number; + issued_at?: string; + key?: string; + volumes?: number; + }; + response: Invoice; + }; + /** + * Remove uma nota fiscal */ - company?: string; + "DELETE /api/v2/orders/:code/packages/:packageCode/invoices/:number": {}; /** - * Link de rastreamento + * Atualiza uma nota fiscal */ - url?: string; -} - - } -/** @description Remove um rastreio */ - "DELETE /api/v2/orders/:order_code/packages/:package_code/trackings/:id": { - - } -/** @description Lista os itens de um carrinho */ - "GET /api/v2/carts/:cart_id/items": { - - } -/** @description Permite criar um item do carrinho */ - "POST /api/v2/carts/:cart_id/items": { - searchParams: /** - * Modelo de carcaterística de produto para item no carrinho - */ -export interface Produto { + "PATCH /api/v2/orders/:code/packages/:packageCode/invoices/:number": { + body: { + number: number; + series?: number; + issued_at?: string; + key?: string; + volumes?: number; + }; + }; /** - * Código SKU da variante do produto + * Será enviado por email um link para o cadastro da nova senha + * O link tem validade de 24 horas */ - sku?: string; + "POST /api/v2/users/reset_password": { + body: { + email: string; + }; + }; /** - * Unidades do produto disponíveis fisicamente + * Cadastra a nova senha + */ + "PATCH /api/v2/users/reset_password": { + body: { + /** + * Token pare renovação de senha enviado por email + */ + token: string; + /** + * Nova senha para o usuário + */ + password: string; + /** + * Confirmação da nova senha do usuário + */ + password_confirmation: string; + }; + }; + /** + * Retorna o endereço de entrega + */ + "GET /api/v2/orders/:code/shipping_address": { + response: { + id?: number; + first_name: string; + last_name: string; + company_name?: string; + email: string; + /** + * Serão retornados apenas os campos preenchidos + */ + documents?: { + cpf?: string; + cnpj?: string; + ie?: string; + }; + street_name: string; + street_number: string; + complement?: string; + neighborhood: string; + /** + * Somente números + */ + first_phone_area: string; + /** + * Somente números + */ + first_phone: string; + /** + * Somente números + */ + second_phone_area?: string; + /** + * Somente números + */ + second_phone?: string; + reference?: string; + /** + * Somente números + */ + zip: string; + city: string; + state: string; + recipient_name?: string; + }; + }; + /** + * Lista os recebedores */ - quantity?: number; + "GET /api/v2/payment_recipients": { + response: PaymentRecipient[]; + }; /** - * Campo para registro de observações, chave ou valores necessários + * Cria um recebedor + */ + "POST /api/v2/payment_recipients": { + body: { + tag_id?: number; + recipient_id?: number; + percentage: number; + active?: boolean; + charge_processing_fee?: boolean; + liable?: boolean; + code?: string; + place_id?: number; + user_id?: number; + /** + * Indica se o frete deve ser incluído no split do pagamento + */ + include_shipping?: boolean; + }; + response: PaymentRecipient; + }; + /** + * Retorna um recebedor */ - extra?: {}; + "GET /api/v2/payment_recipients/:id": { + response: PaymentRecipient; + }; /** - * Código identificador do local do produto + * Remove um recebedor + */ + "DELETE /api/v2/payment_recipients/:id": {}; + /** + * Atualiza um recebedor + */ + "PATCH /api/v2/payment_recipients/:id": { + body: { + tag_id?: number; + recipient_id?: number; + percentage?: number; + active?: boolean; + charge_processing_fee?: boolean; + liable?: boolean; + code?: string; + place_id?: number; + user_id?: number; + /** + * Indica se o frete deve ser incluído no split do pagamento + */ + include_shipping?: boolean; + }; + }; + /** + * Permite a listagem de recebíveis do usuário */ - place_id?: number; + "GET /api/v2/users/:userId/payables": { + response: RecebiveisDoUsuario[]; + }; /** - * Código de cupom + * Lista os membros da audiência */ - store_coupon_code?: string; + "GET /api/v2/audience_members": { + response: AudienceMember[]; + }; /** - * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto + * Permite criar um membro da audiência + */ + "POST /api/v2/audience_members": { + body: { + first_name?: string; + last_name?: string; + email: string; + phone_area?: string; + phone?: string; + tags?: string[]; + }; + response: AudienceMember; + }; + /** + * Permite remover um membro da audiência */ - customizations?: { - /** - * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. - * Se por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. - */ - Customization?: string; - }[]; -} - - } -/** @description Remove um item do carrinho */ - "DELETE /api/v2/carts/:cart_id/items/:id": { - - } -/** @description Atualiza um item do carrinho */ - "PATCH /api/v2/carts/:cart_id/items/:id": { - searchParams: { - quantity?: number; - place_id?: number; - extra?: {}; - store_coupon_code?: string; -} - - } -/** @description Permite adicionar itens em bulk ao carrinho */ - "POST /api/v2/carts/:cart_id/items/bulk": { - searchParams: { - sku?: string; - quantity?: number; - extra?: {}; - place_id?: number; + "DELETE /api/v2/audience_members/:id": {}; /** - * Itens do carrinho + * Permite alterar um membro da audiência */ - items?: unknown[][]; -} - - } -/** @description Cria uma promoção */ - "POST /api/v2/discounts": { - searchParams: { - name?: string; - start_at?: string; - end_at?: string; - valid_to?: {"0": "s"; "1": "t"; "2": "o"; "3": "r"; "4": "e"} | {"0": "c"; "1": "a"; "2": "r"; "3": "t"}; - description?: string; - enabled?: boolean; - email?: string; - cpf?: string; - tags?: string; -} - - } -/** @description Retorna uma promoção */ - "GET /api/v2/discounts/:id": { - - } -/** @description Remove uma promoção */ - "DELETE /api/v2/discounts/:id": { - - } -/** @description Altera uma promoção */ - "PATCH /api/v2/discounts/:id": { - searchParams: { - name?: string; - start_at?: string; - end_at?: string; - valid_to?: {"0": "s"; "1": "t"; "2": "o"; "3": "r"; "4": "e"} | {"0": "c"; "1": "a"; "2": "r"; "3": "t"}; - description?: string; - enabled?: boolean; - email?: string; - cpf?: string; - tags?: string; -} - - } -/** @description Lista as regras de desconto de uma promoção */ - "GET /api/v2/discounts/:discount_id/rules": { - - } -/** @description Cria uma regra de desconto */ - "POST /api/v2/discounts/:discount_id/rules": { - searchParams: { - apply_to?: - | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} - | {"0": "t"; "1": "a"; "2": "g"} - | {"0": "s"; "1": "u"; "2": "b"; "3": "t"; "4": "o"; "5": "t"; "6": "a"; "7": "l"} - | {"0": "t"; "1": "o"; "2": "t"; "3": "a"; "4": "l"} - | {"0": "s"; "1": "h"; "2": "i"; "3": "p"; "4": "p"; "5": "i"; "6": "n"; "7": "g"}; - amount_type?: {"0": "R"; "1": "$"} | {"0": "%"}; - amount?: number; - product_id?: number; - tag_name?: string; - min_quantity?: number; - shipping_method?: string; - min_subtotal?: number; - gift?: boolean; - combinated_product_id?: number; - client_tag?: string; - shipping_rule?: string; - gift_quantity?: number; - agent_tag?: string; - regions?: string[]; - channel?: string[]; -} - - } -/** @description Remove uma regra de desconto */ - "DELETE /api/v2/discounts/:discount_id/rules/:id": { - - } -/** @description Altera uma regra de desconto */ - "PATCH /api/v2/discounts/:discount_id/rules/:id": { - searchParams: { - apply_to?: - | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} - | {"0": "t"; "1": "a"; "2": "g"} - | {"0": "s"; "1": "u"; "2": "b"; "3": "t"; "4": "o"; "5": "t"; "6": "a"; "7": "l"} - | {"0": "t"; "1": "o"; "2": "t"; "3": "a"; "4": "l"} - | {"0": "s"; "1": "h"; "2": "i"; "3": "p"; "4": "p"; "5": "i"; "6": "n"; "7": "g"}; - amount_type?: {"0": "R"; "1": "$"} | {"0": "%"}; - amount?: number; - product_id?: number; - tag_id?: number; - min_quantity?: number; - shipping_method?: string; - min_subtotal?: number; - gift?: boolean; - combinated_product_id?: number; - client_tag?: string; - shipping_rule?: string; - gift_quantity?: number; - agent_tag?: string; - regions?: string[]; - channel?: string[]; -} - - } -/** @description Permite listar os cupons de desconto de uma promoção */ - "GET /api/v2/discounts/:discount_id/coupons": { - - } -/** @description Cria um cupom de desconto */ - "POST /api/v2/discounts/:discount_id/coupons": { - searchParams: { - code?: string; - uses_per_code?: number; - uses_per_user?: number; - referrer_email?: string; - quantity?: number; - user_id?: number; -} - - } -/** @description Remove um cupom de desconto */ - "DELETE /api/v2/discounts/:discount_id/coupons:id": { - - } -/** @description Atualiza um cupom de desconto */ - "PATCH /api/v2/discounts/:discount_id/coupons:id": { - searchParams: { + "PATCH /api/v2/audience_members/:id": { + body: { + first_name?: string; + last_name?: string; + email?: string; + phone_area?: string; + phone?: string; + tags?: string[]; + }; + }; + /** + * Lista os rastreios de um pacote de um pedido + */ + "GET /api/v2/orders/:orderCode/packages/:packageCode/trackings": { + response: { + id?: number; + /** + * Código de rastreio do pacote + */ + tracking_code: string; + /** + * Data e horário da última atualização do código de rastreio do pacote + */ + tracked_at?: string; + /** + * URL para rastreio do pedido com a transportadora + */ + url?: string; + /** + * Transportadora do pacote + */ + company?: string; + }; + }; /** - * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + * Adiciona um rastreio para um pacote de um pedido + */ + "POST /api/v2/orders/:orderCode/packages/:packageCode/trackings": { + body: { + /** + * Código de rastreio + */ + code: string; + /** + * Transportadora + */ + company?: string; + /** + * Link de rastreamento + */ + url?: string; + }; + response: { + /** + * Código de rastreio do pacote + */ + code: string; + /** + * Transportadora + */ + company?: string; + /** + * URL para rastreio do pacote na transportadora + */ + url?: string; + }; + }; + /** + * Remove um rastreio */ - uses_per_code?: number; + "DELETE /api/v2/orders/:orderCode/packages/:packageCode/trackings/:id": {}; /** - * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + * Lista os itens de um carrinho */ - uses_per_user?: number; -} - - } -/** @description Lista os produtos */ - "GET /api/v2/products": { - - } -/** @description Cria um produto */ - "POST /api/v2/products": { - searchParams: /** - * Modelo simplificado de um produto para atualização e criação - */ -export interface SimpleProduct { + "GET /api/v2/carts/:cartId/items": { + response: CartItem[]; + }; /** - * Código de Referência do produto + * Permite criar um item do carrinho */ - reference?: string; + "POST /api/v2/carts/:cartId/items": { + body: Produto; + response: CartItem; + }; /** - * Nome do produto + * Remove um item do carrinho */ - name?: string; + "DELETE /api/v2/carts/:cartId/items/:id": {}; /** - * Descrição do produto + * Atualiza um item do carrinho */ - description?: string; + "PATCH /api/v2/carts/:cartId/items/:id": { + body: { + quantity?: number; + place_id?: number; + extra?: {}; + store_coupon_code?: string; + }; + }; /** - * Indica se o produto está ativo (`true`) ou invativo (`false`) + * Permite adicionar itens em bulk ao carrinho + */ + "POST /api/v2/carts/:cartId/items/bulk": { + body: { + sku: string; + quantity: number; + extra?: {}; + place_id?: number; + /** + * Itens do carrinho + */ + items?: any[][]; + minItems?: 0; + }; + response: CartItem[]; + }; + /** + * Cria uma promoção + */ + "POST /api/v2/discounts": { + body: { + name: string; + start_at: string; + end_at?: string; + valid_to?: "store" | "cart"; + description?: string; + enabled?: boolean; + email?: string; + cpf?: string; + tags?: string; + }; + response: Discount1; + }; + /** + * Retorna uma promoção */ - active?: boolean; + "GET /api/v2/discounts/:id": { + response: Discount1; + }; /** - * Tags associadas ao produto + * Remove uma promoção */ - tag_list?: string; + "DELETE /api/v2/discounts/:id": {}; /** - * Tipo de produto + * Altera uma promoção */ - product_type?: - | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} - | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} - | { - "0": "s"; - "1": "u"; - "2": "b"; - "3": "s"; - "4": "c"; - "5": "r"; - "6": "i"; - "7": "p"; - "8": "t"; - "9": "i"; - "10": "o"; - "11": "n"; - }; -} - - } -/** @description Retorna um produto */ - "GET /api/v2/products/:id": { - - } -/** @description Remove um produto */ - "DELETE /api/v2/products/:id": { - - } -/** @description Atualiza um produto */ - "PATCH /api/v2/products/:id": { - searchParams: { - name?: string; - description?: string; - active?: boolean; - reference?: string; - tag_list?: string; -} - - } -/** @description Permite atualizar um produto pela referência */ - "PATCH /api/v2/products/reference/:reference": { - searchParams: { - reference?: string; - name?: string; - description?: string; - active?: boolean; - product_type?: - | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} - | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} - | { - "0": "s"; - "1": "u"; - "2": "b"; - "3": "s"; - "4": "c"; - "5": "r"; - "6": "i"; - "7": "p"; - "8": "t"; - "9": "i"; - "10": "o"; - "11": "n"; - }; -} - - } -/** @description Recebe uma avaliação e recalcula a pontuação atual */ - "POST /api/v2/products/:id/rate": { - - } -/** @description Busca os produtos de acordo com os parâmetros definidos */ - "GET /api/v2/products/search": { - - } -/** @description Retorna uma variante pelo SKU */ - "GET /api/v2/variants/:sku": { - - } -/** @description Permite atualizar uma variante pelo SKU */ - "PATCH /api/v2/variants/:sku": { - searchParams: { - sku?: string; - name?: string; - quantity?: number; - main?: boolean; + "PATCH /api/v2/discounts/:id": { + body: { + name: string; + start_at: string; + end_at?: string; + valid_to?: "store" | "cart"; + description?: string; + enabled?: boolean; + email?: string; + cpf?: string; + tags?: string; + }; + }; /** - * Largura do produto, em centímetros + * Lista as regras de desconto de uma promoção */ - width?: number; + "GET /api/v2/discounts/:discountId/rules": { + response: DiscountRule[]; + }; /** - * Altura do produto, em centímetros + * Cria uma regra de desconto + */ + "POST /api/v2/discounts/:discountId/rules": { + body: { + apply_to?: "product" | "tag" | "subtotal" | "total" | "shipping"; + amount_type?: "R$" | "%"; + amount?: number; + product_id?: number; + tag_name?: string; + min_quantity?: number; + shipping_method?: string; + min_subtotal?: number; + gift?: boolean; + combinated_product_id?: number; + client_tag?: string; + shipping_rule?: string; + gift_quantity?: number; + agent_tag?: string; + regions?: string[]; + channel?: string[]; + }; + response: { + id?: number; + amount?: number; + apply_to?: "product" | "tag" | "subtotal" | "total" | "shipping"; + min_quantity?: number; + type?: string; + channel?: string[]; + }; + }; + /** + * Remove uma regra de desconto + */ + "DELETE /api/v2/discounts/:discountId/rules/:id": {}; + /** + * Altera uma regra de desconto + */ + "PATCH /api/v2/discounts/:discountId/rules/:id": { + body: { + apply_to?: "product" | "tag" | "subtotal" | "total" | "shipping"; + amount_type?: "R$" | "%"; + amount?: number; + product_id?: number; + tag_id?: number; + min_quantity?: number; + shipping_method?: string; + min_subtotal?: number; + gift?: boolean; + combinated_product_id?: number; + client_tag?: string; + shipping_rule?: string; + gift_quantity?: number; + agent_tag?: string; + regions?: string[]; + channel?: string[]; + }; + }; + /** + * Permite listar os cupons de desconto de uma promoção */ - height?: number; + "GET /api/v2/discounts/:discountId/coupons": { + searchParams: { + /** + * Filtra os cupons pelo campo uses_per_code + */ + uses_per_code?: number; + }; + response: Coupon[]; + }; /** - * Comprimento do produito, em centímetros + * Cria um cupom de desconto + */ + "POST /api/v2/discounts/:discountId/coupons": { + body: { + code?: string; + uses_per_code?: number; + uses_per_user?: number; + referrer_email?: string; + quantity?: number; + user_id?: number; + }; + response: Coupon; + }; + /** + * Remove um cupom de desconto */ - length?: number; + "DELETE /api/v2/discounts/:discountId/coupons:id": {}; /** - * Massa do produto, em gramas + * Atualiza um cupom de desconto */ - weight?: number; + "PATCH /api/v2/discounts/:discountId/coupons:id": { + body: { + /** + * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + */ + uses_per_code?: number; + /** + * Caso deseje um uso ilimitado do cupom, o valor desse campo deverá ser 0 + */ + uses_per_user?: number; + }; + }; /** - * Dias de manuseio da variante + * Lista os produtos + */ + "GET /api/v2/products": { + searchParams: { + /** + * Delimita a quantidade de itens retornados + */ + limit?: number; + /** + * Número da página + */ + page?: number; + /** + * Quantidade de produtos por página + */ + per_page?: number; + /** + * Filtra pela referência + */ + reference?: string; + /** + * Filtra pelo ID dos produtos + */ + ids?: string[]; + /** + * Filtra produtos que coném a tag + */ + tag?: string; + /** + * Filtra produtos alterados depois da data + */ + updated_after?: string; + /** + * Exibe os produtos cadastrados recentemente primeiro + */ + sort?: "newest"; + /** + * Inclui os produtos inativos na listagem + */ + include_inactive?: boolean; + /** + * Inclui na requisição se deseja que venham todas as imagens do produto + */ + include_images?: boolean; + }; + response: Product[]; + }; + /** + * Cria um produto + */ + "POST /api/v2/products": { + body: SimpleProduct; + response: { + id?: number; + /** + * Indica se o produto está ativo (`true`) ou inativo (`false`) + */ + active?: boolean & string; + /** + * Código de Referência do produto + */ + reference: string; + /** + * Nome do produto + */ + name: string; + /** + * Descrição do produto + */ + description?: string; + /** + * Lista de tags associadas ao produto + */ + tag_list?: string[]; + slug?: string; + url?: string; + updated_at?: string; + /** + * Tipo de produto, entre: + * - `sample`: amostra + * - `subscription`: assinatura + * - `product`: produto em geral + */ + product_type?: "product" | "sample" | "subscription"; + }; + }; + /** + * Retorna um produto + */ + "GET /api/v2/products/:id": { + searchParams: { + /** + * Lista de cupons para calcular o desconto do produto + */ + coupon_codes?: string[]; + /** + * Se "true", inclui o nome do local nos inventários das variantes + */ + include_inventory_place?: string; + /** + * Se "true", inclui todas as imagens do produto + */ + include_images?: string; + }; + response: Product; + }; + /** + * Remove um produto */ - handling_days?: number; + "DELETE /api/v2/products/:id": {}; /** - * Preço do item + * Atualiza um produto */ - price?: number; + "PATCH /api/v2/products/:id": { + body: { + name: string; + description?: string; + active?: boolean; + reference: string; + tag_list?: string; + }; + }; /** - * Customização da variante + * Permite atualizar um produto pela referência */ - custom_attributes?: {}; - min_quantity?: number; - norder?: number; - property1?: VariantProperty; - property2?: VariantProperty; - property3?: VariantProperty; - barcode?: string; + "PATCH /api/v2/products/reference/:reference": { + body: { + reference: string; + name: string; + description?: string; + active?: boolean; + product_type?: "product" | "sample" | "subscription"; + }; + }; /** - * Quantidade de itens vendidos + * Recebe uma avaliação e recalcula a pontuação atual + */ + "POST /api/v2/products/:id/rate": { + searchParams: { + /** + * Avaliação + */ + rate?: number; + }; + response: { + rating?: string; + votes?: string; + }; + }; + /** + * Busca os produtos de acordo com os parâmetros definidos + */ + "GET /api/v2/products/search": { + searchParams: { + /** + * Número da página + */ + page?: number; + /** + * Quantidade de produtos por página + */ + per_page?: number; + /** + * Filtra pelo ID dos produtos + */ + "ids[]"?: number[]; + /** + * Filtra produtos que contenham o termo + */ + term?: string; + /** + * Permite que o filtro 'term' realize filtragem de produtos por termo parcial + */ + wildcard?: boolean; + /** + * Filtra pelo nome da tag dentro de um tipo de tag. Exemplo, type_tags[cor]=verde + */ + type_tags?: {}; + /** + * Operador lógico para o filtro de tag + */ + type_tags_operator?: "and" | "or"; + /** + * Filtra pelo valor da propriedade 1 + */ + property1_values?: string[]; + /** + * Operador lógico para o filtro de valor da propriedade 1 + */ + property1_operator?: "and" | "or"; + /** + * Filtra pelo valor da propriedade 2 + */ + property2_values?: string[]; + /** + * Operador lógico para o filtro de valor da propriedade 2 + */ + property2_operator?: "and" | "or"; + /** + * Filtra pelo valor da propriedade 3 + */ + property3_values?: string[]; + /** + * Operador lógico para o filtro de valor da propriedade 3 + */ + property3_operator?: "and" | "or"; + /** + * Filtra pelo preço de venda mínimo do produto + */ + min_price?: number; + /** + * Filtra pelo preço de venda máximo do produto + */ + max_price?: number; + /** + * Filtra pelo nome das tags, independente do tipo + */ + "tags[]"?: string[]; + /** + * Filtra pelo nome das tags, independente do tipo + */ + parent_tags?: string[]; + /** + * Filtra por produtos disponíveis + */ + show_only_available?: boolean; + /** + * Ordena o resultado da busca de produtos conforme a opção escolhida + */ + sort?: "newest" | "oldest" | "lowest_price" | "highest_price"; + }; + response: { + results?: ProductSearch[]; + aggregations?: { + min_price?: number; + max_price?: number; + types?: {}; + properties?: { + property1?: { + value?: string; + count?: number; + }[]; + property2?: { + value?: string; + count?: number; + }[]; + property3?: { + value?: string; + count?: number; + }[]; + }; + }; + }; + }; + /** + * Retorna uma variante pelo SKU */ - quantity_sold?: number; -} -/** - * Modelo que representa uma propriedade de uma variante - */ -export interface VariantProperty { + "GET /api/v2/variants/:sku": { + response: Variant; + }; /** - * Nome da propriedade + * Permite atualizar uma variante pelo SKU + */ + "PATCH /api/v2/variants/:sku": { + body: { + sku: string; + name?: string; + quantity: number; + main?: boolean; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + /** + * Preço do item + */ + price: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: VariantProperty1; + property2?: VariantProperty1; + property3?: VariantProperty1; + barcode?: string; + /** + * Quantidade de itens vendidos + */ + quantity_sold?: number; + }; + }; + /** + * Lista as imagens de uma variante passando o SKU da mesma na URL */ - name: string; + "GET /api/v2/products/:productId/variants/:sku/images": { + response: { + url: string; + /** + * Data e horário da última atualização da imagem do produto + */ + updated_at: string; + }[]; + }; /** - * Valor da propriedade + * Lista as imagens de uma variante passando o SKU da mesma nos parâmetros */ - value: string; + "GET /api/v2/products/:productId/variants/images": { + response: { + url: string; + /** + * Data e horário da última atualização da imagem do produto + */ + updated_at: string; + }[]; + }; /** - * Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`) + * Calcula o frete para uma determinada variante + */ + "GET /api/v2/variants/:sku/shipping_methods": { + body: { + quantity: number; + zip: string; + }; + response: { + name: string; + value: string; + price: number; + description: string; + delivery_days: number; + value_needed_to_discount: number; + shipping_method_id: number; + notice: string; + fulfillment_company: string; + countries: { + country?: string; + price?: string; + }[]; + }[]; + }; + /** + * Permite listar as tags + */ + "GET /api/v2/tags": { + searchParams: { + /** + * Indica a quantidade de tags que devem ser listadas (page será ignorado) + */ + limit?: number; + /** + * Número da página + */ + page?: number; + /** + * Quantidade de resultados por página + */ + per_page?: number; + /** + * Exibe somente as tags com o tipo indicado + */ + type?: string; + /** + * Exibe somente as tags com um dos tipos indicados + */ + types?: string[]; + /** + * Exibe somente as tags com um dos nomes indicados + */ + names?: string[]; + /** + * Quando passado qualquer valor filtra as tags que contenham imagens + */ + images?: string; + /** + * Quando passado qualquer valor filtra as tags marcadas para serem exibidas no carrinho + */ + show_in_carts?: string; + /** + * Exibe somente as tags do produto indicado + */ + product_id?: number; + /** + * Texto livre que permite filtrar as tags pelo nome + */ + name?: string; + /** + * String no formato , que determina o campo a ser ordenado e qual a ordem (asc,desc) + */ + sort?: + | "name,asc" + | "name,desc" + | "type,asc" + | "type,desc" + | "title,asc" + | "title,desc" + | "products_count,asc" + | "products_count,desc"; + }; + response: Tag[]; + }; + /** + * Cria uma tag + */ + "POST /api/v2/tags": { + body: { + name: string; + title?: string; + /** + * Equivalente ao subtítulo + */ + blurb?: string; + description?: string; + tag_type?: string; + show_in_carts?: boolean; + }; + response: Tag; + }; + /** + * Lista os tipos de tags usados em alguma tag + */ + "GET /api/v2/tags/types": { + searchParams: { + /** + * Número da página + */ + page?: number; + /** + * Quantidade de resultados por página + */ + per_page?: number; + }; + response: string[]; + }; + /** + * Retorna uma tag */ - defining: boolean; -} - - } -/** @description Lista as imagens de uma variante passando o SKU da mesma na URL */ - "GET /api/v2/products/:product_id/variants/:sku/images": { - - } -/** @description Lista as imagens de uma variante passando o SKU da mesma nos parâmetros */ - "GET /api/v2/products/:product_id/variants/images": { - - } -/** @description Calcula o frete para uma determinada variante */ - "GET /api/v2/variants/:sku/shipping_methods": { - searchParams: { - quantity?: number; - zip?: string; -} - - } -/** @description Permite listar as tags */ - "GET /api/v2/tags": { - - } -/** @description Cria uma tag */ - "POST /api/v2/tags": { - searchParams: { - name?: string; - title?: string; + "GET /api/v2/tags/:name": { + response: Tag; + }; /** - * Equivalente ao subtítulo + * Remove uma tag */ - blurb?: string; - description?: string; - tag_type?: string; - show_in_carts?: boolean; -} - - } -/** @description Lista os tipos de tags usados em alguma tag */ - "GET /api/v2/tags/types": { - - } -/** @description Retorna uma tag */ - "GET /api/v2/tags/:name": { - - } -/** @description Remove uma tag */ - "DELETE /api/v2/tags/:name": { - - } -/** @description Permite atualizar uma tag */ - "PATCH /api/v2/tags/:name": { - - } -/** @description Retorna os dados de um cupom usando o seu código */ - "GET /api/v2/coupon_codes/:code": { - - } -/** @description Cria um pedido no Paypal para que posteriormente possa receber um pagamento */ - "POST /api/v2/carts/:cart_id/payment/paypal": { - - } -/** @description Retorna uma lista de clientes. Caso seja informado o parâmetro "email", então apenas o cliente com esse email será retornado */ - "GET /api/v2/clients": { - - } -/** @description Permite criar um cliente */ - "POST /api/v2/clients": { - searchParams: { - email?: string; - first_name?: string; - last_name?: string; - birthdate?: string; - gender?: {"0": "M"} | {"0": "F"}; + "DELETE /api/v2/tags/:name": {}; /** - * separado por vírgula + * Permite atualizar uma tag */ - tags?: string; - lists?: string[]; - password?: string; - password_confirmation?: string; - terms?: boolean; -} - - } -/** @description Permite retornar as informações do cliente -O auth_token do cliente pode ser informado no lugar do ID na URL */ - "GET /api/v2/clients/:id": { - - } -/** @description Permite remover um cliente */ - "DELETE /api/v2/clients/:id": { - - } -/** @description Permite atualizar as informações do cliente */ - "PATCH /api/v2/clients/:id": { - searchParams: { - email?: string; - first_name?: string; - last_name?: string; - birthdate?: string; - gender?: {"0": "M"} | {"0": "F"}; + "PATCH /api/v2/tags/:name": {}; /** - * separado por vírgula + * Retorna os dados de um cupom usando o seu código */ - tags?: string; - lists?: string[]; - password?: string; - password_confirmation?: string; - terms?: boolean; -} - - } -/** @description Retorna a lista de pedidos do cliente */ - "GET /api/v2/clients/:id/orders": { - - } -/** @description Lista os endereços do cliente utilizados nos pedidos que foram confirmados */ - "GET /api/v2/clients/:id/addresses": { - - } -/** @description Lista os endereços cadastrados pelo cliente */ - "GET /api/v2/clients/:client_id/registered_addresses": { - - } -/** @description Permite criar um endereço do cliente */ - "POST /api/v2/clients/:client_id/registered_addresses": { - searchParams: { - street_name?: string; - street_number?: string; - complement?: string; - neighborhood?: string; - label?: string; - zip?: string; - reference?: string; -} - - } -/** @description Delete o endereço cadastrado pelo cliente */ - "DELETE /api/v2/clients/:client_id/registered_addresses/:id": { - - } -/** @description Permite atualizar um endereço do cliente */ - "PATCH /api/v2/clients/:client_id/registered_addresses/:id": { - searchParams: { - street_name?: string; - street_number?: string; - complement?: string; - neighborhood?: string; - label?: string; - zip?: string; - reference?: string; -} - - } -/** @description Cria uma senha para o cliente e envia por email */ - "POST /api/v2/clients/recover_password": { - - } -/** @description Retorna o saldo de crétitos do cliente */ - "GET /api/v2/clients/:id/credits": { - - } -/** @description Retorna as transfertências de crétidos realizadas */ - "GET /api/v2/clients/:id/credits/transfers": { - - } -/** @description Lista os bônus do cliente que ainda não foram utilizados */ - "GET /api/v2/clients/:id/bonuses": { - - } -/** @description Solicita a remoção (esquecimento) dos dados pessoais de um cliente, de acordo com a LGPD */ - "PATCH /api/v2/clients/:id/remove_personal_data": { - - } -/** @description Faz o login do cliente pelo token salvo no campo auth_token */ - "GET /api/v2/auth/email/:token": { - - } -/** @description Faz o login do cliente por usuário e senha */ - "POST /api/v2/auth/client": { - searchParams: { - email?: string; - password?: string; -} - - } -/** @description Faz o pagamento do carrinho usando a forma de pagamento informada */ - "POST /api/v2/carts/:cart_id/payment": { - searchParams: { + "GET /api/v2/coupon_codes/:code": { + response: { + id: number; + code: string; + discount_id: number; + updated_at: string; + }; + }; + /** + * Cria um pedido no Paypal para que posteriormente possa receber um pagamento + */ + "POST /api/v2/carts/:cartId/payment/paypal": { + response: { + status?: string; + id?: string; + links?: { + href?: string; + rel?: string; + method?: string; + }[]; + }; + }; + /** + * Retorna uma lista de clientes. Caso seja informado o parâmetro "email", então apenas o cliente com esse email será retornado + */ + "GET /api/v2/clients": { + searchParams: { + /** + * Retorna somente o cliente com o email informado + */ + email?: string; + /** + * Número da página + */ + page?: number; + /** + * Registros por página + */ + per_page?: number; + /** + * Filtra os clientes pela menor data de atualização + */ + min_updated_at?: string; + /** + * Filtra os clientes pela maior data de atualização + */ + max_updated_at?: string; + /** + * Data de inicío da filtragem de clientes pela data de aniversário + */ + birthday_start?: string; + /** + * Data final da filtragem de clientes pela data de aniversário + */ + birthday_end?: string; + /** + * Filtra os clientes que possuem telefone + */ + has_phone?: string; + /** + * Filtra os clientes que possuem first name + */ + has_first_name?: string; + /** + * Filtra os clientes por vendedor + */ + user_id?: number; + /** + * Filtra os clientes que possuem o termo em alguns dos campos + */ + term?: string; + /** + * Ordena o resultado da busca de clientes conforme a opção escolhida + */ + sort?: "name" | "birthdate"; + }; + response: Client[]; + }; + /** + * Permite criar um cliente + */ + "POST /api/v2/clients": { + body: { + email?: string; + first_name?: string; + last_name?: string; + birthdate?: string; + gender?: "M" | "F"; + /** + * separado por vírgula + */ + tags?: string; + lists?: string[]; + password?: string; + password_confirmation?: string; + terms?: boolean; + }; + response: { + id?: number; + first_name?: string; + last_name?: string; + email?: string; + gender?: string; + phone_area?: string; + phone?: string; + cpf?: string; + cnpj?: string; + ie?: string; + tags?: string; + lists?: string[]; + facebook_uid?: string; + liked_facebook_page?: boolean; + updated_at?: string; + birthdate?: string; + recent_address?: { + id?: string; + first_name?: string; + last_name?: string; + company_name?: string; + street_name?: string; + street_number?: string; + neighborhood?: string; + complement?: string; + reference?: string; + city?: string; + state?: string; + zip?: string; + first_phone_area?: string; + first_phone?: string; + second_phone_area?: string; + second_phone?: string; + email?: string; + documents?: { + cpf?: string; + cnpj?: string; + }; + }[]; + }; + }; /** - * Meio de pagamento + * Permite retornar as informações do cliente + * O auth_token do cliente pode ser informado no lugar do ID na URL */ - payment_method?: {"0": "p"; "1": "i"; "2": "x"}; + "GET /api/v2/clients/:id": { + response: Client; + }; /** - * Canal de venda do carrinho + * Permite remover um cliente + */ + "DELETE /api/v2/clients/:id": {}; + /** + * Permite atualizar as informações do cliente + */ + "PATCH /api/v2/clients/:id": { + body: { + email?: string; + first_name?: string; + last_name?: string; + birthdate?: string; + gender?: "M" | "F"; + /** + * separado por vírgula + */ + tags?: string; + lists?: string[]; + password?: string; + password_confirmation?: string; + terms?: boolean; + }; + }; + /** + * Retorna a lista de pedidos do cliente */ - channel?: - | {"0": "e"; "1": "c"; "2": "o"; "3": "m"; "4": "m"; "5": "e"; "6": "r"; "7": "c"; "8": "e"} - | {"0": "d"; "1": "i"; "2": "r"; "3": "e"; "4": "c"; "5": "t"}; -} - - } -/** @description Lista os menus */ - "GET /api/v2/menus": { - - } -/** @description Cria um menu */ - "POST /api/v2/menus": { - searchParams: { - label?: string; - tooltip?: string; - description?: string; - type?: string; - url?: string; - page_id?: number; - parent_id?: number; - position?: string; - new_position?: string; - external?: boolean; - tag_id?: number; -} - - } -/** @description Retorna um menu */ - "GET /api/v2/menus/:id": { - - } -/** @description Remove um menu */ - "DELETE /api/v2/menus/:id": { - - } -/** @description Atualiza um menu */ - "PATCH /api/v2/menus/:id": { - searchParams: { - label?: string; - tooltip?: string; - description?: string; - type?: string; - url?: string; - page_id?: number; - parent_id?: number; - position?: string; - new_position?: string; - external?: boolean; - tag_id?: number; -} - - } -/** @description Lista as posições dos menus */ - "GET /api/v2/menus/positions": { - - } -/** @description Reordena os menus na ordem em que seus ids são listados no request */ - "POST /api/v2/menus/reorder": { - searchParams: { - /** - * A ordem dos elementos será replicada para os menus - */ - ids?: number[]; -} - - } -/** @description Retorna os menus em árvore, organizados pela posição */ - "GET /api/v2/menus/tree": { - - } -/** @description Retorna uma mensagem do site */ - "GET /api/v2/site_message": { - - } -/** @description Remove uma mensagem do site */ - "DELETE /api/v2/site_message": { - - } -/** @description Cria ou atualiza uma mensagem do site */ - "PATCH /api/v2/site_message": { - searchParams: { - title?: string; - description?: string; - call_to_action?: string; -} - - } -/** @description Lista as imagens associadas a loja */ - "GET /api/v2/shop/images": { - - } -/** @description Permite cadastrar uma imagem */ - "POST /api/v2/shop/images": { - searchParams: { - position?: string; - file_uid?: string; -} - - } -/** @description Permite remover uma imagem da loja */ - "DELETE /api/v2/shop/images/:id": { - - } -/** @description Permite adicionar um atributo customizado de produto */ - "POST /api/v2/shop/product_attributes": { - searchParams: { - index?: number; - name?: string; - mandatory?: boolean; -} - - } -/** @description Permite listar as personalizações */ - "GET /api/v2/customizations": { - - } -/** @description Permite criar uma personalização */ - "POST /api/v2/customizations": { - searchParams: { - group_name?: string; - group_type?: string; - name?: string; - label?: string; - image_uid?: string; - image_name?: string; - price?: number; - quantity?: number; - handling_days?: number; - tag_id?: number; - sku?: string; - pattern?: string; -} - - } -/** @description Permite retornar uma personalização */ - "GET /api/v2/customizations/:id": { - - } -/** @description Permite remover uma personalização */ - "DELETE /api/v2/customizations/:id": { - - } -/** @description Permite alterar uma personalização */ - "PATCH /api/v2/customizations/:id": { - searchParams: { - group_name?: string; - group_type?: string; - name?: string; - label?: string; - image_uid?: string; - image_name?: string; - price?: string; - quantity?: string; - handling_days?: string; - tag_id?: string; - sku?: string; - pattern?: string; -} - - } -/** @description Permite listar os itens do pedido */ - "GET /api/v2/orders/:order_id/items": { - - } -/** @description Permite listar as personalizações de cada item do pedido */ - "GET /api/v2/orders/:order_id/items/:item_id/customizations": { - - } -/** @description Permite listar as personalizações de cada item do carrinho */ - "GET /api/v2/carts/:cart_id/items/:item_id/customizations": { - - } -/** @description Permite remover uma customização do item do carrinho */ - "DELETE /api/v2/carts/:cart_id/items/:item_id/customizations": { - - } -/** @description Lista os mapeamentos */ - "GET /api/v2/mappings": { - - } -/** @description Cria um mapeamento */ - "POST /api/v2/mappings": { - searchParams: { - key?: string; - from?: string[]; - to?: string; -} - - } -/** @description Retorna os dados de um mapeamento */ - "GET /api/v2/mappings/:id": { - - } -/** @description Remove um mapeamento */ - "DELETE /api/v2/mappings/:id": { - - } -/** @description Atualiza um mapeamento */ - "PATCH /api/v2/mappings/:id": { - searchParams: { - key?: string; - from?: string[]; - to?: string; -} - - } -/** @description Retorna a lista de banners */ - "GET /api/v2/banners": { - - } -/** @description Retorna os dados de um banner */ - "GET /api/v2/banners/:id": { - - } -/** @description Retorna todos os banners disponíveis agrupados por tag */ - "GET /api/v2/banners/all": { - - } -/** @description Permite calcular o frete para pedidos internacionais */ - "GET /api/v2/carts/:cart_id/shipping_methods/intl": { - - } -/** @description Lista as amostras disponíveis para determinado carrinho */ - "GET /api/v2/carts/:cart_id/samples": { - - } -/** @description Retorna o endereço de entrega */ - "GET /api/v2/carts/:cart_id/shipping_address": { - - } -/** @description Adiciona um endereço de entrega no carrinho */ - "POST /api/v2/carts/:cart_id/shipping_address": { - searchParams: /** - * Modelo de endereço de envio para carrinho e pedido - */ -export interface EnderecoDeEnvio { + "GET /api/v2/clients/:id/orders": { + response: Order[]; + }; /** - * Nome do cliente + * Lista os endereços do cliente utilizados nos pedidos que foram confirmados */ - first_name?: string; + "GET /api/v2/clients/:id/addresses": { + searchParams: { + status?: string; + }; + response: Address; + }; /** - * Sobrenome do cliente + * Lista os endereços cadastrados pelo cliente */ - last_name?: string; + "GET /api/v2/clients/:clientId/registered_addresses": { + response: Client1; + }; /** - * Nome da empresa (para clientes jurídicos) + * Permite criar um endereço do cliente + */ + "POST /api/v2/clients/:clientId/registered_addresses": { + body: { + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + label?: string; + zip?: string; + reference?: string; + }; + response: Client1; + }; + /** + * Delete o endereço cadastrado pelo cliente */ - company_name?: string; + "DELETE /api/v2/clients/:clientId/registered_addresses/:id": {}; /** - * Email do cliente + * Permite atualizar um endereço do cliente */ - email?: string; + "PATCH /api/v2/clients/:clientId/registered_addresses/:id": { + body: { + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + label?: string; + zip?: string; + reference?: string; + }; + response: Client1; + }; /** - * Código de Discagem Direta à Distância (DDD) + * Cria uma senha para o cliente e envia por email + */ + "POST /api/v2/clients/recover_password": { + searchParams: { + /** + * Email do cliente + */ + email: string; + /** + * Preencher para pular o envio do email de senha para o cliente + */ + no_send?: string; + }; + response: Client; + }; + /** + * Retorna o saldo de crétitos do cliente */ - first_phone_area?: string; + "GET /api/v2/clients/:id/credits": { + response: { + balance?: number; + }; + }; /** - * Telefone do cliente + * Retorna as transfertências de crétidos realizadas */ - first_phone?: string; + "GET /api/v2/clients/:id/credits/transfers": { + response: { + from?: { + account?: string; + amount?: number; + }; + to?: { + account?: string; + amount?: number; + }; + }[]; + }; /** - * Código de Discagem Direta à Distância (DDD) + * Lista os bônus do cliente que ainda não foram utilizados + */ + "GET /api/v2/clients/:id/bonuses": { + searchParams: { + /** + * Número da página + */ + page?: string; + /** + * Registros por página + */ + per_page?: string; + }; + response: Bonus[]; + }; + /** + * Solicita a remoção (esquecimento) dos dados pessoais de um cliente, de acordo com a LGPD */ - second_phone_area?: string; + "PATCH /api/v2/clients/:id/remove_personal_data": {}; /** - * Telefone do cliente + * Faz o login do cliente pelo token salvo no campo auth_token */ - second_phone?: string; + "GET /api/v2/auth/email/:token": { + response: { + id: number; + token: string; + }; + }; /** - * Nome do recebedor + * Faz o login do cliente por usuário e senha + */ + "POST /api/v2/auth/client": { + body: { + email: string; + password: string; + }; + response: { + id: number; + auth_token: string; + }; + }; + /** + * Faz o pagamento do carrinho usando a forma de pagamento informada + */ + "POST /api/v2/carts/:cartId/payment": { + body: { + /** + * Meio de pagamento + */ + payment_method: "pix"; + /** + * Canal de venda do carrinho + */ + channel?: "ecommerce" | "direct"; + }; + }; + /** + * Lista os menus */ - recipient_name?: { - [k: string]: unknown; + "GET /api/v2/menus": { + searchParams: { + parent_id?: number; + position?: string; + }; + response: Menu[]; }; /** - * Logradouro + * Cria um menu + */ + "POST /api/v2/menus": { + body: { + label: string; + tooltip?: string; + description?: string; + type: string; + url?: string; + page_id?: number; + parent_id?: number; + position: string; + new_position?: string; + external?: boolean; + tag_id?: number; + }; + response: Menu; + }; + /** + * Retorna um menu */ - street_name?: string; + "GET /api/v2/menus/:id": { + response: Menu; + }; /** - * Número + * Remove um menu + */ + "DELETE /api/v2/menus/:id": {}; + /** + * Atualiza um menu + */ + "PATCH /api/v2/menus/:id": { + body: { + label: string; + tooltip?: string; + description?: string; + type: string; + url?: string; + page_id?: number; + parent_id?: number; + position: string; + new_position?: string; + external?: boolean; + tag_id?: number; + }; + }; + /** + * Lista as posições dos menus */ - street_number?: string; + "GET /api/v2/menus/positions": { + response: string[]; + }; /** - * Complemento + * Reordena os menus na ordem em que seus ids são listados no request */ - complement?: string; + "POST /api/v2/menus/reorder": { + body: { + /** + * A ordem dos elementos será replicada para os menus + */ + ids: number[]; + }; + }; /** - * Bairro + * Retorna os menus em árvore, organizados pela posição */ - neighborhood?: string; + "GET /api/v2/menus/tree": { + response: { + /** + * Posição + */ + [k: string]: MenuTree[]; + }; + }; /** - * Ponto de referência + * Retorna uma mensagem do site */ - reference?: string; + "GET /api/v2/site_message": { + response: SiteMessage; + }; /** - * Código de Endereçamento Postal (CEP) + * Remove uma mensagem do site */ - zip?: string; - documents?: { - /** - * Cadastro de Pessoa Física - */ - cpf?: string; - /** - * Registro Geral - */ - rg?: string; - /** - * Cadastro Nacional de Pessoas Jurídicas - */ - cnpj?: string; - /** - * Inscrição Estadual - */ - ie?: string; - }[]; -} - - } -/** @description Associa um código de cupom ao carrinho */ - "POST /api/v2/carts/:cart_id/coupon_code": { - searchParams: { + "DELETE /api/v2/site_message": {}; /** - * Código do cupom + * Cria ou atualiza uma mensagem do site */ - code?: string; -} - - } -/** @description Lista todos os channels usados nos pedidos criados */ - "GET /api/v2/orders/channels": { - - } -/** @description Lista todos os estados usados nos pedidos criados */ - "GET /api/v2/orders/states": { - - } -/** @description Retorna o preço do produto e das variantes */ - "GET /api/v2/products/:product_id/price": { - - } -/** @description Lista as imagens do produto */ - "GET /api/v2/products/:product_id/images": { - - } -/** @description Cria uma imagem do produto */ - "POST /api/v2/products/:product_id/images": { - searchParams: { - file_url?: string; - /** - * IDs da variantes associadas a imagem - */ - variant_ids?: number[]; -} - - } -/** @description Deleta uma imagem do produto */ - "DELETE /api/v2/products/:product_id/images/:id": { - - } -/** @description Reordena as imagens do produto */ - "POST /api/v2/products/:product_id/images/reorder": { - searchParams: { - ids?: number[]; -} - - } -/** @description Associa a imagem com uma variante */ - "POST /api/v2/products/:product_id/images/:id/add_variant": { - searchParams: { - variant_id?: number; -} - - } -/** @description Remove a associação da imagem com uma variante */ - "POST /api/v2/products/:product_id/images/:id/remove_variant": { - searchParams: { - variant_id?: number; -} - - } -/** @description Retorna uma lista de pacotes de um pedido */ - "GET /api/v2/orders/:order_code/packages": { - - } -/** @description Indica para a API que dererminado evento aconteceu e que ela deve disparar as ações relacionadas */ - "POST /api/v2/events": { - - } -/** @description Permite a listagem de recebíveis (comissão) de um usuário vendedor da loja, quando ocorre split de pagamentos via Pagarme */ - "GET /api/v2/users/:id/payables": { - - } -/** @description Retorna um produto pelo código identificador (`product_id`) */ - "GET /api/v2/products/:product_id": { - - } -/** @description Remove um produto do catálogo pelo código indentificador (`product_id`) */ - "DELETE /api/v2/products/:product_id": { - - } -/** @description Atualiza informações de um produto no catálogo pelo código identificador (`product_id`) */ - "PATCH /api/v2/products/:product_id": { - searchParams: /** - * Modelo simplificado de um produto para atualização e criação - */ -export interface SimpleProduct { + "PATCH /api/v2/site_message": { + body: { + title?: string; + description?: string; + call_to_action?: string; + }; + }; /** - * Código de Referência do produto + * Lista as imagens associadas a loja + */ + "GET /api/v2/shop/images": { + searchParams: { + /** + * Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação + */ + page?: number; + /** + * Número máximo de registros que deve ser retornado por página + */ + per_page?: number; + /** + * Ordena o resultado da busca de produtos em ordem crescente de cadastro + */ + sort?: "newest"; + }; + response: ShopAsset[]; + }; + /** + * Permite cadastrar uma imagem */ - reference?: string; + "POST /api/v2/shop/images": { + body: { + position?: string; + file_uid?: string; + }; + response: ShopAsset; + }; /** - * Nome do produto + * Permite remover uma imagem da loja */ - name?: string; + "DELETE /api/v2/shop/images/:id": {}; /** - * Descrição do produto + * Permite adicionar um atributo customizado de produto */ - description?: string; + "POST /api/v2/shop/product_attributes": { + body: { + index: number; + name: string; + mandatory: boolean; + }; + response: ProductsAttributes; + }; /** - * Indica se o produto está ativo (`true`) ou invativo (`false`) + * Permite listar as personalizações */ - active?: boolean; + "GET /api/v2/customizations": { + searchParams: { + /** + * Filtra por produto + */ + product_id?: number; + }; + response: Customization[]; + }; /** - * Tags associadas ao produto + * Permite criar uma personalização + */ + "POST /api/v2/customizations": { + body: { + group_name: string; + group_type: string; + name: string; + label?: string; + image_uid?: string; + image_name?: string; + price?: number; + quantity?: number; + handling_days?: number; + tag_id: number; + sku?: string; + pattern?: string; + }; + response: Customization; + }; + /** + * Permite retornar uma personalização */ - tag_list?: string; + "GET /api/v2/customizations/:id": { + response: Customization; + }; /** - * Tipo de produto + * Permite remover uma personalização + */ + "DELETE /api/v2/customizations/:id": {}; + /** + * Permite alterar uma personalização + */ + "PATCH /api/v2/customizations/:id": { + body: { + group_name?: string; + group_type?: string; + name?: string; + label?: string; + image_uid?: string; + image_name?: string; + price?: string; + quantity?: string; + handling_days?: string; + tag_id?: string; + sku?: string; + pattern?: string; + }; + }; + /** + * Permite listar os itens do pedido */ - product_type?: - | {"0": "p"; "1": "r"; "2": "o"; "3": "d"; "4": "u"; "5": "c"; "6": "t"} - | {"0": "s"; "1": "a"; "2": "m"; "3": "p"; "4": "l"; "5": "e"} - | { - "0": "s"; - "1": "u"; - "2": "b"; - "3": "s"; - "4": "c"; - "5": "r"; - "6": "i"; - "7": "p"; - "8": "t"; - "9": "i"; - "10": "o"; - "11": "n"; - }; -} - - } -/** @description Recebe uma avaliação e recalcula a pontuação atual */ - "POST /api/v2/products/:product_id/rate": { - - } -/** @description Permite remover uma variante */ - "DELETE /api/v2/products/:product_id/variants/:variant_id": { - - } -/** @description Atualiza as informações de um variante */ - "PATCH /api/v2/products/:product_id/variants/:variant_id": { - searchParams: { - sku?: string; - name?: string; - quantity?: number; - main?: boolean; + "GET /api/v2/orders/:orderId/items": { + response: OrderItems[]; + }; /** - * Massa do produto, em gramas + * Permite listar as personalizações de cada item do pedido */ - weight?: number; + "GET /api/v2/orders/:orderId/items/:itemId/customizations": { + response: OrderItemCustomization[]; + }; /** - * Largura do produto, em centímetros + * Permite listar as personalizações de cada item do carrinho */ - width?: number; + "GET /api/v2/carts/:cartId/items/:itemId/customizations": { + response: { + [k: string]: CartItemCustomization[]; + }; + }; /** - * Altura do produto, em centímetros + * Permite remover uma customização do item do carrinho */ - height?: number; + "DELETE /api/v2/carts/:cartId/items/:itemId/customizations": {}; /** - * Comprimento do produito, em centímetros + * Lista os mapeamentos + */ + "GET /api/v2/mappings": { + searchParams: { + /** + * Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação + */ + page?: number; + /** + * Número máximo de registros que deve ser retornado por página + */ + per_page?: number; + }; + response: Mapping[]; + }; + /** + * Cria um mapeamento + */ + "POST /api/v2/mappings": { + body: { + key: string; + from?: string[]; + to?: string; + }; + response: Mapping; + }; + /** + * Retorna os dados de um mapeamento + */ + "GET /api/v2/mappings/:id": { + response: Mapping; + }; + /** + * Remove um mapeamento + */ + "DELETE /api/v2/mappings/:id": {}; + /** + * Atualiza um mapeamento + */ + "PATCH /api/v2/mappings/:id": { + body: { + key: string; + from?: string[]; + to?: string; + }; + }; + /** + * Retorna a lista de banners + */ + "GET /api/v2/banners": { + searchParams: { + /** + * Booleano indicando para filtrar banners fora do prazo de validade + */ + only_valid?: string; + /** + * Booleano indicando para filtrar banners com prazo de validade expirados + */ + only_expired?: string; + /** + * Booleano indicando para filtrar banners agendados + */ + only_scheduled?: string; + /** + * Lista separada por vírgula com nomes de tags + */ + tag?: string; + /** + * Texto livre que permite filtrar os banners pelo título + */ + title?: string; + /** + * Booleano indicando para não fazer paginação dos resultados + */ + no_paginate?: string; + /** + * Número da página atual. Os dados de paginação estarão disponíveis, em formato JSON, no header X-Pagination no response da API, caso exista paginação + */ + page?: number; + /** + * Número máximo de registros que deve ser retornado por página + */ + per_page?: number; + }; + response: Banner[]; + }; + /** + * Retorna os dados de um banner + */ + "GET /api/v2/banners/:id": { + response: Banner; + }; + /** + * Retorna todos os banners disponíveis agrupados por tag + */ + "GET /api/v2/banners/all": { + response: { + [k: string]: SlimBanner[]; + }; + }; + /** + * Permite calcular o frete para pedidos internacionais + */ + "GET /api/v2/carts/:cartId/shipping_methods/intl": { + searchParams: { + /** + * Código do país de destino + */ + country: string; + }; + response: { + "{package_label}"?: ShippingMethods1[]; + }; + }; + /** + * Lista as amostras disponíveis para determinado carrinho + */ + "GET /api/v2/carts/:cartId/samples": { + response: { + id: number; + image_url: string; + name: string; + reference: string; + updated_at: string; + url: string; + variants: { + id: number; + main: boolean; + sku: string; + name: string; + updated_at: string; + image_url: string; + product_id: number; + norder: number; + }[]; + }; + }; + /** + * Retorna o endereço de entrega + */ + "GET /api/v2/carts/:cartId/shipping_address": { + response: EnderecoDeEnvio; + }; + /** + * Adiciona um endereço de entrega no carrinho + */ + "POST /api/v2/carts/:cartId/shipping_address": { + body: EnderecoDeEnvio1; + response: CartItem; + }; + /** + * Associa um código de cupom ao carrinho + */ + "POST /api/v2/carts/:cartId/coupon_code": { + body: { + /** + * Código do cupom + */ + code: string; + }; + response: { + /** + * Código do cupom + */ + code: string; + discount: number; + rebate_token: string; + rebate_discount: number; + }; + }; + /** + * Lista todos os channels usados nos pedidos criados + */ + "GET /api/v2/orders/channels": { + response: string[]; + }; + /** + * Lista todos os estados usados nos pedidos criados + */ + "GET /api/v2/orders/states": { + response: string[]; + }; + /** + * Retorna o preço do produto e das variantes + */ + "GET /api/v2/products/:productId/price": { + searchParams: { + /** + * Array com os códigos de cupons + */ + coupon_codes?: string[]; + }; + response: { + available: boolean; + on_sale: boolean; + price: number; + sale_price: number; + intl_price: number; + discount_rule?: any; + /** + * @minItems 1 + */ + installments: [ProductInstallment, ...(ProductInstallment)[]]; + /** + * Data e horário da última atualização + */ + updated_at: string; + /** + * @minItems 1 + */ + variants: [ProductPriceVariant, ...(ProductPriceVariant)[]]; + }; + }; + /** + * Lista as imagens do produto + */ + "GET /api/v2/products/:productId/images": { + response: ProductImage[]; + }; + /** + * Cria uma imagem do produto + */ + "POST /api/v2/products/:productId/images": { + body: { + file_url: string; + /** + * IDs da variantes associadas a imagem + */ + variant_ids?: number[]; + }; + response: ProductImage[]; + }; + /** + * Deleta uma imagem do produto + */ + "DELETE /api/v2/products/:productId/images/:id": {}; + /** + * Reordena as imagens do produto + */ + "POST /api/v2/products/:productId/images/reorder": { + body: { + ids: number[]; + }; + }; + /** + * Associa a imagem com uma variante + */ + "POST /api/v2/products/:productId/images/:id/add_variant": { + body: { + variant_id: number; + }; + }; + /** + * Remove a associação da imagem com uma variante + */ + "POST /api/v2/products/:productId/images/:id/remove_variant": { + body: { + variant_id: number; + }; + }; + /** + * Retorna uma lista de pacotes de um pedido + */ + "GET /api/v2/orders/:orderCode/packages": { + response: Package[]; + }; + /** + * Indica para a API que dererminado evento aconteceu e que ela deve disparar as ações relacionadas + */ + "POST /api/v2/events": { + searchParams: { + /** + * Evento que ocorreu + */ + event_type: string; + /** + * ID do recurso selacionado ao evento + */ + id: string; + /** + * IP do usuário + */ + browser_ip?: string; + /** + * User agent do usuário + */ + user_agent?: string; + }; + }; + /** + * Permite a listagem de recebíveis (comissão) de um usuário vendedor da loja, quando ocorre split de pagamentos via Pagarme + */ + "GET /api/v2/users/:id/payables": { + response: RecebiveisDoUsuario[]; + }; + /** + * Retorna um produto pelo código identificador (`product_id`) + */ + "GET /api/v2/products/:productId": { + searchParams: { + /** + * Array com os códigos de cupons + */ + coupon_codes?: string[]; + /** + * Selecione `true` para incluir o nome do local de armazenamento no retorno da requisição + */ + include_inventory_place?: string; + /** + * Selecione `true` para incluir todas as imagens do produto + */ + include_images?: string; + }; + response: Product; + }; + /** + * Remove um produto do catálogo pelo código indentificador (`product_id`) + */ + "DELETE /api/v2/products/:productId": {}; + /** + * Atualiza informações de um produto no catálogo pelo código identificador (`product_id`) + */ + "PATCH /api/v2/products/:productId": { + body: SimpleProduct1; + }; + /** + * Recebe uma avaliação e recalcula a pontuação atual + */ + "POST /api/v2/products/:productId/rate": { + searchParams: { + /** + * Avaliação + */ + rate?: number; + }; + response: { + /** + * Média das avaliações + */ + rating?: string; + /** + * Número de avaliações recebidas + */ + votes?: string; + }; + }; + /** + * Permite remover uma variante + */ + "DELETE /api/v2/products/:productId/variants/:variantId": {}; + /** + * @deprecated + * Atualiza as informações de um variante + */ + "PATCH /api/v2/products/:productId/variants/:variantId": { + body: { + sku: string; + name?: string; + quantity: number; + main?: boolean; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + price: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + min_quantity?: number; + norder?: number; + property1?: { + name?: string; + value?: string; + defining?: boolean; + }; + property2?: { + name?: string; + value?: string; + defining?: boolean; + }; + property3?: { + name?: string; + value?: string; + defining?: boolean; + }; + barcode?: string; + /** + * Quantidade de itens vendidos + */ + quantity_sold?: number; + }; + }; + /** + * Deleta uma imagem do produto + */ + "DELETE /api/v2/products/:productId/images/:imageId": {}; + /** + * Associa a imagem com uma variante + */ + "POST /api/v2/products/:productId/images/:imageId/add_variant": { + body: { + variant_id: number; + }; + }; + /** + * Remove a associação da imagem com uma variante + */ + "POST /api/v2/products/:productId/images/:imageId/remove_variant": { + body: { + variant_id: number; + }; + }; + /** + * Retorna as informações de um carrinho pelo seu `id` ou `token` + */ + "GET /api/v2/carts/:cartId": { + response: Cart1; + }; + /** + * Permite excluir um carrinho + */ + "DELETE /api/v2/carts/:cartId": {}; + /** + * Permite atualizar os atributos de um carrinho + */ + "PATCH /api/v2/carts/:cartId": { + body: ParametrosDeCarrinhoResumido; + }; + /** + * Remove um item do carrinho + */ + "DELETE /api/v2/carts/:cartId/items/:itemId": {}; + /** + * Atualiza um item do carrinho + */ + "PATCH /api/v2/carts/:cartId/items/:itemId": { + body: Produto1; + }; + /** + * Atualiza o método para o envio dos itens do carrinho + */ + "PATCH /api/v2/carts/:cartId/shipping_methods/:valueMethod": { + body: ShippingMethods1; + }; + /** + * Calculo os método de envio disponíveis para o carrinho + */ + "GET /api/v2/carts/:cartId/shipping_methods": { + response: { + "{package_label}"?: ShippingMethods1[]; + }; + }; + /** + * Calcula as parcelas de pagamento para valor total do carrinho + */ + "GET /api/v2/carts/:cartId/installments": { + response: CartInstallment1[]; + }; + /** + * Retorna os dados de um pedido pelo `code` ou `token` do pedido + */ + "GET /api/v2/orders/:orderCode": { + searchParams: { + /** + * Inclui as formas de entrega do pedido + */ + include_shipping_address?: boolean; + }; + response: Order; + }; + /** + * Atualiza o campo de dados extras de um pedido pelo `code` do pedido + */ + "PATCH /api/v2/orders/:orderCode": { + body: { + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra?: {}; + }; + }; + /** + * Retorna a *timeline* de eventos ocorridos em um pedido + */ + "GET /api/v2/orders/:orderCode/events": { + response: {}[]; + }; + /** + * Retorna a avaliação que o cliente fez em um pedido + */ + "GET /api/v2/orders/:orderCode/reviews": {}; + /** + * Retorna os descontos de um pedido pelo `code` ou `token` do pedido + */ + "GET /api/v2/orders/:orderCode/discounts": { + response: {}[]; + }; + /** + * Retorna o endereço de envio pelo `code` do pedido + */ + "GET /api/v2/orders/:orderCode/shipping_address": { + response: EnderecoDeEnvio1; + }; + /** + * Atualiza dados de endereço do pedido + */ + "PATCH /api/v2/orders/:orderCode/shipping_address": { + body: EnderecoDeEnvio1; + }; + /** + * Captura o pagamento no adquirente para pedidos com pagamento por cartão de crédito. + */ + "POST /api/v2/orders/:orderCode/capture": { + response: {}; + }; + /** + * Confirma um pedido + */ + "POST /api/v2/orders/:orderCode/confirm": { + body: { + /** + * Parâmetro para incluir o retorno [da requisição de captura do pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-capture). + * Esse parâmetro é **obrigatório** para pedidos com pagamento por cartão de crédito. + */ + confirmation_data?: string; + }; + }; + /** + * Faz o estorno do pagamento no adquirente do cartão de crédito + * Operação válida para pedidos pagos com cartão de crédito + */ + "POST /api/v2/orders/:orderCode/chargeback": {}; + /** + * Altera o status do pedido para `cancelado` + */ + "POST /api/v2/orders/:orderCode/cancel": { + body: { + /** + * Parâmetro para incluir uma confirmação de estorno de pagamento para o cliente. + * Para pedidos com pagamento via cartão de crédito, é obrigatório que nesse campo seja incluído no parâmetro o retorno [da requisição de estorno de pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-order-code-chargeback). + */ + cancelation_data?: string; + }; + response: {}; + }; + /** + * Retorna os itens de um pedido pelo código do pedido + */ + "GET /api/v2/orders/:orderCode/items": { + response: ProdutoEmUmPedido1[][]; + }; + /** + * Lista as personalizações de um item do pedido pelos códigos do item e do pedido + */ + "GET /api/v2/orders/:orderCode/items/:itemId/customizations": { + response: OrderItemCustomization[]; + }; + /** + * Retorna os pedidos de um cliente pelo seu `id_client` + */ + "GET /api/v2/clients/:idClient/orders": { + response: Order[]; + }; + /** + * Retorna as notas fisicais de um pacote do pedido + */ + "GET /api/v2/orders/:orderCode/packages/:packageCode/invoices": { + response: Invoice[]; + }; + /** + * Inclui nota fiscal no pacote de um pedido + */ + "POST /api/v2/orders/:orderCode/packages/:packageCode/invoices": { + body: Invoice; + response: Invoice; + }; + /** + * Remove uma nota fiscal + */ + "DELETE /api/v2/orders/:orderCode/packages/:packageCode/invoices/:number": {}; + /** + * Atualiza uma nota fiscal + */ + "PATCH /api/v2/orders/:orderCode/packages/:packageCode/invoices/:number": { + body: Invoice; + }; + /** + * Permite listar os pedidos pendentes do feed + */ + "GET /api/feed/orders": { + searchParams: { + /** + * Selecione `true` para incluir o endereço na resposta + */ + include_shipping_address?: true; + /** + * Filtra os pedidos por status + */ + status?: "received" | "confirmed" | "canceled"; + }; + response: Order[]; + }; + /** + * Permite marcar os pedidos para que eles sejam filtrados da listagem do feed + */ + "POST /api/feed/orders": { + body: { + orders?: { + /** + * Código do pedido + */ + code: string; + }[]; + }; + }; +} +/** + * Modelo que representa um usuário na API + */ +export interface User { + /** + * Código identificador do usuário + */ + id?: number; + /** + * Email do usuário + */ + email: string; + /** + * Token de validação de usuário logado (`access_token`) + * + * O `access_token` é gerado quando o usuário loga no Admin + */ + access_token?: string; + /** + * Nome do usuário + */ + name?: string; + /** + * Identificador de usuários administradores + * + * Esse atributo retorna `true` para um usuário administrador do ambiente de loja + */ + admin?: boolean; + /** + * Identificador de usuários que atualizaram a senha inicial + * + * Esse atributo retorna `true` para um usuário que já redefiniu sua senha pelo menos uma vez + */ + renew_password?: boolean; + /** + * Código da função do usuário na loja: + * + * - Agente: `0`; + * - Gestor: `1`; + * - Local: `2`; + * - Agente Social Selling: `3`. + */ + role?: number; + /** + * Tags para agrupamento de usuários + * As tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão + */ + tags?: string[]; + /** + * Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema. + */ + external_code?: string; + /** + * Código de Discagem Direta a Distância (DDD) do telefone do usuário + */ + phone_area?: string; + /** + * Número de telefone do usuário + */ + phone?: string; + /** + * Data de inclusão do usuário no Admin + */ + created_at?: string; + /** + * Data de atualização das informações do usuário + */ + updated_at?: string; +} +/** + * Modelo que representa um pedido na API + */ +export interface Order { + /** + * Desconto por bônus do cliente + */ + rebate_discount: number; + /** + * Código identificador `ID` do desconto por bônus + */ + rebate_token?: string; + /** + * Código identificador `ID` do cliente + */ + user_id?: number; + /** + * Data da última atualização do pedido + */ + updated_at: string; + /** + * Lista com os códigos de rastreio dos pacotes do pedido + */ + tracking_code_list?: string[]; + /** + * Código de rastreio do pacote + */ + tracking_code?: string; + /** + * Valor final do pedido + */ + total: number; + token: string; + taxes: number; + /** + * Valor da soma dos itens do pedido, desconsiderando descontos e frete. + */ + subtotal: number; + /** + * Status do pedido + */ + status: "received" | "confirmed" | "canceled"; + payment_due_date?: string; + slip_url?: string; + slip_token?: string; + slip_due_date?: string; + slip: boolean; + shipping_tracked_at?: string; + shipping_price?: number; + shipping_label?: string; + /** + * Data e horário de envio do pedido + */ + shipped_at: string; + /** + * Data e horário de recebimento do pedido + */ + received_at: string; + payment_tid?: string; + /** + * Método de pagamento do pedido + */ + payment_method: string; + payment_gateway: string; + payment_authorization: string; + /** + * Data e horário do pagamento do pedido + */ + paid_at: string; + items?: ProdutoEmUmPedido[]; + /** + * Parcelas do pagamento parcelado + */ + installments?: number; + /** + * Código identificador do pedido + */ + id?: number; + /** + * Campo de observações do pedido + */ + extra?: {}; + expected_delivery_date?: string; + /** + * Email do cliente + */ + email: string; + /** + * Valor do desconto aplicado no pedido + */ + discount_price: number; + deposit: boolean; + delivery_type?: string; + delivery_message?: string; + /** + * Dias para entrega + */ + delivery_days?: number; + /** + * Data de entrega do pedido + */ + delivered_at: string; + /** + * Código de cupom do pedido + */ + coupon_code: string; + /** + * Data e horário de confirmação do pedido + */ + confirmed_at: string; + /** + * Código do pedido + */ + code: string; + /** + * Código identificador (`ID`) do cliente + */ + client_id: number; + /** + * Canal de venda que originou o pedido + */ + channel: "ecommerce" | "direct"; + /** + * Código identificador do carrinho que originou o pedido + */ + cart_id: number; + /** + * Data de validade do cartão de crédito + */ + card_validity: string; + /** + * Número do cartão de crédito + */ + card_number: string; + /** + * Retorna `true` se o método de pagamento do pedido é por cartão de crédito. + */ + card: boolean; + /** + * Data e horário do cancelamento do pedido + */ + canceled_at?: string; + /** + * Endereço IP de origem do pedido + */ + browser_ip: string; + /** + * Agente do pedido + */ + agent?: string; + affiliate_tag?: string; + pix_qr_code?: string; + /** + * Código de autorização do pagamento + */ + payment_authorization_code?: string; + /** + * Indica se o pedido gerou bônus + */ + bonus_granted?: boolean; + has_split?: boolean; + /** + * Indica se o pedido foi pago usando o Pix + */ + pix: boolean; + ame_qr_code?: string; + /** + * Indica se o pedido foi pago usando o Ame + */ + ame: boolean; + antifraud_assurance?: string; + minItems?: 0; +} +/** + * Modelo de produto em um pedido + */ +export interface ProdutoEmUmPedido { + extra: {}; + height?: number; + id?: number; + length?: number; + original_price?: number; + package?: string; + picture_url?: string; + place_city?: string; + place_id?: number; + place_name?: string; + price?: number; + product_id: number; + product_name: string; + quantity: number; + reference: string; + sku: string; + total: number; + variant_id: number; + variant_name: string; + weight: number; + width: number; + barcode?: string; +} +/** + * Modelo que representa uma variante na API + */ +export interface Variant { + /** + * Código identificador da variante + */ + id?: number; + /** + * Identifica se é a variante principal do produto. Para `true` a variante é principal e `false` a variante é secundária + */ + main?: boolean; + /** + * Identifica se a variante está ativa em `true` e desativa em `false` + */ + available?: boolean; + /** + * Código SKU da variante + */ + sku?: string; + /** + * Nome da variante + */ + name?: string; + /** + * Slug da URL da variante + */ + slug?: string; + /** + * Quantidade mínima para venda + */ + min_quantity?: number; + /** + * Quantidade física + */ + quantity?: number; + quantity_sold?: number; + /** + * Quantidade disponível + */ + stock?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + /** + * [Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante + */ + properties?: { + property1?: VariantProperty; + property2?: VariantProperty; + property3?: VariantProperty; + }; + /** + * Data e horário da última atualização da variante + */ + updated_at?: string; + /** + * Preço do item + */ + price?: number; + /** + * Relação das parcelas para pagamento do item parcelado + */ + installments?: number[]; + /** + * Unidades reservadas e não reservadas do item + */ + available_quantity?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros + */ + length?: number; + /** + * Dias de manuseio da variante + */ + handling_days?: number; + /** + * Relação de itens por estoque (armazém) + */ + inventories?: VariantInventory[]; + /** + * Preço promocional + */ + sale_price?: number; + /** + * Preço internacional + */ + intl_price?: number; + /** + * URL da imagem da variante + */ + image_url?: string; + /** + * Código identificador `ID` do produto + */ + product_id?: number; + /** + * Código de barra da variante + */ + barcode?: string; + norder?: number; + required?: []; + additionalProperties?: never; +} +/** + * Modelo que representa uma propriedade customizada na API + */ +export interface VariantProperty { + /** + * Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`) + */ + defining: boolean; + /** + * Nome da propriedade + */ + name: string; + /** + * Valor da propriedade + */ + value?: string; +} +/** + * Model que representa um inventory da variante + */ +export interface VariantInventory { + id: number; + name: string; + place_id: number; + /** + * Preço do item + */ + price: number; + quantity: number; + /** + * Quantidade de itens vendidos + */ + quantity_sold: number; + /** + * Preço promocional + */ + sale_price: number; + slug: string; +} +/** + * Modelo que representa um template na API + */ +export interface Template { + path: string; + body?: string; + updated_at: string; +} +/** + * Modelo que representa um usuário na API + */ +export interface User1 { + /** + * Código identificador do usuário + */ + id?: number; + /** + * Email do usuário + */ + email: string; + /** + * Token de validação de usuário logado (`access_token`) + * + * O `access_token` é gerado quando o usuário loga no Admin + */ + access_token?: string; + /** + * Nome do usuário + */ + name?: string; + /** + * Identificador de usuários administradores + * + * Esse atributo retorna `true` para um usuário administrador do ambiente de loja + */ + admin?: boolean; + /** + * Identificador de usuários que atualizaram a senha inicial + * + * Esse atributo retorna `true` para um usuário que já redefiniu sua senha pelo menos uma vez + */ + renew_password?: boolean; + /** + * Código da função do usuário na loja: + * + * - Agente: `0`; + * - Gestor: `1`; + * - Local: `2`; + * - Agente Social Selling: `3`. + */ + role?: number; + /** + * Tags para agrupamento de usuários + * As tags podem ser são utilizadas para direcionar promoções para determinados usuários, organizar os recebedores em uma divisão de pagamentos, definir regras de comissão + */ + tags?: string[]; + /** + * Código externo do Vendedor. Esse campo é destinado para cadastrar um código de vendedor já existente em outro sistema. + */ + external_code?: string; + /** + * Código de Discagem Direta a Distância (DDD) do telefone do usuário + */ + phone_area?: string; + /** + * Número de telefone do usuário + */ + phone?: string; + /** + * Data de inclusão do usuário no Admin + */ + created_at?: string; + /** + * Data de atualização das informações do usuário + */ + updated_at?: string; +} +/** + * Modelo que representa um carrinho na API + */ +export interface Cart { + id: number; + email: string; + shipping_method: string; + items_count: number; + quotation_responses_count: number; + payment_responses_count: number; + has_payment_responses: boolean; + has_phone: boolean; + updated_at: string; +} +/** + * Parâmetros criação e atualização de carrinho + */ +export interface ParametrosDeCarrinhoResumido { + /** + * Agente que criou o carrinho + */ + agent?: string; + /** + * Código de Endereçamento Postal (CEP) do destinatário do pedido + */ + zip?: string; + /** + * Código identificador `ID` do cliente + */ + client_id?: number; + /** + * Código identificador `ID` do desconto do carrinho + */ + coupon_code?: string; + /** + * @deprecated + * Email do cliente + */ + email?: string; + /** + * Token do desconto + */ + rebate_token?: string; +} +/** + * Modelo que representa um carrinho na API + */ +export interface Cart1 { + /** + * Agente que criou o carrinho + */ + agent: string; + /** + * Código identificador `ID` do endereço de cobrança do carrinho + */ + billing_address_id: number; + /** + * Canal de venda que originou o carrinho + */ + channel: string; + /** + * Código identificador `ID` do cliente + */ + client_id: number; + /** + * Código identificador `ID` do carrinho + */ + code: string; + /** + * Código de cupom de desconto utilizado no carrinho + */ + coupon_code: string; + discount: Discount; + /** + * @deprecated + * Valor do desconto + */ + discount_price: number; + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra: {}; + /** + * Código identificador `ID` do carrinho + */ + id: number; + /** + * Itens do carrinho + */ + items: string; + /** + * Unidades do item no carrinho + */ + items_count: number; + /** + * Código identificador `ID` do endereço de entrega do carrinho + */ + shipping_address_id: number; + /** + * Método de envio selecionado para o carrinho, como por exemplo: normal, expressa e agendada. + */ + shipping_method: string; + /** + * Lista com as entregas disponíveis para os itens do carrinho de acordo com o endereço de envio + */ + shipping_methods: ShippingMethods[]; + /** + * Preço de envio + */ + shipping_price: number; + /** + * Valor da soma dos itens do carrinho, sem considerar descontos de cupom, carrinho e frete. + */ + subtotal: number; + /** + * Token do carrinho + */ + token: string; + /** + * Valor final do carrinho + */ + total: number; + /** + * Valor total do carrinho para pagamento por depósito + */ + total_for_deposit: number; + /** + * Valor total do carrinho para pagamento por boleto + */ + total_for_slip: number; + /** + * Valor do carrinho para pagamento por PIX + */ + total_for_pix: number; + /** + * Data da última atualização do carrinho + */ + updated_at: string; + /** + * Código identificador `ID` do desconto por bônus + */ + rebate_token: string; + /** + * Desconto por bônus do cliente + */ + rebate_discount: number; + /** + * Número de dias para manuseio dos itens + */ + handling_days: number; + /** + * Valor de desconto de promoções aplicadas ao subtotal do carrinho + */ + subtotal_discount: number; + /** + * Valor de desconto de promoções aplicadas ao valor total do carrinho + */ + total_discount: number; + installments?: CartInstallment; + /** + * Código identificador `ID` do cliente + */ + user_id?: string; + minItems?: 0; +} +/** + * Promoção aplicada no carrinho + */ +export interface Discount { + id: number; + name: string; + description: string; + facebook: boolean; + valid_to: "store" | "cart"; + /** + * DEPRECATED + */ + seal_uid: string; + /** + * DEPRECATED + */ + seal_url: string; + start_at: string; + end_at: string; + email: string; + cpf: string; + tags: string; +} +/** + * Modelo que representa as formas de entrega na API + */ +export interface ShippingMethods { + package: string; + name: string; + label: string; + price: string; + delivery_days: string; + delivery_type: string; + description: string; + short_description: string; + fulfillment_company: string; +} +/** + * Parcelas para pagamento parcelado + */ +export interface CartInstallment { + /** + * Identifica se há (`true`) ou não (`false`) juros no parcelamento + */ + interest: boolean; + /** + * Taxa de juros do parcelamento + */ + interest_rate: number; + /** + * Número de parcelas + */ + number: number; + /** + * Valor de cada parcela + */ + price: number; + /** + * Valor total das parcelas + */ + total: number; +} +/** + * Modelo que representa uma parcela do total de um carrinho + */ +export interface CartInstallment1 { + /** + * Identifica se há (`true`) ou não (`false`) juros no parcelamento + */ + interest: boolean; + /** + * Taxa de juros do parcelamento + */ + interest_rate: number; + /** + * Número de parcelas + */ + number: number; + /** + * Valor de cada parcela + */ + price: number; + /** + * Valor total das parcelas + */ + total: number; +} +/** + * Modelo que representa um local na API + */ +export interface Place { + id?: number; + name: string; + address_line_1: string; + address_line_2?: string; + city: string; + neighborhood?: string; + zip?: string; + home_page?: string; + latitude?: number; + longitude?: number; + images?: string[]; + description?: string; + email: string; + first_phone?: string; + second_phone?: string; + mobile_phone?: string; + only_cash?: boolean; + categories?: string[]; + marker_url?: string; + state?: string; + created_at?: string; + updated_at?: string; + opening_hours?: string; + warehouse?: boolean; + legal_name?: string; + cnpj?: string; +} +/** + * Modelo que representa uma nota fiscal na API + */ +export interface Invoice { + /** + * Número da nota fiscal + */ + number: number; + /** + * Número de série da nota fiscal + */ + series?: number; + /** + * Data e horário da criação da nota fiscal + */ + issued_at?: string; + /** + * Chave da nota fiscal + */ + key?: string; + volumes?: number; +} +/** + * Modelo que representa um recebedor na API + */ +export interface PaymentRecipient { + id: number; + percentage: number; + active?: boolean; + charge_processing_fee?: boolean; + liable?: boolean; + code?: string; + name?: string; + tag_name?: string; + place_id?: number; + recipient_id: number; + tag_id?: number; + user_id?: number; + /** + * Indica se o frete deve ser incluído no split do pagamento + */ + include_shipping?: boolean; +} +/** + * Valores que o usuário possui a receber + */ +export interface RecebiveisDoUsuario { + type?: string; + status?: string; + amount?: number; + fee?: number; + installment?: number; + credit_date?: string; + order_date?: string; + transaction_id?: number; +} +/** + * Modelo que representa um membro do público + */ +export interface AudienceMember { + id?: number; + first_name?: string; + last_name?: string; + email: string; + phone_area?: string; + phone?: string; + tags?: string[]; +} +/** + * Modelo que representa um item no carrinho na API + */ +export interface CartItem { + /** + * Unidades disponíveis do produto + */ + available_quantity: number; + /** + * Número de dias para a entrega + */ + delivery_days: number; + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra: {}; + /** + * Código identificador do local do produto + */ + place_id: number; + /** + * Preço do produto + */ + price: number; + /** + * Preço internacional + */ + intl_price: number; + /** + * Código identificador `ID` do produto + */ + product_id: number; + /** + * Nome do produto + */ + product_name: string; + /** + * Código de referência do produto + */ + product_reference: string; + /** + * URL do produto no e-commerce + */ + product_url: string; + /** + * Unidades do produto no carrinho + */ + quantity: number; + /** + * Identificador do seller + */ + seller: string; + /** + * Nome do seller + */ + seller_name: string; + /** + * Valor do produto sem descontos e promoções + */ + subtotal: number; + /** + * Valor total do produto + */ + total: number; + /** + * Data da última atualização do carrinho + */ + updated_at: string; + /** + * Atributos da variante + */ + variant_attributes: {}; + /** + * Quantidade miníma de variantes para compra + */ + variant_min_quantity: number; + /** + * Nome da variante + */ + variant_name: string; + /** + * Preço da variante + */ + variant_price: number; + /** + * Preço internacional da variante + */ + variant_intl_price: number; + variant_properties: Variant1; + /** + * Código SKU da [Variante](https://developers.vnda.com.br/docs/cat%C3%A1logo-de-produtos#produto-atributo-e-variante) + */ + variant_sku: string; + /** + * Código identificador do item no carrinho + */ + id?: string; + /** + * Tipo de produto + */ + product_type?: string; + /** + * URL da imagem da variante + */ + image_url?: string; +} +/** + * Modelo que representa uma variante na API + */ +export interface Variant1 { + /** + * Código identificador da variante + */ + id?: number; + /** + * Identifica se é a variante principal do produto. Para `true` a variante é principal e `false` a variante é secundária + */ + main?: boolean; + /** + * Identifica se a variante está ativa em `true` e desativa em `false` + */ + available?: boolean; + /** + * Código SKU da variante + */ + sku?: string; + /** + * Nome da variante + */ + name?: string; + /** + * Slug da URL da variante + */ + slug?: string; + /** + * Quantidade mínima para venda + */ + min_quantity?: number; + /** + * Quantidade física + */ + quantity?: number; + quantity_sold?: number; + /** + * Quantidade disponível + */ + stock?: number; + /** + * Customização da variante + */ + custom_attributes?: {}; + /** + * [Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante + */ + properties?: { + property1?: VariantProperty; + property2?: VariantProperty; + property3?: VariantProperty; + }; + /** + * Data e horário da última atualização da variante + */ + updated_at?: string; + /** + * Preço do item + */ + price?: number; + /** + * Relação das parcelas para pagamento do item parcelado + */ + installments?: number[]; + /** + * Unidades reservadas e não reservadas do item + */ + available_quantity?: number; + /** + * Massa do produto, em gramas + */ + weight?: number; + /** + * Largura do produto, em centímetros + */ + width?: number; + /** + * Altura do produto, em centímetros + */ + height?: number; + /** + * Comprimento do produito, em centímetros */ length?: number; /** - * Dias de manuseio da variante + * Dias de manuseio da variante + */ + handling_days?: number; + /** + * Relação de itens por estoque (armazém) + */ + inventories?: VariantInventory[]; + /** + * Preço promocional + */ + sale_price?: number; + /** + * Preço internacional + */ + intl_price?: number; + /** + * URL da imagem da variante + */ + image_url?: string; + /** + * Código identificador `ID` do produto + */ + product_id?: number; + /** + * Código de barra da variante + */ + barcode?: string; + norder?: number; + required?: []; + additionalProperties?: never; +} +/** + * Modelo de carcaterística de produto para item no carrinho + */ +export interface Produto { + sku: string; + quantity: number; + extra?: {}; + place_id?: number; + store_coupon_code?: string; + customizations?: any[]; +} +/** + * Modelo que representa uma promoção na API + */ +export interface Discount1 { + /** + * Código identificador `ID` do desconto + */ + id?: number; + /** + * Nome do desconto ou promoção + */ + name: string; + /** + * Descrição do desconto + */ + description?: string; + /** + * Data de início da regra do desconto + */ + start_at: string; + /** + * Data de fim da regra do desconto + */ + end_at?: string; + /** + * Indica se o desconto está habilitado (`true`) ou desabilitado (`false`) + */ + enabled: boolean; + /** + * Em desuso + */ + facebook?: boolean; + /** + * Indica a regra da promoção: se o desconto é aplicado na vitrine ou no carrinho da loja + */ + valid_to?: string; + /** + * Email do cliente, no caso de promoções direcionadas para clientes específicos + */ + email?: string; + /** + * Cadastro de Pessoa Física (CPF) do cliente, no caso de promoções direcionadas para clientes específicos + */ + cpf?: string; + /** + * Tag de agrupamento de promoção + */ + tags?: string; +} +/** + * Modelo que representa uma regra de desconto na API + */ +export interface DiscountRule { + id?: number; + amount: number; + type: "fixed" | "percentage"; + apply_to: string; + min_quantity: number; + product?: { + id?: number; + reference?: string; + name?: string; + }; + tag?: { + name?: string; + }; + combined_product?: { + id?: number; + reference?: string; + name?: string; + }; + min_subtotal: number; + shipping_method?: string; + shipping_rule?: "any" | "all"; + regions?: string[]; + agent_tag?: string; + channel?: string[]; +} +/** + * Modelo que representa um cupom de desconto + */ +export interface Coupon { + id?: number; + code?: string; + uses_per_code?: number; + uses_per_user?: number; + referrer_email?: string; + user_id?: number; + updated_at?: string; + orders_count?: number; +} +/** + * Modelo que representa um produto na API + */ +export interface Product { + /** + * Código identificador `ID` do priduto + */ + id?: number; + /** + * Indica se o produto está ativo (`true`) ou invativo (`false`) + */ + active?: boolean; + /** + * Indica se o produto está disponível (`true`) ou indisponível (`false`) + */ + available?: boolean; + category_tags?: { + /** + * Tipo de tag + */ + tag_type?: string; + /** + * Nome da tag + */ + name?: string; + /** + * Título da tag + */ + title?: string; + }[]; + /** + * Descrição do produto + */ + description?: string; + /** + * Código de desconto + */ + discount_id?: number; + /** + * Descrição do produto em HTML + */ + html_description?: string; + /** + * URL da imagem do produto + */ + image_url?: string; + /** + * Relação das parcelas para pagamento parcelado + */ + installments?: number[]; + /** + * Quantidade mínima para venda do produto + */ + min_quantity?: string; + /** + * Nome do produto + */ + name?: string; + /** + * Indica se o produto está em promoção (`true`) ou não (`false`) + */ + on_sale?: boolean; + /** + * Descrição simplificada + */ + plain_description?: string; + /** + * Preço do item + */ + price?: number; + /** + * Média de avaliação do produto + */ + rating?: { + rating?: number; + votes?: number; + }; + /** + * Código de referência do produto + */ + reference?: string; + /** + * Preço promocional + */ + sale_price?: number; + /** + * slug do produto + */ + slug?: string; + /** + * Lista de tags que o produto é associado + */ + tag_names?: string[]; + /** + * Data e horário da última atualização do produto + */ + updated_at?: string; + /** + * URL do produto + */ + url?: string; + /** + * Variantes do produto + */ + variants?: { + "{id}"?: ProductVariant; + }[]; + /** + * Regras de desconto de uma promoção + */ + discount_rule: { + type: "fixed" | "percentage"; + amount: number; + }; + /** + * Imagens do produto + */ + images?: { + /** + * id do produto + */ + id?: number; + /** + * Url do produto + */ + url?: string; + /** + * Data e horário da última atualização do produto + */ + updated_at?: string; + variant_ids?: {}[]; + }[]; +} +/** + * Modelo que representa uma variante na API + */ +export interface ProductVariant { + available: boolean; + available_quantity: number; + /** + * Customização da variante + */ + custom_attributes: {}; + /** + * Dias de manuseio da variante + */ + handling_days: number; + height: number; + id?: number; + /** + * URL da imagem da variante + */ + image_url: string; + installments: number[]; + inventories?: ProductVariantInventory[]; + length: number; + main: boolean; + /** + * Quantidade mínima para venda + */ + min_quantity: number; + /** + * Nome da variante + */ + name: string; + norder: number; + /** + * Preço do item + */ + price: number; + product_id: number; + /** + * [Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante + */ + properties: { + property1?: VariantProperty; + property2?: VariantProperty; + property3?: VariantProperty; + }; + quantity: number; + /** + * Quantidade de itens vendidos + */ + quantity_sold?: number; + /** + * Preço promocional + */ + sale_price: number; + sku: string; + slug: string; + /** + * Quantidade de itens disponíveis + */ + stock: number; + /** + * Data e horário da última atualização da variante + */ + updated_at: string; + /** + * Massa do produto, em gramas + */ + weight: number; + /** + * Largura do produto, em centímetros + */ + width: number; + required?: []; + additionalProperties?: never; +} +/** + * Modelo que representa um inventory da variante na API + */ +export interface ProductVariantInventory { + /** + * Código identificador `ID` do inventário + */ + id: number; + /** + * Nome do inventário + */ + name?: string; + /** + * Código identificador do local + */ + place_id: number; + /** + * Nome do local + */ + place_name?: string; + /** + * Preço do item + */ + price: number; + /** + * Quantidade de itens no inventário + */ + quantity: number; + /** + * Quantidade de itens vendidos + */ + quantity_sold: number; + /** + * Preço promocional */ - handling_days?: number; - price?: number; + sale_price: number; /** - * Customização da variante + * Slug do inventário */ - custom_attributes?: {}; - min_quantity?: number; - norder?: number; - property1?: { - name?: string; - value?: string; - defining?: boolean; - }; - property2?: { - name?: string; - value?: string; - defining?: boolean; + slug: string; + /** + * Data e horário da última atualização da variante no inventário + */ + updated_at: string; + /** + * Código da variante + */ + variant_id: number; + /** + * Data de criação do inventário + */ + created_at: string; +} +/** + * Modelo simplificado de um produto para atualização e criação + */ +export interface SimpleProduct { + name: string; + description?: string; + active?: boolean; + reference: string; + tag_list?: string; +} +/** + * Modelo que representa um produto retornado via busca no Elasticsearch + */ +export interface ProductSearch { + id: number; + active: boolean; + available: boolean; + subscription: boolean; + slug: string; + reference: string; + reference_lowercase: string; + name: string; + description: string; + image_url: string; + url: string; + tags: { + name: string; + title: string; + subtitle: string; + description: string; + importance: number; + type: string; + image_url: string; + }[]; + /** + * Preço do item + */ + price: number; + on_sale: boolean; + /** + * Preço promocional + */ + sale_price: number; + intl_price: number; + discount_id: number; + discount_rule: { + type: "fixed" | "percentage"; + amount: number; }; - property3?: { - name?: string; - value?: string; - defining?: boolean; + discount: { + name: string; + description: string; + /** + * Em desuso + */ + facebook: boolean; + valid_to: string; }; - barcode?: string; + images: { + sku: string; + url: string; + }[]; + variants: VariantProductSearch[]; + installments: ProductInstallment[]; + created_at: string; + /** + * Data e horário da última atualização do produto + */ + updated_at: string; +} +/** + * Modelo que representa uma variante retornada via busca no Elasticsearch + */ +export interface VariantProductSearch { + id: number; + sku: string; + sku_lowercase: string; + name: string; + full_name: string; + main: boolean; + available: boolean; + image_url: string; + /** + * Preço do item + */ + price: number; + /** + * Preço promocional + */ + sale_price: number; + intl_price: number; + installments: ProductInstallment[]; + /** + * Quantidade de itens disponíveis + */ + stock: number; + quantity: number; /** * Quantidade de itens vendidos */ - quantity_sold?: number; + quantity_sold: number; + /** + * Quantidade mínima para venda + */ + min_quantity: number; + available_quantity: number; + /** + * Customização da variante + */ + custom_attributes: {}; + /** + * [Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante + */ + properties: { + property1?: VariantPropertyProductSearch; + property2?: VariantPropertyProductSearch; + property3?: VariantPropertyProductSearch; + }; + inventories: { + name: string; + slug: string; + available: boolean; + /** + * Preço do item + */ + price: number; + /** + * Preço promocional + */ + sale_price: number; + quantity: number; + /** + * Quantidade de itens vendidos + */ + quantity_sold: number; + place: { + id: number; + name: string; + }; + }[]; + /** + * Dias de manuseio da variante + */ + handling_days: number; + barcode: string; + /** + * Massa do produto, em gramas + */ + weight: number; + /** + * Largura do produto, em centímetros + */ + width: number; + /** + * Altura do produto, em centímetros + */ + height: number; + /** + * Comprimento do produito, em centímetros + */ + length: number; + required?: []; + additionalProperties?: never; } - - } -/** @description Deleta uma imagem do produto */ - "DELETE /api/v2/products/:product_id/images/:image_id": { - - } -/** @description Associa a imagem com uma variante */ - "POST /api/v2/products/:product_id/images/:image_id/add_variant": { - searchParams: { - variant_id?: number; +/** + * Modelo que representa uma parcela + */ +export interface ProductInstallment { + number: number; + /** + * Preço do item + */ + price: number; + interest: boolean; + interest_rate: number; + total: number; } - - } -/** @description Remove a associação da imagem com uma variante */ - "POST /api/v2/products/:product_id/images/:image_id/remove_variant": { - searchParams: { +/** + * Modelo que representa uma propriedade de uma variante quando retornada via Elasticsearch + */ +export interface VariantPropertyProductSearch { + name: string; + value: string; + defining: boolean; +} +/** + * Modelo que representa uma propriedade de uma variante + */ +export interface VariantProperty1 { + /** + * Nome da propriedade + */ + name: string; + /** + * Valor da propriedade + */ + value: string; + /** + * Indica se a variante possui uma definição (`true`) ou se a variante não possui (`false`) + */ + defining: boolean; +} +/** + * Modelo que representa uma tag na API + */ +export interface Tag { + name: string; + title?: string; + subtitle?: string; + description?: string; + type?: string; + products_count?: number; + image_url?: string; + updated_at?: string; +} +/** + * Modelo que representa um cliente na API + */ +export interface Client { + id?: number; + first_name?: string; + last_name?: string; + email?: string; + gender?: string; + phone_area?: string; + phone?: string; + document_type?: "CPF" | "CNPJ"; + /** + * Número de documento cadastrado pelo cliente + */ + document_number?: string; + cpf?: string; + cnpj?: string; + ie?: string; + tags?: string; + lists?: string[]; + facebook_uid?: string; + liked_facebook_page?: boolean; + updated_at?: string; + birthdate?: string; + recent_address?: { + id?: string; + first_name?: string; + last_name?: string; + company_name?: string; + street_name?: string; + street_number?: string; + neighborhood?: string; + complement?: string; + reference?: string; + city?: string; + state?: string; + zip?: string; + first_phone_area?: string; + first_phone?: string; + second_phone_area?: string; + second_phone?: string; + email?: string; + documents?: { + cpf?: string; + cnpj?: string; + }; + }[]; + auth_token?: string; + last_confirmed_order_at?: string; + received_orders_count?: number; + confirmed_orders_count?: number; + canceled_orders_count?: number; + renew_password?: boolean; +} +/** + * Modelo que representa um endereço na API + */ +export interface Address { + id?: number; + first_name?: string; + last_name?: string; + company_name?: string; + email?: string; + documents?: { + cpf?: string; + cnpj?: string; + }; + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + first_phone_area?: string; + first_phone?: string; + second_phone_area?: string; + second_phone?: string; + reference?: string; + zip?: string; + city?: string; + state?: string; + recipient_name?: string; +} +/** + * Modelo que representa os endereços cadastrados pelo cliente na API + */ +export interface Client1 { + id?: number; + street_name?: string; + street_number?: string; + complement?: string; + neighborhood?: string; + label?: string; + zip?: string; + city?: string; + state?: string; + reference?: string; + client_id?: number; +} +/** + * Modelo que representa um bônus na API + */ +export interface Bonus { + amount?: number; + token?: string; + valid_from?: string; + valid_thru?: string; + created_at?: string; + updated_at?: string; +} +/** + * Modelo que representa um menu na API + */ +export interface Menu { + id?: number; + label?: string; + title?: string; + description?: string; + url?: string; + external?: boolean; + parent_id?: number; + tag_id?: number; + tag_name?: string; + page_id?: number; + page_slug?: string; + items_count?: number; + updated_at?: string; + tooltip?: string; + children?: Menu[]; + image_url?: string; + simple_url?: string; + position?: string; + norder?: number; + type?: string; +} +/** + * Modelo que representa um menu na API quando retornado pela ação de menu em árvore + */ +export interface MenuTree { + id?: number; + title?: string; + description?: string; + external?: boolean; + url?: string; + tag_id?: number; + page_id?: number; + items_count?: number; + children?: MenuTree[]; + updated_at?: string; + tooltip?: string; + image_url?: string; + simple_url?: string; + norder?: number; +} +/** + * Modelo que representa as mensagens do site na API + */ +export interface SiteMessage { + id?: number; + title?: string; + description?: string; + call_to_action?: string; + created_at?: string; + updated_at?: string; +} +/** + * Modelo que representa as imagens da loja na API + */ +export interface ShopAsset { + id?: number; + position?: string; + file_uid?: string; + file_name?: string; + updated_at?: string; +} +/** + * Modelo que representa um atributo customizado de produto + */ +export interface ProductsAttributes { + index?: number; + name?: string; + mandatory?: boolean; + updated_at?: string; +} +/** + * Modelo que representa uma customização + */ +export interface Customization { + id?: number; + group_name?: string; + name?: string; + label?: string; + image_uid?: string; + image_name?: string; + price?: number; + intl_price?: number; + quantity?: number; + handling_days?: number; + tag_id?: number; + sku?: string; + pattern?: string; +} +/** + * Modelo que representa a lista de itens do pedido + */ +export interface OrderItems { + id?: number; variant_id?: number; + product_id?: number; + quantity?: number; + price?: number; + weight?: number; + width?: number; + height?: number; + length?: number; + extra?: { + customization?: string; + }; + picture_url?: string; + reference?: string; + sku?: string; + product_name?: string; + variant_name?: string; + original_price?: string; + place_id?: string; + place_name?: number; + place_city?: number; + total?: number; + package?: number; + has_customizations?: number; + barcode?: number; } - - } -/** @description Retorna as informações de um carrinho pelo seu `id` ou `token` */ - "GET /api/v2/carts/:cart_id": { - - } -/** @description Permite excluir um carrinho */ - "DELETE /api/v2/carts/:cart_id": { - - } -/** @description Permite atualizar os atributos de um carrinho */ - "PATCH /api/v2/carts/:cart_id": { - searchParams: /** - * Parâmetros criação e atualização de carrinho +/** + * Modelo que representa uma personalização de item do pedido na API */ -export interface ParametrosDeCarrinhoResumido { +export interface OrderItemCustomization { + /** + * Código identificador `ID` da personalização + */ + id: number; + /** + * Número de tipos diferentes de personalizações em produtos do pedido + */ + number: number; /** - * Agente que criou o carrinho + * Grupo em que se enquadra a personalização */ - agent?: string; + group_name: string; /** - * Código de Endereçamento Postal (CEP) do destinatário do pedido + * Nome do produto */ - zip?: string; + name: string; /** - * Código identificador `ID` do cliente + * Preço do produto */ - client_id?: number; + price: number; /** - * Código identificador `ID` do desconto do carrinho + * Preço internacional */ - coupon_code?: string; + intl_price: number; /** - * @deprecated - * Email do cliente + * Dias de manuseio do produto */ - email?: string; + handling_days: number; /** - * Token do desconto + * Código SKU da variante de produto */ - rebate_token?: string; + sku: string; } - - } -/** @description Remove um item do carrinho */ - "DELETE /api/v2/carts/:cart_id/items/:item_id": { - - } -/** @description Atualiza um item do carrinho */ - "PATCH /api/v2/carts/:cart_id/items/:item_id": { - searchParams: /** - * Modelo de carcaterística de produto para item no carrinho +/** + * Modelo que representa uma personalização de item do carrinho na API */ -export interface Produto { - /** - * Código SKU da variante do produto - */ - sku?: string; +export interface CartItemCustomization { /** - * Unidades do produto disponíveis fisicamente + * Código identificador do produto */ - quantity?: number; + id: number; + group_name: string; + name: string; + number: number; /** - * Campo para registro de observações, chave ou valores necessários + * Preço unitário */ - extra?: {}; + price: number; /** - * Código identificador do local do produto + * Preço internacional */ - place_id?: number; + intl_price: number; /** - * Código de cupom + * Número de dias para manuseio */ - store_coupon_code?: string; + handling_days: number; /** - * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto + * Código SKU do produto */ - customizations?: { - /** - * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. - * Se por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. - */ - Customization?: string; - }[]; + sku: string; } - - } -/** @description Atualiza o método para o envio dos itens do carrinho */ - "PATCH /api/v2/carts/:cart_id/shipping_methods/:value_method": { - searchParams: /** +/** + * Modelo que representa um mapeamento na API + */ +export interface Mapping { + id?: number; + key: string; + from?: string[]; + to?: string; + created_at?: string; + updated_at?: string; +} +/** + * Modelo que representa um banner na API + */ +export interface Banner { + big_thumb: string; + color: string; + description: string; + end_at: string; + external: boolean; + file_name: string; + file_uid: string; + html_description: string; + id: number; + norder: number; + plain_description: string; + small_thumb: string; + start_at: string; + subtitle: string; + tag: string; + title: string; + updated_at: string; + url: string; +} +/** + * Modelo que representa um banner simplificado na API + */ +export interface SlimBanner { + id: number; + tag: string; + title: string; + subtitle: string; + description: string; + url: string; + external: boolean; + start_at: string; + end_at: string; + file_url: string; + norder: number; + color: string; + updated_at: string; +} +/** * Modelo que representa as formas de entrega na API */ -export interface ShippingMethods { +export interface ShippingMethods1 { /** * Nome do tipo de entrega, como por exemplo Normal, Expressa e Agendada */ - name?: string; + name: string; /** * Identificador do método de envio */ - value?: string; + value: string; /** * Preço de envio */ - price?: number; + price: number; /** * Descrição do tipo de envio e prazo */ - description?: string; + description: string; /** * Número em dias do prazo de envio */ - delivery_days?: number; + delivery_days: number; /** * Valor restante da compra para que o carrinho fique elegível para frete grátis */ @@ -1846,7 +4832,7 @@ export interface ShippingMethods { /** * Código identificador `ID` do tipo de envio */ - shipping_method_id?: number; + shipping_method_id: number; /** * Mensagem ou observação sobre a forma de envio */ @@ -1854,54 +4840,58 @@ export interface ShippingMethods { /** * Empresa responsável pelo envio */ - fulfillment_company?: string; + fulfillment_company: string; } - - } -/** @description Calculo os método de envio disponíveis para o carrinho */ - "GET /api/v2/carts/:cart_id/shipping_methods": { - - } -/** @description Calcula as parcelas de pagamento para valor total do carrinho */ - "GET /api/v2/carts/:cart_id/installments": { - - } -/** @description Retorna os dados de um pedido pelo `code` ou `token` do pedido */ - "GET /api/v2/orders/:order_code": { - - } -/** @description Atualiza o campo de dados extras de um pedido pelo `code` do pedido */ - "PATCH /api/v2/orders/:order_code": { - searchParams: { +/** + * Modelo de endereço de envio para carrinho e pedido + */ +export interface EnderecoDeEnvio { + id?: number; + first_name: string; + last_name: string; + company_name?: string; + email: string; /** - * Campo para registro de observações, chave ou valores necessários + * Serão retornados apenas os campos preenchidos */ - extra?: {}; + documents?: { + cpf?: string; + cnpj?: string; + ie?: string; + }; + street_name: string; + street_number: string; + complement?: string; + neighborhood: string; + /** + * Somente números + */ + first_phone_area: string; + /** + * Somente números + */ + first_phone: string; + /** + * Somente números + */ + second_phone_area?: string; + /** + * Somente números + */ + second_phone?: string; + reference?: string; + /** + * Somente números + */ + zip: string; + city: string; + state: string; + recipient_name?: string; } - - } -/** @description Retorna a *timeline* de eventos ocorridos em um pedido */ - "GET /api/v2/orders/:order_code/events": { - - } -/** @description Retorna a avaliação que o cliente fez em um pedido */ - "GET /api/v2/orders/:order_code/reviews": { - - } -/** @description Retorna os descontos de um pedido pelo `code` ou `token` do pedido */ - "GET /api/v2/orders/:order_code/discounts": { - - } -/** @description Retorna o endereço de envio pelo `code` do pedido */ - "GET /api/v2/orders/:order_code/shipping_address": { - - } -/** @description Atualiza dados de endereço do pedido */ - "PATCH /api/v2/orders/:order_code/shipping_address": { - searchParams: /** +/** * Modelo de endereço de envio para carrinho e pedido */ -export interface EnderecoDeEnvio { +export interface EnderecoDeEnvio1 { /** * Nome do cliente */ @@ -1938,7 +4928,7 @@ export interface EnderecoDeEnvio { * Nome do recebedor */ recipient_name?: { - [k: string]: unknown; + [k: string]: any; }; /** * Logradouro @@ -1963,7 +4953,7 @@ export interface EnderecoDeEnvio { /** * Código de Endereçamento Postal (CEP) */ - zip?: string; + zip: string; documents?: { /** * Cadastro de Pessoa Física @@ -1983,125 +4973,274 @@ export interface EnderecoDeEnvio { ie?: string; }[]; } - - } -/** @description Captura o pagamento no adquirente para pedidos com pagamento por cartão de crédito. */ - "POST /api/v2/orders/:order_code/capture": { - - } -/** @description Confirma um pedido */ - "POST /api/v2/orders/:order_code/confirm": { - searchParams: { - /** - * Parâmetro para incluir o retorno [da requisição de captura do pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-capture). - * Esse parâmetro é **obrigatório** para pedidos com pagamento por cartão de crédito. - */ - confirmation_data?: string; +/** + * Modelo que representa os preços de uma variante + */ +export interface ProductPriceVariant { + /** + * Define se a variante do produto é a principal + */ + main: boolean; + /** + * Código SKU da variante + */ + sku: string; + /** + * Preço do item + */ + price: number; + on_sale: boolean; + /** + * Preço promocional + */ + sale_price: number; + intl_price: number; + available: boolean; + /** + * [Atributos](https://developers.vnda.com.br/docs/atributos-de-produto) da variante + */ + properties: { + property1?: VariantProperty1; + property2?: VariantProperty1; + property3?: VariantProperty1; + }; + /** + * Quantidade de itens disponíveis + */ + stock: number; + installments: ProductInstallment[]; + required?: []; + additionalProperties?: never; } - - } -/** @description Faz o estorno do pagamento no adquirente do cartão de crédito -Operação válida para pedidos pagos com cartão de crédito */ - "POST /api/v2/orders/:order_code/chargeback": { - - } -/** @description Altera o status do pedido para `cancelado` */ - "POST /api/v2/orders/:order_code/cancel": { - searchParams: { - /** - * Parâmetro para incluir uma confirmação de estorno de pagamento para o cliente. - * Para pedidos com pagamento via cartão de crédito, é obrigatório que nesse campo seja incluído no parâmetro o retorno [da requisição de estorno de pagamento](https://developers.vnda.com.br/reference/post-api-v2-orders-order-code-chargeback). - */ - cancelation_data?: string; +/** + * Modelo que representa uma imagem de um produto + */ +export interface ProductImage { + /** + * Código identificador `ID` da imagem + */ + id: number; + /** + * URL da imagem + */ + url: string; + /** + * Data e horário da última atualização da imagem do produto + */ + updated_at: string; + /** + * Códigos das variantes que utilizam a imagem + */ + variant_ids: number[]; } - - } -/** @description Retorna os itens de um pedido pelo código do pedido */ - "GET /api/v2/orders/:order_code/items": { - - } -/** @description Lista as personalizações de um item do pedido pelos códigos do item e do pedido */ - "GET /api/v2/orders/:order_code/items/:item_id/customizations": { - - } -/** @description Retorna os pedidos de um cliente pelo seu `id_client` */ - "GET /api/v2/clients/:id_client/orders": { - - } -/** @description Retorna as notas fisicais de um pacote do pedido */ - "GET /api/v2/orders/:order_code/packages/:package_code/invoices": { - - } -/** @description Inclui nota fiscal no pacote de um pedido */ - "POST /api/v2/orders/:order_code/packages/:package_code/invoices": { - searchParams: /** - * Modelo que representa uma nota fiscal na API +/** + * Modelo que representa um pacote na API */ -export interface Invoice { +export interface Package { + actual_shipping_method: string; /** - * Número da nota fiscal + * Código identificador do pacote */ - number?: number; + code: string; /** - * Número de série da nota fiscal + * Data de entrega do pacote */ - series?: number; + delivered_at: string; + delivered_email_sent_at: string; /** - * Data e horário da criação da nota fiscal + * Número de dias para entrega */ - issued_at?: string; + delivery_days: number; /** - * Chave da nota fiscal + * Tipo de envio do pacote */ - key?: string; - volumes?: number; + delivery_type: string; + /** + * Quantidade de dias úteis para entrega + */ + delivery_work_days: number; + /** + * Transportadora + */ + fulfillment_company: string; + /** + * Status de envio + */ + fulfillment_status: "waiting" | "shipped" | "delivered"; + integrated: boolean; + invoiced: boolean; + label: string; + properties: {}; + quoted_shipping_price: number; + shipped_at: string; + shipped_email_sent_at: string; + shipping_label: string; + shipping_name: string; + shipping_price: number; + total: number; + /** + * Data e horário da última atualização do código de rastreio do pacote + */ + tracked_at: string; + /** + * Código de rastreio do pacote + */ + tracking_code: string; + required?: []; + additionalProperties?: never; } - - } -/** @description Remove uma nota fiscal */ - "DELETE /api/v2/orders/:order_code/packages/:package_code/invoices/:number": { - - } -/** @description Atualiza uma nota fiscal */ - "PATCH /api/v2/orders/:order_code/packages/:package_code/invoices/:number": { - searchParams: /** - * Modelo que representa uma nota fiscal na API +/** + * Modelo simplificado de um produto para atualização e criação */ -export interface Invoice { +export interface SimpleProduct1 { /** - * Número da nota fiscal + * Código de Referência do produto */ - number?: number; + reference: string; /** - * Número de série da nota fiscal + * Nome do produto */ - series?: number; + name: string; /** - * Data e horário da criação da nota fiscal + * Descrição do produto */ - issued_at?: string; + description?: string; /** - * Chave da nota fiscal + * Indica se o produto está ativo (`true`) ou invativo (`false`) */ - key?: string; - volumes?: number; + active?: boolean; + /** + * Tags associadas ao produto + */ + tag_list?: string; + /** + * Tipo de produto + */ + product_type?: "product" | "sample" | "subscription"; } - - } -/** @description Permite listar os pedidos pendentes do feed */ - "GET /api/feed/orders": { - - } -/** @description Permite marcar os pedidos para que eles sejam filtrados da listagem do feed */ - "POST /api/feed/orders": { - searchParams: { - orders?: { +/** + * Modelo de carcaterística de produto para item no carrinho + */ +export interface Produto1 { + /** + * Código SKU da variante do produto + */ + sku?: string; + /** + * Unidades do produto disponíveis fisicamente + */ + quantity?: number; + /** + * Campo para registro de observações, chave ou valores necessários + */ + extra?: {}; + /** + * Código identificador do local do produto + */ + place_id?: number; + /** + * Código de cupom + */ + store_coupon_code?: string; + /** + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) do produto + */ + customizations?: { /** - * Código do pedido + * [Personalização](http://ajuda.vnda.com.br/pt-BR/articles/1763398-funcionalidades-produtos-personalizados) incluídas no Admin da loja. + * Se por exemplo a customização do produto é a cor, o parâmetro para a requisição deve ser `Color` ao invés de `CUstomization`. */ - code?: string; + Customization?: string; }[]; } - - } -} \ No newline at end of file +/** + * Modelo de produto em um pedido + */ +export interface ProdutoEmUmPedido1 { + /** + * Dados extra do produto + */ + extra: {}; + /** + * Altura do produto, em centímetros. + */ + height?: number; + /** + * código identificador do produto + */ + id?: number; + /** + * Comprimento do produito, em centímetros. + */ + length?: number; + /** + * Preço original + */ + original_price?: number; + /** + * Pacote do produto + */ + package?: string; + /** + * URL da imagem do produto + */ + picture_url?: string; + /** + * Cidade que o produto está + */ + place_city?: string; + /** + * Código identificador do local do produto + */ + place_id?: number; + /** + * Nome do local do produto + */ + place_name?: string; + /** + * Preço do produto + */ + price?: number; + product_id: number; + product_name: string; + /** + * Unidades do produto + */ + quantity: number; + /** + * Código de referência do produto + */ + reference: string; + /** + * Código SKU da variante do produto + */ + sku: string; + /** + * Valor total do produto + */ + total: number; + /** + * Código identificador da variante do produto + */ + variant_id: number; + /** + * Nome da variante do produto + */ + variant_name: string; + /** + * Massa do produto, em gramas + */ + weight: number; + /** + * Largura do produto, em centímetros + */ + width: number; + /** + * Código de barras do produto + */ + barcode?: string; + /** + * Indica se o produto possui customização. + */ + has_customizations?: boolean; +} diff --git a/vnda/utils/openapi/vnda.openapi.json b/vnda/utils/openapi/vnda.openapi.json index d58be1017..04d9cec19 100644 --- a/vnda/utils/openapi/vnda.openapi.json +++ b/vnda/utils/openapi/vnda.openapi.json @@ -24,6 +24,80 @@ } ], "paths": { + "/api/v2/seo_data": { + "get": { + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "resource_type": { + "type": "string" + }, + "resource_id": { + "type": "integer" + }, + "parent_id": { + "type": "number" + } + }, + "required": [ + "id", + "resource_type", + "resource_id", + "parent_id" + ] + } + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "resource_type", + "in": "query" + }, + { + "schema": { + "type": "integer" + }, + "name": "resource_id", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "name": "type", + "in": "query" + }, + { + "schema": { + "type": "string" + }, + "name": "code", + "in": "query" + } + ] + } + }, "/api/v2/users/authorize": { "post": { "summary": "User authorize", @@ -7095,7 +7169,7 @@ } }, "in": "query", - "name": "tags", + "name": "tags[]", "description": "Filtra pelo nome das tags, independente do tipo" }, { @@ -12369,7 +12443,6 @@ "content": { "application/json": { "schema": { - "type": "array", "$ref": "#/components/schemas/Product.v0" } } diff --git a/vnda/utils/transform.ts b/vnda/utils/transform.ts index 7b423373e..0d8cdc3c7 100644 --- a/vnda/utils/transform.ts +++ b/vnda/utils/transform.ts @@ -6,13 +6,18 @@ import { Seo, UnitPriceSpecification, } from "../../commerce/types.ts"; +import { ProductGroup, SEO } from "./client/types.ts"; import { - Installment, - ProductGroup, - ProductSearchResult, + OpenAPI, + Product as OProduct, + ProductInstallment, + ProductSearch, ProductVariant, - SEO, -} from "./client/types.ts"; + VariantProductSearch, +} from "./openapi/vnda.openapi.gen.ts"; + +type VNDAProductGroup = ProductSearch | OProduct; +type VNDAProduct = VariantProductSearch | ProductVariant; interface ProductOptions { url: URL; @@ -46,12 +51,12 @@ export const parseSlug = (slug: string) => { }; }; -const pickVariant = (product: ProductGroup, variantId: string | null) => { +const pickVariant = (product: VNDAProductGroup, variantId: string | null) => { const variants = normalizeVariants(product.variants); const [head] = variants; let [target, main, available]: Array< - ProductVariant | null + VNDAProduct | null > = [null, head, null]; for (const variant of variants) { @@ -65,7 +70,9 @@ const pickVariant = (product: ProductGroup, variantId: string | null) => { return target || fallback || head; }; -const normalizeInstallments = (installments: Installment[] | number[] = []) => { +const normalizeInstallments = ( + installments: ProductInstallment[] | number[] = [], +) => { if (typeof installments[0] === "number") { const total = (installments as number[]).reduce((acc, curr) => acc + curr); @@ -76,7 +83,9 @@ const normalizeInstallments = (installments: Installment[] | number[] = []) => { }]; } - return (installments as Installment[]).map(({ number, price, total }) => ({ + return (installments as ProductInstallment[]).map(( + { number, price, total }, + ) => ({ number, price, total, @@ -91,7 +100,7 @@ const toOffer = ({ available_quantity, available, installments = [], -}: ProductVariant): Offer | null => { +}: VNDAProduct): Offer | null => { if (!price || !sale_price) { return null; } @@ -137,7 +146,7 @@ const toOffer = ({ }; }; -const toPropertyValue = (variant: ProductVariant): PropertyValue[] => +const toPropertyValue = (variant: VNDAProduct): PropertyValue[] => Object.values(variant.properties ?? {}) .filter(Boolean) .map(({ value, name }) => @@ -150,16 +159,18 @@ const toPropertyValue = (variant: ProductVariant): PropertyValue[] => ).filter((x): x is PropertyValue => Boolean(x)); // deno-lint-ignore no-explicit-any -const isProductVariant = (p: any): p is ProductVariant => +const isProductVariant = (p: any): p is VariantProductSearch => typeof p.id === "number"; const normalizeVariants = ( - variants: ProductGroup["variants"] = [], -): ProductVariant[] => - variants.flatMap((v) => isProductVariant(v) ? [v] : Object.values(v)); + variants: VNDAProductGroup["variants"] = [], +): VNDAProduct[] => + variants.flatMap((v) => + isProductVariant(v) ? [v] : Object.values(v) as VNDAProduct[] + ); export const toProduct = ( - product: ProductGroup, + product: VNDAProductGroup, variantId: string | null, options: ProductOptions, level = 0, @@ -204,8 +215,8 @@ export const toProduct = ( image: product.images?.length ?? 0 > 1 ? product.images?.map((img) => ({ "@type": "ImageObject" as const, - alternateName: img.id?.toString() ?? "", - url: toURL(img.url), + alternateName: `${img.url}`, + url: toURL(img.url!), })) : [ { @@ -250,22 +261,31 @@ const removeFilter = ( ); export const toFilters = ( - aggregations: ProductSearchResult["aggregations"], + aggregations: + OpenAPI["GET /api/v2/products/search"]["response"]["aggregations"], typeTagsInUse: { key: string; value: string }[], cleanUrl: URL, ): Filter[] => { + if (!aggregations) { + return []; + } + const priceRange = { "@type": "FilterRange" as const, label: "Valor", key: "price_range", values: { - min: aggregations.min_price, - max: aggregations.max_price, + min: aggregations.min_price!, + max: aggregations.max_price!, }, }; - const types = Object.keys(aggregations.types).map((typeKey) => { - const typeValues = aggregations.types[typeKey]; + const types = Object.keys(aggregations.types ?? {}).map((typeKey) => { + const typeValues = (aggregations.types as any)[typeKey] as { + name: string; + title: string; + count: number; + }[]; return { "@type": "FilterToggle" as const, diff --git a/wake/actions/cart/addCoupon.ts b/wake/actions/cart/addCoupon.ts index d330a0703..84e632d62 100644 --- a/wake/actions/cart/addCoupon.ts +++ b/wake/actions/cart/addCoupon.ts @@ -7,7 +7,7 @@ import { AddCouponMutation, AddCouponMutationVariables, CheckoutFragment, -} from "../../utils/graphql/graphql.gen.ts"; +} from "../../utils/graphql/storefront.graphql.gen.ts"; export interface Props { coupon: string; diff --git a/wake/actions/cart/addItem.ts b/wake/actions/cart/addItem.ts index ca7a0bf7d..95b148c1d 100644 --- a/wake/actions/cart/addItem.ts +++ b/wake/actions/cart/addItem.ts @@ -7,7 +7,7 @@ import { AddItemToCartMutation, AddItemToCartMutationVariables, CheckoutFragment, -} from "../../utils/graphql/graphql.gen.ts"; +} from "../../utils/graphql/storefront.graphql.gen.ts"; export interface Props { productVariantId: number; diff --git a/wake/actions/cart/removeCoupon.ts b/wake/actions/cart/removeCoupon.ts index e9bd4d93c..3f0da7e20 100644 --- a/wake/actions/cart/removeCoupon.ts +++ b/wake/actions/cart/removeCoupon.ts @@ -7,7 +7,7 @@ import { CheckoutFragment, RemoveCouponMutation, RemoveCouponMutationVariables, -} from "../../utils/graphql/graphql.gen.ts"; +} from "../../utils/graphql/storefront.graphql.gen.ts"; const action = async ( _props: unknown, diff --git a/wake/actions/cart/updateItemQuantity.ts b/wake/actions/cart/updateItemQuantity.ts index d8efa736d..885ea17ab 100644 --- a/wake/actions/cart/updateItemQuantity.ts +++ b/wake/actions/cart/updateItemQuantity.ts @@ -9,7 +9,7 @@ import { CheckoutFragment, RemoveItemFromCartMutation, RemoveItemFromCartMutationVariables, -} from "../../utils/graphql/graphql.gen.ts"; +} from "../../utils/graphql/storefront.graphql.gen.ts"; export interface Props { productVariantId: number; diff --git a/wake/mod.ts b/wake/mod.ts index 2e46c55f9..4e4738813 100644 --- a/wake/mod.ts +++ b/wake/mod.ts @@ -1,7 +1,7 @@ import type { App, FnContext } from "deco/mod.ts"; import { createHttpClient } from "../utils/http.ts"; import manifest, { Manifest } from "./manifest.gen.ts"; -import { API } from "./utils/openapi/wake.openapi.gen.ts"; +import { OpenAPI } from "./utils/openapi/wake.openapi.gen.ts"; import { fetchSafe } from "../utils/fetch.ts"; import { createGraphqlClient } from "../utils/graphql.ts"; @@ -35,7 +35,7 @@ export interface Props { } export interface State extends Props { - api: ReturnType>; + api: ReturnType>; storefront: ReturnType; } @@ -44,7 +44,7 @@ export interface State extends Props { */ export default function App(props: Props): App { const { token, storefrontToken } = props; - const api = createHttpClient({ + const api = createHttpClient({ base: "https://api.fbits.net", headers: new Headers({ "Authorization": `Basic ${token}` }), fetcher: fetchSafe, diff --git a/wake/utils/openapi/wake.openapi.gen.ts b/wake/utils/openapi/wake.openapi.gen.ts index 05bae9cc8..b6aa40323 100644 --- a/wake/utils/openapi/wake.openapi.gen.ts +++ b/wake/utils/openapi/wake.openapi.gen.ts @@ -1,15 +1,38 @@ // DO NOT EDIT. This file is generated by deco. // This file SHOULD be checked into source version control. -// To generate this file: deno run -A scripts/openAPI.ts +// To generate this file: deno task start -export interface API { - /** @description Últimos Pedidos */ - "GET /dashboard/pedidos": {}; - /** @description Lista de hotsites vinculados ao banner */ - "GET /banners/:bannerId/hotsites": {}; - /** @description Vincula hotsites com um banner específico */ +export interface OpenAPI { + /** + * Últimos Pedidos + */ + "GET /dashboard/pedidos": { + response: { + pedidoId?: number; + situacaoPedidoId?: number; + situacaoNome?: string; + data?: string; + dataFormatado?: string; + hora?: string; + valorTotal?: string; + }[]; + }; + /** + * Lista de hotsites vinculados ao banner + */ + "GET /banners/:bannerId/hotsites": { + response: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + }; + /** + * Vincula hotsites com um banner específico + */ "POST /banners/:bannerId/hotsites": { - searchParams: { + body: { /** * lista de identificadores de hotsites a serem vinculados ao banner */ @@ -21,18 +44,22 @@ export interface API { }[]; }; }; - /** @description Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não */ + /** + * Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não + */ "PUT /banners/:bannerId/hotsites": { - searchParams: { + body: { /** * Exibição do banner nos hotsites */ exibirEmTodosHotsites?: boolean; }; }; - /** @description Deleta o vinculo de um ou mais hotsites com um banner específico */ + /** + * Deleta o vinculo de um ou mais hotsites com um banner específico + */ "DELETE /banners/:bannerId/hotsites": { - searchParams: { + body: { /** * Lista de identificadores de hotsites para desvincular do banner (optional) */ @@ -44,27 +71,39 @@ export interface API { /** * Id do hotsite para vinculo com banner */ - hotSiteId?: unknown[]; + hotSiteId?: any[]; }[]; }; }; }; - /** @description Retorna se o usuário ativou o recebimento de newsletter */ - "GET /usuarios/:email/comunicacao": {}; - /** @description Atualiza a comunicação de um usuário via newsletter */ + /** + * Retorna se o usuário ativou o recebimento de newsletter + */ + "GET /usuarios/:email/comunicacao": { + response: { + recebimentoNewsletter?: boolean; + }; + }; + /** + * Atualiza a comunicação de um usuário via newsletter + */ "PUT /usuarios/:email/comunicacao": { - searchParams: { + body: { /** * Novo status da comunicação via new ajuste realisletter */ recebimentoNewsletter?: boolean; }; }; - /** @description Buscar autor por id */ + /** + * Buscar autor por id + */ "GET /autores/:autorId": {}; - /** @description Atualizar autor */ + /** + * Atualizar autor + */ "PUT /autores/:autorId": { - searchParams: { + body: { /** * Nome do Autor */ @@ -75,17 +114,98 @@ export interface API { ativo?: boolean; }; }; - /** @description Deletar autor */ + /** + * Deletar autor + */ "DELETE /autores/:autorId": {}; - /** @description Retorna lista contendo os Id's dos pedidos do usuário */ - "GET /usuarios/:email/pedidos": {}; - /** @description Usuário encontrado */ - "GET /usuarios/cpf/:cpf": {}; - /** @description Loja Física */ - "GET /lojasFisicas/:lojaFisicaId": {}; - /** @description Atualiza uma Loja Física */ + /** + * Retorna lista contendo os Id's dos pedidos do usuário + */ + "GET /usuarios/:email/pedidos": { + response: { + pedidoId?: number; + links?: { + href?: string; + rel?: string; + method?: string; + }[]; + }[]; + }; + /** + * Usuário encontrado + */ + "GET /usuarios/cpf/:cpf": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** + * Loja Física + */ + "GET /lojasFisicas/:lojaFisicaId": { + response: { + lojaId?: number; + nome?: string; + ddd?: number; + telefone?: string; + email?: string; + cep?: string; + logradouro?: string; + numero?: string; + complemento?: string; + bairro?: string; + cidade?: string; + estadoId?: number; + prazoEntrega?: number; + prazoMaximoRetirada?: number; + ativo?: boolean; + valido?: boolean; + textoComplementar?: string; + retirarNaLoja?: boolean; + latitude?: number; + longitude?: number; + centroDistribuicaoId?: number; + centroDistribuicao?: { + centroDistribuicaoId?: number; + prazoEntrega?: number; + }[]; + }; + }; + /** + * Atualiza uma Loja Física + */ "PUT /lojasFisicas/:lojaFisicaId": { - searchParams: { + body: { /** * Id da loja (optional) */ @@ -181,13 +301,26 @@ export interface API { }[]; }; }; - /** @description Remove uma Loja Física */ + /** + * Remove uma Loja Física + */ "DELETE /lojasFisicas/:lojaFisicaId": {}; - /** @description Atributo encontrado */ - "GET /atributos/:nome": {}; - /** @description Atualiza um atributo */ + /** + * Atributo encontrado + */ + "GET /atributos/:nome": { + response: { + nome?: string; + tipo?: string; + tipoExibicao?: string; + prioridade?: number; + }; + }; + /** + * Atualiza um atributo + */ "PUT /atributos/:nome": { - searchParams: { + body: { /** * Nome do atributo (optional) */ @@ -196,130 +329,50 @@ export interface API { * Tipo do atributo (optional) */ tipo?: - | { - "0": "S"; - "1": "e"; - "2": "l"; - "3": "e"; - "4": "c"; - "5": "a"; - "6": "o"; - } - | { "0": "F"; "1": "i"; "2": "l"; "3": "t"; "4": "r"; "5": "o" } - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "p"; - "4": "a"; - "5": "r"; - "6": "a"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "C"; - "1": "o"; - "2": "n"; - "3": "f"; - "4": "i"; - "5": "g"; - "6": "u"; - "7": "r"; - "8": "a"; - "9": "c"; - "10": "a"; - "11": "o"; - } - | { - "0": "E"; - "1": "x"; - "2": "c"; - "3": "l"; - "4": "u"; - "5": "s"; - "6": "i"; - "7": "v"; - "8": "o"; - "9": "G"; - "10": "o"; - "11": "o"; - "12": "g"; - "13": "l"; - "14": "e"; - }; + | "Selecao" + | "Filtro" + | "Comparacao" + | "Configuracao" + | "ExclusivoGoogle"; /** * Tipo de exibição (optional) */ tipoExibicao?: - | { "0": "C"; "1": "o"; "2": "m"; "3": "b"; "4": "o" } - | { "0": "D"; "1": "i"; "2": "v" } - | { - "0": "D"; - "1": "i"; - "2": "v"; - "3": "C"; - "4": "o"; - "5": "m"; - "6": "C"; - "7": "o"; - "8": "r"; - } - | { - "0": "D"; - "1": "i"; - "2": "v"; - "3": "C"; - "4": "o"; - "5": "m"; - "6": "F"; - "7": "o"; - "8": "t"; - "9": "o"; - "10": "D"; - "11": "o"; - "12": "P"; - "13": "r"; - "14": "o"; - "15": "d"; - "16": "u"; - "17": "t"; - "18": "o"; - "19": "V"; - "20": "a"; - "21": "r"; - "22": "i"; - "23": "a"; - "24": "n"; - "25": "t"; - "26": "e"; - } - | { - "0": "J"; - "1": "a"; - "2": "v"; - "3": "a"; - "4": "s"; - "5": "c"; - "6": "r"; - "7": "i"; - "8": "p"; - "9": "t"; - }; + | "Combo" + | "Div" + | "DivComCor" + | "DivComFotoDoProdutoVariante" + | "Javascript"; /** * Prioridade do atributo (optional) */ prioridade?: number; }; }; - /** @description Deleta um atributo */ + /** + * Deleta um atributo + */ "DELETE /atributos/:nome": {}; - /** @description Lista de resellers */ - "GET /resellers": {}; - /** @description Insere um novo Seller no marketplace */ + /** + * Lista de resellers + */ + "GET /resellers": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }[]; + }; + /** + * Insere um novo Seller no marketplace + */ "POST /resellers": { - searchParams: { + body: { /** * Razão Social/Nome do Reseller */ @@ -347,35 +400,7 @@ export interface API { /** * Tipo de autonomia do vendedor */ - tipoAutonomia?: - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "A"; - "4": "u"; - "5": "t"; - "6": "o"; - "7": "n"; - "8": "o"; - "9": "m"; - "10": "i"; - "11": "a"; - } - | { - "0": "S"; - "1": "e"; - "2": "m"; - "3": "A"; - "4": "u"; - "5": "t"; - "6": "o"; - "7": "n"; - "8": "o"; - "9": "m"; - "10": "i"; - "11": "a"; - }; + tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; /** * Seller Ativo */ @@ -398,9 +423,17 @@ export interface API { cep?: string; }; }; - /** @description Atualiza um novo Seller no marketplace */ + /** + * Atualiza um novo Seller no marketplace + */ "PUT /resellers": { searchParams: { + /** + * Valor único utilizado para identificar o seller + */ + resellerId?: number; + }; + body: { /** * Razão Social/Nome do Reseller */ @@ -428,35 +461,7 @@ export interface API { /** * Tipo de autonomia do vendedor */ - tipoAutonomia?: - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "A"; - "4": "u"; - "5": "t"; - "6": "o"; - "7": "n"; - "8": "o"; - "9": "m"; - "10": "i"; - "11": "a"; - } - | { - "0": "S"; - "1": "e"; - "2": "m"; - "3": "A"; - "4": "u"; - "5": "t"; - "6": "o"; - "7": "n"; - "8": "o"; - "9": "m"; - "10": "i"; - "11": "a"; - }; + tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; /** * Seller Ativo */ @@ -479,13 +484,154 @@ export interface API { cep?: string; }; }; - /** @description Reseller específico */ - "GET /resellers/:resellerId": {}; - /** @description Lista de produtos */ - "GET /produtos": {}; - /** @description Método que insere um produto na base */ - "POST /produtos": { + /** + * Reseller específico + */ + "GET /resellers/:resellerId": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + }; + /** + * Lista de produtos + */ + "GET /produtos": { searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Lista de categorias que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as categorias + */ + categorias?: string; + /** + * Lista de fabricantes que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + fabricantes?: string; + /** + * Lista de centros de distribuição que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará produtos de todos os cd's + */ + centrosDistribuicao?: string; + /** + * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + */ + alteradosPartirDe?: string; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Retorna apenas os produtos que estão marcados como válido + */ + somenteValidos?: boolean; + /** + * Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + consumo?: { + quantidadeDias?: number; + enviarEmail?: boolean; + }; + prazoValidade?: number; + }[]; + }; + /** + * Método que insere um produto na base + */ + "POST /produtos": { + body: { /** * Representa o ProdutoId agrupador por variante (optional) */ @@ -509,10 +655,7 @@ export interface API { /** * Tipo de exibição da matriz de atributos (optional) */ - exibirMatrizAtributos?: - | { "0": "S"; "1": "i"; "2": "m" } - | { "0": "N"; "1": "a"; "2": "o" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; /** * Se o produto aceita contra proposta (optional) */ @@ -568,32 +711,7 @@ export interface API { /** * Define a qual regra de calculo de frete o produto vai pertencer */ - freteGratis?: - | { "0": "S"; "1": "e"; "2": "m"; "3": "p"; "4": "r"; "5": "e" } - | { "0": "N"; "1": "u"; "2": "n"; "3": "c"; "4": "a" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" } - | { - "0": "D"; - "1": "e"; - "2": "s"; - "3": "c"; - "4": "o"; - "5": "n"; - "6": "s"; - "7": "i"; - "8": "d"; - "9": "e"; - "10": "r"; - "11": "a"; - "12": "r"; - "13": "_"; - "14": "R"; - "15": "e"; - "16": "g"; - "17": "r"; - "18": "a"; - "19": "s"; - }; + freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; /** * Define se o produto variante tem troca grátis (optional) */ @@ -692,31 +810,7 @@ export interface API { /** * Condição do produto variante (optional) */ - condicao?: - | { "0": "N"; "1": "o"; "2": "v"; "3": "o" } - | { "0": "U"; "1": "s"; "2": "a"; "3": "d"; "4": "o" } - | { - "0": "R"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "v"; - "5": "a"; - "6": "d"; - "7": "o"; - } - | { - "0": "D"; - "1": "a"; - "2": "n"; - "3": "i"; - "4": "f"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "d"; - "9": "o"; - }; + condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; /** * Url do vídeo do Produto (optional) */ @@ -760,15 +854,19 @@ export interface API { }; }; }; - /** @description Remove um produto de uma tabela de preço */ + /** + * Remove um produto de uma tabela de preço + */ "DELETE /tabelaPrecos/:tabelaPrecoId/:sku": {}; - /** @description Atualiza o frete de todos os produtos de um pedido */ + /** + * Atualiza o frete de todos os produtos de um pedido + */ "PUT /pedidos/:pedidoId/changeseller": { - searchParams: { + body: { /** * Objeto com os dados de cotação e responsável */ - RAW_BODY?: { + RAW_BODY: { /** * ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes */ @@ -780,11 +878,70 @@ export interface API { }; }; }; - /** @description Objeto do banner */ - "GET /banners/:bannerId": {}; - /** @description Atualiza um banner existente */ + /** + * Objeto do banner + */ + "GET /banners/:bannerId": { + response: { + id?: number; + nome?: string; + dataInicio?: string; + dataFim?: string; + ativo?: boolean; + detalhe?: { + posicionamentoId?: number; + urlBanner?: string; + imagemBanner?: { + nome?: string; + base64?: string; + formato?: string; + }; + ordemExibicao?: number; + abrirBannerNovaAba?: boolean; + largura?: number; + altura?: number; + title?: string; + urlClique?: string; + urlBannerAlternativo?: string; + titleAlternativo?: string; + diasExibicao?: { + todosDias?: boolean; + domingo?: boolean; + segunda?: boolean; + terca?: boolean; + quarta?: boolean; + quinta?: boolean; + sexta?: boolean; + sabado?: boolean; + }; + textoAlternativo?: string; + }; + apresentacao?: { + exibirNoSite?: boolean; + exibirEmTodasBuscas?: boolean; + naoExibirEmBuscas?: boolean; + termosBusca?: string; + listaHotsites?: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + exibirEmTodasCategorias?: boolean; + listaParceiros?: { + exibirEmTodosParceiros?: boolean; + parceiros?: { + parceiroId?: number; + }[]; + }; + }; + }; + }; + /** + * Atualiza um banner existente + */ "PUT /banners/:bannerId": { - searchParams: { + body: { /** * Nome do banner */ @@ -820,10 +977,7 @@ export interface API { /** * formato da imagem */ - formato?: - | { "0": "P"; "1": "N"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; + formato?: "PNG" | "JPG" | "JPEG"; /** * nome da imagem */ @@ -966,11 +1120,15 @@ export interface API { }; }; }; - /** @description Deleta um banner existente */ + /** + * Deleta um banner existente + */ "DELETE /banners/:bannerId": {}; - /** @description Atualiza um produto em uma assinatura */ + /** + * Atualiza um produto em uma assinatura + */ "PUT /assinaturas/produtos/:assinaturaProdutoId/Alterar": { - searchParams: { + body: { /** * Novo valor do produto na assinatura (optional) */ @@ -985,11 +1143,27 @@ export interface API { quantidade?: number; }; }; - /** @description Parceiro encontrado */ - "GET /parceiros/:parceiroId": {}; - /** @description Parceiro atualizado com sucesso */ + /** + * Parceiro encontrado + */ + "GET /parceiros/:parceiroId": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }; + }; + /** + * Parceiro atualizado com sucesso + */ "PUT /parceiros/:parceiroId": { - searchParams: { + body: { /** * Nome do parceiro */ @@ -1005,37 +1179,7 @@ export interface API { /** * Tipo de escopo */ - tipoEscopo?: - | { - "0": "A"; - "1": "b"; - "2": "e"; - "3": "r"; - "4": "t"; - "5": "o"; - "6": '"'; - } - | { - "0": "F"; - "1": "e"; - "2": "c"; - "3": "h"; - "4": "a"; - "5": "d"; - "6": "o"; - } - | { - "0": "P"; - "1": "o"; - "2": "r"; - "3": "C"; - "4": "l"; - "5": "i"; - "6": "e"; - "7": "n"; - "8": "t"; - "9": "e"; - }; + tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; /** * Status do parceiro */ @@ -1053,14 +1197,43 @@ export interface API { */ alias?: string; }; + response: { + resultadoOperacao?: boolean; + codigo?: number; + mensagem?: string; + }[]; + }; + /** + * Parceiro excluído com sucesso + */ + "DELETE /parceiros/:parceiroId": { + response: { + resultadoOperacao?: boolean; + codigo?: number; + mensagem?: string; + }; + }; + /** + * Lista de parceiros + */ + "GET /parceiros": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }[]; }; - /** @description Parceiro excluído com sucesso */ - "DELETE /parceiros/:parceiroId": {}; - /** @description Lista de parceiros */ - "GET /parceiros": {}; - /** @description Insere um novo parceiro */ + /** + * Insere um novo parceiro + */ "POST /parceiros": { - searchParams: { + body: { /** * Nome do parceiro */ @@ -1076,37 +1249,7 @@ export interface API { /** * Tipo de escopo */ - tipoEscopo?: - | { - "0": "A"; - "1": "b"; - "2": "e"; - "3": "r"; - "4": "t"; - "5": "o"; - "6": '"'; - } - | { - "0": "F"; - "1": "e"; - "2": "c"; - "3": "h"; - "4": "a"; - "5": "d"; - "6": "o"; - } - | { - "0": "P"; - "1": "o"; - "2": "r"; - "3": "C"; - "4": "l"; - "5": "i"; - "6": "e"; - "7": "n"; - "8": "t"; - "9": "e"; - }; + tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; /** * Status do parceiro */ @@ -1121,131 +1264,70 @@ export interface API { origem?: string; }; }; - /** @description Lista de tipos de evento */ - "GET /tiposEvento": {}; - /** @description Insere um novo tipo de evento */ - "POST /tiposEvento": { + /** + * Lista de tipos de evento + */ + "GET /tiposEvento": { searchParams: { /** - * Nome do Tipo de Evento + * Status do tipo de evento */ - nome?: string; + ativo?: boolean; /** - * Tipo de entrega + * Se o tipo de evento está disponível */ - tipoEntrega?: - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "A"; - "8": "g"; - "9": "e"; - "10": "n"; - "11": "d"; - "12": "a"; - "13": "d"; - "14": "a"; - } - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "C"; - "8": "o"; - "9": "n"; - "10": "f"; - "11": "o"; - "12": "r"; - "13": "m"; - "14": "e"; - "15": "C"; - "16": "o"; - "17": "m"; - "18": "p"; - "19": "r"; - "20": "a"; - "21": "R"; - "22": "e"; - "23": "a"; - "24": "l"; - "25": "i"; - "26": "z"; - "27": "a"; - "28": "d"; - "29": "a"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } - | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; + disponivel?: boolean; /** - * Disponibilização do Tipo de Evento + * Nome do tipo de evento */ - tipoDisponibilizacao?: - | { - "0": "D"; - "1": "i"; - "2": "s"; - "3": "p"; - "4": "o"; - "5": "n"; - "6": "i"; - "7": "b"; - "8": "i"; - "9": "l"; - "10": "i"; - "11": "z"; - "12": "a"; - "13": "c"; - "14": "a"; - "15": "o"; - "16": "D"; - "17": "e"; - "18": "C"; - "19": "r"; - "20": "e"; - "21": "d"; - "22": "i"; - "23": "t"; - "24": "o"; - "25": "s"; - } - | { - "0": "D"; - "1": "i"; - "2": "s"; - "3": "p"; - "4": "o"; - "5": "n"; - "6": "i"; - "7": "b"; - "8": "i"; - "9": "l"; - "10": "i"; - "11": "z"; - "12": "a"; - "13": "c"; - "14": "a"; - "15": "o"; - "16": "D"; - "17": "e"; - "18": "P"; - "19": "r"; - "20": "o"; - "21": "d"; - "22": "u"; - "23": "t"; - "24": "o"; - "25": "s"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" }; + nome?: string; + }; + response: { + tipoEventoId?: number; + nome?: string; + tipoEntrega?: string; + tipoDisponibilizacao?: string; + permitirRemocaoAutomaticaProdutos?: boolean; + corHexTituloInformacoes?: string; + corHexCorpoInformacoes?: string; + numeroAbasInformacoes?: number; + quantidadeDiasParaEventoExpirar?: number; + numeroLocaisEvento?: number; + ativo?: boolean; + disponivel?: boolean; + tipoBeneficiarioFrete?: string; + caminhoLogoEvento?: string; + caminhoSubTemplate?: string; + sugestaoProdutos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + }[]; + }[]; + }; + /** + * Insere um novo tipo de evento + */ + "POST /tiposEvento": { + body: { + /** + * Nome do Tipo de Evento + */ + nome?: string; + /** + * Tipo de entrega + */ + tipoEntrega?: + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; + /** + * Disponibilização do Tipo de Evento + */ + tipoDisponibilizacao?: + | "DisponibilizacaoDeCreditos" + | "DisponibilizacaoDeProdutos" + | "Todos"; /** * Permissão para remoção automática de produtos */ @@ -1281,31 +1363,7 @@ export interface API { /** * O beneficiário do frete */ - tipoBeneficiarioFrete?: - | { - "0": "D"; - "1": "o"; - "2": "n"; - "3": "o"; - "4": "d"; - "5": "a"; - "6": "L"; - "7": "i"; - "8": "s"; - "9": "t"; - "10": "a"; - } - | { - "0": "C"; - "1": "o"; - "2": "n"; - "3": "v"; - "4": "i"; - "5": "d"; - "6": "a"; - "7": "d"; - "8": "o"; - }; + tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; /** * Imagem da logo do evento em base64 */ @@ -1325,15 +1383,74 @@ export interface API { }[]; }; }; - /** @description Lista de preços e estoque de produtos que sofreram alterações */ - "GET /produtos/alteracoes": {}; - /** @description Retorna a situação reseller de um produto */ - "GET /produtos/:identificador/situacaoReseller": {}; - /** @description Lista de atributos */ - "GET /atributos": {}; - /** @description Insere um novo atributo */ - "POST /atributos": { + /** + * Lista de preços e estoque de produtos que sofreram alterações + */ + "GET /produtos/alteracoes": { searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + */ + alteradosPartirDe?: string; + }; + response: { + produtoId?: number; + produtoVarianteId?: number; + sku?: string; + precoDe?: number; + precoPor?: number; + disponivel?: boolean; + valido?: boolean; + exibirSite?: boolean; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + }[]; + }; + /** + * Retorna a situação reseller de um produto + */ + "GET /produtos/:identificador/situacaoReseller": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** + * Lista de atributos + */ + "GET /atributos": { + response: { + nome?: string; + tipo?: string; + tipoExibicao?: string; + prioridade?: number; + }[]; + }; + /** + * Insere um novo atributo + */ + "POST /atributos": { + body: { /** * Nome do atributo (optional) */ @@ -1342,128 +1459,50 @@ export interface API { * Tipo do atributo (optional) */ tipo?: - | { - "0": "S"; - "1": "e"; - "2": "l"; - "3": "e"; - "4": "c"; - "5": "a"; - "6": "o"; - } - | { "0": "F"; "1": "i"; "2": "l"; "3": "t"; "4": "r"; "5": "o" } - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "p"; - "4": "a"; - "5": "r"; - "6": "a"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "C"; - "1": "o"; - "2": "n"; - "3": "f"; - "4": "i"; - "5": "g"; - "6": "u"; - "7": "r"; - "8": "a"; - "9": "c"; - "10": "a"; - "11": "o"; - } - | { - "0": "E"; - "1": "x"; - "2": "c"; - "3": "l"; - "4": "u"; - "5": "s"; - "6": "i"; - "7": "v"; - "8": "o"; - "9": "G"; - "10": "o"; - "11": "o"; - "12": "g"; - "13": "l"; - "14": "e"; - }; + | "Selecao" + | "Filtro" + | "Comparacao" + | "Configuracao" + | "ExclusivoGoogle"; /** * Tipo de exibição (optional) */ tipoExibicao?: - | { "0": "C"; "1": "o"; "2": "m"; "3": "b"; "4": "o" } - | { "0": "D"; "1": "i"; "2": "v" } - | { - "0": "D"; - "1": "i"; - "2": "v"; - "3": "C"; - "4": "o"; - "5": "m"; - "6": "C"; - "7": "o"; - "8": "r"; - } - | { - "0": "D"; - "1": "i"; - "2": "v"; - "3": "C"; - "4": "o"; - "5": "m"; - "6": "F"; - "7": "o"; - "8": "t"; - "9": "o"; - "10": "D"; - "11": "o"; - "12": "P"; - "13": "r"; - "14": "o"; - "15": "d"; - "16": "u"; - "17": "t"; - "18": "o"; - "19": "V"; - "20": "a"; - "21": "r"; - "22": "i"; - "23": "a"; - "24": "n"; - "25": "t"; - "26": "e"; - } - | { - "0": "J"; - "1": "a"; - "2": "v"; - "3": "a"; - "4": "s"; - "5": "c"; - "6": "r"; - "7": "i"; - "8": "p"; - "9": "t"; - }; + | "Combo" + | "Div" + | "DivComCor" + | "DivComFotoDoProdutoVariante" + | "Javascript"; /** * Prioridade do atributo (optional) */ prioridade?: number; }; }; - /** @description Inscrição */ - "GET /webhook/inscricao/:inscricaoId": {}; - /** @description Atualiza uma inscrição */ + /** + * Inscrição + */ + "GET /webhook/inscricao/:inscricaoId": { + response: { + inscricaoId?: number; + nome?: string; + appUrl?: string; + ativo?: boolean; + emailResponsavel?: string; + topico?: string[]; + usuario?: string; + header?: { + headerId?: number; + chave?: string; + valor?: string; + }[]; + }; + }; + /** + * Atualiza uma inscrição + */ "PUT /webhook/inscricao/:inscricaoId": { - searchParams: { + body: { /** * Nome da inscrição */ @@ -1475,7 +1514,7 @@ export interface API { /** * Tópicos em que deseja se inscrever */ - topicos?: string[]; + topicos: string[]; /** * Usuário que está realizando a inscrição */ @@ -1503,11 +1542,25 @@ export interface API { }[]; }; }; - /** @description Produtos de uma assinatura */ - "GET /assinaturas/:assinaturaId/produtos": {}; - /** @description Insere um novo produto na assinatura */ + /** + * Produtos de uma assinatura + */ + "GET /assinaturas/:assinaturaId/produtos": { + response: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }; + /** + * Insere um novo produto na assinatura + */ "POST /assinaturas/:assinaturaId/produtos": { - searchParams: { + body: { /** * Produto Variante que será incluído na assinatura */ @@ -1518,11 +1571,39 @@ export interface API { quantidade?: number; }; }; - /** @description Categoria encontrada */ - "GET /categorias/:id": {}; - /** @description Atualiza uma categoria */ - "PUT /categorias/:id": { + /** + * Categoria encontrada + */ + "GET /categorias/:id": { searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }; + }; + /** + * Atualiza uma categoria + */ + "PUT /categorias/:id": { + body: { /** * Nome da categoria (optional) */ @@ -1546,10 +1627,7 @@ export interface API { /** * Exibir Matriz de Atributos (optional) */ - exibirMatrizAtributos?: - | { "0": "S"; "1": "i"; "2": "m" } - | { "0": "N"; "1": "a"; "2": "o" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; /** * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ @@ -1564,14 +1642,33 @@ export interface API { exibeMenu?: boolean; }; }; - /** @description Exclui uma categoria */ + /** + * Exclui uma categoria + */ "DELETE /categorias/:id": {}; - /** @description Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado */ - "GET /produtos/:identificador/relacionados": {}; - /** @description Atualiza um valor pré definido pelo id */ + /** + * Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado + */ + "GET /produtos/:identificador/relacionados": { + searchParams: { + /** + * Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + response: { + produtoId?: number; + parentId?: number; + produtoVarianteId?: number; + sku?: string; + }[]; + }; + /** + * Atualiza um valor pré definido pelo id + */ "PUT /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": { - searchParams: { + body: { /** * Valor para o campo (optional) */ @@ -1582,14 +1679,85 @@ export interface API { ordem?: number; }; }; - /** @description Remove um valor pré definido */ + /** + * Remove um valor pré definido + */ "DELETE /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": {}; - /** @description Lista de banners */ - "GET /banners": {}; - /** @description Insere um novo banner */ - "POST /banners": { + /** + * Lista de banners + */ + "GET /banners": { searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadePorPagina?: number; + }; + response: { + id?: number; + nome?: string; + dataInicio?: string; + dataFim?: string; + ativo?: boolean; + detalhe?: { + posicionamentoId?: number; + urlBanner?: string; + imagemBanner?: { + nome?: string; + base64?: string; + formato?: string; + }; + ordemExibicao?: number; + abrirBannerNovaAba?: boolean; + largura?: number; + altura?: number; + title?: string; + urlClique?: string; + urlBannerAlternativo?: string; + titleAlternativo?: string; + diasExibicao?: { + todosDias?: boolean; + domingo?: boolean; + segunda?: boolean; + terca?: boolean; + quarta?: boolean; + quinta?: boolean; + sexta?: boolean; + sabado?: boolean; + }; + textoAlternativo?: string; + }; + apresentacao?: { + exibirNoSite?: boolean; + exibirEmTodasBuscas?: boolean; + naoExibirEmBuscas?: boolean; + termosBusca?: string; + listaHotsites?: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + exibirEmTodasCategorias?: boolean; + listaParceiros?: { + exibirEmTodosParceiros?: boolean; + parceiros?: { + parceiroId?: number; + }[]; + }; + }; + }[]; + }; + /** + * Insere um novo banner + */ + "POST /banners": { + body: { /** * Nome do banner */ @@ -1625,10 +1793,7 @@ export interface API { /** * formato da imagem */ - formato?: - | { "0": "P"; "1": "N"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; + formato?: "PNG" | "JPG" | "JPEG"; /** * nome da imagem */ @@ -1771,11 +1936,19 @@ export interface API { }; }; }; - /** @description Avatar do usuário encontrado */ - "GET /usuarios/:email/avatar": {}; - /** @description Insere um novo avatar para o usuário */ + /** + * Avatar do usuário encontrado + */ + "GET /usuarios/:email/avatar": { + response: { + urlAvatar?: string; + }; + }; + /** + * Insere um novo avatar para o usuário + */ "POST /usuarios/:email/avatar": { - searchParams: { + body: { /** * Imagem do avatar em base64 (optional) */ @@ -1785,14 +1958,32 @@ export interface API { */ formato?: string; }; + response: { + urlAvatar?: string; + }; }; - /** @description Deleta um avatar de um usuário */ + /** + * Deleta um avatar de um usuário + */ "DELETE /usuarios/:email/avatar": {}; - /** @description Fabricante encontrado */ - "GET /fabricantes/:fabricanteId": {}; - /** @description Atualiza um fabricante */ + /** + * Fabricante encontrado + */ + "GET /fabricantes/:fabricanteId": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; + }; + }; + /** + * Atualiza um fabricante + */ "PUT /fabricantes/:fabricanteId": { - searchParams: { + body: { /** * Nome do fabricante (optional) */ @@ -1811,26 +2002,71 @@ export interface API { urlCarrossel?: string; }; }; - /** @description Exclui um fabricante */ + /** + * Exclui um fabricante + */ "DELETE /fabricantes/:fabricanteId": {}; - /** @description Lista de posicionamentos do banner */ - "GET /banners/posicionamentos": {}; - /** @description Preços do produto variante informado */ - "GET /produtos/:identificador/precos": {}; - /** @description Atualiza a autonomia de um Seller */ - "PUT /resellers/:resellerId/autonomia": { + /** + * Lista de posicionamentos do banner + */ + "GET /banners/posicionamentos": { + response: { + posicionamentoId?: number; + descricao?: string; + }[]; + }; + /** + * Preços do produto variante informado + */ + "GET /produtos/:identificador/precos": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteId?: number; + sku?: string; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + precosTabelaPreco?: { + produtoVarianteId?: number; + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + }; + }; + /** + * Atualiza a autonomia de um Seller + */ + "PUT /resellers/:resellerId/autonomia": { + body: { /** * Status da autonomia do seller */ ativo?: boolean; }; }; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos/:eventoId/produtos": {}; - /** @description Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente */ + /** + * Lista de produtos variantes vinculados aos tipo de evento + */ + "GET /eventos/:eventoId/produtos": { + response: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + }; + /** + * Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente + */ "POST /eventos/:eventoId/produtos": { - searchParams: { + body: { /** * Identificadores dos produtos variantes a serem vinculados ao evento desejado */ @@ -1842,9 +2078,11 @@ export interface API { }[]; }; }; - /** @description Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request */ + /** + * Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request + */ "PUT /eventos/:eventoId/produtos": { - searchParams: { + body: { /** * Identificadores dos produtos variantes a serem vinculados ao evento desejado */ @@ -1856,18 +2094,22 @@ export interface API { }[]; }; }; - /** @description Atualiza o status do hotsite, sendo ativo (true) ou inativo (false) */ + /** + * Atualiza o status do hotsite, sendo ativo (true) ou inativo (false) + */ "PUT /hotsites/:hotsiteId/status": { - searchParams: { + body: { /** * Status para qual o hotsite indicado deve ir */ ativo?: boolean; }; }; - /** @description Autenticação realizada com sucesso */ + /** + * Autenticação realizada com sucesso + */ "POST /autenticacao/login": { - searchParams: { + body: { /** * Login do usuário (optional) */ @@ -1878,24 +2120,59 @@ export interface API { senha?: string; }; }; - /** @description Parceiro encontrado */ - "GET /parceiros/:nome": {}; - /** @description Seta status do produto variante como ativo ou inativo */ + /** + * Parceiro encontrado + */ + "GET /parceiros/:nome": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }; + }; + /** + * Seta status do produto variante como ativo ou inativo + */ "PUT /produtos/:identificador/situacao": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Define se o produto variante informado será ativo ou inativo */ status?: boolean; }; }; - /** @description Lista de Grupos de Personalização */ - "GET /grupospersonalizacao": {}; - /** @description Retorna o saldo de um usuário */ + /** + * Lista de Grupos de Personalização + */ + "GET /grupospersonalizacao": { + response: { + grupoPersonalizacaoId?: number; + nome?: string; + ativo?: boolean; + obrigatorio?: boolean; + }[]; + }; + /** + * Retorna o saldo de um usuário + */ "GET /contascorrentes/:email": {}; - /** @description Realiza um novo lançamento na conta corrente do cliente */ + /** + * Realiza um novo lançamento na conta corrente do cliente + */ "POST /contascorrentes/:email": { - searchParams: { + body: { /** * Valor da conta corrente (optional) */ @@ -1903,17 +2180,7 @@ export interface API { /** * Tipo de Lançamento (optional) */ - tipoLancamento?: - | { - "0": "C"; - "1": "r"; - "2": "e"; - "3": "d"; - "4": "i"; - "5": "t"; - "6": "o"; - } - | { "0": "D"; "1": "e"; "2": "b"; "3": "i"; "4": "t"; "5": "o" }; + tipoLancamento?: "Credito" | "Debito"; /** * Observação (optional) */ @@ -1924,74 +2191,785 @@ export interface API { visivelParaCliente?: boolean; }; }; - /** @description Lista de produtos */ - "GET /resellers/produtos/:identificador": {}; - /** @description Lista de pedidos */ - "GET /pedidos/formaPagamento/:formasPagamento": {}; - /** @description Lista de pedidos */ - "GET /pedidos": {}; - /** @description Caso a loja utilize as formas de pagamento do gateway o campo "formaPagamentoId" do objeto "pagamento" deverá conter o valor "200". */ - "POST /pedidos": { + /** + * Lista de produtos + */ + "GET /resellers/produtos/:identificador": { searchParams: { /** - * Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional) - */ - pedidoId?: number; - /** - * Id do carrinho que foi utilizado no pedido (optional) - */ - carrinhoId?: string; - /** - * Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido - */ - situacaoPedidoId?: number; - /** - * Data em que o pedido foi realizado - */ - data?: string; - /** - * Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional) - */ - valorTotal?: number; - /** - * Informação do juros do pedido - */ - valorJuros?: number; - /** - * Informação de desconto do pedido - */ - valorDesconto?: number; - /** - * Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios + * Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller */ - usuarioId?: number; + tipoIdentificador?: "ResellerId" | "RazaoSocial"; /** - * Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos + * Página da lista (padrão: 1) */ - enderecoId?: number; + pagina?: number; /** - * Define se o pedido foi feito através de um dispositivo móvel ou não + * Quantidade de registros que deverão retornar (max: 50) */ - isMobile?: boolean; + quantidadeRegistros?: number; /** - * Id do evento ao qual o pedido está vinculado (opcional) + * Se deve retornar apenas produtos válidos (padrão: false) */ - eventoId?: number; + somenteValidos?: boolean; /** - * Lista contendo os produtos do pedido + * Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo */ - produtos?: { - /** - * Id do produto variante que está vinculado a esse pedido. - */ - produtoVarianteId?: number; - /** - * Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição - */ - quantidade?: { - /** - * Quantidade por centro de distribuição - */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + }[]; + }; + /** + * Lista de pedidos + */ + "GET /pedidos/formaPagamento/:formasPagamento": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + situacoesPedido?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** + * Lista de pedidos + */ + "GET /pedidos": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + situacoesPedido?: string; + /** + * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + */ + formasPagamento?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado + */ + email?: string; + /** + * Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado) + */ + valido?: boolean; + /** + * Deverá retornar apenas pedidos que o produto de determinado sku foi comprado + */ + sku?: string; + /** + * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + */ + apenasAssinaturas?: boolean; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** + * Caso a loja utilize as formas de pagamento do gateway o campo "formaPagamentoId" do objeto "pagamento" deverá conter o valor "200". + */ + "POST /pedidos": { + body: { + /** + * Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional) + */ + pedidoId?: number; + /** + * Id do carrinho que foi utilizado no pedido (optional) + */ + carrinhoId?: string; + /** + * Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido + */ + situacaoPedidoId?: number; + /** + * Data em que o pedido foi realizado + */ + data?: string; + /** + * Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional) + */ + valorTotal?: number; + /** + * Informação do juros do pedido + */ + valorJuros?: number; + /** + * Informação de desconto do pedido + */ + valorDesconto?: number; + /** + * Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios + */ + usuarioId?: number; + /** + * Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos + */ + enderecoId?: number; + /** + * Define se o pedido foi feito através de um dispositivo móvel ou não + */ + isMobile?: boolean; + /** + * Id do evento ao qual o pedido está vinculado (opcional) + */ + eventoId?: number; + /** + * Lista contendo os produtos do pedido + */ + produtos?: { + /** + * Id do produto variante que está vinculado a esse pedido. + */ + produtoVarianteId?: number; + /** + * Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição + */ + quantidade?: { + /** + * Quantidade por centro de distribuição + */ quantidadeTotal?: number; /** * Quantidade (optional) @@ -2185,26 +3163,66 @@ export interface API { usuarioMaster?: number; }; }; - /** @description Lista de portfolios */ - "GET /portfolios": {}; - /** @description Insere um novo portfolio */ + /** + * Lista de portfolios + */ + "GET /portfolios": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }[]; + }; + /** + * Insere um novo portfolio + */ "POST /portfolios": { - searchParams: { + body: { /** * Nome do portfolio */ nome?: string; }; }; - /** @description Lista de imagens vinculadas a um produtos */ - "GET /produtos/:identificador/imagens": {}; - /** @description Adiciona uma nova imagem vinculada a um produto */ + /** + * Lista de imagens vinculadas a um produtos + */ + "GET /produtos/:identificador/imagens": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + produtosIrmaos?: boolean; + }; + response: { + idImagem?: number; + nomeArquivo?: string; + url?: string; + ordem?: number; + estampa?: boolean; + exibirMiniatura?: boolean; + }[]; + }; + /** + * Adiciona uma nova imagem vinculada a um produto + */ "POST /produtos/:identificador/imagens": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + */ + tipoRetorno?: "ListaIds" | "Booleano"; + }; + body: { /** * Lista com as imagens do produto no formato base 64 (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Imagem do produto em base64 */ @@ -2228,13 +3246,49 @@ export interface API { }[]; }; }; - /** @description Limite de crédito de um usuário específico */ - "GET /usuarios/limiteCreditoPorUsuarioId/:usuarioId": {}; - /** @description SEO do produto informado */ - "GET /produtos/:identificador/seo": {}; - /** @description Insere um SEO para um produto específico */ + /** + * Limite de crédito de um usuário específico + */ + "GET /usuarios/limiteCreditoPorUsuarioId/:usuarioId": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }; + }; + /** + * SEO do produto informado + */ + "GET /produtos/:identificador/seo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + response: { + tagCanonical?: string; + title?: string; + metatags?: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; + }; + }; + /** + * Insere um SEO para um produto específico + */ "POST /produtos/:identificador/seo": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { /** * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) */ @@ -2266,9 +3320,17 @@ export interface API { }[]; }; }; - /** @description Atualiza um SEO de um produto específico */ + /** + * Atualiza um SEO de um produto específico + */ "PUT /produtos/:identificador/seo": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { /** * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) */ @@ -2300,11 +3362,22 @@ export interface API { }[]; }; }; - /** @description Deleta o SEO de um produto específico */ - "DELETE /produtos/:identificador/seo": {}; - /** @description Adiciona um vínculo entre usuário e parceiro */ - "POST /usuarios/:email/parceiro": { + /** + * Deleta o SEO de um produto específico + */ + "DELETE /produtos/:identificador/seo": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + }; + /** + * Adiciona um vínculo entre usuário e parceiro + */ + "POST /usuarios/:email/parceiro": { + body: { /** * Id do parceiro (optional) */ @@ -2323,9 +3396,11 @@ export interface API { dataFinal?: string; }; }; - /** @description Atualiza um vínculo entre usuário e parceiro */ + /** + * Atualiza um vínculo entre usuário e parceiro + */ "PUT /usuarios/:email/parceiro": { - searchParams: { + body: { /** * Vinculo vitalício (optional) */ @@ -2340,20 +3415,41 @@ export interface API { dataFinal?: string; }; }; - /** @description Remove o vínculo entre usuário e parceiro */ + /** + * Remove o vínculo entre usuário e parceiro + */ "DELETE /usuarios/:email/parceiro": { - searchParams: { + body: { /** * Número identificador do parceiro (Max Length: 4) */ parceiroId?: number; }; }; - /** @description Retorna usuário encontrado */ - "GET /usuarios/:email/enderecos": {}; - /** @description Insere um endereço para um usuário pelo e-mail */ + /** + * Retorna usuário encontrado + */ + "GET /usuarios/:email/enderecos": { + response: { + enderecoId?: number; + nomeEndereco?: string; + rua?: string; + numero?: string; + complemento?: string; + referencia?: string; + bairro?: string; + cidade?: string; + estado?: string; + cep?: string; + utilizadoUltimoPedido?: boolean; + pais?: string; + }[]; + }; + /** + * Insere um endereço para um usuário pelo e-mail + */ "POST /usuarios/:email/enderecos": { - searchParams: { + body: { /** * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ @@ -2392,9 +3488,11 @@ export interface API { cep?: string; }; }; - /** @description Atualiza um script existente */ + /** + * Atualiza um script existente + */ "PUT /gestorscripts/scripts/:scriptId": { - searchParams: { + body: { /** * Nome do script */ @@ -2419,182 +3517,24 @@ export interface API { * Posição do script */ posicao?: - | { - "0": "H"; - "1": "e"; - "2": "a"; - "3": "d"; - "4": "e"; - "5": "r"; - "6": "P"; - "7": "r"; - "8": "i"; - "9": "m"; - "10": "e"; - "11": "i"; - "12": "r"; - "13": "a"; - "14": "L"; - "15": "i"; - "16": "n"; - "17": "h"; - "18": "a"; - } - | { - "0": "H"; - "1": "e"; - "2": "a"; - "3": "d"; - "4": "e"; - "5": "r"; - "6": "U"; - "7": "l"; - "8": "t"; - "9": "i"; - "10": "m"; - "11": "a"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - } - | { - "0": "B"; - "1": "o"; - "2": "d"; - "3": "y"; - "4": "P"; - "5": "r"; - "6": "i"; - "7": "m"; - "8": "e"; - "9": "i"; - "10": "r"; - "11": "a"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - } - | { - "0": "B"; - "1": "o"; - "2": "d"; - "3": "y"; - "4": "U"; - "5": "l"; - "6": "t"; - "7": "i"; - "8": "m"; - "9": "a"; - "10": "L"; - "11": "i"; - "12": "n"; - "13": "h"; - "14": "a"; - } - | { - "0": "F"; - "1": "o"; - "2": "o"; - "3": "t"; - "4": "e"; - "5": "r"; - "6": "P"; - "7": "r"; - "8": "i"; - "9": "m"; - "10": "e"; - "11": "i"; - "12": "r"; - "13": "a"; - "14": "L"; - "15": "i"; - "16": "n"; - "17": "h"; - "18": "a"; - } - | { - "0": "F"; - "1": "o"; - "2": "o"; - "3": "t"; - "4": "e"; - "5": "r"; - "6": "U"; - "7": "l"; - "8": "t"; - "9": "i"; - "10": "m"; - "11": "e"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - }; + | "HeaderPrimeiraLinha" + | "HeaderUltimaLinha" + | "BodyPrimeiraLinha" + | "BodyUltimaLinha" + | "FooterPrimeiraLinha" + | "FooterUltimeLinha"; /** * Tipo da página do script */ tipoPagina?: - | { "0": "T"; "1": "o"; "2": "d"; "3": "a"; "4": "s" } - | { "0": "H"; "1": "o"; "2": "m"; "3": "e" } - | { "0": "B"; "1": "u"; "2": "s"; "3": "c"; "4": "a" } - | { - "0": "C"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "g"; - "5": "o"; - "6": "r"; - "7": "i"; - "8": "a"; - } - | { - "0": "F"; - "1": "a"; - "2": "b"; - "3": "r"; - "4": "i"; - "5": "c"; - "6": "a"; - "7": "n"; - "8": "t"; - "9": "e"; - } - | { - "0": "E"; - "1": "s"; - "2": "t"; - "3": "a"; - "4": "t"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "s"; - } - | { - "0": "P"; - "1": "r"; - "2": "o"; - "3": "d"; - "4": "u"; - "5": "t"; - "6": "o"; - } - | { - "0": "C"; - "1": "a"; - "2": "r"; - "3": "r"; - "4": "i"; - "5": "n"; - "6": "h"; - "7": "o"; - }; + | "Todas" + | "Home" + | "Busca" + | "Categoria" + | "Fabricante" + | "Estaticas" + | "Produto" + | "Carrinho"; /** * Identificador da página */ @@ -2609,31 +3549,59 @@ export interface API { publicado?: boolean; }; }; - /** @description Exclui um Script */ + /** + * Exclui um Script + */ "DELETE /gestorscripts/scripts/:scriptId": {}; - /** @description Ativa ou desativa um endereço de um usuário com base no id do usuário */ + /** + * Ativa ou desativa um endereço de um usuário com base no id do usuário + */ "PUT /usuarios/:usuarioId/enderecos/:enderecoId/ativar": { - searchParams: { + body: { /** * Status do endereço */ status?: boolean; }; }; - /** @description Ativa ou desativa um Seller */ + /** + * Ativa ou desativa um Seller + */ "PUT /resellers/:resellerId/status": { - searchParams: { + body: { /** * Status do seller (ativo / inativo) */ ativo?: boolean; }; }; - /** @description Atacarejo */ - "GET /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": {}; - /** @description Atualiza um Atacarejo */ + /** + * Atacarejo + */ + "GET /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }; + }; + /** + * Atualiza um Atacarejo + */ "PUT /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Preço atacado (optional) */ @@ -2644,13 +3612,26 @@ export interface API { quantidade?: number; }; }; - /** @description Remove um Atacarejo */ - "DELETE /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": {}; - /** @description Buscar todos os autores */ + /** + * Remove um Atacarejo + */ + "DELETE /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** + * Buscar todos os autores + */ "GET /autores": {}; - /** @description Inserir autor */ + /** + * Inserir autor + */ "POST /autores": { - searchParams: { + body: { /** * Nome do Autor */ @@ -2661,13 +3642,132 @@ export interface API { ativo?: boolean; }; }; - /** @description Lista dos estados */ - "GET /lojasFisicas/estados": {}; - /** @description Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais. */ - "GET /produtos/:identificador": {}; - /** @description Atualiza um produto com base nos dados enviados */ + /** + * Lista dos estados + */ + "GET /lojasFisicas/estados": { + response: { + estadoId?: number; + nome?: string; + sigla?: string; + regiao?: string; + }[]; + }; + /** + * Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais. + */ + "GET /produtos/:identificador": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + /** + * Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + consumo?: { + quantidadeDias?: number; + enviarEmail?: boolean; + }; + prazoValidade?: number; + }; + }; + /** + * Atualiza um produto com base nos dados enviados + */ "PUT /produtos/:identificador": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Representa o ProdutoId agrupador por variante (optional) */ @@ -2691,10 +3791,7 @@ export interface API { /** * Tipo de exibição da matriz de atributos (optional) */ - exibirMatrizAtributos?: - | { "0": "S"; "1": "i"; "2": "m" } - | { "0": "N"; "1": "a"; "2": "o" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; /** * Se o produto aceita contra proposta (optional) */ @@ -2750,32 +3847,7 @@ export interface API { /** * Define a qual regra de calculo de frete o produto vai pertencer */ - freteGratis?: - | { "0": "S"; "1": "e"; "2": "m"; "3": "p"; "4": "r"; "5": "e" } - | { "0": "N"; "1": "u"; "2": "n"; "3": "c"; "4": "a" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" } - | { - "0": "D"; - "1": "e"; - "2": "s"; - "3": "c"; - "4": "o"; - "5": "n"; - "6": "s"; - "7": "i"; - "8": "d"; - "9": "e"; - "10": "r"; - "11": "a"; - "12": "r"; - "13": "_"; - "14": "R"; - "15": "e"; - "16": "g"; - "17": "r"; - "18": "a"; - "19": "s"; - }; + freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; /** * Define se o produto variante tem troca grátis (optional) */ @@ -2874,31 +3946,7 @@ export interface API { /** * Condição do produto variante (optional) */ - condicao?: - | { "0": "N"; "1": "o"; "2": "v"; "3": "o" } - | { "0": "U"; "1": "s"; "2": "a"; "3": "d"; "4": "o" } - | { - "0": "R"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "v"; - "5": "a"; - "6": "d"; - "7": "o"; - } - | { - "0": "D"; - "1": "a"; - "2": "n"; - "3": "i"; - "4": "f"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "d"; - "9": "o"; - }; + condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; /** * Url do vídeo do Produto (optional) */ @@ -2942,11 +3990,24 @@ export interface API { }; }; }; - /** @description Lista de versões */ - "GET /gestorscripts/scripts/:scriptId/versoes": {}; - /** @description Insere uma versão para um script existente */ + /** + * Lista de versões + */ + "GET /gestorscripts/scripts/:scriptId/versoes": { + response: { + versaoId?: number; + scriptId?: number; + dataCadastro?: string; + identificadorPagina?: string; + publicado?: boolean; + usuario?: string; + }[]; + }; + /** + * Insere uma versão para um script existente + */ "POST /gestorscripts/scripts/:scriptId/versoes": { - searchParams: { + body: { /** * Identificador da página */ @@ -2961,13 +4022,54 @@ export interface API { publicado?: boolean; }; }; - /** @description Reseller específico */ - "GET /resellers/token": {}; - /** @description Categoria encontrada */ - "GET /categorias/erp/:id": {}; - /** @description Atualiza uma categoria utilizando o id do erp como identificador */ - "PUT /categorias/erp/:id": { + /** + * Reseller específico + */ + "GET /resellers/token": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + }; + /** + * Categoria encontrada + */ + "GET /categorias/erp/:id": { searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }; + }; + /** + * Atualiza uma categoria utilizando o id do erp como identificador + */ + "PUT /categorias/erp/:id": { + body: { /** * Nome da categoria (optional) */ @@ -2991,10 +4093,7 @@ export interface API { /** * Exibir Matriz de Atributos (optional) */ - exibirMatrizAtributos?: - | { "0": "S"; "1": "i"; "2": "m" } - | { "0": "N"; "1": "a"; "2": "o" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; /** * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ @@ -3009,190 +4108,106 @@ export interface API { exibeMenu?: boolean; }; }; - /** @description Categoria excluída com sucesso */ - "DELETE /categorias/erp/:id": {}; - /** @description Templates */ - "GET /templates": {}; - /** @description Lista de usuários */ - "GET /usuarios": {}; - /** @description Insere um novo usuário */ + /** + * Categoria excluída com sucesso + */ + "DELETE /categorias/erp/:id": {}; + /** + * Templates + */ + "GET /templates": {}; + /** + * Lista de usuários + */ + "GET /usuarios": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro de data + */ + enumTipoFiltroData?: "DataAlteracao" | "DataCriacao"; + /** + * Status de aprovação + */ + aprovado?: boolean; + }; + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }[]; + }; + /** + * Insere um novo usuário + */ "POST /usuarios": { - searchParams: { + body: { /** * Tipo de pessoa */ - tipoPessoa?: - | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } - | { - "0": "J"; - "1": "u"; - "2": "r"; - "3": "i"; - "4": "d"; - "5": "i"; - "6": "c"; - "7": "a"; - }; + tipoPessoa?: "Fisica" | "Juridica"; /** * Origem do contato */ origemContato?: - | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } - | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } - | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } - | { - "0": "P"; - "1": "a"; - "2": "t"; - "3": "r"; - "4": "o"; - "5": "c"; - "6": "i"; - "7": "n"; - "8": "i"; - "9": "o"; - "10": "E"; - "11": "s"; - "12": "p"; - "13": "o"; - "14": "r"; - "15": "t"; - "16": "i"; - "17": "v"; - "18": "o"; - } - | { - "0": "R"; - "1": "e"; - "2": "c"; - "3": "o"; - "4": "m"; - "5": "e"; - "6": "n"; - "7": "d"; - "8": "a"; - "9": "c"; - "10": "a"; - "11": "o"; - "12": "A"; - "13": "l"; - "14": "g"; - "15": "u"; - "16": "e"; - "17": "m"; - } - | { - "0": "R"; - "1": "e"; - "2": "v"; - "3": "i"; - "4": "s"; - "5": "t"; - "6": "a"; - } - | { - "0": "S"; - "1": "i"; - "2": "t"; - "3": "e"; - "4": "I"; - "5": "n"; - "6": "t"; - "7": "e"; - "8": "r"; - "9": "n"; - "10": "e"; - "11": "t"; - } - | { - "0": "T"; - "1": "e"; - "2": "l"; - "3": "e"; - "4": "v"; - "5": "i"; - "6": "s"; - "7": "a"; - "8": "o"; - } - | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } - | { - "0": "U"; - "1": "s"; - "2": "u"; - "3": "a"; - "4": "r"; - "5": "i"; - "6": "o"; - "7": "I"; - "8": "m"; - "9": "p"; - "10": "o"; - "11": "r"; - "12": "t"; - "13": "a"; - "14": "d"; - "15": "o"; - "16": "V"; - "17": "i"; - "18": "a"; - "19": "A"; - "20": "d"; - "21": "m"; - "22": "i"; - "23": "n"; - } - | { - "0": "P"; - "1": "a"; - "2": "y"; - "3": "P"; - "4": "a"; - "5": "l"; - "6": "E"; - "7": "x"; - "8": "p"; - "9": "r"; - "10": "e"; - "11": "s"; - "12": "s"; - }; + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; /** * Tipo Sexo (optional) */ - tipoSexo?: - | { - "0": "U"; - "1": "n"; - "2": "d"; - "3": "e"; - "4": "f"; - "5": "i"; - "6": "n"; - "7": "e"; - "8": "d"; - } - | { - "0": "M"; - "1": "a"; - "2": "s"; - "3": "c"; - "4": "u"; - "5": "l"; - "6": "i"; - "7": "n"; - "8": "o"; - } - | { - "0": "F"; - "1": "e"; - "2": "m"; - "3": "i"; - "4": "n"; - "5": "i"; - "6": "n"; - "7": "o"; - }; + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; /** * Nome do usuário (Max Length: 100) */ @@ -3280,17 +4295,94 @@ export interface API { aprovado?: boolean; }; }; - /** @description Dados da loja */ - "GET /loja": {}; - /** @description Indicadores de Faturamento */ - "GET /dashboard/faturamento": {}; - /** @description Grupo de assinatura */ - "GET /assinaturas/grupoassinatura": {}; - /** @description Lista de pedidos */ - "GET /pedidos/:pedidoId/rastreamento": {}; - /** @description Insere um rastreamento e status a um pedido */ - "POST /pedidos/:pedidoId/rastreamento": { + /** + * Dados da loja + */ + "GET /loja": { + response: { + nome?: string; + urlSite?: string; + urlCarrinho?: string; + }; + }; + /** + * Indicadores de Faturamento + */ + "GET /dashboard/faturamento": { searchParams: { + /** + * Data inicial dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataInicialComparativo?: string; + /** + * Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataFinalComparativo?: string; + }; + response: { + indicadorReceita?: number; + indicadorPedido?: number; + indicadorTicketMedio?: number; + indicadorReceitaComparativo?: number; + indicadorPedidoComparativo?: number; + indicadorTicketMedioComparativo?: number; + indicadorReceitaFormatado?: string; + indicadorPedidoFormatado?: string; + indicadorTicketMedioFormatado?: string; + indicadorReceitaComparativoFormatado?: string; + indicadorPedidoComparativoFormatado?: string; + indicadorTicketMedioComparativoFormatado?: string; + indicadorReceitaPorcentagem?: string; + indicadorPedidoPorcentagem?: string; + indicadorTicketMedioPorcentagem?: string; + }; + }; + /** + * Grupo de assinatura + */ + "GET /assinaturas/grupoassinatura": { + response: { + grupoAssinaturaId?: number; + nome?: string; + recorrencias?: { + recorrenciaId?: number; + nome?: string; + dias?: number; + }[]; + }[]; + }; + /** + * Lista de pedidos + */ + "GET /pedidos/:pedidoId/rastreamento": { + response: { + pedidoRastreamentoId?: number; + dataAtualizacao?: string; + notaFiscal?: string; + serieNF?: string; + cfop?: number; + dataEnviado?: string; + urlNFE?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + transportadora?: string; + dataEntrega?: string; + }; + }; + /** + * Insere um rastreamento e status a um pedido + */ + "POST /pedidos/:pedidoId/rastreamento": { + body: { /** * Id da situação do pedido */ @@ -3333,13 +4425,15 @@ export interface API { urlRastreamento?: string; }; }; - /** @description Atualiza a data de entrega do pedido */ + /** + * Atualiza a data de entrega do pedido + */ "PUT /pedidos/:pedidoId/rastreamento": { - searchParams: { + body: { /** * Objeto com os dados do rastreamento */ - RAW_BODY?: { + RAW_BODY: { /** * Código de verificação do transporte do produto */ @@ -3351,13 +4445,39 @@ export interface API { }; }; }; - /** @description Rastreamento de produto encontrado */ + /** + * Rastreamento de produto encontrado + */ "GET /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": - {}; - /** @description Atualiza rastreamento de produto completo (com os dados da N.F.) */ + { + response: { + pedidoRastreamentoProdutoId?: number; + pedidoId?: number; + produtoVarianteId?: number; + pedidoProdutoId?: number; + dataInclusao?: string; + dataAlteracao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + quantidade?: number; + urlNFE?: string; + serieNFE?: string; + tipoPostagem?: string; + centroDistribuicao?: string; + transportadora?: string; + dataEntrega?: string; + }; + }; + /** + * Atualiza rastreamento de produto completo (com os dados da N.F.) + */ "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": { - searchParams: { + body: { /** * Nota Fiscal */ @@ -3392,11 +4512,29 @@ export interface API { dataEntrega?: string; }; }; - /** @description Lista de detalhes de frete */ - "GET /fretes/:freteId/detalhes": {}; - /** @description Insere um novo detalhe de frete vinculado a um contrato de frete */ + /** + * Lista de detalhes de frete + */ + "GET /fretes/:freteId/detalhes": { + response: { + freteId?: number; + cepInicial?: number; + cepFinal?: number; + variacoesFreteDetalhe?: { + pesoInicial?: number; + pesoFinal?: number; + valorFrete?: number; + prazoEntrega?: number; + valorPreco?: number; + valorPeso?: number; + }[]; + }[]; + }; + /** + * Insere um novo detalhe de frete vinculado a um contrato de frete + */ "POST /fretes/:freteId/detalhes": { - searchParams: { + body: { /** * Informe o cep inicial (optional) */ @@ -3436,19 +4574,288 @@ export interface API { }[]; }; }; - /** @description Exclui os detalhes de um contrato de frete */ + /** + * Exclui os detalhes de um contrato de frete + */ "DELETE /fretes/:freteId/detalhes": {}; - /** @description Pedido encontrado */ - "GET /pedidos/:pedidoId": {}; - /** @description Lista de identificadores de conteúdos vinculados ao hotsite */ - "GET /hotsites/:hotsiteId/conteudos": {}; - /** @description Vincula um ou mais conteúdos a um hotsite específico */ + /** + * Pedido encontrado + */ + "GET /pedidos/:pedidoId": { + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }; + }; + /** + * Lista de identificadores de conteúdos vinculados ao hotsite + */ + "GET /hotsites/:hotsiteId/conteudos": { + response: { + conteudoId?: number; + }[]; + }; + /** + * Vincula um ou mais conteúdos a um hotsite específico + */ "POST /hotsites/:hotsiteId/conteudos": { - searchParams: { + body: { /** * Lista de identificadores de conteúdos a serem vinculados */ - RAW_BODY?: { + RAW_BODY: { /** * Identificador do conteúdo */ @@ -3456,9 +4863,11 @@ export interface API { }[]; }; }; - /** @description Desvincula um ou mais conteúdos de um hotsite específico */ + /** + * Desvincula um ou mais conteúdos de um hotsite específico + */ "DELETE /hotsites/:hotsiteId/conteudos": { - searchParams: { + body: { /** * Lista de identificadores de conteúdos a serem desvinculados */ @@ -3470,9 +4879,11 @@ export interface API { }[]; }; }; - /** @description Atualiza um campo de cadastro personalizado pelo id */ + /** + * Atualiza um campo de cadastro personalizado pelo id + */ "PUT /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": { - searchParams: { + body: { /** * Nome do campo (optional) */ @@ -3487,16 +4898,33 @@ export interface API { ordem?: number; }; }; - /** @description Remove um campo de cadastro personalizado */ + /** + * Remove um campo de cadastro personalizado + */ "DELETE /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": {}; - /** @description Dados do serviço de frete do pedido */ + /** + * Dados do serviço de frete do pedido + */ "GET /pedidos/:pedidoId/frete": {}; - /** @description Tabela de preços específica */ - "GET /tabelaPrecos/:tabelaPrecoId": {}; - /** @description Atualiza uma tabela de preços */ + /** + * Tabela de preços específica + */ + "GET /tabelaPrecos/:tabelaPrecoId": { + response: { + tabelaPrecoId?: number; + nome?: string; + dataInicial?: string; + dataFinal?: string; + ativo?: boolean; + isSite?: boolean; + }; + }; + /** + * Atualiza uma tabela de preços + */ "PUT /tabelaPrecos/:tabelaPrecoId": { - searchParams: { + body: { /** * Nome da tabela de preço */ @@ -3515,17 +4943,41 @@ export interface API { ativo?: boolean; }; }; - /** @description Exclui uma tabela de preços */ + /** + * Exclui uma tabela de preços + */ "DELETE /tabelaPrecos/:tabelaPrecoId": {}; - /** @description Último status do pedido */ - "GET /pedidos/:pedidoId/status": {}; - /** @description Atualiza a situação do status do pedido */ + /** + * Último status do pedido + */ + "GET /pedidos/:pedidoId/status": { + response: { + situacaoPedidoId?: number; + dataAtualizacao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + nomeTransportadora?: string; + produtos?: { + produtoVarianteId?: number; + situacaoProdutoId?: number; + quantidade?: number; + centroDistribuicaoId?: number; + }[]; + }; + }; + /** + * Atualiza a situação do status do pedido + */ "PUT /pedidos/:pedidoId/status": { - searchParams: { + body: { /** * Id da situação do pedido */ - RAW_BODY?: { + RAW_BODY: { /** * Id da situação do pedido */ @@ -3533,15 +4985,25 @@ export interface API { }; }; }; - /** @description Lista de Tópicos */ - "GET /webhook/Topicos": {}; - /** @description Seta o pedido como integrado */ + /** + * Lista de Tópicos + */ + "GET /webhook/Topicos": { + response: { + nome?: string; + descricao?: string; + payload?: string; + }[]; + }; + /** + * Seta o pedido como integrado + */ "POST /pedidos/complete": { - searchParams: { + body: { /** * Pedido que se deseja inserir o "complete" */ - RAW_BODY?: { + RAW_BODY: { /** * Id do pedido */ @@ -3549,54 +5011,155 @@ export interface API { }; }; }; - /** @description Portfolio encontrado */ - "GET /portfolios/:portfolioId": {}; - /** @description Atualiza um portfolio */ + /** + * Portfolio encontrado + */ + "GET /portfolios/:portfolioId": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }; + }; + /** + * Atualiza um portfolio + */ "PUT /portfolios/:portfolioId": { + body: { + /** + * Nome do portfolio + */ + nome?: string; + }; + }; + /** + * Deleta um portfolio + */ + "DELETE /portfolios/:portfolioId": {}; + /** + * Retorna se o produto variante está disponível ou não + */ + "GET /produtos/:identificador/disponibilidade": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** + * Lista de formas de pagamento + */ + "GET /formasPagamento": { + response: { + formaPagamentoId?: number; + nome?: string; + nomeExibicao?: string; + descricao?: string; + }[]; + }; + /** + * Lista de pedidos + */ + "GET /pedidos/:pedidoId/rastreamento/produtos": { + response: { + produtoVarianteId?: number; + rastreamentos?: { + pedidoRastreamentoProdutoId?: number; + quantidade?: number; + dataAtualizacao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + transportadora?: string; + centroDistribuicaoId?: number; + dataEntrega?: string; + }[]; + }[]; + }; + /** + * Altera o status de um portfolio + */ + "PUT /portfolios/:portfolioId/status": { + body: { + /** + * Status do portfolio: true ou false + */ + RAW_BODY?: { + /** + * Novo status do portfolio + */ + ativo?: boolean; + }; + }; + }; + /** + * Limite de crédito que estão vinculados aos usuários + */ + "GET /usuarios/limiteCredito": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }[]; + }; + /** + * Exclui uma imagem de um produto + */ + "DELETE /produtos/:identificador/imagens/:id": { searchParams: { /** - * Nome do portfolio + * Define se o identificador informado é um sku ou um id interno. */ - nome?: string; + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; }; }; - /** @description Deleta um portfolio */ - "DELETE /portfolios/:portfolioId": {}; - /** @description Retorna se o produto variante está disponível ou não */ - "GET /produtos/:identificador/disponibilidade": {}; - /** @description Lista de formas de pagamento */ - "GET /formasPagamento": {}; - /** @description Lista de pedidos */ - "GET /pedidos/:pedidoId/rastreamento/produtos": {}; - /** @description Altera o status de um portfolio */ - "PUT /portfolios/:portfolioId/status": { + /** + * Extrato retornado com sucesso + */ + "GET /contascorrentes/:email/extrato": { searchParams: { /** - * Status do portfolio: true ou false + * Data Inicial para verificar extrato */ - RAW_BODY?: { - /** - * Novo status do portfolio - */ - ativo?: boolean; - }; + dataInicial?: string; + /** + * Data Final para verificar extrato + */ + dataFinal?: string; }; + response: { + data?: string; + historico?: string; + valor?: number; + tipoLancamento?: string; + observacao?: string; + visivelParaCliente?: boolean; + }[]; + }; + /** + * Lista de observações de um pedido + */ + "GET /pedidos/:pedidoId/observacao": { + response: { + observacao?: string; + usuario?: string; + publica?: boolean; + data?: string; + }[]; }; - /** @description Limite de crédito que estão vinculados aos usuários */ - "GET /usuarios/limiteCredito": {}; - /** @description Exclui uma imagem de um produto */ - "DELETE /produtos/:identificador/imagens/:id": {}; - /** @description Extrato retornado com sucesso */ - "GET /contascorrentes/:email/extrato": {}; - /** @description Lista de observações de um pedido */ - "GET /pedidos/:pedidoId/observacao": {}; - /** @description Insere uma observação a um pedido */ + /** + * Insere uma observação a um pedido + */ "POST /pedidos/:pedidoId/observacao": { - searchParams: { + body: { /** * Objeto com os dados da observação (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Texto da observação */ @@ -3612,15 +5175,57 @@ export interface API { }; }; }; - /** @description Lista de centros de distribuição */ - "GET /centrosdistribuicao": {}; - /** @description Lista de avaliações de produtos */ - "GET /produtoavaliacao": {}; - /** @description Conteúdo encontrado */ + /** + * Lista de centros de distribuição + */ + "GET /centrosdistribuicao": { + response: { + id?: number; + nome?: string; + cep?: number; + padrao?: boolean; + }[]; + }; + /** + * Lista de avaliações de produtos + */ + "GET /produtoavaliacao": { + searchParams: { + /** + * Referente ao status que libera a visualização da avaliação no site + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + produtoVarianteId?: number; + sku?: string; + produtoAvaliacaoId?: number; + comentario?: string; + avaliacao?: number; + usuarioId?: number; + dataAvaliacao?: string; + nome?: string; + email?: string; + status?: string; + }[]; + }; + /** + * Conteúdo encontrado + */ "GET /conteudos/:conteudoId": {}; - /** @description Atualiza um conteúdo */ + /** + * Atualiza um conteúdo + */ "PUT /conteudos/:conteudoId": { - searchParams: { + body: { /** * Titulo do conteúdo */ @@ -3641,68 +5246,13 @@ export interface API { * Posicionamento do conteúdo */ posicionamento?: - | { "0": "T"; "1": "o"; "2": "p"; "3": "o" } - | { "0": "C"; "1": "e"; "2": "n"; "3": "t"; "4": "r"; "5": "o" } - | { "0": "R"; "1": "o"; "2": "d"; "3": "a"; "4": "p"; "5": "e" } - | { - "0": "L"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "r"; - "5": "a"; - "6": "l"; - "7": "D"; - "8": "i"; - "9": "r"; - "10": "e"; - "11": "i"; - "12": "t"; - "13": "a"; - } - | { - "0": "L"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "r"; - "5": "a"; - "6": "l"; - "7": "E"; - "8": "s"; - "9": "q"; - "10": "u"; - "11": "e"; - "12": "r"; - "13": "d"; - "14": "a"; - } - | { - "0": "M"; - "1": "o"; - "2": "b"; - "3": "i"; - "4": "l"; - "5": "e"; - "6": "T"; - "7": "o"; - "8": "p"; - "9": "o"; - } - | { - "0": "M"; - "1": "o"; - "2": "b"; - "3": "i"; - "4": "l"; - "5": "e"; - "6": "R"; - "7": "o"; - "8": "d"; - "9": "a"; - "10": "p"; - "11": "e"; - }; + | "Topo" + | "Centro" + | "Rodape" + | "LateralDireita" + | "LateralEsquerda" + | "MobileTopo" + | "MobileRodape"; /** * Informações do conteúdo */ @@ -3729,13 +5279,24 @@ export interface API { hotsiteId?: number[]; }; }; - /** @description Atualiza o status do tipo de evento, ativando-o ou inativando-o */ + /** + * Atualiza o status do tipo de evento, ativando-o ou inativando-o + */ "PUT /tiposEvento/:tipoEventoId/AlterarStatus": {}; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /tiposEvento/:tipoEventoId/produtos": {}; - /** @description Lista de resposta para cada produto vinculado */ + /** + * Lista de produtos variantes vinculados aos tipo de evento + */ + "GET /tiposEvento/:tipoEventoId/produtos": { + response: { + tipoEventoId?: number; + produtoVariantePrincipalId?: number; + }[]; + }; + /** + * Lista de resposta para cada produto vinculado + */ "POST /tiposEvento/:tipoEventoId/produtos": { - searchParams: { + body: { /** * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado */ @@ -3746,10 +5307,24 @@ export interface API { produtoVarianteId?: number; }[]; }; + response: { + sugestaoProdutosInseridos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + detalhes?: string; + }[]; + produtosNaoInseridos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + detalhes?: string; + }[]; + }; }; - /** @description Atualiza os produtos sugeridos de um tipo de evento */ + /** + * Atualiza os produtos sugeridos de um tipo de evento + */ "PUT /tiposEvento/:tipoEventoId/produtos": { - searchParams: { + body: { /** * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado */ @@ -3761,30 +5336,170 @@ export interface API { }[]; }; }; - /** @description Atualiza a ativação automática de produtos de um Seller */ + /** + * Atualiza a ativação automática de produtos de um Seller + */ "PUT /resellers/:resellerId/ativacaoAutomaticaProdutos": { - searchParams: { + body: { /** * Status da ativação automática de produtos */ ativo?: boolean; }; }; - /** @description Gráfico Forma de Pagamento */ - "GET /dashboard/graficoformapagamento": {}; - /** @description Lista de números de pedidos ainda não integrados */ - "GET /pedidos/naoIntegrados": {}; - /** @description Dados da lista de desejos de um usuário */ - "GET /usuarios/:usuarioId/listaDesejos": {}; - /** @description Usuários encontrados */ - "GET /parceiros/:nome/usuarios": {}; - /** @description Indicador dos Novos Compradores */ - "GET /dashboard/novoscompradores": {}; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos": {}; - /** @description Cria um Novo Evento */ - "POST /eventos": { + /** + * Gráfico Forma de Pagamento + */ + "GET /dashboard/graficoformapagamento": { + searchParams: { + /** + * Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + nome?: string; + quantidade?: number; + cor?: string; + }[]; + }; + /** + * Lista de números de pedidos ainda não integrados + */ + "GET /pedidos/naoIntegrados": { + response: { + pedidoId?: number; + }[]; + }; + /** + * Dados da lista de desejos de um usuário + */ + "GET /usuarios/:usuarioId/listaDesejos": { + response: { + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + dataAdicao?: string; + }[]; + }; + /** + * Usuários encontrados + */ + "GET /parceiros/:nome/usuarios": { + response: { + usuarioId?: number; + email?: string; + ativo?: boolean; + dataInicial?: string; + dataFinal?: string; + vinculoVitalicio?: boolean; + }[]; + }; + /** + * Indicador dos Novos Compradores + */ + "GET /dashboard/novoscompradores": { + searchParams: { + /** + * Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos novos compradores que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorComprador?: string; + }; + }; + /** + * Lista de produtos variantes vinculados aos tipo de evento + */ + "GET /eventos": { searchParams: { + /** + * Data de inicio do evento + */ + dataInicial?: string; + /** + * Data do termino do evento + */ + dataFinal?: string; + /** + * Status do evento + */ + disponivel?: boolean; + /** + * Titulo do evento + */ + titulo?: string; + /** + * Email do Usuário + */ + usuarioEmail?: string; + /** + * Identificador do Tipo de Evento + */ + tipoEventoId?: number; + }; + response: { + eventoId?: number; + tipoEventoId?: number; + userId?: number; + enderecoEntregaId?: number; + data?: string; + dataCriacao?: string; + titulo?: string; + url?: string; + disponivel?: boolean; + diasDepoisEvento?: number; + diasAntesEvento?: number; + urlLogoEvento?: string; + urlCapaEvento?: string; + proprietarioEvento?: string; + abaInfo01Habilitado?: boolean; + textoInfo01?: string; + conteudoInfo01?: string; + abaInfo02Habilitado?: boolean; + textoInfo02?: string; + conteudoInfo02?: string; + abaMensagemHabilitado?: boolean; + fotos?: string; + enumTipoListaPresenteId?: string; + enumTipoEntregaId?: string; + eventoProdutoSelecionado?: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + enderecoEvento?: { + enderecoEventoId?: number; + eventoId?: number; + nome?: string; + cep?: string; + endereco?: string; + numero?: string; + bairro?: string; + cidade?: string; + estado?: string; + }[]; + }[]; + }; + /** + * Cria um Novo Evento + */ + "POST /eventos": { + body: { /** * Identificador do tipo de evento */ @@ -3864,88 +5579,15 @@ export interface API { /** * Tipo de lista de presente */ - enumTipoListaPresenteId?: - | { - "0": "L"; - "1": "i"; - "2": "s"; - "3": "t"; - "4": "a"; - "5": "P"; - "6": "r"; - "7": "o"; - "8": "n"; - "9": "t"; - "10": "a"; - } - | { - "0": "L"; - "1": "i"; - "2": "s"; - "3": "t"; - "4": "a"; - "5": "M"; - "6": "a"; - "7": "n"; - "8": "u"; - "9": "a"; - "10": "l"; - }; + enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; /** * Tipo de entrega */ enumTipoEntregaId?: - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "A"; - "8": "g"; - "9": "e"; - "10": "n"; - "11": "d"; - "12": "a"; - "13": "d"; - "14": "a"; - } - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "C"; - "8": "o"; - "9": "n"; - "10": "f"; - "11": "o"; - "12": "r"; - "13": "m"; - "14": "e"; - "15": "C"; - "16": "o"; - "17": "m"; - "18": "p"; - "19": "r"; - "20": "a"; - "21": "R"; - "22": "e"; - "23": "a"; - "24": "l"; - "25": "i"; - "26": "z"; - "27": "a"; - "28": "d"; - "29": "a"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } - | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; /** * Seleção de produto no evento */ @@ -3998,11 +5640,38 @@ export interface API { }[]; }; }; - /** @description Retorna todas as informações de um produto específico */ - "GET /produtos/:identificador/informacoes": {}; - /** @description Adiciona uma nova informação */ + /** + * Retorna todas as informações de um produto específico + */ + "GET /produtos/:identificador/informacoes": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + }; + response: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + }; + /** + * Adiciona uma nova informação + */ "POST /produtos/:identificador/informacoes": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + */ + tipoRetorno?: "Id" | "Booleano"; + }; + body: { /** * Titulo da informação (optional) */ @@ -4019,214 +5688,73 @@ export interface API { * Tipo de informação do produto (optional) */ tipoInformacao?: - | { - "0": "I"; - "1": "n"; - "2": "f"; - "3": "o"; - "4": "r"; - "5": "m"; - "6": "a"; - "7": "c"; - "8": "o"; - "9": "e"; - "10": "s"; - } - | { - "0": "B"; - "1": "e"; - "2": "n"; - "3": "e"; - "4": "f"; - "5": "i"; - "6": "c"; - "7": "i"; - "8": "o"; - "9": "s"; - } - | { - "0": "E"; - "1": "s"; - "2": "p"; - "3": "e"; - "4": "c"; - "5": "i"; - "6": "f"; - "7": "i"; - "8": "c"; - "9": "a"; - "10": "c"; - "11": "o"; - "12": "e"; - "13": "s"; - } - | { - "0": "D"; - "1": "a"; - "2": "d"; - "3": "o"; - "4": "s"; - "5": "T"; - "6": "e"; - "7": "c"; - "8": "n"; - "9": "i"; - "10": "c"; - "11": "o"; - "12": "s"; - } - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "p"; - "4": "o"; - "5": "s"; - "6": "i"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "M"; - "1": "o"; - "2": "d"; - "3": "o"; - "4": "D"; - "5": "e"; - "6": "U"; - "7": "s"; - "8": "a"; - "9": "r"; - } - | { - "0": "C"; - "1": "u"; - "2": "i"; - "3": "d"; - "4": "a"; - "5": "d"; - "6": "o"; - "7": "s"; - } - | { - "0": "I"; - "1": "t"; - "2": "e"; - "3": "n"; - "4": "s"; - "5": "I"; - "6": "n"; - "7": "c"; - "8": "l"; - "9": "u"; - "10": "s"; - "11": "o"; - "12": "s"; - } - | { "0": "D"; "1": "i"; "2": "c"; "3": "a"; "4": "s" } - | { "0": "V"; "1": "i"; "2": "d"; "3": "e"; "4": "o" } - | { - "0": "D"; - "1": "e"; - "2": "s"; - "3": "c"; - "4": "r"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "o"; - } - | { - "0": "V"; - "1": "a"; - "2": "l"; - "3": "o"; - "4": "r"; - "5": "R"; - "6": "e"; - "7": "f"; - "8": "e"; - "9": "r"; - "10": "e"; - "11": "n"; - "12": "t"; - "13": "e"; - } - | { - "0": "P"; - "1": "o"; - "2": "p"; - "3": "U"; - "4": "p"; - "5": "R"; - "6": "e"; - "7": "f"; - "8": "e"; - "9": "r"; - "10": "e"; - "11": "n"; - "12": "t"; - "13": "e"; - } - | { - "0": "P"; - "1": "r"; - "2": "e"; - "3": "s"; - "4": "c"; - "5": "r"; - "6": "i"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "T"; - "1": "a"; - "2": "b"; - "3": "e"; - "4": "l"; - "5": "a"; - "6": "D"; - "7": "e"; - "8": "M"; - "9": "e"; - "10": "d"; - "11": "i"; - "12": "d"; - "13": "a"; - "14": "s"; - } - | { "0": "S"; "1": "p"; "2": "o"; "3": "t" } - | { - "0": "S"; - "1": "i"; - "2": "n"; - "3": "o"; - "4": "p"; - "5": "s"; - "6": "e"; - } - | { - "0": "C"; - "1": "a"; - "2": "r"; - "3": "r"; - "4": "i"; - "5": "n"; - "6": "h"; - "7": "o"; - }; + | "Informacoes" + | "Beneficios" + | "Especificacoes" + | "DadosTecnicos" + | "Composicao" + | "ModoDeUsar" + | "Cuidados" + | "ItensInclusos" + | "Dicas" + | "Video" + | "Descricao" + | "ValorReferente" + | "PopUpReferente" + | "Prescricao" + | "TabelaDeMedidas" + | "Spot" + | "Sinopse" + | "Carrinho"; + }; + }; + /** + * Indicador do Carrinho Abandonado + */ + "GET /dashboard/carrinhoabandonado": { + searchParams: { + /** + * Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorCarrinhoAbandonado?: string; + }; + }; + /** + * Lista de Metatags do produto informado + */ + "GET /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; }; + response: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; }; - /** @description Indicador do Carrinho Abandonado */ - "GET /dashboard/carrinhoabandonado": {}; - /** @description Lista de Metatags do produto informado */ - "GET /produtos/:identificador/seo/metaTag": {}; - /** @description Insere um ou mais metatags para um produto */ + /** + * Insere um ou mais metatags para um produto + */ "POST /produtos/:identificador/seo/metaTag": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { /** * Lista de metatags (optional) */ @@ -4249,10 +5777,25 @@ export interface API { scheme?: string; }[]; }; - }; - /** @description Deleta um ou mais Metatags de produto */ + response: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; + }; + /** + * Deleta um ou mais Metatags de produto + */ "DELETE /produtos/:identificador/seo/metaTag": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { /** * Lista de identificadores de metatags (optional) */ @@ -4264,11 +5807,34 @@ export interface API { }[]; }; }; - /** @description Frete encontrado */ - "GET /fretes/:freteId": {}; - /** @description Frete atualizado com sucesso */ + /** + * Frete encontrado + */ + "GET /fretes/:freteId": { + response: { + freteId?: number; + nome?: string; + ativo?: boolean; + volumeMaximo?: number; + pesoCubado?: number; + entregaAgendadaConfiguracaoId?: number; + linkRastreamento?: string; + ehAssinatura?: boolean; + larguraMaxima?: number; + alturaMaxima?: number; + comprimentoMaximo?: number; + limiteMaximoDimensoes?: number; + limitePesoCubado?: number; + tempoMinimoDespacho?: number; + centroDistribuicaoId?: number; + valorMinimoProdutos?: number; + }; + }; + /** + * Frete atualizado com sucesso + */ "PUT /fretes/:freteId": { - searchParams: { + body: { /** * Nome do contrato de frete (optional) */ @@ -4331,17 +5897,67 @@ export interface API { valorMinimoProdutos?: number; }; }; - /** @description Relatório de transações de um determinado período */ - "GET /dashboard/transacoes": {}; - /** @description Lista de produtos de uma tabela de preços */ - "GET /tabelaPrecos/:tabelaPrecoId/produtos": {}; - /** @description Inseri uma lista de produto variantes em uma tabela de preços */ - "POST /tabelaPrecos/:tabelaPrecoId/produtos": { + /** + * Relatório de transações de um determinado período + */ + "GET /dashboard/transacoes": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** + * Lista de produtos de uma tabela de preços + */ + "GET /tabelaPrecos/:tabelaPrecoId/produtos": { searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + tabelaPrecoProdutoVarianteId?: number; + tabelaPrecoId?: number; + sku?: string; + produtoVarianteId?: number; + precoDe?: number; + precoPor?: number; + }[]; + }; + /** + * Inseri uma lista de produto variantes em uma tabela de preços + */ + "POST /tabelaPrecos/:tabelaPrecoId/produtos": { + body: { /** * Lista de produtos variantes */ - RAW_BODY?: { + RAW_BODY: { /** * SKU do produto */ @@ -4356,14 +5972,28 @@ export interface API { precoPor?: number; }[]; }; + response: { + sucesso?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + erro?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; }; - /** @description Lista com o retorno do processamento dos produtos enviados */ + /** + * Lista com o retorno do processamento dos produtos enviados + */ "PUT /tabelaPrecos/:tabelaPrecoId/produtos": { - searchParams: { + body: { /** * Lista de produtos variantes */ - RAW_BODY?: { + RAW_BODY: { /** * SKU do produto */ @@ -4378,12 +6008,39 @@ export interface API { precoPor?: number; }[]; }; + response: { + sucesso?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + erro?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** + * Lista de scripts + */ + "GET /gestorscripts/scripts": { + response: { + scriptId?: number; + nome?: string; + posicao?: string; + tipoPagina?: string; + dataInicial?: string; + datafinal?: string; + ativo?: boolean; + prioridade?: number; + }[]; }; - /** @description Lista de scripts */ - "GET /gestorscripts/scripts": {}; - /** @description Insere um novo script */ + /** + * Insere um novo script + */ "POST /gestorscripts/scripts": { - searchParams: { + body: { /** * Nome do script */ @@ -4408,201 +6065,76 @@ export interface API { * Posição do script */ posicao?: - | { - "0": "H"; - "1": "e"; - "2": "a"; - "3": "d"; - "4": "e"; - "5": "r"; - "6": "P"; - "7": "r"; - "8": "i"; - "9": "m"; - "10": "e"; - "11": "i"; - "12": "r"; - "13": "a"; - "14": "L"; - "15": "i"; - "16": "n"; - "17": "h"; - "18": "a"; - } - | { - "0": "H"; - "1": "e"; - "2": "a"; - "3": "d"; - "4": "e"; - "5": "r"; - "6": "U"; - "7": "l"; - "8": "t"; - "9": "i"; - "10": "m"; - "11": "a"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - } - | { - "0": "B"; - "1": "o"; - "2": "d"; - "3": "y"; - "4": "P"; - "5": "r"; - "6": "i"; - "7": "m"; - "8": "e"; - "9": "i"; - "10": "r"; - "11": "a"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - } - | { - "0": "B"; - "1": "o"; - "2": "d"; - "3": "y"; - "4": "U"; - "5": "l"; - "6": "t"; - "7": "i"; - "8": "m"; - "9": "a"; - "10": "L"; - "11": "i"; - "12": "n"; - "13": "h"; - "14": "a"; - } - | { - "0": "F"; - "1": "o"; - "2": "o"; - "3": "t"; - "4": "e"; - "5": "r"; - "6": "P"; - "7": "r"; - "8": "i"; - "9": "m"; - "10": "e"; - "11": "i"; - "12": "r"; - "13": "a"; - "14": "L"; - "15": "i"; - "16": "n"; - "17": "h"; - "18": "a"; - } - | { - "0": "F"; - "1": "o"; - "2": "o"; - "3": "t"; - "4": "e"; - "5": "r"; - "6": "U"; - "7": "l"; - "8": "t"; - "9": "i"; - "10": "m"; - "11": "e"; - "12": "L"; - "13": "i"; - "14": "n"; - "15": "h"; - "16": "a"; - }; + | "HeaderPrimeiraLinha" + | "HeaderUltimaLinha" + | "BodyPrimeiraLinha" + | "BodyUltimaLinha" + | "FooterPrimeiraLinha" + | "FooterUltimeLinha"; /** * Tipo da página do script */ tipoPagina?: - | { "0": "T"; "1": "o"; "2": "d"; "3": "a"; "4": "s" } - | { "0": "H"; "1": "o"; "2": "m"; "3": "e" } - | { "0": "B"; "1": "u"; "2": "s"; "3": "c"; "4": "a" } - | { - "0": "C"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "g"; - "5": "o"; - "6": "r"; - "7": "i"; - "8": "a"; - } - | { - "0": "F"; - "1": "a"; - "2": "b"; - "3": "r"; - "4": "i"; - "5": "c"; - "6": "a"; - "7": "n"; - "8": "t"; - "9": "e"; - } - | { - "0": "E"; - "1": "s"; - "2": "t"; - "3": "a"; - "4": "t"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "s"; - } - | { - "0": "P"; - "1": "r"; - "2": "o"; - "3": "d"; - "4": "u"; - "5": "t"; - "6": "o"; - } - | { - "0": "C"; - "1": "a"; - "2": "r"; - "3": "r"; - "4": "i"; - "5": "n"; - "6": "h"; - "7": "o"; - }; + | "Todas" + | "Home" + | "Busca" + | "Categoria" + | "Fabricante" + | "Estaticas" + | "Produto" + | "Carrinho"; /** * Identificador da página */ identificadorPagina?: string; /** - * Conteúdo do script + * Conteúdo do script + */ + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; + }; + }; + /** + * Assinaturas com erro na loja + */ + "GET /assinaturas/erros": { + searchParams: { + /** + * Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) */ - conteudo?: string; + dataFinal?: string; /** - * Status do script + * Erros já resolvidos ou não */ - publicado?: boolean; + resolvidos?: boolean; }; }; - /** @description Assinaturas com erro na loja */ - "GET /assinaturas/erros": {}; - /** @description Método que realiza uma cotação de frete */ + /** + * Método que realiza uma cotação de frete + */ "POST /fretes/cotacoes": { searchParams: { + /** + * Cep de entrega + */ + cep?: string; + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define se deve retornar as opções de retirada em loja ("False" por padrão) (optional) + */ + retiradaLoja?: boolean; + }; + body: { /** * Valor total do pedido (optional) */ @@ -4621,12 +6153,35 @@ export interface API { quantidade?: number; }[]; }; + response: { + id?: string; + nome?: string; + prazo?: number; + tabelaFreteId?: string; + tipo?: string; + valor?: number; + produtos?: { + produtoVarianteId?: number; + valor?: number; + }[]; + }[]; + }; + /** + * Lista de Ranges de Ceps de uma Loja Física + */ + "GET /lojasFisicas/:lojaFisicaId/rangeCep": { + response: { + rangeCepId?: number; + nome?: string; + cepInicial?: string; + cepFinal?: string; + }[]; }; - /** @description Lista de Ranges de Ceps de uma Loja Física */ - "GET /lojasFisicas/:lojaFisicaId/rangeCep": {}; - /** @description Insere um range de cep em uma Loja Física */ + /** + * Insere um range de cep em uma Loja Física + */ "POST /lojasFisicas/:lojaFisicaId/rangeCep": { - searchParams: { + body: { /** * Nome do range de cep */ @@ -4641,13 +6196,15 @@ export interface API { cepFinal?: string; }; }; - /** @description Remove uma lista de range de cep de uma Loja Física */ + /** + * Remove uma lista de range de cep de uma Loja Física + */ "DELETE /lojasFisicas/:lojaFisicaId/rangeCep": { - searchParams: { + body: { /** * Lista de range de cep a serem excluídos da loja física */ - RAW_BODY?: { + RAW_BODY: { /** * Id da faixa de cep a ser deletado */ @@ -4655,11 +6212,30 @@ export interface API { }[]; }; }; - /** @description Retorna usuário encontrado */ - "GET /usuarios/:usuarioId/enderecos": {}; - /** @description Insere um endereço para um usuário pelo id do usuário */ + /** + * Retorna usuário encontrado + */ + "GET /usuarios/:usuarioId/enderecos": { + response: { + enderecoId?: number; + nomeEndereco?: string; + rua?: string; + numero?: string; + complemento?: string; + referencia?: string; + bairro?: string; + cidade?: string; + estado?: string; + cep?: string; + utilizadoUltimoPedido?: boolean; + pais?: string; + }[]; + }; + /** + * Insere um endereço para um usuário pelo id do usuário + */ "POST /usuarios/:usuarioId/enderecos": { - searchParams: { + body: { /** * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ @@ -4698,15 +6274,25 @@ export interface API { cep?: string; }; }; - /** @description Retorna uma lista de vínculos entre usuário e parceiro */ + /** + * Retorna uma lista de vínculos entre usuário e parceiro + */ "GET /usuarios/:email/parceiros": {}; - /** @description Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + /** + * Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição + */ "PUT /produtos/precos": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Lista com os dados da atualização do preço (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Identificador do produto (ProdutoVarianteId ou SKU) */ @@ -4729,18 +6315,133 @@ export interface API { fatorMultiplicadorPreco?: number; }[]; }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** + * Usuário encontrado + */ + "GET /usuarios/email/:email": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** + * Novo token gerado com sucesso + */ + "POST /autenticacao/trocarLoja/:novaLoja": { + response: { + lojas?: string[]; + accessToken?: string; + dataExpiracaoAccessTokenUTC?: string; + }; + }; + /** + * Campos de cadastro personalizado encontrados + */ + "GET /usuarios/camposcadastropersonalizado": { + response: { + grupoInformacaoCadastralId?: number; + nome?: string; + tipo?: string; + obrigatorio?: boolean; + ordem?: number; + valorPreDefinido?: { + valoresDefinidosCampoGrupoInformacaoId?: number; + valor?: string; + ordem?: number; + }[]; + }[]; + }; + /** + * Objeto do hotsite + */ + "GET /hotsites/:hotsiteId": { + response: { + hotsiteId?: number; + nome?: string; + ativo?: boolean; + template?: string; + dataCriacao?: string; + dataInicio?: string; + dataFinal?: string; + url?: string; + tamanhoPagina?: number; + templateId?: number; + ordenacao?: string; + listaProdutos?: { + expressao?: string; + produtos?: { + produtoId?: number; + ordem?: number; + }[]; + }; + seo?: { + seoHotsiteId?: number; + hotsiteId?: number; + titulo?: string; + metas?: { + conteudo?: string; + nome?: string; + httpEquiv?: string; + scheme?: string; + }[]; + }; + banners?: { + bannerId?: number; + }[]; + conteudos?: { + conteudoId?: number; + }[]; + }; }; - /** @description Usuário encontrado */ - "GET /usuarios/email/:email": {}; - /** @description Novo token gerado com sucesso */ - "POST /autenticacao/trocarLoja/:novaLoja": {}; - /** @description Campos de cadastro personalizado encontrados */ - "GET /usuarios/camposcadastropersonalizado": {}; - /** @description Objeto do hotsite */ - "GET /hotsites/:hotsiteId": {}; - /** @description Atualiza os dados de um hotsite existente */ + /** + * Atualiza os dados de um hotsite existente + */ "PUT /hotsites/:hotsiteId": { - searchParams: { + body: { /** * Nome do hotsite */ @@ -4769,154 +6470,17 @@ export interface API { * Informe qual será a ordenação dos Produtos no Hotsite (optional) */ ordenacao?: - | { - "0": "N"; - "1": "e"; - "2": "n"; - "3": "h"; - "4": "u"; - "5": "m"; - "6": "a"; - } - | { - "0": "N"; - "1": "o"; - "2": "m"; - "3": "e"; - "4": "C"; - "5": "r"; - "6": "e"; - "7": "s"; - "8": "c"; - "9": "e"; - "10": "n"; - "11": "t"; - "12": "e"; - } - | { - "0": "N"; - "1": "o"; - "2": "m"; - "3": "e"; - "4": "D"; - "5": "e"; - "6": "c"; - "7": "r"; - "8": "e"; - "9": "s"; - "10": "c"; - "11": "e"; - "12": "n"; - "13": "t"; - "14": "e"; - } - | { - "0": "L"; - "1": "a"; - "2": "n"; - "3": "c"; - "4": "a"; - "5": "m"; - "6": "e"; - "7": "n"; - "8": "t"; - "9": "o"; - } - | { - "0": "M"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "r"; - "5": "P"; - "6": "r"; - "7": "e"; - "8": "c"; - "9": "o"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "P"; - "6": "r"; - "7": "e"; - "8": "c"; - "9": "o"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "s"; - "4": "V"; - "5": "e"; - "6": "n"; - "7": "d"; - "8": "i"; - "9": "d"; - "10": "o"; - "11": "s"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "e"; - "6": "s"; - "7": "D"; - "8": "e"; - "9": "s"; - "10": "c"; - "11": "o"; - "12": "n"; - "13": "t"; - "14": "o"; - "15": "s"; - } - | { - "0": "A"; - "1": "l"; - "2": "e"; - "3": "a"; - "4": "t"; - "5": "o"; - "6": "r"; - "7": "i"; - "8": "o"; - } - | { - "0": "M"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "r"; - "5": "E"; - "6": "s"; - "7": "t"; - "8": "o"; - "9": "q"; - "10": "u"; - "11": "e"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "E"; - "6": "s"; - "7": "t"; - "8": "o"; - "9": "q"; - "10": "u"; - "11": "e"; - }; + | "Nenhuma" + | "NomeCrescente" + | "NomeDecrescente" + | "Lancamento" + | "MenorPreco" + | "MaiorPreco" + | "MaisVendidos" + | "MaioresDescontos" + | "Aleatorio" + | "MenorEstoque" + | "MaiorEstoque"; /** * Produtos que devem aparecer no hotsite */ @@ -4993,15 +6557,102 @@ export interface API { ativo?: boolean; }; }; - /** @description Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados */ + /** + * Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados + */ "DELETE /hotsites/:hotsiteId": {}; - /** @description Lista com assinaturas */ - "GET /assinaturas": {}; - /** @description Lista de categorias */ - "GET /categorias": {}; - /** @description Insere uma nova categoria */ - "POST /categorias": { + /** + * Lista com assinaturas + */ + "GET /assinaturas": { + searchParams: { + /** + * Situação da assinatura + */ + situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; + /** + * Período de recorrência + */ + periodoRecorrencia?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Data inicial da próxima recorrência + */ + dataInicialProximaRecorrencia?: string; + /** + * Data final da próxima recorrencia + */ + dataFinalProximaRecorrencia?: string; + /** + * Data inicial de cancelamento + */ + dataInicialCancelamento?: string; + /** + * Data final de cancelamento + */ + dataFinalCancelamento?: string; + }; + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + }[]; + }; + /** + * Lista de categorias + */ + "GET /categorias": { searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado apenas Reseller + */ + apenasReseller?: boolean; + /** + * Se será apresentado apenas o último nível das categorias + */ + apenasUltimoNivel?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }[]; + }; + /** + * Insere uma nova categoria + */ + "POST /categorias": { + body: { /** * Nome da categoria (optional) */ @@ -5025,10 +6676,7 @@ export interface API { /** * Exibir Matriz de Atributos (optional) */ - exibirMatrizAtributos?: - | { "0": "S"; "1": "i"; "2": "m" } - | { "0": "N"; "1": "a"; "2": "o" } - | { "0": "N"; "1": "e"; "2": "u"; "3": "t"; "4": "r"; "5": "o" }; + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; /** * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) */ @@ -5043,11 +6691,24 @@ export interface API { exibeMenu?: boolean; }; }; - /** @description Lista de fabricantes */ - "GET /fabricantes": {}; - /** @description Insere um novo fabricante */ + /** + * Lista de fabricantes + */ + "GET /fabricantes": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; + }[]; + }; + /** + * Insere um novo fabricante + */ "POST /fabricantes": { - searchParams: { + body: { /** * Nome do fabricante (optional) */ @@ -5066,9 +6727,11 @@ export interface API { urlCarrossel?: string; }; }; - /** @description Atualiza o campo Recebido de um produto vinculado a um evento */ + /** + * Atualiza o campo Recebido de um produto vinculado a um evento + */ "PUT /eventos/:eventoId/produtos/recebido": { - searchParams: { + body: { /** * Id do produto variante (optional) */ @@ -5079,11 +6742,37 @@ export interface API { recebidoForaLista?: boolean; }; }; - /** @description Tipo evento buscado */ - "GET /tiposEvento/:tipoEventoId": {}; - /** @description Atualiza o tipo evento */ + /** + * Tipo evento buscado + */ + "GET /tiposEvento/:tipoEventoId": { + response: { + tipoEventoId?: number; + nome?: string; + tipoEntrega?: string; + tipoDisponibilizacao?: string; + permitirRemocaoAutomaticaProdutos?: boolean; + corHexTituloInformacoes?: string; + corHexCorpoInformacoes?: string; + numeroAbasInformacoes?: number; + quantidadeDiasParaEventoExpirar?: number; + numeroLocaisEvento?: number; + ativo?: boolean; + disponivel?: boolean; + tipoBeneficiarioFrete?: string; + caminhoLogoEvento?: string; + caminhoSubTemplate?: string; + sugestaoProdutos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + }[]; + }; + }; + /** + * Atualiza o tipo evento + */ "PUT /tiposEvento/:tipoEventoId": { - searchParams: { + body: { /** * Nome do Tipo de Evento */ @@ -5092,118 +6781,17 @@ export interface API { * Tipo de entrega */ tipoEntrega?: - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "A"; - "8": "g"; - "9": "e"; - "10": "n"; - "11": "d"; - "12": "a"; - "13": "d"; - "14": "a"; - } - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "C"; - "8": "o"; - "9": "n"; - "10": "f"; - "11": "o"; - "12": "r"; - "13": "m"; - "14": "e"; - "15": "C"; - "16": "o"; - "17": "m"; - "18": "p"; - "19": "r"; - "20": "a"; - "21": "R"; - "22": "e"; - "23": "a"; - "24": "l"; - "25": "i"; - "26": "z"; - "27": "a"; - "28": "d"; - "29": "a"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } - | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; /** * Disponibilização do Tipo de Evento */ tipoDisponibilizacao?: - | { - "0": "D"; - "1": "i"; - "2": "s"; - "3": "p"; - "4": "o"; - "5": "n"; - "6": "i"; - "7": "b"; - "8": "i"; - "9": "l"; - "10": "i"; - "11": "z"; - "12": "a"; - "13": "c"; - "14": "a"; - "15": "o"; - "16": "D"; - "17": "e"; - "18": "C"; - "19": "r"; - "20": "e"; - "21": "d"; - "22": "i"; - "23": "t"; - "24": "o"; - "25": "s"; - } - | { - "0": "D"; - "1": "i"; - "2": "s"; - "3": "p"; - "4": "o"; - "5": "n"; - "6": "i"; - "7": "b"; - "8": "i"; - "9": "l"; - "10": "i"; - "11": "z"; - "12": "a"; - "13": "c"; - "14": "a"; - "15": "o"; - "16": "D"; - "17": "e"; - "18": "P"; - "19": "r"; - "20": "o"; - "21": "d"; - "22": "u"; - "23": "t"; - "24": "o"; - "25": "s"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" }; + | "DisponibilizacaoDeCreditos" + | "DisponibilizacaoDeProdutos" + | "Todos"; /** * Permissão para remoção automática de produtos */ @@ -5239,31 +6827,7 @@ export interface API { /** * O beneficiário do frete */ - tipoBeneficiarioFrete?: - | { - "0": "D"; - "1": "o"; - "2": "n"; - "3": "o"; - "4": "d"; - "5": "a"; - "6": "L"; - "7": "i"; - "8": "s"; - "9": "t"; - "10": "a"; - } - | { - "0": "C"; - "1": "o"; - "2": "n"; - "3": "v"; - "4": "i"; - "5": "d"; - "6": "a"; - "7": "d"; - "8": "o"; - }; + tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; /** * Imagem da logo do evento em base64 */ @@ -5283,13 +6847,85 @@ export interface API { }[]; }; }; - /** @description Produtos de uma assinatura */ - "GET /assinaturas/:email": {}; - /** @description Lista de produtos variantes vinculados aos tipo de evento */ - "GET /eventos/:eventoId": {}; - /** @description Atualiza um evento */ + /** + * Produtos de uma assinatura + */ + "GET /assinaturas/:email": { + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + produtos?: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }[]; + }; + /** + * Lista de produtos variantes vinculados aos tipo de evento + */ + "GET /eventos/:eventoId": { + response: { + eventoId?: number; + tipoEventoId?: number; + userId?: number; + enderecoEntregaId?: number; + data?: string; + dataCriacao?: string; + titulo?: string; + url?: string; + disponivel?: boolean; + diasDepoisEvento?: number; + diasAntesEvento?: number; + urlLogoEvento?: string; + urlCapaEvento?: string; + proprietarioEvento?: string; + abaInfo01Habilitado?: boolean; + textoInfo01?: string; + conteudoInfo01?: string; + abaInfo02Habilitado?: boolean; + textoInfo02?: string; + conteudoInfo02?: string; + abaMensagemHabilitado?: boolean; + fotos?: string; + enumTipoListaPresenteId?: string; + enumTipoEntregaId?: string; + eventoProdutoSelecionado?: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + enderecoEvento?: { + enderecoEventoId?: number; + eventoId?: number; + nome?: string; + cep?: string; + endereco?: string; + numero?: string; + bairro?: string; + cidade?: string; + estado?: string; + }[]; + }[]; + }; + /** + * Atualiza um evento + */ "PUT /eventos/:eventoId": { - searchParams: { + body: { /** * Identificador do tipo de evento */ @@ -5369,88 +7005,15 @@ export interface API { /** * Tipo de lista de presente */ - enumTipoListaPresenteId?: - | { - "0": "L"; - "1": "i"; - "2": "s"; - "3": "t"; - "4": "a"; - "5": "P"; - "6": "r"; - "7": "o"; - "8": "n"; - "9": "t"; - "10": "a"; - } - | { - "0": "L"; - "1": "i"; - "2": "s"; - "3": "t"; - "4": "a"; - "5": "M"; - "6": "a"; - "7": "n"; - "8": "u"; - "9": "a"; - "10": "l"; - }; + enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; /** * Tipo de entrega */ enumTipoEntregaId?: - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "A"; - "8": "g"; - "9": "e"; - "10": "n"; - "11": "d"; - "12": "a"; - "13": "d"; - "14": "a"; - } - | { - "0": "E"; - "1": "n"; - "2": "t"; - "3": "r"; - "4": "e"; - "5": "g"; - "6": "a"; - "7": "C"; - "8": "o"; - "9": "n"; - "10": "f"; - "11": "o"; - "12": "r"; - "13": "m"; - "14": "e"; - "15": "C"; - "16": "o"; - "17": "m"; - "18": "p"; - "19": "r"; - "20": "a"; - "21": "R"; - "22": "e"; - "23": "a"; - "24": "l"; - "25": "i"; - "26": "z"; - "27": "a"; - "28": "d"; - "29": "a"; - } - | { "0": "T"; "1": "o"; "2": "d"; "3": "o"; "4": "s" } - | { "0": "N"; "1": "e"; "2": "n"; "3": "h"; "4": "u"; "5": "m" }; + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; /** * Seleção de produto no evento */ @@ -5503,11 +7066,19 @@ export interface API { }[]; }; }; - /** @description Lista de identificadores de banners vinculados ao hotsite */ - "GET /hotsites/:hotsiteId/banners": {}; - /** @description Vincula um ou mais banners a um hotsite específico */ + /** + * Lista de identificadores de banners vinculados ao hotsite + */ + "GET /hotsites/:hotsiteId/banners": { + response: { + bannerId?: number; + }[]; + }; + /** + * Vincula um ou mais banners a um hotsite específico + */ "POST /hotsites/:hotsiteId/banners": { - searchParams: { + body: { /** * Lista de identificadores de banners para vincular ao hotsite */ @@ -5519,9 +7090,11 @@ export interface API { }[]; }; }; - /** @description Desvincula um ou mais banners de um hotsite específico */ + /** + * Desvincula um ou mais banners de um hotsite específico + */ "DELETE /hotsites/:hotsiteId/banners": { - searchParams: { + body: { /** * Lista de identificadores de banners a serem desvinculados */ @@ -5533,18 +7106,22 @@ export interface API { }[]; }; }; - /** @description Estorna um valor menor ou igual ao total do pedido "Pago" */ + /** + * Estorna um valor menor ou igual ao total do pedido "Pago" + */ "POST /pedidos/estorno/:pedidoId": { - searchParams: { + body: { /** * Valor a ser estornado do pedido. Total ou parcial. */ Valor?: number; }; }; - /** @description Pedidos que terão vínculo com o grupo de assinatura informado. */ + /** + * Pedidos que terão vínculo com o grupo de assinatura informado. + */ "POST /assinaturas/grupoassinatura/assinatura": { - searchParams: { + body: { /** * Lista de pedidos a serem vinculados a assinatura */ @@ -5555,22 +7132,73 @@ export interface API { pedidoId?: number; }[]; /** - * ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura + * ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura + */ + recorrenciaId?: number; + /** + * ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura + */ + grupoAssinaturaId?: number; + }; + }; + /** + * Lista de situações de pedido + */ + "GET /situacoesPedido": { + response: { + situacaoPedidoId?: number; + nome?: string; + descricao?: string; + observacao?: string; + }[]; + }; + /** + * Lista de Lojas Físicas + */ + "GET /lojasFisicas": { + searchParams: { + /** + * Página da lista (padrão: 1) */ - recorrenciaId?: number; + pagina?: number; /** - * ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura + * Quantidade de registros que deverão retornar (max: 50) */ - grupoAssinaturaId?: number; + quantidadeRegistros?: number; }; + response: { + lojaId?: number; + nome?: string; + ddd?: number; + telefone?: string; + email?: string; + cep?: string; + logradouro?: string; + numero?: string; + complemento?: string; + bairro?: string; + cidade?: string; + estadoId?: number; + prazoEntrega?: number; + prazoMaximoRetirada?: number; + ativo?: boolean; + valido?: boolean; + textoComplementar?: string; + retirarNaLoja?: boolean; + latitude?: number; + longitude?: number; + centroDistribuicaoId?: number; + centroDistribuicao?: { + centroDistribuicaoId?: number; + prazoEntrega?: number; + }[]; + }[]; }; - /** @description Lista de situações de pedido */ - "GET /situacoesPedido": {}; - /** @description Lista de Lojas Físicas */ - "GET /lojasFisicas": {}; - /** @description Insere uma Loja Física */ + /** + * Insere uma Loja Física + */ "POST /lojasFisicas": { - searchParams: { + body: { /** * Id da loja (optional) */ @@ -5666,184 +7294,34 @@ export interface API { }[]; }; }; - /** @description Atualiza um usuário pelo email */ + /** + * Atualiza um usuário pelo email + */ "PUT /usuarios/:email": { - searchParams: { + body: { /** * Tipo de pessoa */ - tipoPessoa?: - | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } - | { - "0": "J"; - "1": "u"; - "2": "r"; - "3": "i"; - "4": "d"; - "5": "i"; - "6": "c"; - "7": "a"; - }; + tipoPessoa?: "Fisica" | "Juridica"; /** * Origem do contato */ origemContato?: - | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } - | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } - | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } - | { - "0": "P"; - "1": "a"; - "2": "t"; - "3": "r"; - "4": "o"; - "5": "c"; - "6": "i"; - "7": "n"; - "8": "i"; - "9": "o"; - "10": "E"; - "11": "s"; - "12": "p"; - "13": "o"; - "14": "r"; - "15": "t"; - "16": "i"; - "17": "v"; - "18": "o"; - } - | { - "0": "R"; - "1": "e"; - "2": "c"; - "3": "o"; - "4": "m"; - "5": "e"; - "6": "n"; - "7": "d"; - "8": "a"; - "9": "c"; - "10": "a"; - "11": "o"; - "12": "A"; - "13": "l"; - "14": "g"; - "15": "u"; - "16": "e"; - "17": "m"; - } - | { - "0": "R"; - "1": "e"; - "2": "v"; - "3": "i"; - "4": "s"; - "5": "t"; - "6": "a"; - } - | { - "0": "S"; - "1": "i"; - "2": "t"; - "3": "e"; - "4": "I"; - "5": "n"; - "6": "t"; - "7": "e"; - "8": "r"; - "9": "n"; - "10": "e"; - "11": "t"; - } - | { - "0": "T"; - "1": "e"; - "2": "l"; - "3": "e"; - "4": "v"; - "5": "i"; - "6": "s"; - "7": "a"; - "8": "o"; - } - | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } - | { - "0": "U"; - "1": "s"; - "2": "u"; - "3": "a"; - "4": "r"; - "5": "i"; - "6": "o"; - "7": "I"; - "8": "m"; - "9": "p"; - "10": "o"; - "11": "r"; - "12": "t"; - "13": "a"; - "14": "d"; - "15": "o"; - "16": "V"; - "17": "i"; - "18": "a"; - "19": "A"; - "20": "d"; - "21": "m"; - "22": "i"; - "23": "n"; - } - | { - "0": "P"; - "1": "a"; - "2": "y"; - "3": "P"; - "4": "a"; - "5": "l"; - "6": "E"; - "7": "x"; - "8": "p"; - "9": "r"; - "10": "e"; - "11": "s"; - "12": "s"; - }; + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; /** * Tipo Sexo (optional) */ - tipoSexo?: - | { - "0": "U"; - "1": "n"; - "2": "d"; - "3": "e"; - "4": "f"; - "5": "i"; - "6": "n"; - "7": "e"; - "8": "d"; - } - | { - "0": "M"; - "1": "a"; - "2": "s"; - "3": "c"; - "4": "u"; - "5": "l"; - "6": "i"; - "7": "n"; - "8": "o"; - } - | { - "0": "F"; - "1": "e"; - "2": "m"; - "3": "i"; - "4": "n"; - "5": "i"; - "6": "n"; - "7": "o"; - }; + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; /** * Nome do usuário (Max Length: 100) */ @@ -5931,9 +7409,11 @@ export interface API { aprovado?: boolean; }; }; - /** @description Insere um novo campo de cadastro personalizado */ + /** + * Insere um novo campo de cadastro personalizado + */ "POST /usuarios/CadastroPersonalizado": { - searchParams: { + body: { /** * Nome do campo */ @@ -5941,53 +7421,7 @@ export interface API { /** * Tipo do campo */ - tipo?: - | { - "0": "T"; - "1": "e"; - "2": "x"; - "3": "t"; - "4": "o"; - "5": "L"; - "6": "i"; - "7": "v"; - "8": "r"; - "9": "e"; - } - | { - "0": "V"; - "1": "a"; - "2": "l"; - "3": "o"; - "4": "r"; - "5": "e"; - "6": "s"; - "7": "P"; - "8": "r"; - "9": "e"; - "10": "d"; - "11": "e"; - "12": "f"; - "13": "i"; - "14": "n"; - "15": "i"; - "16": "d"; - "17": "o"; - "18": "s"; - } - | { - "0": "R"; - "1": "a"; - "2": "d"; - "3": "i"; - "4": "o"; - "5": "B"; - "6": "u"; - "7": "t"; - "8": "t"; - "9": "o"; - "10": "n"; - }; + tipo?: "TextoLivre" | "ValoresPredefinidos" | "RadioButton"; /** * Se o campo será obrigatório */ @@ -6011,13 +7445,41 @@ export interface API { }[]; }; }; - /** @description Seta identificador como variante principal */ - "PUT /produtos/:identificador/principal": {}; - /** @description Lista de inscrições */ - "GET /webhook/inscricao": {}; - /** @description Insere uma inscrição */ - "POST /webhook/inscricao": { + /** + * Seta identificador como variante principal + */ + "PUT /produtos/:identificador/principal": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** + * Lista de inscrições + */ + "GET /webhook/inscricao": { + response: { + inscricaoId?: number; + nome?: string; + appUrl?: string; + ativo?: boolean; + emailResponsavel?: string; + topico?: string[]; + usuario?: string; + header?: { + headerId?: number; + chave?: string; + valor?: string; + }[]; + }[]; + }; + /** + * Insere uma inscrição + */ + "POST /webhook/inscricao": { + body: { /** * Nome da inscrição */ @@ -6029,7 +7491,7 @@ export interface API { /** * Tópicos em que deseja se inscrever */ - topicos?: string[]; + topicos: string[]; /** * Usuário que está realizando a inscrição */ @@ -6057,15 +7519,25 @@ export interface API { }[]; }; }; - /** @description Lista de produtos de um Grupo de Personalização */ - "GET /grupospersonalizacao/:grupoPersonalizacaoId/produtos": {}; - /** @description Vincula produtos a um Grupo de Personalização */ + /** + * Lista de produtos de um Grupo de Personalização + */ + "GET /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { + response: { + produtoId?: number; + nome?: string; + alias?: string; + }[]; + }; + /** + * Vincula produtos a um Grupo de Personalização + */ "POST /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { - searchParams: { + body: { /** * Lista de Id dos produtos */ - RAW_BODY?: { + RAW_BODY: { /** * Id do produto */ @@ -6073,13 +7545,15 @@ export interface API { }[]; }; }; - /** @description Remove o vinculo de produtos de um Grupo de Personalização */ + /** + * Remove o vinculo de produtos de um Grupo de Personalização + */ "DELETE /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { - searchParams: { + body: { /** * Lista de Id dos produtos */ - RAW_BODY?: { + RAW_BODY: { /** * Id do produto */ @@ -6087,11 +7561,48 @@ export interface API { }[]; }; }; - /** @description Gráfico do Faturamento */ - "GET /dashboard/graficofaturamento": {}; - /** @description Atualiza uma informação de um produto específico */ + /** + * Gráfico do Faturamento + */ + "GET /dashboard/graficofaturamento": { + searchParams: { + /** + * Data inicial do faturamento que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final do faturamento que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Se o faturamento é somente da loja + */ + isLoja?: number; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + parceiroId?: number; + parceiro?: string; + receitaPagos?: number; + transacoesPagos?: number; + valorMedioPagos?: number; + usuarioEnderecoEstado?: string; + }[]; + }; + /** + * Atualiza uma informação de um produto específico + */ "PUT /produtos/:identificador/informacoes/:informacaoId": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Titulo da informação (optional) */ @@ -6108,218 +7619,69 @@ export interface API { * Tipo de informação do produto (optional) */ tipoInformacao?: - | { - "0": "I"; - "1": "n"; - "2": "f"; - "3": "o"; - "4": "r"; - "5": "m"; - "6": "a"; - "7": "c"; - "8": "o"; - "9": "e"; - "10": "s"; - } - | { - "0": "B"; - "1": "e"; - "2": "n"; - "3": "e"; - "4": "f"; - "5": "i"; - "6": "c"; - "7": "i"; - "8": "o"; - "9": "s"; - } - | { - "0": "E"; - "1": "s"; - "2": "p"; - "3": "e"; - "4": "c"; - "5": "i"; - "6": "f"; - "7": "i"; - "8": "c"; - "9": "a"; - "10": "c"; - "11": "o"; - "12": "e"; - "13": "s"; - } - | { - "0": "D"; - "1": "a"; - "2": "d"; - "3": "o"; - "4": "s"; - "5": "T"; - "6": "e"; - "7": "c"; - "8": "n"; - "9": "i"; - "10": "c"; - "11": "o"; - "12": "s"; - } - | { - "0": "C"; - "1": "o"; - "2": "m"; - "3": "p"; - "4": "o"; - "5": "s"; - "6": "i"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "M"; - "1": "o"; - "2": "d"; - "3": "o"; - "4": "D"; - "5": "e"; - "6": "U"; - "7": "s"; - "8": "a"; - "9": "r"; - } - | { - "0": "C"; - "1": "u"; - "2": "i"; - "3": "d"; - "4": "a"; - "5": "d"; - "6": "o"; - "7": "s"; - } - | { - "0": "I"; - "1": "t"; - "2": "e"; - "3": "n"; - "4": "s"; - "5": "I"; - "6": "n"; - "7": "c"; - "8": "l"; - "9": "u"; - "10": "s"; - "11": "o"; - "12": "s"; - } - | { "0": "D"; "1": "i"; "2": "c"; "3": "a"; "4": "s" } - | { "0": "V"; "1": "i"; "2": "d"; "3": "e"; "4": "o" } - | { - "0": "D"; - "1": "e"; - "2": "s"; - "3": "c"; - "4": "r"; - "5": "i"; - "6": "c"; - "7": "a"; - "8": "o"; - } - | { - "0": "V"; - "1": "a"; - "2": "l"; - "3": "o"; - "4": "r"; - "5": "R"; - "6": "e"; - "7": "f"; - "8": "e"; - "9": "r"; - "10": "e"; - "11": "n"; - "12": "t"; - "13": "e"; - } - | { - "0": "P"; - "1": "o"; - "2": "p"; - "3": "U"; - "4": "p"; - "5": "R"; - "6": "e"; - "7": "f"; - "8": "e"; - "9": "r"; - "10": "e"; - "11": "n"; - "12": "t"; - "13": "e"; - } - | { - "0": "P"; - "1": "r"; - "2": "e"; - "3": "s"; - "4": "c"; - "5": "r"; - "6": "i"; - "7": "c"; - "8": "a"; - "9": "o"; - } - | { - "0": "T"; - "1": "a"; - "2": "b"; - "3": "e"; - "4": "l"; - "5": "a"; - "6": "D"; - "7": "e"; - "8": "M"; - "9": "e"; - "10": "d"; - "11": "i"; - "12": "d"; - "13": "a"; - "14": "s"; - } - | { "0": "S"; "1": "p"; "2": "o"; "3": "t" } - | { - "0": "S"; - "1": "i"; - "2": "n"; - "3": "o"; - "4": "p"; - "5": "s"; - "6": "e"; - } - | { - "0": "C"; - "1": "a"; - "2": "r"; - "3": "r"; - "4": "i"; - "5": "n"; - "6": "h"; - "7": "o"; - }; - }; + | "Informacoes" + | "Beneficios" + | "Especificacoes" + | "DadosTecnicos" + | "Composicao" + | "ModoDeUsar" + | "Cuidados" + | "ItensInclusos" + | "Dicas" + | "Video" + | "Descricao" + | "ValorReferente" + | "PopUpReferente" + | "Prescricao" + | "TabelaDeMedidas" + | "Spot" + | "Sinopse" + | "Carrinho"; + }; + }; + /** + * Exclui uma informação de um produto + */ + "DELETE /produtos/:identificador/informacoes/:informacaoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + }; + /** + * Assinatura de um determinado pedido + */ + "GET /assinaturas/pedido/:pedidoId": { + response: { + assinaturaPedidoId?: number; + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + pedidoId?: number; + valor?: number; + data?: string; + origemPedidoEnumId?: number; + produtoVarianteId?: number; + }[]; }; - /** @description Exclui uma informação de um produto */ - "DELETE /produtos/:identificador/informacoes/:informacaoId": {}; - /** @description Assinatura de um determinado pedido */ - "GET /assinaturas/pedido/:pedidoId": {}; - /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + /** + * Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) + */ "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId/parcial": { - searchParams: { + body: { /** * Objeto Pedido Rastreamento */ - RAW_BODY?: { + RAW_BODY: { /** * Rastreamento (optional) */ @@ -6331,11 +7693,21 @@ export interface API { }; }; }; - /** @description Access token atualizado com sucesso */ - "POST /autenticacao/refresh": {}; - /** @description Ativa ou inativa uma inscrição */ + /** + * Access token atualizado com sucesso + */ + "POST /autenticacao/refresh": { + response: { + lojas?: string[]; + accessToken?: string; + dataExpiracaoAccessTokenUTC?: string; + }; + }; + /** + * Ativa ou inativa uma inscrição + */ "PUT /webhook/inscricao/:inscricaoId/Ativar": { - searchParams: { + body: { /** * Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada) */ @@ -6350,23 +7722,76 @@ export interface API { observacao?: string; }; }; - /** @description Assinatura com erro na loja */ - "GET /assinaturas/erros/:assinaturaId": {}; - /** @description Limite de crédito de um usuário específico */ - "GET /usuarios/limiteCreditoPorEmail/:email": {}; - /** @description Retorna o histórico de situações de um pedido */ - "GET /pedidos/:pedidoId/historicoSituacao": {}; - /** @description Atualiza o limite de crédito para um usuário */ - "PUT /usuarios/limiteCredito/:usuarioId": {}; - /** @description Retorna a lista de produtos de um portfolio */ - "GET /portfolios/:portfolioId/produtos": {}; - /** @description Vinculo de produtos ao portfolio */ - "PUT /portfolios/:portfolioId/produtos": { + /** + * Assinatura com erro na loja + */ + "GET /assinaturas/erros/:assinaturaId": { + response: { + assinaturaErroId?: number; + assinaturaId?: number; + usuarioId?: string; + visualizado?: boolean; + dataErro?: string; + resolvido?: boolean; + codigoAssinaturaErro?: number; + assinaturaErroNome?: string; + assinaturaErroDescricao?: string; + }[]; + }; + /** + * Limite de crédito de um usuário específico + */ + "GET /usuarios/limiteCreditoPorEmail/:email": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }; + }; + /** + * Retorna o histórico de situações de um pedido + */ + "GET /pedidos/:pedidoId/historicoSituacao": { + response: { + situacoes?: { + situacaoPedidoId?: number; + nome?: string; + dataAtualizacao?: string; + }[]; + }; + }; + /** + * Atualiza o limite de crédito para um usuário + */ + "PUT /usuarios/limiteCredito/:usuarioId": { searchParams: { + /** + * CPF ou CNPJ do usuário + */ + cpf_cnpj?: string; + /** + * Valor do limite de crédito + */ + valor?: number; + }; + }; + /** + * Retorna a lista de produtos de um portfolio + */ + "GET /portfolios/:portfolioId/produtos": { + response: { + produtoId?: number; + }[]; + }; + /** + * Vinculo de produtos ao portfolio + */ + "PUT /portfolios/:portfolioId/produtos": { + body: { /** * Lista dos Id's dos produtos */ - RAW_BODY?: { + RAW_BODY: { /** * Id do produto */ @@ -6374,9 +7799,11 @@ export interface API { }[]; }; }; - /** @description Insere um rastreamento e status a um produto variante */ + /** + * Insere um rastreamento e status a um produto variante + */ "POST /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento": { - searchParams: { + body: { /** * Id da situação do pedido */ @@ -6423,13 +7850,34 @@ export interface API { urlRastreamento?: string; }; }; - /** @description Usuários encontrados */ - "GET /parceiros/:parceiroId/usuarios": {}; - /** @description Dados de transação do pedido */ + /** + * Usuários encontrados + */ + "GET /parceiros/:parceiroId/usuarios": { + response: { + usuarioId?: number; + email?: string; + ativo?: boolean; + dataInicial?: string; + dataFinal?: string; + vinculoVitalicio?: boolean; + }[]; + }; + /** + * Dados de transação do pedido + */ "GET /pedidos/transacoes/:transacaoId": {}; - /** @description Operação realizada com ou sem sucesso para os usuários */ + /** + * Operação realizada com ou sem sucesso para os usuários + */ "PUT /usuarios/autorizar": { searchParams: { + /** + * Tipo de Identificador + */ + tipoIdentificador?: "UsuarioId" | "Email"; + }; + body: { /** * Usuários */ @@ -6444,23 +7892,121 @@ export interface API { aprovado?: boolean; }[]; }; + response: { + usuariosAtualizados?: string[]; + usuariosNaoAtualizados?: string[]; + }; }; - /** @description Atualiza a data de cadastro um produto com base nos dados enviados */ + /** + * Atualiza a data de cadastro um produto com base nos dados enviados + */ "PUT /produtos/:identificador/DataCadastro": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss */ dataCadastro?: string; }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + }; }; - /** @description Atualiza a situação do status de um produto do pedido */ + /** + * Atualiza a situação do status de um produto do pedido + */ "PUT /pedidos/:pedidoId/:produtoVarianteId/status": { - searchParams: { + body: { /** * Dados da situação do produto (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Id do centro de distribuição do produto */ @@ -6476,11 +8022,30 @@ export interface API { }; }; }; - /** @description Indicadores dos Produtos no Estoque */ - "GET /dashboard/produtoestoque": {}; - /** @description Atualiza um endereço de um usuário pelo e-mail do usuário */ - "PUT /usuarios/:email/enderecos/:enderecoId": { + /** + * Indicadores dos Produtos no Estoque + */ + "GET /dashboard/produtoestoque": { searchParams: { + /** + * Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorProdutoComEstoque?: string; + indicadorProdutoSemEstoque?: string; + }; + }; + /** + * Atualiza um endereço de um usuário pelo e-mail do usuário + */ + "PUT /usuarios/:email/enderecos/:enderecoId": { + body: { /** * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ @@ -6519,59 +8084,43 @@ export interface API { cep?: string; }; }; - /** @description Atualiza o status de uma avaliação de um produto variante */ + /** + * Atualiza o status de uma avaliação de um produto variante + */ "PUT /produtoavaliacao/:produtoAvaliacaoId/status": { - searchParams: { + body: { /** * Status para a avaliação */ - status?: - | { - "0": "P"; - "1": "e"; - "2": "n"; - "3": "d"; - "4": "e"; - "5": "n"; - "6": "t"; - "7": "e"; - } - | { - "0": "N"; - "1": "a"; - "2": "o"; - "3": "A"; - "4": "p"; - "5": "r"; - "6": "o"; - "7": "v"; - "8": "a"; - "9": "d"; - "10": "o"; - } - | { - "0": "A"; - "1": "p"; - "2": "r"; - "3": "o"; - "4": "v"; - "5": "a"; - "6": "d"; - "7": "o"; - }; + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + }; + }; + /** + * Fabricante encontrado + */ + "GET /fabricantes/:nome": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; }; }; - /** @description Fabricante encontrado */ - "GET /fabricantes/:nome": {}; - /** @description Lista de parceiros vinculados ao banner */ + /** + * Lista de parceiros vinculados ao banner + */ "GET /banners/:bannerId/parceiros": {}; - /** @description Vincula parceiros com um banner específico */ + /** + * Vincula parceiros com um banner específico + */ "POST /banners/:bannerId/parceiros": { - searchParams: { + body: { /** * Lista de Id dos parceiros */ - RAW_BODY?: { + RAW_BODY: { /** * Id do parceiro (optional) */ @@ -6579,9 +8128,11 @@ export interface API { }[]; }; }; - /** @description Deleta o vinculo de um ou mais parceiros com um banner específico */ + /** + * Deleta o vinculo de um ou mais parceiros com um banner específico + */ "DELETE /banners/:bannerId/parceiros": { - searchParams: { + body: { /** * Lista de identificadores de parceiros para desvincular do banner */ @@ -6593,11 +8144,24 @@ export interface API { }[]; }; }; - /** @description Lista de tabelas de preços */ - "GET /tabelaPrecos": {}; - /** @description Insere uma nova tabela de preços */ + /** + * Lista de tabelas de preços + */ + "GET /tabelaPrecos": { + response: { + tabelaPrecoId?: number; + nome?: string; + dataInicial?: string; + dataFinal?: string; + ativo?: boolean; + isSite?: boolean; + }[]; + }; + /** + * Insere uma nova tabela de preços + */ "POST /tabelaPrecos": { - searchParams: { + body: { /** * Nome da tabela de preço */ @@ -6611,49 +8175,152 @@ export interface API { */ dataFinal?: string; /** - * Status da tabela de preço + * Status da tabela de preço + */ + ativo?: boolean; + }; + }; + /** + * Atualiza a imagem do banner + */ + "PUT /banners/:bannerId/Imagem": { + body: { + /** + * URL da Imagem (optional) + */ + urlImagem?: string; + /** + * Informações para atualizar a imagem (optional) + */ + Imagem?: { + /** + * string da imagem em base 64 + */ + base64?: string; + /** + * formato da imagem + */ + formato?: "PNG" | "JPG" | "JPEG"; + /** + * nome da imagem + */ + nome?: string; + }; + }; + }; + /** + * Exclui o vínculo entre uma categoria e um produto + */ + "DELETE /produtos/:identificador/categorias/:id": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** + * Xml com os dados de uma mídia específicas entre duas datas + */ + "GET /midias/:identificador": { + searchParams: { + /** + * Data inicial (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final (aaaa-mm-dd) */ - ativo?: boolean; + dataFinal?: string; + }; + response: { + dias?: { + diaMidiaApiModel?: { + dia?: string; + investimento?: { + meta?: number; + realizado?: number; + }; + pedidos?: { + meta?: number; + realizado?: number; + }; + roi?: { + meta?: number; + realizado?: number; + }; + receita?: { + meta?: number; + realizado?: number; + }; + visitas?: { + meta?: number; + realizado?: number; + }; + }[]; + }; + id?: number; + nome?: string; + tipo?: string; }; }; - /** @description Atualiza a imagem do banner */ - "PUT /banners/:bannerId/Imagem": { + /** + * Lista de hotsites + */ + "GET /hotsites": { searchParams: { /** - * URL da Imagem (optional) + * Página da lista (padrão: 1) */ - urlImagem?: string; + pagina?: number; /** - * Informações para atualizar a imagem (optional) + * Quantidade de registros que deverão retornar (max: 50) */ - Imagem?: { - /** - * string da imagem em base 64 - */ - base64?: string; - /** - * formato da imagem - */ - formato?: - | { "0": "P"; "1": "N"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "G" } - | { "0": "J"; "1": "P"; "2": "E"; "3": "G" }; - /** - * nome da imagem - */ - nome?: string; - }; + quantidadePorPagina?: number; }; + response: { + hotsiteId?: number; + nome?: string; + ativo?: boolean; + template?: string; + dataCriacao?: string; + dataInicio?: string; + dataFinal?: string; + url?: string; + tamanhoPagina?: number; + templateId?: number; + ordenacao?: string; + listaProdutos?: { + expressao?: string; + produtos?: { + produtoId?: number; + ordem?: number; + }[]; + }; + seo?: { + seoHotsiteId?: number; + hotsiteId?: number; + titulo?: string; + metas?: { + conteudo?: string; + nome?: string; + httpEquiv?: string; + scheme?: string; + }[]; + }; + banners?: { + bannerId?: number; + }[]; + conteudos?: { + conteudoId?: number; + }[]; + }[]; }; - /** @description Exclui o vínculo entre uma categoria e um produto */ - "DELETE /produtos/:identificador/categorias/:id": {}; - /** @description Xml com os dados de uma mídia específicas entre duas datas */ - "GET /midias/:identificador": {}; - /** @description Lista de hotsites */ - "GET /hotsites": {}; - /** @description A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos. */ + /** + * A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos. + */ "POST /hotsites": { - searchParams: { + body: { /** * Nome do hotsite */ @@ -6682,154 +8349,17 @@ export interface API { * Informe qual será a ordenação dos Produtos no Hotsite (optional) */ ordenacao?: - | { - "0": "N"; - "1": "e"; - "2": "n"; - "3": "h"; - "4": "u"; - "5": "m"; - "6": "a"; - } - | { - "0": "N"; - "1": "o"; - "2": "m"; - "3": "e"; - "4": "C"; - "5": "r"; - "6": "e"; - "7": "s"; - "8": "c"; - "9": "e"; - "10": "n"; - "11": "t"; - "12": "e"; - } - | { - "0": "N"; - "1": "o"; - "2": "m"; - "3": "e"; - "4": "D"; - "5": "e"; - "6": "c"; - "7": "r"; - "8": "e"; - "9": "s"; - "10": "c"; - "11": "e"; - "12": "n"; - "13": "t"; - "14": "e"; - } - | { - "0": "L"; - "1": "a"; - "2": "n"; - "3": "c"; - "4": "a"; - "5": "m"; - "6": "e"; - "7": "n"; - "8": "t"; - "9": "o"; - } - | { - "0": "M"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "r"; - "5": "P"; - "6": "r"; - "7": "e"; - "8": "c"; - "9": "o"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "P"; - "6": "r"; - "7": "e"; - "8": "c"; - "9": "o"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "s"; - "4": "V"; - "5": "e"; - "6": "n"; - "7": "d"; - "8": "i"; - "9": "d"; - "10": "o"; - "11": "s"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "e"; - "6": "s"; - "7": "D"; - "8": "e"; - "9": "s"; - "10": "c"; - "11": "o"; - "12": "n"; - "13": "t"; - "14": "o"; - "15": "s"; - } - | { - "0": "A"; - "1": "l"; - "2": "e"; - "3": "a"; - "4": "t"; - "5": "o"; - "6": "r"; - "7": "i"; - "8": "o"; - } - | { - "0": "M"; - "1": "e"; - "2": "n"; - "3": "o"; - "4": "r"; - "5": "E"; - "6": "s"; - "7": "t"; - "8": "o"; - "9": "q"; - "10": "u"; - "11": "e"; - } - | { - "0": "M"; - "1": "a"; - "2": "i"; - "3": "o"; - "4": "r"; - "5": "E"; - "6": "s"; - "7": "t"; - "8": "o"; - "9": "q"; - "10": "u"; - "11": "e"; - }; + | "Nenhuma" + | "NomeCrescente" + | "NomeDecrescente" + | "Lancamento" + | "MenorPreco" + | "MaiorPreco" + | "MaisVendidos" + | "MaioresDescontos" + | "Aleatorio" + | "MenorEstoque" + | "MaiorEstoque"; /** * Produtos que devem aparecer no hotsite */ @@ -6906,15 +8436,357 @@ export interface API { ativo?: boolean; }; }; - /** @description Lista de pedidos */ - "GET /pedidos/situacaoPedido/:situacoesPedido": {}; - /** @description Portfolio encontrado */ - "GET /portfolios/:nome": {}; - /** @description Lista de categorias de um produto */ - "GET /produtos/:identificador/categorias": {}; - /** @description Adiciona o vínculo entre um produto e uma categoria com base na lista enviada */ + /** + * Lista de pedidos + */ + "GET /pedidos/situacaoPedido/:situacoesPedido": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + */ + formasPagamento?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + */ + apenasAssinaturas?: boolean; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** + * Portfolio encontrado + */ + "GET /portfolios/:nome": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }; + }; + /** + * Lista de categorias de um produto + */ + "GET /produtos/:identificador/categorias": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadRegistros?: number; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + caminhoHierarquia?: string; + categoriaPrincipal?: boolean; + }[]; + }; + /** + * Adiciona o vínculo entre um produto e uma categoria com base na lista enviada + */ "POST /produtos/:identificador/categorias": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Id da Categoria Principal (optional) */ @@ -6925,15 +8797,37 @@ export interface API { listaCategoriaId?: number[]; }; }; - /** @description Lista de Atacarejos */ - "GET /produtos/:identificador/atacarejo": {}; - /** @description Adiciona novos Atacarejos */ + /** + * Lista de Atacarejos + */ + "GET /produtos/:identificador/atacarejo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }[]; + }; + /** + * Adiciona novos Atacarejos + */ "POST /produtos/:identificador/atacarejo": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Lista de Atacarejos (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Preço atacado */ @@ -6944,16 +8838,29 @@ export interface API { quantidade?: number; }[]; }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }[]; + }; + /** + * Recorrências cadastradas na loja + */ + "GET /assinaturas/recorrencias": { + response: { + recorrencias?: string[]; + }; }; - /** @description Recorrências cadastradas na loja */ - "GET /assinaturas/recorrencias": {}; - /** @description Atualiza rastreamento completo (com os dados da N.F.) */ + /** + * Atualiza rastreamento completo (com os dados da N.F.) + */ "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId": { - searchParams: { + body: { /** * Objeto Pedido Rastreamento */ - RAW_BODY?: { + RAW_BODY: { /** * Número da nota fiscal */ @@ -6989,9 +8896,11 @@ export interface API { }; }; }; - /** @description Atualiza a prioridade de um centro de distribuição */ + /** + * Atualiza a prioridade de um centro de distribuição + */ "PUT /centrosdistribuicao/:centroDistribuicaoId/prioridade": { - searchParams: { + body: { /** * (optional) */ @@ -7001,12 +8910,42 @@ export interface API { */ desativarPriorizacao?: boolean; }; + response: {}; }; - /** @description Conteúdos encontrados */ - "GET /conteudos": {}; - /** @description Insere um novo conteúdo na loja */ - "POST /conteudos": { + /** + * Conteúdos encontrados + */ + "GET /conteudos": { searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadePorPagina?: number; + }; + response: { + conteudoId?: number; + titulo?: string; + ativo?: boolean; + dataInicio?: string; + dataFim?: string; + posicionamento?: string; + codigoFonte?: string; + termoBusca?: string; + exibeTodasBuscas?: boolean; + naoExibeBuscas?: boolean; + exibeTodosHotsites?: boolean; + hotsitesId?: number[]; + }[]; + }; + /** + * Insere um novo conteúdo na loja + */ + "POST /conteudos": { + body: { /** * Titulo do conteúdo */ @@ -7027,68 +8966,13 @@ export interface API { * Posicionamento do conteúdo */ posicionamento?: - | { "0": "T"; "1": "o"; "2": "p"; "3": "o" } - | { "0": "C"; "1": "e"; "2": "n"; "3": "t"; "4": "r"; "5": "o" } - | { "0": "R"; "1": "o"; "2": "d"; "3": "a"; "4": "p"; "5": "e" } - | { - "0": "L"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "r"; - "5": "a"; - "6": "l"; - "7": "D"; - "8": "i"; - "9": "r"; - "10": "e"; - "11": "i"; - "12": "t"; - "13": "a"; - } - | { - "0": "L"; - "1": "a"; - "2": "t"; - "3": "e"; - "4": "r"; - "5": "a"; - "6": "l"; - "7": "E"; - "8": "s"; - "9": "q"; - "10": "u"; - "11": "e"; - "12": "r"; - "13": "d"; - "14": "a"; - } - | { - "0": "M"; - "1": "o"; - "2": "b"; - "3": "i"; - "4": "l"; - "5": "e"; - "6": "T"; - "7": "o"; - "8": "p"; - "9": "o"; - } - | { - "0": "M"; - "1": "o"; - "2": "b"; - "3": "i"; - "4": "l"; - "5": "e"; - "6": "R"; - "7": "o"; - "8": "d"; - "9": "a"; - "10": "p"; - "11": "e"; - }; + | "Topo" + | "Centro" + | "Rodape" + | "LateralDireita" + | "LateralEsquerda" + | "MobileTopo" + | "MobileRodape"; /** * Informações do conteúdo */ @@ -7115,29 +8999,86 @@ export interface API { hotsitesId?: number[]; }; }; - /** @description Atualiza a imagem de estampa do produto */ + /** + * Atualiza a imagem de estampa do produto + */ "PUT /produtos/:identificador/imagens/estampa": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Id da imagem que será marcada como estampa */ idImagem?: number; }; }; - /** @description Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página) */ - "GET /usuarios/newsletter": {}; - /** @description Ativa ou desativa um endereço de um usuário com base no e-mail do usuário */ + /** + * Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página) + */ + "GET /usuarios/newsletter": { + searchParams: { + /** + * Tipo de ordenação + */ + ordenarPor?: "DataCadastro" | "DataAtualizacao"; + /** + * Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Status do usuário + */ + status?: boolean; + /** + * DoubleOptIn aceito (verificar estado da configuração) + */ + doubleOptIn?: boolean; + }; + response: { + nome?: string; + email?: string; + sexo?: string; + status?: boolean; + grupoInformacao?: { + nome?: string; + valor?: string; + }[]; + }[]; + }; + /** + * Ativa ou desativa um endereço de um usuário com base no e-mail do usuário + */ "PUT /usuarios/:email/enderecos/:enderecoId/ativar": { - searchParams: { + body: { /** * Status do endereço */ status?: boolean; }; }; - /** @description Insere uma avaliação para um produto variante */ + /** + * Insere uma avaliação para um produto variante + */ "POST /produtoavaliacao/:identificador": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Texto referente a avaliação do produto */ @@ -7165,49 +9106,66 @@ export interface API { /** * Referente ao status que libera a visualização da avaliação no site */ - status?: - | { - "0": "P"; - "1": "e"; - "2": "n"; - "3": "d"; - "4": "e"; - "5": "n"; - "6": "t"; - "7": "e"; - } - | { - "0": "N"; - "1": "a"; - "2": "o"; - "3": "A"; - "4": "p"; - "5": "r"; - "6": "o"; - "7": "v"; - "8": "a"; - "9": "d"; - "10": "o"; - } - | { - "0": "A"; - "1": "p"; - "2": "r"; - "3": "o"; - "4": "v"; - "5": "a"; - "6": "d"; - "7": "o"; - }; + status?: "Pendente" | "NaoAprovado" | "Aprovado"; }; }; - /** @description Relatório de receitas de um determinado período */ - "GET /dashboard/receita": {}; - /** @description Lista de fretes */ - "GET /fretes": {}; - /** @description Insere um novo contrato de frete */ - "POST /fretes": { + /** + * Relatório de receitas de um determinado período + */ + "GET /dashboard/receita": { searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** + * Lista de fretes + */ + "GET /fretes": { + response: { + freteId?: number; + nome?: string; + ativo?: boolean; + volumeMaximo?: number; + pesoCubado?: number; + entregaAgendadaConfiguracaoId?: number; + linkRastreamento?: string; + ehAssinatura?: boolean; + larguraMaxima?: number; + alturaMaxima?: number; + comprimentoMaximo?: number; + limiteMaximoDimensoes?: number; + limitePesoCubado?: number; + tempoMinimoDespacho?: number; + centroDistribuicaoId?: number; + valorMinimoProdutos?: number; + }[]; + }; + /** + * Insere um novo contrato de frete + */ + "POST /fretes": { + body: { /** * Nome do contrato de frete (optional) */ @@ -7270,11 +9228,37 @@ export interface API { valorMinimoProdutos?: number; }; }; - /** @description Detalhes de uma assinatura */ - "GET /assinaturas/:assinaturaId": {}; - /** @description Atualiza a situação de uma assinatura específica */ + /** + * Detalhes de uma assinatura + */ + "GET /assinaturas/:assinaturaId": { + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + produtos?: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }; + }; + /** + * Atualiza a situação de uma assinatura específica + */ "PUT /assinaturas/:assinaturaId": { - searchParams: { + body: { /** * Id do endereço (optional) */ @@ -7290,71 +9274,144 @@ export interface API { /** * Situação da Assinatura (optional) */ - situacaoAssinatura?: - | { "0": "A"; "1": "t"; "2": "i"; "3": "v"; "4": "a" } - | { - "0": "P"; - "1": "a"; - "2": "u"; - "3": "s"; - "4": "a"; - "5": "d"; - "6": "a"; - } - | { - "0": "C"; - "1": "a"; - "2": "n"; - "3": "c"; - "4": "e"; - "5": "l"; - "6": "a"; - "7": "d"; - "8": "a"; - }; + situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; /** * Cupom (optional) */ cupom?: string; }; }; - /** @description Buscar autor pelo nome */ + /** + * Buscar autor pelo nome + */ "GET /autores/:nomeAutor": {}; - /** @description Lista o conteúdo de uma versão */ - "GET /gestorscripts/scripts/:scriptId/versao/:versaoId/conteudo": {}; - /** @description Altera a data de recorrência de uma assinatura */ + /** + * Lista o conteúdo de uma versão + */ + "GET /gestorscripts/scripts/:scriptId/versao/:versaoId/conteudo": { + response: { + scriptId?: number; + versaoId?: number; + conteudo?: string; + }[]; + }; + /** + * Altera a data de recorrência de uma assinatura + */ "PUT /assinaturas/:assinaturaId/proximaRecorrencia": { - searchParams: { + body: { /** * Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados) */ proximaRecorrencia?: string; }; }; - /** @description Lista de parceiros com pedidos */ - "GET /parceiros/comPedidos": {}; - /** @description Usuário encontrado */ - "GET /usuarios/cnpj/:cnpj": {}; - /** @description Deleta um produto da lista de sugestões de produtos de um tipo de evento */ + /** + * Lista de parceiros com pedidos + */ + "GET /parceiros/comPedidos": { + searchParams: { + /** + * Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + }; + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }[]; + }; + /** + * Usuário encontrado + */ + "GET /usuarios/cnpj/:cnpj": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** + * Deleta um produto da lista de sugestões de produtos de um tipo de evento + */ "DELETE /tiposEvento/:tipoEventoId/produto/:produtoVarianteId": {}; - /** @description Deleta o vinculo de um produto a um evento */ - "DELETE /eventos/:eventoId/produto/:produtoVarianteId": {}; - /** @description Define uma categoria de um produto como principal */ + /** + * Deleta o vinculo de um produto a um evento + */ + "DELETE /eventos/:eventoId/produto/:produtoVarianteId": { + response: string; + }; + /** + * Define uma categoria de um produto como principal + */ "PUT /produtos/:identificador/categoriaPrincipal": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Id da categoria */ categoriaId?: number; }; }; - /** @description Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + /** + * Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição + */ "PUT /produtos/estoques": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { /** * Lista com os dados da atualização do estoque (optional) */ - RAW_BODY?: { + RAW_BODY: { /** * Valor único utilizado para identificar o produto */ @@ -7390,21 +9447,118 @@ export interface API { }[]; }[]; }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + centroDistribuicaoId?: number; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + centroDistribuicaoId?: number; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** + * Objeto com o estoque total e o estoque por centro de distribuição de um produto variante + */ + "GET /produtos/:identificador/estoque": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + estoqueFisico?: number; + estoqueReservado?: number; + listProdutoVarianteCentroDistribuicaoEstoque?: { + centroDistribuicaoId?: number; + nome?: string; + estoqueFisico?: number; + estoqueReservado?: number; + }[]; + }; + }; + /** + * Usuário encontrado + */ + "GET /usuarios/usuarioId/:usuarioId": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** + * Produtos Mais Vendidos + */ + "GET /dashboard/produtos": { + searchParams: { + /** + * Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + produtoVarianteId?: number; + nomeProduto?: string; + sku?: string; + quantidade?: number; + receita?: string; + }[]; }; - /** @description Objeto com o estoque total e o estoque por centro de distribuição de um produto variante */ - "GET /produtos/:identificador/estoque": {}; - /** @description Usuário encontrado */ - "GET /usuarios/usuarioId/:usuarioId": {}; - /** @description Produtos Mais Vendidos */ - "GET /dashboard/produtos": {}; - /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + /** + * Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) + */ "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId/parcial": { - searchParams: { + body: { /** * Objeto Pedido Rastreamento Produto */ - RAW_BODY?: { + RAW_BODY: { /** * Rastreamento (optional) */ @@ -7416,18 +9570,22 @@ export interface API { }; }; }; - /** @description Atualiza o status do banner pelo id */ + /** + * Atualiza o status do banner pelo id + */ "PUT /banners/:bannerId/status": { - searchParams: { + body: { /** * Status para qual deve ir o baner: Ativo (true) ou Inativo (false) */ status?: boolean; }; }; - /** @description Atualiza um endereço de um usuário pelo id do usuário */ + /** + * Atualiza um endereço de um usuário pelo id do usuário + */ "PUT /usuarios/:usuarioId/enderecos/:enderecoId": { - searchParams: { + body: { /** * Nome de identificação do endereço a ser cadastrado (Max Length: 100) */ @@ -7466,186 +9624,69 @@ export interface API { cep?: string; }; }; - /** @description Lista de avaliações de produtos */ - "GET /produtos/:identificador/avaliacoes": {}; - /** @description Atualiza um usuário pelo id */ - "PUT /usuarios/:usuarioId": { + /** + * Lista de avaliações de produtos + */ + "GET /produtos/:identificador/avaliacoes": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado'] + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + produtoVarianteId?: number; + sku?: string; + produtoAvaliacaoId?: number; + comentario?: string; + avaliacao?: number; + usuarioId?: number; + dataAvaliacao?: string; + nome?: string; + email?: string; + status?: string; + }[]; + }; + /** + * Atualiza um usuário pelo id + */ + "PUT /usuarios/:usuarioId": { + body: { /** * Tipo de pessoa */ - tipoPessoa?: - | { "0": "F"; "1": "i"; "2": "s"; "3": "i"; "4": "c"; "5": "a" } - | { - "0": "J"; - "1": "u"; - "2": "r"; - "3": "i"; - "4": "d"; - "5": "i"; - "6": "c"; - "7": "a"; - }; + tipoPessoa?: "Fisica" | "Juridica"; /** * Origem do contato */ origemContato?: - | { "0": "G"; "1": "o"; "2": "o"; "3": "g"; "4": "l"; "5": "e" } - | { "0": "B"; "1": "i"; "2": "n"; "3": "g" } - | { "0": "J"; "1": "o"; "2": "r"; "3": "n"; "4": "a"; "5": "l" } - | { - "0": "P"; - "1": "a"; - "2": "t"; - "3": "r"; - "4": "o"; - "5": "c"; - "6": "i"; - "7": "n"; - "8": "i"; - "9": "o"; - "10": "E"; - "11": "s"; - "12": "p"; - "13": "o"; - "14": "r"; - "15": "t"; - "16": "i"; - "17": "v"; - "18": "o"; - } - | { - "0": "R"; - "1": "e"; - "2": "c"; - "3": "o"; - "4": "m"; - "5": "e"; - "6": "n"; - "7": "d"; - "8": "a"; - "9": "c"; - "10": "a"; - "11": "o"; - "12": "A"; - "13": "l"; - "14": "g"; - "15": "u"; - "16": "e"; - "17": "m"; - } - | { - "0": "R"; - "1": "e"; - "2": "v"; - "3": "i"; - "4": "s"; - "5": "t"; - "6": "a"; - } - | { - "0": "S"; - "1": "i"; - "2": "t"; - "3": "e"; - "4": "I"; - "5": "n"; - "6": "t"; - "7": "e"; - "8": "r"; - "9": "n"; - "10": "e"; - "11": "t"; - } - | { - "0": "T"; - "1": "e"; - "2": "l"; - "3": "e"; - "4": "v"; - "5": "i"; - "6": "s"; - "7": "a"; - "8": "o"; - } - | { "0": "O"; "1": "u"; "2": "t"; "3": "r"; "4": "o" } - | { - "0": "U"; - "1": "s"; - "2": "u"; - "3": "a"; - "4": "r"; - "5": "i"; - "6": "o"; - "7": "I"; - "8": "m"; - "9": "p"; - "10": "o"; - "11": "r"; - "12": "t"; - "13": "a"; - "14": "d"; - "15": "o"; - "16": "V"; - "17": "i"; - "18": "a"; - "19": "A"; - "20": "d"; - "21": "m"; - "22": "i"; - "23": "n"; - } - | { - "0": "P"; - "1": "a"; - "2": "y"; - "3": "P"; - "4": "a"; - "5": "l"; - "6": "E"; - "7": "x"; - "8": "p"; - "9": "r"; - "10": "e"; - "11": "s"; - "12": "s"; - }; + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; /** * Tipo Sexo (optional) */ - tipoSexo?: - | { - "0": "U"; - "1": "n"; - "2": "d"; - "3": "e"; - "4": "f"; - "5": "i"; - "6": "n"; - "7": "e"; - "8": "d"; - } - | { - "0": "M"; - "1": "a"; - "2": "s"; - "3": "c"; - "4": "u"; - "5": "l"; - "6": "i"; - "7": "n"; - "8": "o"; - } - | { - "0": "F"; - "1": "e"; - "2": "m"; - "3": "i"; - "4": "n"; - "5": "i"; - "6": "n"; - "7": "o"; - }; + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; /** * Nome do usuário (Max Length: 100) */ @@ -7733,22 +9774,26 @@ export interface API { aprovado?: boolean; }; }; - /** @description Liberar reservas de pedidos */ + /** + * Liberar reservas de pedidos + */ "POST /pedidos/liberarReservas": { - searchParams: { + body: { /** * Números dos pedidos que se deseja buscar */ - RAW_BODY?: number[]; + RAW_BODY: number[]; }; }; - /** @description Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição */ + /** + * Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição + */ "PUT /produtos/precos/lote": { - searchParams: { + body: { /** * Lista com os dados da atualização do preço por lote */ - RAW_BODY?: { + RAW_BODY: { /** * Identificador do produto (SKU) */ @@ -7771,23 +9816,72 @@ export interface API { fatorMultiplicadorPreco?: number; }[]; }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; }; - /** @description Atualiza a exibição do banner em parceiros, se deve ser em todos ou não */ + /** + * Atualiza a exibição do banner em parceiros, se deve ser em todos ou não + */ "PUT /banners/:bannerId/Parceiros": { - searchParams: { + body: { /** * Exibição do banner em parceiros */ exibirEmTodosParceiros?: boolean; }; }; - /** @description Retorna lista contendo os Id's dos pedidos do usuário */ - "GET /usuarios/documento/:documento/pedidos": {}; - /** @description Objeto com o precoDe e precoPor de um produto variante */ - "GET /produtos/:identificador/preco": {}; - /** @description Campo atualizado com sucesso */ - "PUT /usuarios/bloquear": { + /** + * Retorna lista contendo os Id's dos pedidos do usuário + */ + "GET /usuarios/documento/:documento/pedidos": { + searchParams: { + /** + * Define se o documento informado é um CPF ou um CNPJ + */ + tipoDocumento?: "Cpf" | "Cnpj"; + }; + response: { + pedidoId?: number; + links?: { + href?: string; + rel?: string; + method?: string; + }[]; + }[]; + }; + /** + * Objeto com o precoDe e precoPor de um produto variante + */ + "GET /produtos/:identificador/preco": { searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + }; + }; + /** + * Campo atualizado com sucesso + */ + "PUT /usuarios/bloquear": { + body: { /** * Usuários (optional) */ @@ -7802,22 +9896,93 @@ export interface API { bloqueado?: boolean; }[]; }; + response: { + usuariosAtualizados?: string[]; + usuariosNaoAtualizados?: string[]; + }; }; - /** @description Frete atualizado com sucesso */ + /** + * Frete atualizado com sucesso + */ "PUT /fretes/:freteId/Ativo": { - searchParams: { + body: { /** * Status para atualização do contrato de frete */ ativo?: boolean; }; }; - /** @description Gera um novo pedido para a assinatura */ + /** + * Gera um novo pedido para a assinatura + */ "POST /assinaturas/:assinaturaId/pedido": {}; - /** @description Xml com os dados das mídias entre duas datas */ - "GET /midias": {}; - /** @description Relatório de ticket médio de um determinado período */ - "GET /dashboard/ticketMedio": {}; - /** @description Objeto com as cotações de frete */ - "GET /fretes/pedidos/:pedidoId/cotacoes": {}; + /** + * Xml com os dados das mídias entre duas datas + */ + "GET /midias": { + searchParams: { + /** + * Data inicial (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final (aaaa-mm-dd) + */ + dataFinal?: string; + }; + }; + /** + * Relatório de ticket médio de um determinado período + */ + "GET /dashboard/ticketMedio": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** + * Objeto com as cotações de frete + */ + "GET /fretes/pedidos/:pedidoId/cotacoes": { + searchParams: { + /** + * Força cotação de todos os CD's. + */ + forcarCotacaoTodosCDs?: boolean; + }; + response: { + id?: string; + nome?: string; + prazo?: number; + tabelaFreteId?: string; + tipo?: string; + valor?: number; + centroDistribuicao?: number; + produtos?: { + produtoVarianteId?: number; + valor?: number; + centroDistribuicaoId?: number; + }[]; + }[]; + }; } diff --git a/wake/utils/transform.ts b/wake/utils/transform.ts index 3c3b6eac3..bb00483bc 100644 --- a/wake/utils/transform.ts +++ b/wake/utils/transform.ts @@ -11,7 +11,7 @@ import { ProductFragment, SearchQuery, SingleProductFragment, -} from "./graphql/graphql.gen.ts"; +} from "./graphql/storefront.graphql.gen.ts"; export const stale = { deco: { cache: "stale-while-revalidate" }, From 4d2c75b2c65ab69a13ceb053bb0c87098686cc57 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 08:19:07 -0300 Subject: [PATCH 03/21] migrate shopify --- shopify/actions/cart/addItems.ts | 24 ++++++--- shopify/actions/cart/updateCoupons.ts | 28 +++++++--- shopify/actions/cart/updateItems.ts | 25 ++++++--- shopify/loaders/ProductDetailsPage.ts | 18 +++++-- shopify/loaders/ProductList.ts | 25 ++++++--- shopify/loaders/ProductListingPage.ts | 28 +++++++--- shopify/loaders/cart.ts | 33 ++++++------ shopify/mod.ts | 2 +- shopify/utils/fragments/cart.ts | 44 +--------------- shopify/utils/fragments/product.ts | 36 ++----------- shopify/utils/fragments/productVariant.ts | 28 +--------- shopify/utils/queries/addItem.ts | 29 ----------- shopify/utils/queries/cart.ts | 15 ------ shopify/utils/queries/createCart.ts | 17 ------- shopify/utils/queries/product.ts | 16 ------ shopify/utils/queries/products.ts | 27 ---------- shopify/utils/queries/updateCart.ts | 24 --------- shopify/utils/queries/updateCoupon.ts | 5 +- shopify/utils/storefront.graphql.gen.ts | 62 +++++++++++++++++++++++ shopify/utils/transform.ts | 14 ++--- vnda/utils/constants.ts | 0 21 files changed, 211 insertions(+), 289 deletions(-) delete mode 100644 shopify/utils/queries/addItem.ts delete mode 100644 shopify/utils/queries/cart.ts delete mode 100644 shopify/utils/queries/createCart.ts delete mode 100644 shopify/utils/queries/product.ts delete mode 100644 shopify/utils/queries/products.ts delete mode 100644 shopify/utils/queries/updateCart.ts create mode 100644 vnda/utils/constants.ts diff --git a/shopify/actions/cart/addItems.ts b/shopify/actions/cart/addItems.ts index 305dce726..fcf098df5 100644 --- a/shopify/actions/cart/addItems.ts +++ b/shopify/actions/cart/addItems.ts @@ -1,7 +1,11 @@ +import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { Data, query, Variables } from "../../utils/queries/addItem.ts"; -import { Data as CartData } from "../../utils/queries/cart.ts"; +import { fragment } from "../../utils/fragments/cart.ts"; +import { + AddItemToCartMutation, + AddItemToCartMutationVariables, +} from "../../utils/storefront.graphql.gen.ts"; type UpdateLineProps = { lines: { @@ -16,7 +20,7 @@ const action = async ( { lines }: UpdateLineProps, req: Request, ctx: AppContext, -): Promise => { +): Promise["cart"]> => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -24,14 +28,22 @@ const action = async ( throw new Error("Missing cart id"); } - const { payload: { cart } } = await storefront.query({ + const { payload } = await storefront.query< + AddItemToCartMutation, + AddItemToCartMutationVariables + >({ variables: { cartId, lines }, - query, + fragments: [fragment], + query: gql`mutation AddItemToCart($cartId: ID!, $lines: [CartLineInput!]!) { + payload: cartLinesAdd(cartId: $cartId, lines: $lines) { + cart { ...Cart } + } + }`, }); setCartCookie(ctx.response.headers, cartId); - return cart; + return payload?.cart; }; export default action; diff --git a/shopify/actions/cart/updateCoupons.ts b/shopify/actions/cart/updateCoupons.ts index 88f243f98..ce4d25ff6 100644 --- a/shopify/actions/cart/updateCoupons.ts +++ b/shopify/actions/cart/updateCoupons.ts @@ -1,7 +1,11 @@ +import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { Data as CartData } from "../../utils/queries/cart.ts"; -import { Data, query, Variables } from "../../utils/queries/updateCoupon.ts"; +import { fragment } from "../../utils/fragments/cart.ts"; +import { + AddCouponMutation, + AddCouponMutationVariables, +} from "../../utils/storefront.graphql.gen.ts"; type AddCouponProps = { discountCodes: string[]; @@ -11,7 +15,7 @@ const action = async ( props: AddCouponProps, req: Request, ctx: AppContext, -): Promise => { +): Promise["cart"]> => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -19,14 +23,26 @@ const action = async ( throw new Error("Missing cart id"); } - const { payload: { cart } } = await storefront.query({ + const { payload } = await storefront.query< + AddCouponMutation, + AddCouponMutationVariables + >({ variables: { cartId, discountCodes: props.discountCodes }, - query, + fragments: [fragment], + query: gql`mutation AddCoupon($cartId: ID!, $discountCodes: [String!]!) { + payload: cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) { + cart { ...Cart } + userErrors { + field + message + } + } + }`, }); setCartCookie(ctx.response.headers, cartId); - return cart; + return payload?.cart; }; export default action; diff --git a/shopify/actions/cart/updateItems.ts b/shopify/actions/cart/updateItems.ts index dadc32941..1c7f722bf 100644 --- a/shopify/actions/cart/updateItems.ts +++ b/shopify/actions/cart/updateItems.ts @@ -1,7 +1,11 @@ +import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { Data as CartData } from "../../utils/queries/cart.ts"; -import { Data, query, Variables } from "../../utils/queries/updateCart.ts"; +import { fragment } from "../../utils/fragments/cart.ts"; +import { + UpdateItemsMutation, + UpdateItemsMutationVariables, +} from "../../utils/storefront.graphql.gen.ts"; type UpdateLineProps = { lines: Array<{ @@ -14,7 +18,7 @@ const action = async ( { lines }: UpdateLineProps, req: Request, ctx: AppContext, -): Promise => { +): Promise["cart"]> => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -22,14 +26,23 @@ const action = async ( throw new Error("Missing cart id"); } - const { payload: { cart } } = await storefront.query({ + const { payload } = await storefront.query< + UpdateItemsMutation, + UpdateItemsMutationVariables + >({ variables: { cartId, lines }, - query, + fragments: [fragment], + query: + gql`mutation UpdateItems($cartId: ID!, $lines: [CartLineUpdateInput!]!) { + payload: cartLinesUpdate(cartId: $cartId, lines: $lines) { + cart { ...Cart } + } + }`, }); setCartCookie(ctx.response.headers, cartId); - return cart; + return payload?.cart; }; export default action; diff --git a/shopify/loaders/ProductDetailsPage.ts b/shopify/loaders/ProductDetailsPage.ts index d8aa78de4..693777209 100644 --- a/shopify/loaders/ProductDetailsPage.ts +++ b/shopify/loaders/ProductDetailsPage.ts @@ -1,8 +1,14 @@ import { ProductDetailsPage } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; import { toProductPage } from "../../shopify/utils/transform.ts"; +import { gql } from "../../utils/graphql.ts"; import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; -import { Data, query, Variables } from "../utils/queries/product.ts"; +import { fragment as productFragment } from "../utils/fragments/product.ts"; +import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; +import { + GetProductQuery, + GetProductQueryVariables, +} from "../utils/storefront.graphql.gen.ts"; export interface Props { slug: RequestURLParam; @@ -25,9 +31,15 @@ const loader = async ( const handle = splitted.slice(0, maybeSkuId ? -1 : undefined).join("-"); - const data = await storefront.query({ - query, + const data = await storefront.query< + GetProductQuery, + GetProductQueryVariables + >({ variables: { handle }, + fragments: [productFragment, variantFragment], + query: gql`query GetProduct($handle: String) { + product(handle: $handle) { ...Product } + }`, }); if (!data?.product) { diff --git a/shopify/loaders/ProductList.ts b/shopify/loaders/ProductList.ts index f58cb1f8a..88a92206e 100644 --- a/shopify/loaders/ProductList.ts +++ b/shopify/loaders/ProductList.ts @@ -1,10 +1,12 @@ import type { Product } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; +import { gql } from "../../utils/graphql.ts"; +import { fragment as productFragment } from "../utils/fragments/product.ts"; +import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; import { - Data, - query as productsQuery, - Variables, -} from "../utils/queries/products.ts"; + ListProductsQuery, + ListProductsQueryVariables, +} from "../utils/storefront.graphql.gen.ts"; import { toProduct } from "../utils/transform.ts"; export interface Props { @@ -28,10 +30,19 @@ const loader = async ( const count = props.count ?? 12; const query = props.query || ""; - // search products on Shopify. Feel free to change any of these parameters - const data = await storefront.query({ - query: productsQuery, + const data = await storefront.query< + ListProductsQuery, + ListProductsQueryVariables + >({ variables: { first: count, query }, + fragments: [productFragment, variantFragment], + query: gql`query ListProducts($first: Int, $after: String, $query: String) { + products(first: $first, after: $after, query: $query) { + nodes { + ...Product + } + } + }`, }); // Transform Shopify product format into schema.org's compatible format diff --git a/shopify/loaders/ProductListingPage.ts b/shopify/loaders/ProductListingPage.ts index 9446d7b44..f6939a4f0 100644 --- a/shopify/loaders/ProductListingPage.ts +++ b/shopify/loaders/ProductListingPage.ts @@ -1,10 +1,12 @@ import type { ProductListingPage } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; +import { gql } from "../../utils/graphql.ts"; +import { fragment as productFragment } from "../utils/fragments/product.ts"; +import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; import { - Data, - query as productsQuery, - Variables, -} from "../utils/queries/products.ts"; + SearchProductsQuery, + SearchProductsQueryVariables, +} from "../utils/storefront.graphql.gen.ts"; import { toProduct } from "../utils/transform.ts"; export interface Props { @@ -35,10 +37,22 @@ const loader = async ( const query = props.query || url.searchParams.get("q") || ""; const page = Number(url.searchParams.get("page")) ?? 0; - // search products on Shopify. Feel free to change any of these parameters - const data = await storefront.query({ - query: productsQuery, + const data = await storefront.query< + SearchProductsQuery, + SearchProductsQueryVariables + >({ variables: { first: count, query: query }, + fragments: [productFragment, variantFragment], + query: gql`query SearchProducts($first: Int, $after: String, $query: String) { + products(first: $first, after: $after, query: $query) { + pageInfo { + hasNextPage + } + nodes { + ...Product + } + } + }`, }); // Transform Shopify product format into schema.org's compatible format diff --git a/shopify/loaders/cart.ts b/shopify/loaders/cart.ts index 3401c8527..bede9fd3a 100644 --- a/shopify/loaders/cart.ts +++ b/shopify/loaders/cart.ts @@ -1,36 +1,39 @@ +import { gql } from "../../utils/graphql.ts"; import { AppContext } from "../mod.ts"; import { getCartCookie, setCartCookie } from "../utils/cart.ts"; +import { fragment } from "../utils/fragments/cart.ts"; import { - Data as CartData, - query as getCart, - Variables as CartVariables, -} from "../utils/queries/cart.ts"; -import { - Data as CreateCartData, - query as createCart, - Variables as CreateVariablesData, -} from "../utils/queries/createCart.ts"; + CreateCartMutation, + CreateCartMutationVariables, + GetCartQuery, + GetCartQueryVariables, +} from "../utils/storefront.graphql.gen.ts"; const loader = async ( _props: unknown, req: Request, ctx: AppContext, -): Promise => { +): Promise => { const { storefront } = ctx; const maybeCartId = getCartCookie(req.headers); const cartId = maybeCartId || - await storefront.query({ - query: createCart, - }).then((data) => data.payload.cart.id); + await storefront.query({ + query: gql`mutation CreateCart { + payload: cartCreate { + cart { id } + } + }`, + }).then((data) => data.payload?.cart?.id); if (!cartId) { throw new Error("Missing cart id"); } - const cart = await storefront.query({ - query: getCart, + const cart = await storefront.query({ variables: { id: cartId }, + fragments: [fragment], + query: gql`query GetCart($id: ID!) { cart(id: $id) { ...Cart } }`, }).then((data) => data.cart); setCartCookie(ctx.response.headers, cartId); diff --git a/shopify/mod.ts b/shopify/mod.ts index 03b47f4ed..6aa79cec9 100644 --- a/shopify/mod.ts +++ b/shopify/mod.ts @@ -34,8 +34,8 @@ export interface State extends Props { export default function App(props: Props): App { const { storeName, storefrontAccessToken } = props; const storefront = createGraphqlClient({ - endpoint: `https://${storeName}.myshopify.com/api/2023-07/graphql.json`, fetcher: fetchSafe, + endpoint: `https://${storeName}.myshopify.com/api/2023-07/graphql.json`, headers: new Headers({ "Content-Type": "application/json", "X-Shopify-Storefront-Access-Token": storefrontAccessToken, diff --git a/shopify/utils/fragments/cart.ts b/shopify/utils/fragments/cart.ts index 638f14486..d80340e11 100644 --- a/shopify/utils/fragments/cart.ts +++ b/shopify/utils/fragments/cart.ts @@ -1,47 +1,7 @@ import { gql } from "../../../utils/graphql.ts"; -import type { Image, Money } from "../types.ts"; -export interface Item { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - product: { - title: string; - }; - image: Image; - price: Money; - }; - cost: { - totalAmount: Money; - subtotalAmount: Money; - amountPerQuantity: Money; - compareAtAmountPerQuantity: Money; - }; -} - -export interface Fragment { - id: string; - lines?: { - nodes: Item[]; - }; - checkoutUrl?: string; - cost?: { - subtotalAmount: Money; - totalAmount: Money; - checkoutChargeAmount: Money; - }; - discountCodes?: { - code: string; - applicable: boolean; - }[]; - discountAllocations?: { - discountedAmount: Money; - }; -} - -export const fragment = gql`on Cart { +export const fragment = gql` +fragment Cart on Cart { id checkoutUrl totalQuantity diff --git a/shopify/utils/fragments/product.ts b/shopify/utils/fragments/product.ts index 24ba32e2f..cacdec3ae 100644 --- a/shopify/utils/fragments/product.ts +++ b/shopify/utils/fragments/product.ts @@ -1,37 +1,7 @@ import { gql } from "../../../utils/graphql.ts"; -import { Image, Media, Option, PriceRange, SEO } from "../types.ts"; -import { - Fragment as Variant, - fragment as ProductVariantFragment, -} from "./productVariant.ts"; -export interface Fragment { - availableForSale: boolean; - createdAt: string; - description: string; - descriptionHtml: string; - featuredImage: Image; - handle: string; - id: string; - images: { nodes: Image[] }; - isGiftCard: boolean; - media: Media; - onlineStoreUrl: null; - options: Option[]; - priceRange: PriceRange; - productType: string; - publishedAt: string; - requiresSellingPlan: boolean; - seo: SEO; - tags: string[]; - title: string; - totalInventory: number; - updatedAt: string; - variants: { nodes: Variant[] }; - vendor: string; -} - -export const fragment = gql`on Product { +export const fragment = gql` +fragment Product on Product { availableForSale createdAt description @@ -87,7 +57,7 @@ export const fragment = gql`on Product { updatedAt variants(first: 10) { nodes { - ...${ProductVariantFragment} + ...ProductVariant } } vendor diff --git a/shopify/utils/fragments/productVariant.ts b/shopify/utils/fragments/productVariant.ts index c9eab64cc..0e2c8a4cc 100644 --- a/shopify/utils/fragments/productVariant.ts +++ b/shopify/utils/fragments/productVariant.ts @@ -1,31 +1,7 @@ import { gql } from "../../../utils/graphql.ts"; -import { - Image, - Price, - SelectedOption, - UnitPriceMeasurement, -} from "../types.ts"; -export interface Fragment { - availableForSale: boolean; - barcode: string; - compareAtPrice: Price | null; - currentlyNotInStock: boolean; - id: string; - image: Image; - price: Price; - quantityAvailable: number; - requiresShipping: boolean; - selectedOptions: SelectedOption[]; - sku: string; - title: string; - unitPrice: null; - unitPriceMeasurement: UnitPriceMeasurement; - weight: number; - weightUnit: string; -} - -export const fragment = gql`on ProductVariant { +export const fragment = gql` +fragment ProductVariant on ProductVariant { availableForSale barcode compareAtPrice { diff --git a/shopify/utils/queries/addItem.ts b/shopify/utils/queries/addItem.ts deleted file mode 100644 index d4e34f3a8..000000000 --- a/shopify/utils/queries/addItem.ts +++ /dev/null @@ -1,29 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import { - Fragment as CartFragment, - fragment as cartFragment, -} from "../fragments/cart.ts"; - -export const query = gql` -mutation add($cartId: ID!, $lines: [CartLineInput!]!) { - payload: cartLinesAdd(cartId: $cartId, lines: $lines) { - cart { ...${cartFragment} } - } -} -`; - -export interface Variables { - cartId: string; - lines: { - merchandiseId: string; - attributes?: Array<{ key: string; value: string }>; - quantity?: number; - sellingPlanId?: string; - }; -} - -export interface Data { - payload: { - cart: CartFragment; - }; -} diff --git a/shopify/utils/queries/cart.ts b/shopify/utils/queries/cart.ts deleted file mode 100644 index 9d28423a2..000000000 --- a/shopify/utils/queries/cart.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import type { Fragment } from "../fragments/cart.ts"; -import { fragment } from "../fragments/cart.ts"; - -export const query = gql` -query($id: ID!) { cart(id: $id) { ...${fragment} } } -`; - -export interface Variables { - id: string; -} - -export interface Data { - cart: Fragment; -} diff --git a/shopify/utils/queries/createCart.ts b/shopify/utils/queries/createCart.ts deleted file mode 100644 index 5ac79d2eb..000000000 --- a/shopify/utils/queries/createCart.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; - -export const query = gql` -mutation createCart { - payload: cartCreate { - cart { - id - } - } -} -`; - -export type Variables = never; - -export interface Data { - payload: { cart: { id: string } }; -} diff --git a/shopify/utils/queries/product.ts b/shopify/utils/queries/product.ts deleted file mode 100644 index f44928dce..000000000 --- a/shopify/utils/queries/product.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import { Fragment as Product, fragment } from "../fragments/product.ts"; - -export const query = gql` -query GetProduct($handle: String) { - product(handle: $handle) { ...${fragment} } -} -`; - -export interface Variables { - handle: string; -} - -export interface Data { - product: Product; -} diff --git a/shopify/utils/queries/products.ts b/shopify/utils/queries/products.ts deleted file mode 100644 index a39762d08..000000000 --- a/shopify/utils/queries/products.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import { Fragment as Product, fragment } from "../fragments/product.ts"; - -export const query = gql` -query GetProducts($first: Int, $after: String, $query: String) { - products(first: $first, after: $after, query: $query) { - pageInfo { - hasNextPage - } - nodes { - ...${fragment} - } - } -} -`; - -export interface Variables { - first: number; - query: string; -} - -export interface Data { - products: { - pageInfo: { hasNextPage: boolean }; - nodes: Product[]; - }; -} diff --git a/shopify/utils/queries/updateCart.ts b/shopify/utils/queries/updateCart.ts deleted file mode 100644 index a4f19cb33..000000000 --- a/shopify/utils/queries/updateCart.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import { - Fragment as CartFragment, - fragment as cartFragment, -} from "../fragments/cart.ts"; - -export const query = gql` -mutation update($cartId: ID!, $lines: [CartLineUpdateInput!]!) { - payload: cartLinesUpdate(cartId: $cartId, lines: $lines) { - cart { ...${cartFragment} } - } -} -`; - -export interface Variables { - cartId: string; - lines: Array<{ id: string; quantity?: number }>; -} - -export interface Data { - payload: { - cart: CartFragment; - }; -} diff --git a/shopify/utils/queries/updateCoupon.ts b/shopify/utils/queries/updateCoupon.ts index a04973c88..6f3a7a413 100644 --- a/shopify/utils/queries/updateCoupon.ts +++ b/shopify/utils/queries/updateCoupon.ts @@ -1,13 +1,12 @@ import { gql } from "../../../utils/graphql.ts"; import { - Fragment as CartFragment, - fragment as cartFragment, + Fragment as CartFragment } from "../fragments/cart.ts"; export const query = gql` mutation addCoupon($cartId: ID!, $discountCodes: [String!]!) { payload: cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) { - cart { ...${cartFragment} } + cart { ...Cart } userErrors { field message diff --git a/shopify/utils/storefront.graphql.gen.ts b/shopify/utils/storefront.graphql.gen.ts index 6820a62fd..3a59a56cb 100644 --- a/shopify/utils/storefront.graphql.gen.ts +++ b/shopify/utils/storefront.graphql.gen.ts @@ -7685,7 +7685,69 @@ export type WeightUnit = /** 1 pound equals 16 ounces. */ | 'POUNDS'; +export type AddItemToCartMutationVariables = Exact<{ + cartId: Scalars['ID']['input']; + lines: Array | CartLineInput; +}>; + + +export type AddItemToCartMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; + +export type AddCouponMutationVariables = Exact<{ + cartId: Scalars['ID']['input']; + discountCodes: Array | Scalars['String']['input']; +}>; + + +export type AddCouponMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null, userErrors: Array<{ field?: Array | null, message: string }> } | null }; + +export type UpdateItemsMutationVariables = Exact<{ + cartId: Scalars['ID']['input']; + lines: Array | CartLineUpdateInput; +}>; + + +export type UpdateItemsMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; + +export type GetProductQueryVariables = Exact<{ + handle?: InputMaybe; +}>; + + +export type GetProductQuery = { product?: { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } } | null }; + +export type ListProductsQueryVariables = Exact<{ + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; +}>; + + +export type ListProductsQuery = { products: { nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; + +export type SearchProductsQueryVariables = Exact<{ + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; +}>; + + +export type SearchProductsQuery = { products: { pageInfo: { hasNextPage: boolean }, nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; + export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; export type CreateCartMutation = { payload?: { cart?: { id: string } | null } | null }; + +export type GetCartQueryVariables = Exact<{ + id: Scalars['ID']['input']; +}>; + + +export type GetCartQuery = { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null }; + +export type CartFragment = { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> }; + +export type ProductFragment = { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }; + +export type ProductVariantFragment = { availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }; diff --git a/shopify/utils/transform.ts b/shopify/utils/transform.ts index eaef491b8..3de607d28 100644 --- a/shopify/utils/transform.ts +++ b/shopify/utils/transform.ts @@ -6,8 +6,10 @@ import type { UnitPriceSpecification, } from "../../commerce/types.ts"; import { DEFAULT_IMAGE } from "../../commerce/utils/constants.ts"; -import { Fragment as ProductShopify } from "./fragments/product.ts"; -import { Fragment as SkuShopify } from "./fragments/productVariant.ts"; +import { + ProductFragment as ProductShopify, + ProductVariantFragment as SkuShopify, +} from "./storefront.graphql.gen.ts"; import { SelectedOption as SelectedOptionShopify } from "./types.ts"; const getPath = ({ handle }: ProductShopify, sku?: SkuShopify) => @@ -117,7 +119,7 @@ export const toProduct = ( name: sku.title, description, sku: productID, - gtin: barcode, + gtin: barcode ?? undefined, brand: { "@type": "Brand", name: vendor }, releaseDate: createdAt, additionalProperty, @@ -136,8 +138,8 @@ export const toProduct = ( }, image: skuImages?.map((img) => ({ "@type": "ImageObject", - alternateName: img.altText ?? "", - url: img.url, + alternateName: img?.altText ?? "", + url: img?.url, })) ?? [DEFAULT_IMAGE], offers: { "@type": "AggregateOffer", @@ -153,7 +155,7 @@ export const toProduct = ( availability: availableForSale ? "https://schema.org/InStock" : "https://schema.org/OutOfStock", - inventoryLevel: { value: quantityAvailable }, + inventoryLevel: { value: quantityAvailable ?? 0 }, priceSpecification: priceSpec, }], }, diff --git a/vnda/utils/constants.ts b/vnda/utils/constants.ts new file mode 100644 index 000000000..e69de29bb From 1bb64c10734cf0575e3974bdc36beb596f6b8774 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 09:06:51 -0300 Subject: [PATCH 04/21] make lint pass --- scripts/start.ts | 26 +- shopify/actions/cart/addItems.ts | 5 +- shopify/actions/cart/updateCoupons.ts | 5 +- shopify/actions/cart/updateItems.ts | 5 +- shopify/hooks/context.ts | 8 +- shopify/hooks/useCart.ts | 43 +- shopify/loaders/ProductListingPage.ts | 3 +- shopify/utils/queries/updateCoupon.ts | 25 - shopify/utils/storefront.graphql.gen.ts | 4957 +++++++++-------- shopify/utils/storefront.graphql.json | 2 +- utils/http.ts | 1 + .../loaders/productDetailsPage.ts | 2 +- verified-reviews/loaders/productList.ts | 4 +- vnda/hooks/useCart.ts | 1 + vnda/utils/openapi/vnda.openapi.gen.ts | 3 + vnda/utils/openapi/vnda.openapi.json | 2 +- vnda/utils/transform.ts | 1 + vtex/hooks/context.ts | 2 +- vtex/hooks/useCart.ts | 61 +- vtex/hooks/useWishlist.ts | 34 +- wake/hooks/useCart.ts | 1 + wake/utils/graphql/storefront.graphql.gen.ts | 3353 ++++++----- wake/utils/graphql/storefront.graphql.json | 2 +- wake/utils/openapi/wake.openapi.gen.ts | 3 + wake/utils/openapi/wake.openapi.json | 2 +- 25 files changed, 4766 insertions(+), 3785 deletions(-) delete mode 100644 shopify/utils/queries/updateCoupon.ts diff --git a/scripts/start.ts b/scripts/start.ts index d006ed853..0aed54525 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -1,3 +1,4 @@ +// deno-lint-ignore-file no-explicit-any import "npm:@graphql-codegen/typescript"; import "npm:@graphql-codegen/typescript-operations"; @@ -26,6 +27,15 @@ for await (const entry of walk(".")) { } } +const BANNER = ` +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno task start +// +`; + const toOutfile = (path: string) => path.replace(".json", ".gen.ts"); // transforms: /a/{b}/c => /a/:b/c @@ -164,12 +174,7 @@ const generateOpenAPI = async () => { unknownAny: false, additionalProperties: false, format: false, - bannerComment: ` -// DO NOT EDIT. This file is generated by deco. -// This file SHOULD be checked into source version control. -// To generate this file: deno task start - -`, + bannerComment: BANNER, }, ); @@ -185,6 +190,7 @@ const generateGraphQL = async () => { for (const path of allGraphqlPaths) { const [folder, base] = [dirname(path), basename(path)]; const [appEntrypoint, ...tail] = folder.split("/"); + const outfile = toOutfile(join(...tail, base)); console.info(`Generating GraphQL types for specs at ${folder}`); const config: CodegenConfig = { @@ -192,7 +198,7 @@ const generateGraphQL = async () => { schema: join(Deno.cwd(), path), documents: [`./**/*.ts`], generates: { - [toOutfile(join(...tail, base))]: { + [outfile]: { plugins: [ "typescript", "typescript-operations", @@ -206,6 +212,12 @@ const generateGraphQL = async () => { }; await generate({ ...config, cwd: appEntrypoint }, true); + + const o = join(appEntrypoint, outfile); + await Deno.writeTextFile( + o, + `${BANNER.trim()}\n${await Deno.readTextFile(o)}`, + ); } }; diff --git a/shopify/actions/cart/addItems.ts b/shopify/actions/cart/addItems.ts index fcf098df5..24cc641b0 100644 --- a/shopify/actions/cart/addItems.ts +++ b/shopify/actions/cart/addItems.ts @@ -5,6 +5,7 @@ import { fragment } from "../../utils/fragments/cart.ts"; import { AddItemToCartMutation, AddItemToCartMutationVariables, + CartFragment, } from "../../utils/storefront.graphql.gen.ts"; type UpdateLineProps = { @@ -20,7 +21,7 @@ const action = async ( { lines }: UpdateLineProps, req: Request, ctx: AppContext, -): Promise["cart"]> => { +): Promise => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -43,7 +44,7 @@ const action = async ( setCartCookie(ctx.response.headers, cartId); - return payload?.cart; + return payload?.cart ?? null; }; export default action; diff --git a/shopify/actions/cart/updateCoupons.ts b/shopify/actions/cart/updateCoupons.ts index ce4d25ff6..7cf6655eb 100644 --- a/shopify/actions/cart/updateCoupons.ts +++ b/shopify/actions/cart/updateCoupons.ts @@ -5,6 +5,7 @@ import { fragment } from "../../utils/fragments/cart.ts"; import { AddCouponMutation, AddCouponMutationVariables, + CartFragment, } from "../../utils/storefront.graphql.gen.ts"; type AddCouponProps = { @@ -15,7 +16,7 @@ const action = async ( props: AddCouponProps, req: Request, ctx: AppContext, -): Promise["cart"]> => { +): Promise => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -42,7 +43,7 @@ const action = async ( setCartCookie(ctx.response.headers, cartId); - return payload?.cart; + return payload?.cart ?? null; }; export default action; diff --git a/shopify/actions/cart/updateItems.ts b/shopify/actions/cart/updateItems.ts index 1c7f722bf..3cf947814 100644 --- a/shopify/actions/cart/updateItems.ts +++ b/shopify/actions/cart/updateItems.ts @@ -3,6 +3,7 @@ import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; import { fragment } from "../../utils/fragments/cart.ts"; import { + CartFragment, UpdateItemsMutation, UpdateItemsMutationVariables, } from "../../utils/storefront.graphql.gen.ts"; @@ -18,7 +19,7 @@ const action = async ( { lines }: UpdateLineProps, req: Request, ctx: AppContext, -): Promise["cart"]> => { +): Promise => { const { storefront } = ctx; const cartId = getCartCookie(req.headers); @@ -42,7 +43,7 @@ const action = async ( setCartCookie(ctx.response.headers, cartId); - return payload?.cart; + return payload?.cart ?? null; }; export default action; diff --git a/shopify/hooks/context.ts b/shopify/hooks/context.ts index d80cb1cd2..72ddb9aa8 100644 --- a/shopify/hooks/context.ts +++ b/shopify/hooks/context.ts @@ -1,15 +1,15 @@ import { IS_BROWSER } from "$fresh/runtime.ts"; import { signal } from "@preact/signals"; import { invoke } from "../runtime.ts"; -import { Fragment as Cart } from "../utils/fragments/cart.ts"; +import type { CartFragment } from "../utils/storefront.graphql.gen.ts"; -interface Context { - cart: Cart; +export interface Context { + cart: CartFragment | null; } const loading = signal(true); const context = { - cart: signal(null), + cart: signal(null), }; let queue = Promise.resolve(); diff --git a/shopify/hooks/useCart.ts b/shopify/hooks/useCart.ts index 9da24b020..6103e7848 100644 --- a/shopify/hooks/useCart.ts +++ b/shopify/hooks/useCart.ts @@ -1,12 +1,12 @@ -import { InvocationFuncFor } from "deco/clients/withManifest.ts"; +// deno-lint-ignore-file no-explicit-any import type { AnalyticsItem } from "../../commerce/types.ts"; -import { Manifest } from "../manifest.gen.ts"; +import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; -import { Fragment as Cart, Item } from "../utils/fragments/cart.ts"; -import { state as storeState } from "./context.ts"; +import type { CartFragment } from "../utils/storefront.graphql.gen.ts"; +import { Context, state as storeState } from "./context.ts"; export const itemToAnalyticsItem = ( - item: Item & { quantity: number }, + item: CartFragment["lines"]["nodes"][number] & { quantity: number }, index: number, ): AnalyticsItem => ({ item_id: item.id, @@ -23,30 +23,25 @@ export const itemToAnalyticsItem = ( const { cart, loading } = storeState; -type PropsOf = T extends (props: infer P, r: any, ctx: any) => any ? P - : T extends (props: infer P, r: any) => any ? P - : T extends (props: infer P) => any ? P - : never; +type EnqueuableActions< + K extends keyof Manifest["actions"], +> = Manifest["actions"][K]["default"] extends + (...args: any[]) => Promise ? K : never; -type Actions = - | "shopify/actions/cart/addItems.ts" - | "shopify/actions/cart/updateItems.ts" - | "shopify/actions/cart/updateCoupons.ts"; - -const action = - (key: Actions) => (props: PropsOf>) => - storeState.enqueue((signal) => - invoke({ cart: { key, props } }, { signal }) satisfies Promise< - { cart: Cart } - > - ); +const enqueue = < + K extends keyof Manifest["actions"], +>(key: EnqueuableActions) => +(props: Parameters[0]) => + storeState.enqueue((signal) => + invoke({ cart: { key, props } } as any, { signal }) as any + ); const state = { cart, loading, - addItems: action("shopify/actions/cart/addItems.ts"), - updateItems: action("shopify/actions/cart/updateItems.ts"), - addCouponsToCart: action("shopify/actions/cart/updateCoupons.ts"), + addItems: enqueue("shopify/actions/cart/addItems.ts"), + updateItems: enqueue("shopify/actions/cart/updateItems.ts"), + addCouponsToCart: enqueue("shopify/actions/cart/updateCoupons.ts"), }; export const useCart = () => state; diff --git a/shopify/loaders/ProductListingPage.ts b/shopify/loaders/ProductListingPage.ts index f6939a4f0..509ee19ca 100644 --- a/shopify/loaders/ProductListingPage.ts +++ b/shopify/loaders/ProductListingPage.ts @@ -43,7 +43,8 @@ const loader = async ( >({ variables: { first: count, query: query }, fragments: [productFragment, variantFragment], - query: gql`query SearchProducts($first: Int, $after: String, $query: String) { + query: + gql`query SearchProducts($first: Int, $after: String, $query: String) { products(first: $first, after: $after, query: $query) { pageInfo { hasNextPage diff --git a/shopify/utils/queries/updateCoupon.ts b/shopify/utils/queries/updateCoupon.ts deleted file mode 100644 index 6f3a7a413..000000000 --- a/shopify/utils/queries/updateCoupon.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; -import { - Fragment as CartFragment -} from "../fragments/cart.ts"; - -export const query = gql` -mutation addCoupon($cartId: ID!, $discountCodes: [String!]!) { - payload: cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) { - cart { ...Cart } - userErrors { - field - message - } - } -} -`; - -export interface Variables { - cartId: string; - discountCodes: string[]; -} - -export interface Data { - payload: { cart: CartFragment }; -} diff --git a/shopify/utils/storefront.graphql.gen.ts b/shopify/utils/storefront.graphql.gen.ts index 3a59a56cb..90d02748f 100644 --- a/shopify/utils/storefront.graphql.gen.ts +++ b/shopify/utils/storefront.graphql.gen.ts @@ -1,79 +1,92 @@ +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno task start +// export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { [K in keyof T]: T[K] }; -export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; -export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; -export type MakeEmpty = { [_ in K]?: never }; -export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +export type Exact = { + [K in keyof T]: T[K]; +}; +export type MakeOptional = + & Omit + & { [SubKey in K]?: Maybe }; +export type MakeMaybe = + & Omit + & { [SubKey in K]: Maybe }; +export type MakeEmpty = + { [_ in K]?: never }; +export type Incremental = + | T + | { + [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; + }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string; } - String: { input: string; output: string; } - Boolean: { input: boolean; output: boolean; } - Int: { input: number; output: number; } - Float: { input: number; output: number; } - Color: { input: any; output: any; } - DateTime: { input: any; output: any; } - Decimal: { input: any; output: any; } - HTML: { input: any; output: any; } - JSON: { input: any; output: any; } - URL: { input: any; output: any; } - UnsignedInt64: { input: any; output: any; } + ID: { input: string; output: string }; + String: { input: string; output: string }; + Boolean: { input: boolean; output: boolean }; + Int: { input: number; output: number }; + Float: { input: number; output: number }; + Color: { input: any; output: any }; + DateTime: { input: any; output: any }; + Decimal: { input: any; output: any }; + HTML: { input: any; output: any }; + JSON: { input: any; output: any }; + URL: { input: any; output: any }; + UnsignedInt64: { input: any; output: any }; }; /** * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). * Versions are commonly referred to by their handle (for example, `2021-10`). - * */ export type ApiVersion = { /** The human-readable name of the version. */ - displayName: Scalars['String']['output']; + displayName: Scalars["String"]["output"]; /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** * Whether the version is actively supported by Shopify. Supported API versions * are guaranteed to be stable. Unsupported API versions include unstable, * release candidate, and end-of-life versions that are marked as unsupported. * For more information, refer to * [Versioning](https://shopify.dev/api/usage/versioning). - * */ - supported: Scalars['Boolean']['output']; + supported: Scalars["Boolean"]["output"]; }; /** * The input fields for submitting Apple Pay payment method information for checkout. - * */ export type ApplePayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** The data for the Apple Pay wallet. */ - data: Scalars['String']['input']; + data: Scalars["String"]["input"]; /** The header data for the Apple Pay wallet. */ header: ApplePayWalletHeaderInput; /** The last digits of the card used to create the payment. */ - lastDigits?: InputMaybe; + lastDigits?: InputMaybe; /** The signature for the Apple Pay wallet. */ - signature: Scalars['String']['input']; + signature: Scalars["String"]["input"]; /** The version for the Apple Pay wallet. */ - version: Scalars['String']['input']; + version: Scalars["String"]["input"]; }; /** * The input fields for submitting wallet payment method information for checkout. - * */ export type ApplePayWalletHeaderInput = { /** The application data for the Apple Pay wallet. */ - applicationData?: InputMaybe; + applicationData?: InputMaybe; /** The ephemeral public key for the Apple Pay wallet. */ - ephemeralPublicKey: Scalars['String']['input']; + ephemeralPublicKey: Scalars["String"]["input"]; /** The public key hash for the Apple Pay wallet. */ - publicKeyHash: Scalars['String']['input']; + publicKeyHash: Scalars["String"]["input"]; /** The transaction ID for the Apple Pay wallet. */ - transactionId: Scalars['String']['input']; + transactionId: Scalars["String"]["input"]; }; /** Details about the gift card used on the checkout. */ @@ -93,91 +106,90 @@ export type AppliedGiftCard = Node & { */ balanceV2: MoneyV2; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The last characters of the gift card. */ - lastCharacters: Scalars['String']['output']; + lastCharacters: Scalars["String"]["output"]; /** The amount that was applied to the checkout in its currency. */ presentmentAmountUsed: MoneyV2; }; /** An article in an online store blog. */ -export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** - * The article's author. - * @deprecated Use `authorV2` instead. - */ - author: ArticleAuthor; - /** The article's author. */ - authorV2?: Maybe; - /** The blog that the article belongs to. */ - blog: Blog; - /** List of comments posted on the article. */ - comments: CommentConnection; - /** Stripped content of the article, single line with HTML tags removed. */ - content: Scalars['String']['output']; - /** The content of the article, complete with HTML formatting. */ - contentHtml: Scalars['HTML']['output']; - /** Stripped excerpt of the article, single line with HTML tags removed. */ - excerpt?: Maybe; - /** The excerpt of the article, complete with HTML formatting. */ - excerptHtml?: Maybe; - /** A human-friendly unique string for the Article automatically generated from its title. */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** The image associated with the article. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** The date and time when the article was published. */ - publishedAt: Scalars['DateTime']['output']; - /** The article’s SEO information. */ - seo?: Maybe; - /** - * A categorization that a article can be tagged with. - * - */ - tags: Array; - /** The article’s name. */ - title: Scalars['String']['output']; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; -}; - +export type Article = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** + * The article's author. + * @deprecated Use `authorV2` instead. + */ + author: ArticleAuthor; + /** The article's author. */ + authorV2?: Maybe; + /** The blog that the article belongs to. */ + blog: Blog; + /** List of comments posted on the article. */ + comments: CommentConnection; + /** Stripped content of the article, single line with HTML tags removed. */ + content: Scalars["String"]["output"]; + /** The content of the article, complete with HTML formatting. */ + contentHtml: Scalars["HTML"]["output"]; + /** Stripped excerpt of the article, single line with HTML tags removed. */ + excerpt?: Maybe; + /** The excerpt of the article, complete with HTML formatting. */ + excerptHtml?: Maybe; + /** A human-friendly unique string for the Article automatically generated from its title. */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated with the article. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The date and time when the article was published. */ + publishedAt: Scalars["DateTime"]["output"]; + /** The article’s SEO information. */ + seo?: Maybe; + /** + * A categorization that a article can be tagged with. + */ + tags: Array; + /** The article’s name. */ + title: Scalars["String"]["output"]; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + }; /** An article in an online store blog. */ export type ArticleCommentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleExcerptArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An article in an online store blog. */ export type ArticleMetafieldsArgs = { identifiers: Array; @@ -186,20 +198,19 @@ export type ArticleMetafieldsArgs = { /** The author of an article. */ export type ArticleAuthor = { /** The author's bio. */ - bio?: Maybe; + bio?: Maybe; /** The author’s email. */ - email: Scalars['String']['output']; + email: Scalars["String"]["output"]; /** The author's first name. */ - firstName: Scalars['String']['output']; + firstName: Scalars["String"]["output"]; /** The author's last name. */ - lastName: Scalars['String']['output']; + lastName: Scalars["String"]["output"]; /** The author's full name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple Articles. - * */ export type ArticleConnection = { /** A list of edges. */ @@ -212,11 +223,10 @@ export type ArticleConnection = { /** * An auto-generated type which holds one Article and a cursor during pagination. - * */ export type ArticleEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ArticleEdge. */ node: Article; }; @@ -224,43 +234,41 @@ export type ArticleEdge = { /** The set of valid sort keys for the Article query. */ export type ArticleSortKeys = /** Sort by the `author` value. */ - | 'AUTHOR' + | "AUTHOR" /** Sort by the `blog_title` value. */ - | 'BLOG_TITLE' + | "BLOG_TITLE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `published_at` value. */ - | 'PUBLISHED_AT' + | "PUBLISHED_AT" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** Represents a generic custom attribute. */ export type Attribute = { /** Key or name of the attribute. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** Value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** The input fields for an attribute. */ export type AttributeInput = { /** Key or name of the attribute. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** Value of the attribute. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** * Automatic discount applications capture the intentions of a discount that was automatically applied. - * */ export type AutomaticDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -270,7 +278,7 @@ export type AutomaticDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -281,9 +289,8 @@ export type AvailableShippingRates = { * Whether or not the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. - * */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** The fetched shipping rates. `null` until the `ready` field is `true`. */ shippingRates?: Maybe>; }; @@ -293,7 +300,6 @@ export type AvailableShippingRates = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type BaseCartLine = { /** An attribute associated with the cart line. */ @@ -310,30 +316,27 @@ export type BaseCartLine = { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** * An object with an ID field to support global identification, in accordance with the * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type BaseCartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** * An auto-generated type for paginating through multiple BaseCartLines. - * */ export type BaseCartLineConnection = { /** A list of edges. */ @@ -346,11 +349,10 @@ export type BaseCartLineConnection = { /** * An auto-generated type which holds one BaseCartLine and a cursor during pagination. - * */ export type BaseCartLineEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of BaseCartLineEdge. */ node: BaseCartLine; }; @@ -365,49 +367,44 @@ export type Blog = HasMetafields & Node & OnlineStorePublishable & { authors: Array; /** * A human-friendly unique string for the Blog automatically generated from its title. - * */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The blog's SEO information. */ seo?: Maybe; /** The blogs’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; - /** An online store blog. */ export type BlogArticleByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** An online store blog. */ export type BlogArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** An online store blog. */ export type BlogMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An online store blog. */ export type BlogMetafieldsArgs = { identifiers: Array; @@ -415,7 +412,6 @@ export type BlogMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Blogs. - * */ export type BlogConnection = { /** A list of edges. */ @@ -428,11 +424,10 @@ export type BlogConnection = { /** * An auto-generated type which holds one Blog and a cursor during pagination. - * */ export type BlogEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of BlogEdge. */ node: Blog; }; @@ -440,21 +435,19 @@ export type BlogEdge = { /** The set of valid sort keys for the Blog query. */ export type BlogSortKeys = /** Sort by the `handle` value. */ - | 'HANDLE' + | "HANDLE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** * The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets). - * */ export type Brand = { /** The colors of the store's brand. */ @@ -464,27 +457,25 @@ export type Brand = { /** The store's default logo. */ logo?: Maybe; /** The store's short description. */ - shortDescription?: Maybe; + shortDescription?: Maybe; /** The store's slogan. */ - slogan?: Maybe; + slogan?: Maybe; /** The store's preferred logo for square UI elements. */ squareLogo?: Maybe; }; /** * A group of related colors for the shop's brand. - * */ export type BrandColorGroup = { /** The background color. */ - background?: Maybe; + background?: Maybe; /** The foreground color. */ - foreground?: Maybe; + foreground?: Maybe; }; /** * The colors of the shop's brand. - * */ export type BrandColors = { /** The shop's primary brand colors. */ @@ -496,24 +487,23 @@ export type BrandColors = { /** Card brand, such as Visa or Mastercard, which can be used for payments. */ export type CardBrand = /** American Express. */ - | 'AMERICAN_EXPRESS' + | "AMERICAN_EXPRESS" /** Diners Club. */ - | 'DINERS_CLUB' + | "DINERS_CLUB" /** Discover. */ - | 'DISCOVER' + | "DISCOVER" /** JCB. */ - | 'JCB' + | "JCB" /** Mastercard. */ - | 'MASTERCARD' + | "MASTERCARD" /** Visa. */ - | 'VISA'; + | "VISA"; /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type Cart = HasMetafields & Node & { /** An attribute associated with the cart. */ @@ -523,20 +513,18 @@ export type Cart = HasMetafields & Node & { /** Information about the buyer that's interacting with the cart. */ buyerIdentity: CartBuyerIdentity; /** The URL of the checkout for the cart. */ - checkoutUrl: Scalars['URL']['output']; + checkoutUrl: Scalars["URL"]["output"]; /** * The estimated costs that the buyer will pay at checkout. The costs are subject * to change and changes will be reflected at checkout. The `cost` field uses the * `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ cost: CartCost; /** The date and time when the cart was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** * The delivery groups available for the cart, based on the buyer identity default * delivery address preference or the default address of the logged-in customer. - * */ deliveryGroups: CartDeliveryGroupConnection; /** The discounts that have been applied to the entire cart. */ @@ -553,7 +541,7 @@ export type Cart = HasMetafields & Node & { */ estimatedCost: CartEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** A list of lines containing information about the items the customer intends to purchase. */ lines: BaseCartLineConnection; /** Returns a metafield found by namespace and key. */ @@ -561,77 +549,67 @@ export type Cart = HasMetafields & Node & { /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A note that's associated with the cart. For example, the note can be a personalized message to the buyer. */ - note?: Maybe; + note?: Maybe; /** The total number of items in the cart. */ - totalQuantity: Scalars['Int']['output']; + totalQuantity: Scalars["Int"]["output"]; /** The date and time when the cart was updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartDeliveryGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartMetafieldsArgs = { identifiers: Array; @@ -650,7 +628,7 @@ export type CartAutomaticDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Represents information about the buyer that is interacting with the cart. */ @@ -663,19 +641,17 @@ export type CartBuyerIdentity = { * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. - * */ deliveryAddressPreferences: Array; /** The email address of the buyer that's interacting with the cart. */ - email?: Maybe; + email?: Maybe; /** The phone number of the buyer that's interacting with the cart. */ - phone?: Maybe; + phone?: Maybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. - * */ - walletPreferences: Array; + walletPreferences: Array; }; /** @@ -683,31 +659,28 @@ export type CartBuyerIdentity = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. - * */ export type CartBuyerIdentityInput = { /** The country where the buyer is located. */ countryCode?: InputMaybe; /** The access token used to identify the customer associated with the cart. */ - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; /** * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. - * */ deliveryAddressPreferences?: InputMaybe>; /** The email address of the buyer that is interacting with the cart. */ - email?: InputMaybe; + email?: InputMaybe; /** The phone number of the buyer that is interacting with the cart. */ - phone?: InputMaybe; + phone?: InputMaybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. * Accepted value: `["shop_pay"]`. - * */ - walletPreferences?: InputMaybe>; + walletPreferences?: InputMaybe>; }; /** Return type for `cartBuyerIdentityUpdate` mutation. */ @@ -720,20 +693,17 @@ export type CartBuyerIdentityUpdatePayload = { /** * Represents how credit card details are provided for a direct payment. - * */ -export type CartCardSource = - /** +export type CartCardSource = /** * The credit card was provided by a third party and vaulted on their system. * Using this value requires a separate permission from Shopify. - * */ - | 'SAVED_CREDIT_CARD'; + "SAVED_CREDIT_CARD"; /** The discount that has been applied to the cart line using a discount code. */ export type CartCodeDiscountAllocation = CartDiscountAllocation & { /** The code used to apply the discount. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; }; @@ -746,45 +716,48 @@ export type CartCompletionActionRequired = { /** The action required to complete the cart completion attempt. */ action?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; }; /** The result of a cart completion attempt. */ -export type CartCompletionAttemptResult = CartCompletionActionRequired | CartCompletionFailed | CartCompletionProcessing | CartCompletionSuccess; +export type CartCompletionAttemptResult = + | CartCompletionActionRequired + | CartCompletionFailed + | CartCompletionProcessing + | CartCompletionSuccess; /** A failed completion to checkout a cart. */ export type CartCompletionFailed = { /** The errors that caused the checkout to fail. */ errors: Array; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; }; /** A cart checkout completion that's still processing. */ export type CartCompletionProcessing = { /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** The number of milliseconds to wait before polling again. */ - pollDelay: Scalars['Int']['output']; + pollDelay: Scalars["Int"]["output"]; }; /** A successful completion to checkout a cart and a created order. */ export type CartCompletionSuccess = { /** The date and time when the job completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** The ID of the order that's created in Shopify. */ - orderId: Scalars['ID']['output']; + orderId: Scalars["ID"]["output"]; /** The URL of the order confirmation in Shopify. */ - orderUrl: Scalars['URL']['output']; + orderUrl: Scalars["URL"]["output"]; }; /** * The costs that the buyer will pay at checkout. * The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ export type CartCost = { /** @@ -792,25 +765,24 @@ export type CartCost = { * checkout. The checkout charge amount doesn't include any deferred payments * that'll be paid at a later date. If the cart has no deferred payments, then * the checkout charge amount is equivalent to `subtotalAmount`. - * */ checkoutChargeAmount: MoneyV2; /** The amount, before taxes and cart-level discounts, for the customer to pay. */ subtotalAmount: MoneyV2; /** Whether the subtotal amount is estimated. */ - subtotalAmountEstimated: Scalars['Boolean']['output']; + subtotalAmountEstimated: Scalars["Boolean"]["output"]; /** The total amount for the customer to pay. */ totalAmount: MoneyV2; /** Whether the total amount is estimated. */ - totalAmountEstimated: Scalars['Boolean']['output']; + totalAmountEstimated: Scalars["Boolean"]["output"]; /** The duty amount for the customer to pay at checkout. */ totalDutyAmount?: Maybe; /** Whether the total duty amount is estimated. */ - totalDutyAmountEstimated: Scalars['Boolean']['output']; + totalDutyAmountEstimated: Scalars["Boolean"]["output"]; /** The tax amount for the customer to pay at checkout. */ totalTaxAmount?: Maybe; /** Whether the total tax amount is estimated. */ - totalTaxAmountEstimated: Scalars['Boolean']['output']; + totalTaxAmountEstimated: Scalars["Boolean"]["output"]; }; /** Return type for `cartCreate` mutation. */ @@ -826,7 +798,7 @@ export type CartCustomDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Information about the options available for one or more line items to be delivered to a specific address. */ @@ -838,24 +810,22 @@ export type CartDeliveryGroup = { /** The delivery options available for the delivery group. */ deliveryOptions: Array; /** The ID for the delivery group. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The selected delivery option for the delivery group. */ selectedDeliveryOption?: Maybe; }; - /** Information about the options available for one or more line items to be delivered to a specific address. */ export type CartDeliveryGroupCartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple CartDeliveryGroups. - * */ export type CartDeliveryGroupConnection = { /** A list of edges. */ @@ -868,11 +838,10 @@ export type CartDeliveryGroupConnection = { /** * An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination. - * */ export type CartDeliveryGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CartDeliveryGroupEdge. */ node: CartDeliveryGroup; }; @@ -880,22 +849,21 @@ export type CartDeliveryGroupEdge = { /** Information about a delivery option. */ export type CartDeliveryOption = { /** The code of the delivery option. */ - code?: Maybe; + code?: Maybe; /** The method for the delivery option. */ deliveryMethodType: DeliveryMethodType; /** The description of the delivery option. */ - description?: Maybe; + description?: Maybe; /** The estimated cost for the delivery option. */ estimatedCost: MoneyV2; /** The unique identifier of the delivery option. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** The title of the delivery option. */ - title?: Maybe; + title?: Maybe; }; /** * The input fields for submitting direct payment method information for checkout. - * */ export type CartDirectPaymentMethodInput = { /** The customer's billing address. */ @@ -903,7 +871,7 @@ export type CartDirectPaymentMethodInput = { /** The source of the credit card payment. */ cardSource?: InputMaybe; /** The session ID for the direct payment method used to create the payment. */ - sessionId: Scalars['String']['input']; + sessionId: Scalars["String"]["input"]; }; /** The discounts that have been applied to the cart line. */ @@ -915,9 +883,9 @@ export type CartDiscountAllocation = { /** The discount codes applied to the cart. */ export type CartDiscountCode = { /** Whether the discount code is applicable to the cart's current contents. */ - applicable: Scalars['Boolean']['output']; + applicable: Scalars["Boolean"]["output"]; /** The code for the discount. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; }; /** Return type for `cartDiscountCodesUpdate` mutation. */ @@ -931,27 +899,27 @@ export type CartDiscountCodesUpdatePayload = { /** Possible error codes that can be returned by `CartUserError`. */ export type CartErrorCode = /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Delivery group was not found in cart. */ - | 'INVALID_DELIVERY_GROUP' + | "INVALID_DELIVERY_GROUP" /** Delivery option was not valid. */ - | 'INVALID_DELIVERY_OPTION' + | "INVALID_DELIVERY_OPTION" /** Merchandise line was not found in cart. */ - | 'INVALID_MERCHANDISE_LINE' + | "INVALID_MERCHANDISE_LINE" /** The metafields were not valid. */ - | 'INVALID_METAFIELDS' + | "INVALID_METAFIELDS" /** The payment wasn't valid. */ - | 'INVALID_PAYMENT' + | "INVALID_PAYMENT" /** Cannot update payment on an empty cart */ - | 'INVALID_PAYMENT_EMPTY_CART' + | "INVALID_PAYMENT_EMPTY_CART" /** The input value should be less than the maximum value allowed. */ - | 'LESS_THAN' + | "LESS_THAN" /** Missing discount code. */ - | 'MISSING_DISCOUNT_CODE' + | "MISSING_DISCOUNT_CODE" /** Missing note. */ - | 'MISSING_NOTE' + | "MISSING_NOTE" /** The payment method is not supported. */ - | 'PAYMENT_METHOD_NOT_SUPPORTED'; + | "PAYMENT_METHOD_NOT_SUPPORTED"; /** * The estimated costs that the buyer will pay at checkout. @@ -959,7 +927,6 @@ export type CartErrorCode = * [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) * to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ export type CartEstimatedCost = { /** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`. */ @@ -976,7 +943,6 @@ export type CartEstimatedCost = { /** * The input fields for submitting a billing address without a selected payment method. - * */ export type CartFreePaymentMethodInput = { /** The customer's billing address. */ @@ -991,40 +957,35 @@ export type CartInput = { * The customer associated with the cart. Used to determine [international pricing] * (https://shopify.dev/custom-storefronts/internationalization/international-pricing). * Buyer identity should match the customer's shipping address. - * */ buyerIdentity?: InputMaybe; /** * The case-insensitive discount codes that the customer added at checkout. - * */ - discountCodes?: InputMaybe>; + discountCodes?: InputMaybe>; /** A list of merchandise lines to add to the cart. */ lines?: InputMaybe>; /** The metafields to associate with this cart. */ metafields?: InputMaybe>; /** * A note that's associated with the cart. For example, the note can be a personalized message to the buyer. - * */ - note?: InputMaybe; + note?: InputMaybe; }; /** The input fields for a cart metafield value to set. */ export type CartInputMetafieldInput = { /** The key name of the metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). - * */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. - * */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents information about the merchandise in the cart. */ @@ -1043,19 +1004,18 @@ export type CartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** Represents information about the merchandise in the cart. */ export type CartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** The cost of the merchandise line that the buyer will pay at checkout. */ @@ -1072,7 +1032,6 @@ export type CartLineCost = { /** * The estimated cost of the merchandise line that the buyer will pay at checkout. - * */ export type CartLineEstimatedCost = { /** The amount of the merchandise line. */ @@ -1090,11 +1049,11 @@ export type CartLineInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise that the buyer intends to purchase. */ - merchandiseId: Scalars['ID']['input']; + merchandiseId: Scalars["ID"]["input"]; /** The quantity of the merchandise. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** The input fields to update a line item on a cart. */ @@ -1102,13 +1061,13 @@ export type CartLineUpdateInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise line. */ - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; /** The ID of the merchandise for the line item. */ - merchandiseId?: InputMaybe; + merchandiseId?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** Return type for `cartLinesAdd` mutation. */ @@ -1140,17 +1099,16 @@ export type CartMetafieldDeleteInput = { /** * The key name of the cart metafield. Can either be a composite key (`namespace.key`) or a simple key * that relies on the default app-reserved namespace. - * */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The ID of the cart resource. */ - ownerId: Scalars['ID']['input']; + ownerId: Scalars["ID"]["input"]; }; /** Return type for `cartMetafieldDelete` mutation. */ export type CartMetafieldDeletePayload = { /** The ID of the deleted cart metafield. */ - deletedId?: Maybe; + deletedId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -1158,20 +1116,18 @@ export type CartMetafieldDeletePayload = { /** The input fields for a cart metafield value to set. */ export type CartMetafieldsSetInput = { /** The key name of the cart metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The ID of the cart resource. */ - ownerId: Scalars['ID']['input']; + ownerId: Scalars["ID"]["input"]; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). - * */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. - * */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Return type for `cartMetafieldsSet` mutation. */ @@ -1192,31 +1148,26 @@ export type CartNoteUpdatePayload = { /** * The input fields for updating the payment method that will be used to checkout. - * */ export type CartPaymentInput = { /** The amount that the customer will be charged at checkout. */ amount: MoneyInput; /** * The input fields to use when checking out a cart with a direct payment method (like a credit card). - * */ directPaymentMethod?: InputMaybe; /** * The input fields to use to checkout a cart without providing a payment method. * Use this payment method input if the total cost of the cart is 0. - * */ freePaymentMethod?: InputMaybe; /** * An ID of the order placed on the originating platform. * Note that this value doesn't correspond to the Shopify Order ID. - * */ - sourceIdentifier?: InputMaybe; + sourceIdentifier?: InputMaybe; /** * The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay). - * */ walletPaymentMethod?: InputMaybe; }; @@ -1231,13 +1182,12 @@ export type CartPaymentUpdatePayload = { /** * The input fields for updating the selected delivery options for a delivery group. - * */ export type CartSelectedDeliveryOptionInput = { /** The ID of the cart delivery group. */ - deliveryGroupId: Scalars['ID']['input']; + deliveryGroupId: Scalars["ID"]["input"]; /** The handle of the selected delivery option. */ - deliveryOptionHandle: Scalars['String']['input']; + deliveryOptionHandle: Scalars["String"]["input"]; }; /** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */ @@ -1257,21 +1207,24 @@ export type CartSubmitForCompletionPayload = { }; /** The result of cart submit completion. */ -export type CartSubmitForCompletionResult = SubmitAlreadyAccepted | SubmitFailed | SubmitSuccess | SubmitThrottled; +export type CartSubmitForCompletionResult = + | SubmitAlreadyAccepted + | SubmitFailed + | SubmitSuccess + | SubmitThrottled; /** Represents an error that happens during execution of a cart mutation. */ export type CartUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** * The input fields for submitting wallet payment method information for checkout. - * */ export type CartWalletPaymentMethodInput = { /** The payment method information for the Apple Pay wallet. */ @@ -1288,15 +1241,14 @@ export type Checkout = Node & { * The available shipping rates for this Checkout. * Should only be used when checkout `requiresShipping` is `true` and * the shipping address is valid. - * */ availableShippingRates?: Maybe; /** The identity of the customer associated with the checkout. */ buyerIdentity: CheckoutBuyerIdentity; /** The date and time when the checkout was completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The date and time when the checkout was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The currency code for the checkout. */ currencyCode: CurrencyCode; /** A list of extra information that's added to the checkout. */ @@ -1304,19 +1256,19 @@ export type Checkout = Node & { /** Discounts that have been applied on the checkout. */ discountApplications: DiscountApplicationConnection; /** The email attached to this checkout. */ - email?: Maybe; + email?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection; /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ lineItemsSubtotalPrice: MoneyV2; /** The note associated with the checkout. */ - note?: Maybe; + note?: Maybe; /** The resulting order from a paid checkout. */ order?: Maybe; /** The Order Status Page for this Checkout, null when checkout isn't completed. */ - orderStatusUrl?: Maybe; + orderStatusUrl?: Maybe; /** The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards. */ paymentDue: MoneyV2; /** @@ -1329,16 +1281,14 @@ export type Checkout = Node & { * have asynchronous operations that can take time to finish. If you want * to complete a checkout or ensure all the fields are populated and up to * date, polling is required until the value is true. - * */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** States whether or not the fulfillment requires shipping. */ - requiresShipping: Scalars['Boolean']['output']; + requiresShipping: Scalars["Boolean"]["output"]; /** The shipping address to where the line items will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. - * */ shippingDiscountAllocations: Array; /** Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object. */ @@ -1351,9 +1301,9 @@ export type Checkout = Node & { */ subtotalPriceV2: MoneyV2; /** Whether the checkout is tax exempt. */ - taxExempt: Scalars['Boolean']['output']; + taxExempt: Scalars["Boolean"]["output"]; /** Whether taxes are included in the line item and shipping line prices. */ - taxesIncluded: Scalars['Boolean']['output']; + taxesIncluded: Scalars["Boolean"]["output"]; /** The sum of all the duties applied to the line items in the checkout. */ totalDuties?: Maybe; /** The sum of all the prices of all the items in the checkout, including taxes and duties. */ @@ -1371,29 +1321,27 @@ export type Checkout = Node & { */ totalTaxV2: MoneyV2; /** The date and time when the checkout was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** The url pointing to the checkout accessible from the web. */ - webUrl: Scalars['URL']['output']; + webUrl: Scalars["URL"]["output"]; }; - /** A container for all the information required to checkout items and pay. */ export type CheckoutDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** A container for all the information required to checkout items and pay. */ export type CheckoutLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** The input fields required to update a checkout's attributes. */ @@ -1403,13 +1351,12 @@ export type CheckoutAttributesUpdateV2Input = { * The required attributes are city, province, and country. * Full validation of the addresses is still done at completion time. Defaults to `false` with * each operation. - * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; }; /** Return type for `checkoutAttributesUpdateV2` mutation. */ @@ -1437,7 +1384,6 @@ export type CheckoutBuyerIdentityInput = { * The country code of one of the shop's * [enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup). * For example, `CA`. Including this field creates a checkout in the specified country's currency. - * */ countryCode: CountryCode; }; @@ -1491,19 +1437,18 @@ export type CheckoutCreateInput = { * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. * The required attributes are city, province, and country. * Full validation of addresses is still done at completion time. Defaults to `null`. - * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** The identity of the customer associated with the checkout. */ buyerIdentity?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The email with which the customer wants to checkout. */ - email?: InputMaybe; + email?: InputMaybe; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; /** The shipping address to where the line items will be shipped. */ shippingAddress?: InputMaybe; }; @@ -1515,7 +1460,7 @@ export type CheckoutCreatePayload = { /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** The checkout queue token. Available only to selected stores. */ - queueToken?: Maybe; + queueToken?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. @@ -1593,97 +1538,97 @@ export type CheckoutEmailUpdateV2Payload = { /** Possible error codes that can be returned by `CheckoutUserError`. */ export type CheckoutErrorCode = /** Checkout is already completed. */ - | 'ALREADY_COMPLETED' + | "ALREADY_COMPLETED" /** Input email contains an invalid domain name. */ - | 'BAD_DOMAIN' + | "BAD_DOMAIN" /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** Cart does not meet discount requirements notice. */ - | 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE' + | "CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE" /** Customer already used once per customer discount notice. */ - | 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE' + | "CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE" /** Discount already applied. */ - | 'DISCOUNT_ALREADY_APPLIED' + | "DISCOUNT_ALREADY_APPLIED" /** Discount code isn't working right now. Please contact us for help. */ - | 'DISCOUNT_CODE_APPLICATION_FAILED' + | "DISCOUNT_CODE_APPLICATION_FAILED" /** Discount disabled. */ - | 'DISCOUNT_DISABLED' + | "DISCOUNT_DISABLED" /** Discount expired. */ - | 'DISCOUNT_EXPIRED' + | "DISCOUNT_EXPIRED" /** Discount limit reached. */ - | 'DISCOUNT_LIMIT_REACHED' + | "DISCOUNT_LIMIT_REACHED" /** Discount not found. */ - | 'DISCOUNT_NOT_FOUND' + | "DISCOUNT_NOT_FOUND" /** Checkout is already completed. */ - | 'EMPTY' + | "EMPTY" /** Queue token has expired. */ - | 'EXPIRED_QUEUE_TOKEN' + | "EXPIRED_QUEUE_TOKEN" /** Gift card has already been applied. */ - | 'GIFT_CARD_ALREADY_APPLIED' + | "GIFT_CARD_ALREADY_APPLIED" /** Gift card code is invalid. */ - | 'GIFT_CARD_CODE_INVALID' + | "GIFT_CARD_CODE_INVALID" /** Gift card currency does not match checkout currency. */ - | 'GIFT_CARD_CURRENCY_MISMATCH' + | "GIFT_CARD_CURRENCY_MISMATCH" /** Gift card has no funds left. */ - | 'GIFT_CARD_DEPLETED' + | "GIFT_CARD_DEPLETED" /** Gift card is disabled. */ - | 'GIFT_CARD_DISABLED' + | "GIFT_CARD_DISABLED" /** Gift card is expired. */ - | 'GIFT_CARD_EXPIRED' + | "GIFT_CARD_EXPIRED" /** Gift card was not found. */ - | 'GIFT_CARD_NOT_FOUND' + | "GIFT_CARD_NOT_FOUND" /** Gift card cannot be applied to a checkout that contains a gift card. */ - | 'GIFT_CARD_UNUSABLE' + | "GIFT_CARD_UNUSABLE" /** The input value should be greater than or equal to the minimum value allowed. */ - | 'GREATER_THAN_OR_EQUAL_TO' + | "GREATER_THAN_OR_EQUAL_TO" /** Higher value discount applied. */ - | 'HIGHER_VALUE_DISCOUNT_APPLIED' + | "HIGHER_VALUE_DISCOUNT_APPLIED" /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Cannot specify country and presentment currency code. */ - | 'INVALID_COUNTRY_AND_CURRENCY' + | "INVALID_COUNTRY_AND_CURRENCY" /** Input Zip is invalid for country provided. */ - | 'INVALID_FOR_COUNTRY' + | "INVALID_FOR_COUNTRY" /** Input Zip is invalid for country and province provided. */ - | 'INVALID_FOR_COUNTRY_AND_PROVINCE' + | "INVALID_FOR_COUNTRY_AND_PROVINCE" /** Invalid province in country. */ - | 'INVALID_PROVINCE_IN_COUNTRY' + | "INVALID_PROVINCE_IN_COUNTRY" /** Queue token is invalid. */ - | 'INVALID_QUEUE_TOKEN' + | "INVALID_QUEUE_TOKEN" /** Invalid region in country. */ - | 'INVALID_REGION_IN_COUNTRY' + | "INVALID_REGION_IN_COUNTRY" /** Invalid state in country. */ - | 'INVALID_STATE_IN_COUNTRY' + | "INVALID_STATE_IN_COUNTRY" /** The input value should be less than the maximum value allowed. */ - | 'LESS_THAN' + | "LESS_THAN" /** The input value should be less than or equal to the maximum value allowed. */ - | 'LESS_THAN_OR_EQUAL_TO' + | "LESS_THAN_OR_EQUAL_TO" /** Line item was not found in checkout. */ - | 'LINE_ITEM_NOT_FOUND' + | "LINE_ITEM_NOT_FOUND" /** Checkout is locked. */ - | 'LOCKED' + | "LOCKED" /** Maximum number of discount codes limit reached. */ - | 'MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED' + | "MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED" /** Missing payment input. */ - | 'MISSING_PAYMENT_INPUT' + | "MISSING_PAYMENT_INPUT" /** Not enough in stock. */ - | 'NOT_ENOUGH_IN_STOCK' + | "NOT_ENOUGH_IN_STOCK" /** Input value is not supported. */ - | 'NOT_SUPPORTED' + | "NOT_SUPPORTED" /** The input value needs to be blank. */ - | 'PRESENT' + | "PRESENT" /** Product is not published for this customer. */ - | 'PRODUCT_NOT_AVAILABLE' + | "PRODUCT_NOT_AVAILABLE" /** Shipping rate expired. */ - | 'SHIPPING_RATE_EXPIRED' + | "SHIPPING_RATE_EXPIRED" /** Throttled during checkout. */ - | 'THROTTLED_DURING_CHECKOUT' + | "THROTTLED_DURING_CHECKOUT" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The amount of the payment does not match the value to be paid. */ - | 'TOTAL_PRICE_MISMATCH' + | "TOTAL_PRICE_MISMATCH" /** Unable to apply discount. */ - | 'UNABLE_TO_APPLY'; + | "UNABLE_TO_APPLY"; /** Return type for `checkoutGiftCardRemoveV2` mutation. */ export type CheckoutGiftCardRemoveV2Payload = { @@ -1718,11 +1663,11 @@ export type CheckoutLineItem = Node & { /** The discounts that have been allocated onto the checkout line item by discount applications. */ discountAllocations: Array; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The quantity of the line item. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** Title of the line item. Defaults to the product's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Unit price of the line item. */ unitPrice?: Maybe; /** Product variant of the line item. */ @@ -1731,7 +1676,6 @@ export type CheckoutLineItem = Node & { /** * An auto-generated type for paginating through multiple CheckoutLineItems. - * */ export type CheckoutLineItemConnection = { /** A list of edges. */ @@ -1744,11 +1688,10 @@ export type CheckoutLineItemConnection = { /** * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. - * */ export type CheckoutLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CheckoutLineItemEdge. */ node: CheckoutLineItem; }; @@ -1758,9 +1701,9 @@ export type CheckoutLineItemInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The quantity of the line item. */ - quantity: Scalars['Int']['input']; + quantity: Scalars["Int"]["input"]; /** The ID of the product variant for the line item. */ - variantId: Scalars['ID']['input']; + variantId: Scalars["ID"]["input"]; }; /** The input fields to update a line item on the checkout. */ @@ -1768,11 +1711,11 @@ export type CheckoutLineItemUpdateInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The ID of the line item. */ - id?: InputMaybe; + id?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The variant ID of the line item. */ - variantId?: InputMaybe; + variantId?: InputMaybe; }; /** Return type for `checkoutLineItemsAdd` mutation. */ @@ -1853,99 +1796,93 @@ export type CheckoutUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ -export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** Stripped description of the collection, single line with HTML tags removed. */ - description: Scalars['String']['output']; - /** The description of the collection, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML']['output']; - /** - * A human-friendly unique string for the collection automatically generated from its title. - * Limit of 255 characters. - * - */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** Image associated with the collection. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of products in the collection. */ - products: ProductConnection; - /** The collection's SEO information. */ - seo: Seo; - /** The collection’s name. Limit of 255 characters. */ - title: Scalars['String']['output']; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** The date and time when the collection was last modified. */ - updatedAt: Scalars['DateTime']['output']; -}; - +export type Collection = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** Stripped description of the collection, single line with HTML tags removed. */ + description: Scalars["String"]["output"]; + /** The description of the collection, complete with HTML formatting. */ + descriptionHtml: Scalars["HTML"]["output"]; + /** + * A human-friendly unique string for the collection automatically generated from its title. + * Limit of 255 characters. + */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Image associated with the collection. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of products in the collection. */ + products: ProductConnection; + /** The collection's SEO information. */ + seo: Seo; + /** The collection’s name. Limit of 255 characters. */ + title: Scalars["String"]["output"]; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** The date and time when the collection was last modified. */ + updatedAt: Scalars["DateTime"]["output"]; + }; /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionMetafieldsArgs = { identifiers: Array; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * An auto-generated type for paginating through multiple Collections. - * */ export type CollectionConnection = { /** A list of edges. */ @@ -1955,16 +1892,15 @@ export type CollectionConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Collections. */ - totalCount: Scalars['UnsignedInt64']['output']; + totalCount: Scalars["UnsignedInt64"]["output"]; }; /** * An auto-generated type which holds one Collection and a cursor during pagination. - * */ export type CollectionEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CollectionEdge. */ node: Collection; }; @@ -1972,47 +1908,44 @@ export type CollectionEdge = { /** The set of valid sort keys for the Collection query. */ export type CollectionSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** A comment on an article. */ export type Comment = Node & { /** The comment’s author. */ author: CommentAuthor; /** Stripped content of the comment, single line with HTML tags removed. */ - content: Scalars['String']['output']; + content: Scalars["String"]["output"]; /** The content of the comment, complete with HTML formatting. */ - contentHtml: Scalars['HTML']['output']; + contentHtml: Scalars["HTML"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; - /** A comment on an article. */ export type CommentContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; /** The author of a comment. */ export type CommentAuthor = { /** The author's email. */ - email: Scalars['String']['output']; + email: Scalars["String"]["output"]; /** The author’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple Comments. - * */ export type CommentConnection = { /** A list of edges. */ @@ -2025,11 +1958,10 @@ export type CommentConnection = { /** * An auto-generated type which holds one Comment and a cursor during pagination. - * */ export type CommentEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CommentEdge. */ node: Comment; }; @@ -2037,7 +1969,7 @@ export type CommentEdge = { /** The action for the 3DS payment redirect. */ export type CompletePaymentChallenge = { /** The URL for the 3DS payment redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; /** An error that occurred during a cart completion attempt. */ @@ -2045,24 +1977,24 @@ export type CompletionError = { /** The error code. */ code: CompletionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during a cart completion attempt. */ export type CompletionErrorCode = - | 'ERROR' - | 'INVENTORY_RESERVATION_ERROR' - | 'PAYMENT_AMOUNT_TOO_SMALL' - | 'PAYMENT_CALL_ISSUER' - | 'PAYMENT_CARD_DECLINED' - | 'PAYMENT_ERROR' - | 'PAYMENT_GATEWAY_NOT_ENABLED_ERROR' - | 'PAYMENT_INSUFFICIENT_FUNDS' - | 'PAYMENT_INVALID_BILLING_ADDRESS' - | 'PAYMENT_INVALID_CREDIT_CARD' - | 'PAYMENT_INVALID_CURRENCY' - | 'PAYMENT_INVALID_PAYMENT_METHOD' - | 'PAYMENT_TRANSIENT_ERROR'; + | "ERROR" + | "INVENTORY_RESERVATION_ERROR" + | "PAYMENT_AMOUNT_TOO_SMALL" + | "PAYMENT_CALL_ISSUER" + | "PAYMENT_CARD_DECLINED" + | "PAYMENT_ERROR" + | "PAYMENT_GATEWAY_NOT_ENABLED_ERROR" + | "PAYMENT_INSUFFICIENT_FUNDS" + | "PAYMENT_INVALID_BILLING_ADDRESS" + | "PAYMENT_INVALID_CREDIT_CARD" + | "PAYMENT_INVALID_CURRENCY" + | "PAYMENT_INVALID_PAYMENT_METHOD" + | "PAYMENT_TRANSIENT_ERROR"; /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLine = BaseCartLine & Node & { @@ -2080,21 +2012,20 @@ export type ComponentizableCartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The components of the line item. */ lineComponents: Array; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** A country. */ @@ -2108,7 +2039,7 @@ export type Country = { /** The market that includes this country. */ market?: Maybe; /** The name of the country. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The unit system used in the country. */ unitSystem: UnitSystem; }; @@ -2118,982 +2049,974 @@ export type Country = { * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision * of another country. For example, the territories associated with Spain are represented by the country code `ES`, * and the territories associated with the United States of America are represented by the country code `US`. - * */ export type CountryCode = /** Ascension Island. */ - | 'AC' + | "AC" /** Andorra. */ - | 'AD' + | "AD" /** United Arab Emirates. */ - | 'AE' + | "AE" /** Afghanistan. */ - | 'AF' + | "AF" /** Antigua & Barbuda. */ - | 'AG' + | "AG" /** Anguilla. */ - | 'AI' + | "AI" /** Albania. */ - | 'AL' + | "AL" /** Armenia. */ - | 'AM' + | "AM" /** Netherlands Antilles. */ - | 'AN' + | "AN" /** Angola. */ - | 'AO' + | "AO" /** Argentina. */ - | 'AR' + | "AR" /** Austria. */ - | 'AT' + | "AT" /** Australia. */ - | 'AU' + | "AU" /** Aruba. */ - | 'AW' + | "AW" /** Åland Islands. */ - | 'AX' + | "AX" /** Azerbaijan. */ - | 'AZ' + | "AZ" /** Bosnia & Herzegovina. */ - | 'BA' + | "BA" /** Barbados. */ - | 'BB' + | "BB" /** Bangladesh. */ - | 'BD' + | "BD" /** Belgium. */ - | 'BE' + | "BE" /** Burkina Faso. */ - | 'BF' + | "BF" /** Bulgaria. */ - | 'BG' + | "BG" /** Bahrain. */ - | 'BH' + | "BH" /** Burundi. */ - | 'BI' + | "BI" /** Benin. */ - | 'BJ' + | "BJ" /** St. Barthélemy. */ - | 'BL' + | "BL" /** Bermuda. */ - | 'BM' + | "BM" /** Brunei. */ - | 'BN' + | "BN" /** Bolivia. */ - | 'BO' + | "BO" /** Caribbean Netherlands. */ - | 'BQ' + | "BQ" /** Brazil. */ - | 'BR' + | "BR" /** Bahamas. */ - | 'BS' + | "BS" /** Bhutan. */ - | 'BT' + | "BT" /** Bouvet Island. */ - | 'BV' + | "BV" /** Botswana. */ - | 'BW' + | "BW" /** Belarus. */ - | 'BY' + | "BY" /** Belize. */ - | 'BZ' + | "BZ" /** Canada. */ - | 'CA' + | "CA" /** Cocos (Keeling) Islands. */ - | 'CC' + | "CC" /** Congo - Kinshasa. */ - | 'CD' + | "CD" /** Central African Republic. */ - | 'CF' + | "CF" /** Congo - Brazzaville. */ - | 'CG' + | "CG" /** Switzerland. */ - | 'CH' + | "CH" /** Côte d’Ivoire. */ - | 'CI' + | "CI" /** Cook Islands. */ - | 'CK' + | "CK" /** Chile. */ - | 'CL' + | "CL" /** Cameroon. */ - | 'CM' + | "CM" /** China. */ - | 'CN' + | "CN" /** Colombia. */ - | 'CO' + | "CO" /** Costa Rica. */ - | 'CR' + | "CR" /** Cuba. */ - | 'CU' + | "CU" /** Cape Verde. */ - | 'CV' + | "CV" /** Curaçao. */ - | 'CW' + | "CW" /** Christmas Island. */ - | 'CX' + | "CX" /** Cyprus. */ - | 'CY' + | "CY" /** Czechia. */ - | 'CZ' + | "CZ" /** Germany. */ - | 'DE' + | "DE" /** Djibouti. */ - | 'DJ' + | "DJ" /** Denmark. */ - | 'DK' + | "DK" /** Dominica. */ - | 'DM' + | "DM" /** Dominican Republic. */ - | 'DO' + | "DO" /** Algeria. */ - | 'DZ' + | "DZ" /** Ecuador. */ - | 'EC' + | "EC" /** Estonia. */ - | 'EE' + | "EE" /** Egypt. */ - | 'EG' + | "EG" /** Western Sahara. */ - | 'EH' + | "EH" /** Eritrea. */ - | 'ER' + | "ER" /** Spain. */ - | 'ES' + | "ES" /** Ethiopia. */ - | 'ET' + | "ET" /** Finland. */ - | 'FI' + | "FI" /** Fiji. */ - | 'FJ' + | "FJ" /** Falkland Islands. */ - | 'FK' + | "FK" /** Faroe Islands. */ - | 'FO' + | "FO" /** France. */ - | 'FR' + | "FR" /** Gabon. */ - | 'GA' + | "GA" /** United Kingdom. */ - | 'GB' + | "GB" /** Grenada. */ - | 'GD' + | "GD" /** Georgia. */ - | 'GE' + | "GE" /** French Guiana. */ - | 'GF' + | "GF" /** Guernsey. */ - | 'GG' + | "GG" /** Ghana. */ - | 'GH' + | "GH" /** Gibraltar. */ - | 'GI' + | "GI" /** Greenland. */ - | 'GL' + | "GL" /** Gambia. */ - | 'GM' + | "GM" /** Guinea. */ - | 'GN' + | "GN" /** Guadeloupe. */ - | 'GP' + | "GP" /** Equatorial Guinea. */ - | 'GQ' + | "GQ" /** Greece. */ - | 'GR' + | "GR" /** South Georgia & South Sandwich Islands. */ - | 'GS' + | "GS" /** Guatemala. */ - | 'GT' + | "GT" /** Guinea-Bissau. */ - | 'GW' + | "GW" /** Guyana. */ - | 'GY' + | "GY" /** Hong Kong SAR. */ - | 'HK' + | "HK" /** Heard & McDonald Islands. */ - | 'HM' + | "HM" /** Honduras. */ - | 'HN' + | "HN" /** Croatia. */ - | 'HR' + | "HR" /** Haiti. */ - | 'HT' + | "HT" /** Hungary. */ - | 'HU' + | "HU" /** Indonesia. */ - | 'ID' + | "ID" /** Ireland. */ - | 'IE' + | "IE" /** Israel. */ - | 'IL' + | "IL" /** Isle of Man. */ - | 'IM' + | "IM" /** India. */ - | 'IN' + | "IN" /** British Indian Ocean Territory. */ - | 'IO' + | "IO" /** Iraq. */ - | 'IQ' + | "IQ" /** Iran. */ - | 'IR' + | "IR" /** Iceland. */ - | 'IS' + | "IS" /** Italy. */ - | 'IT' + | "IT" /** Jersey. */ - | 'JE' + | "JE" /** Jamaica. */ - | 'JM' + | "JM" /** Jordan. */ - | 'JO' + | "JO" /** Japan. */ - | 'JP' + | "JP" /** Kenya. */ - | 'KE' + | "KE" /** Kyrgyzstan. */ - | 'KG' + | "KG" /** Cambodia. */ - | 'KH' + | "KH" /** Kiribati. */ - | 'KI' + | "KI" /** Comoros. */ - | 'KM' + | "KM" /** St. Kitts & Nevis. */ - | 'KN' + | "KN" /** North Korea. */ - | 'KP' + | "KP" /** South Korea. */ - | 'KR' + | "KR" /** Kuwait. */ - | 'KW' + | "KW" /** Cayman Islands. */ - | 'KY' + | "KY" /** Kazakhstan. */ - | 'KZ' + | "KZ" /** Laos. */ - | 'LA' + | "LA" /** Lebanon. */ - | 'LB' + | "LB" /** St. Lucia. */ - | 'LC' + | "LC" /** Liechtenstein. */ - | 'LI' + | "LI" /** Sri Lanka. */ - | 'LK' + | "LK" /** Liberia. */ - | 'LR' + | "LR" /** Lesotho. */ - | 'LS' + | "LS" /** Lithuania. */ - | 'LT' + | "LT" /** Luxembourg. */ - | 'LU' + | "LU" /** Latvia. */ - | 'LV' + | "LV" /** Libya. */ - | 'LY' + | "LY" /** Morocco. */ - | 'MA' + | "MA" /** Monaco. */ - | 'MC' + | "MC" /** Moldova. */ - | 'MD' + | "MD" /** Montenegro. */ - | 'ME' + | "ME" /** St. Martin. */ - | 'MF' + | "MF" /** Madagascar. */ - | 'MG' + | "MG" /** North Macedonia. */ - | 'MK' + | "MK" /** Mali. */ - | 'ML' + | "ML" /** Myanmar (Burma). */ - | 'MM' + | "MM" /** Mongolia. */ - | 'MN' + | "MN" /** Macao SAR. */ - | 'MO' + | "MO" /** Martinique. */ - | 'MQ' + | "MQ" /** Mauritania. */ - | 'MR' + | "MR" /** Montserrat. */ - | 'MS' + | "MS" /** Malta. */ - | 'MT' + | "MT" /** Mauritius. */ - | 'MU' + | "MU" /** Maldives. */ - | 'MV' + | "MV" /** Malawi. */ - | 'MW' + | "MW" /** Mexico. */ - | 'MX' + | "MX" /** Malaysia. */ - | 'MY' + | "MY" /** Mozambique. */ - | 'MZ' + | "MZ" /** Namibia. */ - | 'NA' + | "NA" /** New Caledonia. */ - | 'NC' + | "NC" /** Niger. */ - | 'NE' + | "NE" /** Norfolk Island. */ - | 'NF' + | "NF" /** Nigeria. */ - | 'NG' + | "NG" /** Nicaragua. */ - | 'NI' + | "NI" /** Netherlands. */ - | 'NL' + | "NL" /** Norway. */ - | 'NO' + | "NO" /** Nepal. */ - | 'NP' + | "NP" /** Nauru. */ - | 'NR' + | "NR" /** Niue. */ - | 'NU' + | "NU" /** New Zealand. */ - | 'NZ' + | "NZ" /** Oman. */ - | 'OM' + | "OM" /** Panama. */ - | 'PA' + | "PA" /** Peru. */ - | 'PE' + | "PE" /** French Polynesia. */ - | 'PF' + | "PF" /** Papua New Guinea. */ - | 'PG' + | "PG" /** Philippines. */ - | 'PH' + | "PH" /** Pakistan. */ - | 'PK' + | "PK" /** Poland. */ - | 'PL' + | "PL" /** St. Pierre & Miquelon. */ - | 'PM' + | "PM" /** Pitcairn Islands. */ - | 'PN' + | "PN" /** Palestinian Territories. */ - | 'PS' + | "PS" /** Portugal. */ - | 'PT' + | "PT" /** Paraguay. */ - | 'PY' + | "PY" /** Qatar. */ - | 'QA' + | "QA" /** Réunion. */ - | 'RE' + | "RE" /** Romania. */ - | 'RO' + | "RO" /** Serbia. */ - | 'RS' + | "RS" /** Russia. */ - | 'RU' + | "RU" /** Rwanda. */ - | 'RW' + | "RW" /** Saudi Arabia. */ - | 'SA' + | "SA" /** Solomon Islands. */ - | 'SB' + | "SB" /** Seychelles. */ - | 'SC' + | "SC" /** Sudan. */ - | 'SD' + | "SD" /** Sweden. */ - | 'SE' + | "SE" /** Singapore. */ - | 'SG' + | "SG" /** St. Helena. */ - | 'SH' + | "SH" /** Slovenia. */ - | 'SI' + | "SI" /** Svalbard & Jan Mayen. */ - | 'SJ' + | "SJ" /** Slovakia. */ - | 'SK' + | "SK" /** Sierra Leone. */ - | 'SL' + | "SL" /** San Marino. */ - | 'SM' + | "SM" /** Senegal. */ - | 'SN' + | "SN" /** Somalia. */ - | 'SO' + | "SO" /** Suriname. */ - | 'SR' + | "SR" /** South Sudan. */ - | 'SS' + | "SS" /** São Tomé & Príncipe. */ - | 'ST' + | "ST" /** El Salvador. */ - | 'SV' + | "SV" /** Sint Maarten. */ - | 'SX' + | "SX" /** Syria. */ - | 'SY' + | "SY" /** Eswatini. */ - | 'SZ' + | "SZ" /** Tristan da Cunha. */ - | 'TA' + | "TA" /** Turks & Caicos Islands. */ - | 'TC' + | "TC" /** Chad. */ - | 'TD' + | "TD" /** French Southern Territories. */ - | 'TF' + | "TF" /** Togo. */ - | 'TG' + | "TG" /** Thailand. */ - | 'TH' + | "TH" /** Tajikistan. */ - | 'TJ' + | "TJ" /** Tokelau. */ - | 'TK' + | "TK" /** Timor-Leste. */ - | 'TL' + | "TL" /** Turkmenistan. */ - | 'TM' + | "TM" /** Tunisia. */ - | 'TN' + | "TN" /** Tonga. */ - | 'TO' + | "TO" /** Turkey. */ - | 'TR' + | "TR" /** Trinidad & Tobago. */ - | 'TT' + | "TT" /** Tuvalu. */ - | 'TV' + | "TV" /** Taiwan. */ - | 'TW' + | "TW" /** Tanzania. */ - | 'TZ' + | "TZ" /** Ukraine. */ - | 'UA' + | "UA" /** Uganda. */ - | 'UG' + | "UG" /** U.S. Outlying Islands. */ - | 'UM' + | "UM" /** United States. */ - | 'US' + | "US" /** Uruguay. */ - | 'UY' + | "UY" /** Uzbekistan. */ - | 'UZ' + | "UZ" /** Vatican City. */ - | 'VA' + | "VA" /** St. Vincent & Grenadines. */ - | 'VC' + | "VC" /** Venezuela. */ - | 'VE' + | "VE" /** British Virgin Islands. */ - | 'VG' + | "VG" /** Vietnam. */ - | 'VN' + | "VN" /** Vanuatu. */ - | 'VU' + | "VU" /** Wallis & Futuna. */ - | 'WF' + | "WF" /** Samoa. */ - | 'WS' + | "WS" /** Kosovo. */ - | 'XK' + | "XK" /** Yemen. */ - | 'YE' + | "YE" /** Mayotte. */ - | 'YT' + | "YT" /** South Africa. */ - | 'ZA' + | "ZA" /** Zambia. */ - | 'ZM' + | "ZM" /** Zimbabwe. */ - | 'ZW' + | "ZW" /** Unknown Region. */ - | 'ZZ'; + | "ZZ"; /** Credit card information used for a payment. */ export type CreditCard = { /** The brand of the credit card. */ - brand?: Maybe; + brand?: Maybe; /** The expiry month of the credit card. */ - expiryMonth?: Maybe; + expiryMonth?: Maybe; /** The expiry year of the credit card. */ - expiryYear?: Maybe; + expiryYear?: Maybe; /** The credit card's BIN number. */ - firstDigits?: Maybe; + firstDigits?: Maybe; /** The first name of the card holder. */ - firstName?: Maybe; + firstName?: Maybe; /** The last 4 digits of the credit card. */ - lastDigits?: Maybe; + lastDigits?: Maybe; /** The last name of the card holder. */ - lastName?: Maybe; + lastName?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; /** * Specifies the fields required to complete a checkout with * a Shopify vaulted credit card payment. - * */ export type CreditCardPaymentInputV2 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars['String']['input']; + idempotencyKey: Scalars["String"]["input"]; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars['String']['input']; + vaultId: Scalars["String"]["input"]; }; /** The part of the image that should remain after cropping. */ export type CropRegion = /** Keep the bottom of the image. */ - | 'BOTTOM' + | "BOTTOM" /** Keep the center of the image. */ - | 'CENTER' + | "CENTER" /** Keep the left of the image. */ - | 'LEFT' + | "LEFT" /** Keep the right of the image. */ - | 'RIGHT' + | "RIGHT" /** Keep the top of the image. */ - | 'TOP'; + | "TOP"; /** A currency. */ export type Currency = { /** The ISO code of the currency. */ isoCode: CurrencyCode; /** The name of the currency. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The symbol of the currency. */ - symbol: Scalars['String']['output']; + symbol: Scalars["String"]["output"]; }; /** * The three-letter currency codes that represent the world currencies used in * stores. These include standard ISO 4217 codes, legacy codes, * and non-standard codes. - * */ export type CurrencyCode = /** United Arab Emirates Dirham (AED). */ - | 'AED' + | "AED" /** Afghan Afghani (AFN). */ - | 'AFN' + | "AFN" /** Albanian Lek (ALL). */ - | 'ALL' + | "ALL" /** Armenian Dram (AMD). */ - | 'AMD' + | "AMD" /** Netherlands Antillean Guilder. */ - | 'ANG' + | "ANG" /** Angolan Kwanza (AOA). */ - | 'AOA' + | "AOA" /** Argentine Pesos (ARS). */ - | 'ARS' + | "ARS" /** Australian Dollars (AUD). */ - | 'AUD' + | "AUD" /** Aruban Florin (AWG). */ - | 'AWG' + | "AWG" /** Azerbaijani Manat (AZN). */ - | 'AZN' + | "AZN" /** Bosnia and Herzegovina Convertible Mark (BAM). */ - | 'BAM' + | "BAM" /** Barbadian Dollar (BBD). */ - | 'BBD' + | "BBD" /** Bangladesh Taka (BDT). */ - | 'BDT' + | "BDT" /** Bulgarian Lev (BGN). */ - | 'BGN' + | "BGN" /** Bahraini Dinar (BHD). */ - | 'BHD' + | "BHD" /** Burundian Franc (BIF). */ - | 'BIF' + | "BIF" /** Bermudian Dollar (BMD). */ - | 'BMD' + | "BMD" /** Brunei Dollar (BND). */ - | 'BND' + | "BND" /** Bolivian Boliviano (BOB). */ - | 'BOB' + | "BOB" /** Brazilian Real (BRL). */ - | 'BRL' + | "BRL" /** Bahamian Dollar (BSD). */ - | 'BSD' + | "BSD" /** Bhutanese Ngultrum (BTN). */ - | 'BTN' + | "BTN" /** Botswana Pula (BWP). */ - | 'BWP' + | "BWP" /** Belarusian Ruble (BYN). */ - | 'BYN' + | "BYN" /** Belarusian Ruble (BYR). */ - | 'BYR' + | "BYR" /** Belize Dollar (BZD). */ - | 'BZD' + | "BZD" /** Canadian Dollars (CAD). */ - | 'CAD' + | "CAD" /** Congolese franc (CDF). */ - | 'CDF' + | "CDF" /** Swiss Francs (CHF). */ - | 'CHF' + | "CHF" /** Chilean Peso (CLP). */ - | 'CLP' + | "CLP" /** Chinese Yuan Renminbi (CNY). */ - | 'CNY' + | "CNY" /** Colombian Peso (COP). */ - | 'COP' + | "COP" /** Costa Rican Colones (CRC). */ - | 'CRC' + | "CRC" /** Cape Verdean escudo (CVE). */ - | 'CVE' + | "CVE" /** Czech Koruny (CZK). */ - | 'CZK' + | "CZK" /** Djiboutian Franc (DJF). */ - | 'DJF' + | "DJF" /** Danish Kroner (DKK). */ - | 'DKK' + | "DKK" /** Dominican Peso (DOP). */ - | 'DOP' + | "DOP" /** Algerian Dinar (DZD). */ - | 'DZD' + | "DZD" /** Egyptian Pound (EGP). */ - | 'EGP' + | "EGP" /** Eritrean Nakfa (ERN). */ - | 'ERN' + | "ERN" /** Ethiopian Birr (ETB). */ - | 'ETB' + | "ETB" /** Euro (EUR). */ - | 'EUR' + | "EUR" /** Fijian Dollars (FJD). */ - | 'FJD' + | "FJD" /** Falkland Islands Pounds (FKP). */ - | 'FKP' + | "FKP" /** United Kingdom Pounds (GBP). */ - | 'GBP' + | "GBP" /** Georgian Lari (GEL). */ - | 'GEL' + | "GEL" /** Ghanaian Cedi (GHS). */ - | 'GHS' + | "GHS" /** Gibraltar Pounds (GIP). */ - | 'GIP' + | "GIP" /** Gambian Dalasi (GMD). */ - | 'GMD' + | "GMD" /** Guinean Franc (GNF). */ - | 'GNF' + | "GNF" /** Guatemalan Quetzal (GTQ). */ - | 'GTQ' + | "GTQ" /** Guyanese Dollar (GYD). */ - | 'GYD' + | "GYD" /** Hong Kong Dollars (HKD). */ - | 'HKD' + | "HKD" /** Honduran Lempira (HNL). */ - | 'HNL' + | "HNL" /** Croatian Kuna (HRK). */ - | 'HRK' + | "HRK" /** Haitian Gourde (HTG). */ - | 'HTG' + | "HTG" /** Hungarian Forint (HUF). */ - | 'HUF' + | "HUF" /** Indonesian Rupiah (IDR). */ - | 'IDR' + | "IDR" /** Israeli New Shekel (NIS). */ - | 'ILS' + | "ILS" /** Indian Rupees (INR). */ - | 'INR' + | "INR" /** Iraqi Dinar (IQD). */ - | 'IQD' + | "IQD" /** Iranian Rial (IRR). */ - | 'IRR' + | "IRR" /** Icelandic Kronur (ISK). */ - | 'ISK' + | "ISK" /** Jersey Pound. */ - | 'JEP' + | "JEP" /** Jamaican Dollars (JMD). */ - | 'JMD' + | "JMD" /** Jordanian Dinar (JOD). */ - | 'JOD' + | "JOD" /** Japanese Yen (JPY). */ - | 'JPY' + | "JPY" /** Kenyan Shilling (KES). */ - | 'KES' + | "KES" /** Kyrgyzstani Som (KGS). */ - | 'KGS' + | "KGS" /** Cambodian Riel. */ - | 'KHR' + | "KHR" /** Kiribati Dollar (KID). */ - | 'KID' + | "KID" /** Comorian Franc (KMF). */ - | 'KMF' + | "KMF" /** South Korean Won (KRW). */ - | 'KRW' + | "KRW" /** Kuwaiti Dinar (KWD). */ - | 'KWD' + | "KWD" /** Cayman Dollars (KYD). */ - | 'KYD' + | "KYD" /** Kazakhstani Tenge (KZT). */ - | 'KZT' + | "KZT" /** Laotian Kip (LAK). */ - | 'LAK' + | "LAK" /** Lebanese Pounds (LBP). */ - | 'LBP' + | "LBP" /** Sri Lankan Rupees (LKR). */ - | 'LKR' + | "LKR" /** Liberian Dollar (LRD). */ - | 'LRD' + | "LRD" /** Lesotho Loti (LSL). */ - | 'LSL' + | "LSL" /** Lithuanian Litai (LTL). */ - | 'LTL' + | "LTL" /** Latvian Lati (LVL). */ - | 'LVL' + | "LVL" /** Libyan Dinar (LYD). */ - | 'LYD' + | "LYD" /** Moroccan Dirham. */ - | 'MAD' + | "MAD" /** Moldovan Leu (MDL). */ - | 'MDL' + | "MDL" /** Malagasy Ariary (MGA). */ - | 'MGA' + | "MGA" /** Macedonia Denar (MKD). */ - | 'MKD' + | "MKD" /** Burmese Kyat (MMK). */ - | 'MMK' + | "MMK" /** Mongolian Tugrik. */ - | 'MNT' + | "MNT" /** Macanese Pataca (MOP). */ - | 'MOP' + | "MOP" /** Mauritanian Ouguiya (MRU). */ - | 'MRU' + | "MRU" /** Mauritian Rupee (MUR). */ - | 'MUR' + | "MUR" /** Maldivian Rufiyaa (MVR). */ - | 'MVR' + | "MVR" /** Malawian Kwacha (MWK). */ - | 'MWK' + | "MWK" /** Mexican Pesos (MXN). */ - | 'MXN' + | "MXN" /** Malaysian Ringgits (MYR). */ - | 'MYR' + | "MYR" /** Mozambican Metical. */ - | 'MZN' + | "MZN" /** Namibian Dollar. */ - | 'NAD' + | "NAD" /** Nigerian Naira (NGN). */ - | 'NGN' + | "NGN" /** Nicaraguan Córdoba (NIO). */ - | 'NIO' + | "NIO" /** Norwegian Kroner (NOK). */ - | 'NOK' + | "NOK" /** Nepalese Rupee (NPR). */ - | 'NPR' + | "NPR" /** New Zealand Dollars (NZD). */ - | 'NZD' + | "NZD" /** Omani Rial (OMR). */ - | 'OMR' + | "OMR" /** Panamian Balboa (PAB). */ - | 'PAB' + | "PAB" /** Peruvian Nuevo Sol (PEN). */ - | 'PEN' + | "PEN" /** Papua New Guinean Kina (PGK). */ - | 'PGK' + | "PGK" /** Philippine Peso (PHP). */ - | 'PHP' + | "PHP" /** Pakistani Rupee (PKR). */ - | 'PKR' + | "PKR" /** Polish Zlotych (PLN). */ - | 'PLN' + | "PLN" /** Paraguayan Guarani (PYG). */ - | 'PYG' + | "PYG" /** Qatari Rial (QAR). */ - | 'QAR' + | "QAR" /** Romanian Lei (RON). */ - | 'RON' + | "RON" /** Serbian dinar (RSD). */ - | 'RSD' + | "RSD" /** Russian Rubles (RUB). */ - | 'RUB' + | "RUB" /** Rwandan Franc (RWF). */ - | 'RWF' + | "RWF" /** Saudi Riyal (SAR). */ - | 'SAR' + | "SAR" /** Solomon Islands Dollar (SBD). */ - | 'SBD' + | "SBD" /** Seychellois Rupee (SCR). */ - | 'SCR' + | "SCR" /** Sudanese Pound (SDG). */ - | 'SDG' + | "SDG" /** Swedish Kronor (SEK). */ - | 'SEK' + | "SEK" /** Singapore Dollars (SGD). */ - | 'SGD' + | "SGD" /** Saint Helena Pounds (SHP). */ - | 'SHP' + | "SHP" /** Sierra Leonean Leone (SLL). */ - | 'SLL' + | "SLL" /** Somali Shilling (SOS). */ - | 'SOS' + | "SOS" /** Surinamese Dollar (SRD). */ - | 'SRD' + | "SRD" /** South Sudanese Pound (SSP). */ - | 'SSP' + | "SSP" /** Sao Tome And Principe Dobra (STD). */ - | 'STD' + | "STD" /** Sao Tome And Principe Dobra (STN). */ - | 'STN' + | "STN" /** Syrian Pound (SYP). */ - | 'SYP' + | "SYP" /** Swazi Lilangeni (SZL). */ - | 'SZL' + | "SZL" /** Thai baht (THB). */ - | 'THB' + | "THB" /** Tajikistani Somoni (TJS). */ - | 'TJS' + | "TJS" /** Turkmenistani Manat (TMT). */ - | 'TMT' + | "TMT" /** Tunisian Dinar (TND). */ - | 'TND' + | "TND" /** Tongan Pa'anga (TOP). */ - | 'TOP' + | "TOP" /** Turkish Lira (TRY). */ - | 'TRY' + | "TRY" /** Trinidad and Tobago Dollars (TTD). */ - | 'TTD' + | "TTD" /** Taiwan Dollars (TWD). */ - | 'TWD' + | "TWD" /** Tanzanian Shilling (TZS). */ - | 'TZS' + | "TZS" /** Ukrainian Hryvnia (UAH). */ - | 'UAH' + | "UAH" /** Ugandan Shilling (UGX). */ - | 'UGX' + | "UGX" /** United States Dollars (USD). */ - | 'USD' + | "USD" /** Uruguayan Pesos (UYU). */ - | 'UYU' + | "UYU" /** Uzbekistan som (UZS). */ - | 'UZS' + | "UZS" /** Venezuelan Bolivares (VED). */ - | 'VED' + | "VED" /** Venezuelan Bolivares (VEF). */ - | 'VEF' + | "VEF" /** Venezuelan Bolivares (VES). */ - | 'VES' + | "VES" /** Vietnamese đồng (VND). */ - | 'VND' + | "VND" /** Vanuatu Vatu (VUV). */ - | 'VUV' + | "VUV" /** Samoan Tala (WST). */ - | 'WST' + | "WST" /** Central African CFA Franc (XAF). */ - | 'XAF' + | "XAF" /** East Caribbean Dollar (XCD). */ - | 'XCD' + | "XCD" /** West African CFA franc (XOF). */ - | 'XOF' + | "XOF" /** CFP Franc (XPF). */ - | 'XPF' + | "XPF" /** Unrecognized currency. */ - | 'XXX' + | "XXX" /** Yemeni Rial (YER). */ - | 'YER' + | "YER" /** South African Rand (ZAR). */ - | 'ZAR' + | "ZAR" /** Zambian Kwacha (ZMW). */ - | 'ZMW'; + | "ZMW"; /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type Customer = HasMetafields & { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing: Scalars['Boolean']['output']; + acceptsMarketing: Scalars["Boolean"]["output"]; /** A list of addresses for the customer. */ addresses: MailingAddressConnection; /** The date and time when the customer was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The customer’s default address. */ defaultAddress?: Maybe; /** The customer’s name, email or phone number. */ - displayName: Scalars['String']['output']; + displayName: Scalars["String"]["output"]; /** The customer’s email address. */ - email?: Maybe; + email?: Maybe; /** The customer’s first name. */ - firstName?: Maybe; + firstName?: Maybe; /** A unique ID for the customer. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The customer's most recently updated, incomplete checkout. */ lastIncompleteCheckout?: Maybe; /** The customer’s last name. */ - lastName?: Maybe; + lastName?: Maybe; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The number of orders that the customer has made at the store in their lifetime. */ - numberOfOrders: Scalars['UnsignedInt64']['output']; + numberOfOrders: Scalars["UnsignedInt64"]["output"]; /** The orders associated with the customer. */ orders: OrderConnection; /** The customer’s phone number. */ - phone?: Maybe; + phone?: Maybe; /** * A comma separated list of tags that have been added to the customer. * Additional access scope required: unauthenticated_read_customer_tags. - * */ - tags: Array; + tags: Array; /** The date and time when the customer information was updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerAddressesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldsArgs = { identifiers: Array; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerOrdersArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ export type CustomerAccessToken = { /** The customer’s access token. */ - accessToken: Scalars['String']['output']; + accessToken: Scalars["String"]["output"]; /** The date and time when the customer access token expires. */ - expiresAt: Scalars['DateTime']['output']; + expiresAt: Scalars["DateTime"]["output"]; }; /** The input fields required to create a customer access token. */ export type CustomerAccessTokenCreateInput = { /** The email associated to the customer. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The login password to be used by the customer. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; }; /** Return type for `customerAccessTokenCreate` mutation. */ @@ -3120,9 +3043,9 @@ export type CustomerAccessTokenCreateWithMultipassPayload = { /** Return type for `customerAccessTokenDelete` mutation. */ export type CustomerAccessTokenDeletePayload = { /** The destroyed access token. */ - deletedAccessToken?: Maybe; + deletedAccessToken?: Maybe; /** ID of the destroyed customer access token. */ - deletedCustomerAccessTokenId?: Maybe; + deletedCustomerAccessTokenId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -3148,9 +3071,9 @@ export type CustomerActivateByUrlPayload = { /** The input fields to activate a customer. */ export type CustomerActivateInput = { /** The activation token required to activate the customer. */ - activationToken: Scalars['String']['input']; + activationToken: Scalars["String"]["input"]; /** New password that will be set during activation. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; }; /** Return type for `customerActivate` mutation. */ @@ -3186,7 +3109,7 @@ export type CustomerAddressDeletePayload = { /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** ID of the deleted customer address. */ - deletedCustomerAddressId?: Maybe; + deletedCustomerAddressId?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. @@ -3210,22 +3133,21 @@ export type CustomerAddressUpdatePayload = { /** The input fields to create a new customer. */ export type CustomerCreateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerCreate` mutation. */ @@ -3257,35 +3179,35 @@ export type CustomerDefaultAddressUpdatePayload = { /** Possible error codes that can be returned by `CustomerUserError`. */ export type CustomerErrorCode = /** Customer already enabled. */ - | 'ALREADY_ENABLED' + | "ALREADY_ENABLED" /** Input email contains an invalid domain name. */ - | 'BAD_DOMAIN' + | "BAD_DOMAIN" /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** Input contains HTML tags. */ - | 'CONTAINS_HTML_TAGS' + | "CONTAINS_HTML_TAGS" /** Input contains URL. */ - | 'CONTAINS_URL' + | "CONTAINS_URL" /** Customer is disabled. */ - | 'CUSTOMER_DISABLED' + | "CUSTOMER_DISABLED" /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Multipass token is not valid. */ - | 'INVALID_MULTIPASS_REQUEST' + | "INVALID_MULTIPASS_REQUEST" /** Address does not exist. */ - | 'NOT_FOUND' + | "NOT_FOUND" /** Input password starts or ends with whitespace. */ - | 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE' + | "PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE" /** The input value is already taken. */ - | 'TAKEN' + | "TAKEN" /** Invalid activation token. */ - | 'TOKEN_INVALID' + | "TOKEN_INVALID" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The input value is too short. */ - | 'TOO_SHORT' + | "TOO_SHORT" /** Unidentified customer. */ - | 'UNIDENTIFIED_CUSTOMER'; + | "UNIDENTIFIED_CUSTOMER"; /** Return type for `customerRecover` mutation. */ export type CustomerRecoverPayload = { @@ -3316,9 +3238,9 @@ export type CustomerResetByUrlPayload = { /** The input fields to reset a customer's password. */ export type CustomerResetInput = { /** New password that will be set as part of the reset password process. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; /** The reset token required to reset the customer’s password. */ - resetToken: Scalars['String']['input']; + resetToken: Scalars["String"]["input"]; }; /** Return type for `customerReset` mutation. */ @@ -3339,22 +3261,21 @@ export type CustomerResetPayload = { /** The input fields to update the Customer information. */ export type CustomerUpdateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email?: InputMaybe; + email?: InputMaybe; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password?: InputMaybe; + password?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. - * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerUpdate` mutation. */ @@ -3364,7 +3285,6 @@ export type CustomerUpdatePayload = { /** * The newly created customer access token. If the customer's password is updated, all previous access tokens * (including the one used to perform this mutation) become invalid, and a new token is generated. - * */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ @@ -3381,9 +3301,9 @@ export type CustomerUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** A delivery address of the buyer that is interacting with the cart. */ @@ -3391,14 +3311,12 @@ export type DeliveryAddress = MailingAddress; /** * The input fields for delivery address preferences. - * */ export type DeliveryAddressInput = { /** * The ID of a customer address that is associated with the buyer that is interacting with the cart. - * */ - customerAddressId?: InputMaybe; + customerAddressId?: InputMaybe; /** A delivery address preference of a buyer that is interacting with the cart. */ deliveryAddress?: InputMaybe; }; @@ -3406,32 +3324,31 @@ export type DeliveryAddressInput = { /** List of different delivery method types. */ export type DeliveryMethodType = /** Local Delivery. */ - | 'LOCAL' + | "LOCAL" /** None. */ - | 'NONE' + | "NONE" /** Shipping to a Pickup Point. */ - | 'PICKUP_POINT' + | "PICKUP_POINT" /** Local Pickup. */ - | 'PICK_UP' + | "PICK_UP" /** Retail. */ - | 'RETAIL' + | "RETAIL" /** Shipping. */ - | 'SHIPPING'; + | "SHIPPING"; /** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ export type DigitalWallet = /** Android Pay. */ - | 'ANDROID_PAY' + | "ANDROID_PAY" /** Apple Pay. */ - | 'APPLE_PAY' + | "APPLE_PAY" /** Google Pay. */ - | 'GOOGLE_PAY' + | "GOOGLE_PAY" /** Shopify Pay. */ - | 'SHOPIFY_PAY'; + | "SHOPIFY_PAY"; /** * An amount discounting the line that has been allocated by a discount. - * */ export type DiscountAllocation = { /** Amount of discount allocated. */ @@ -3443,7 +3360,6 @@ export type DiscountAllocation = { /** * Discount applications capture the intentions of a discount source at * the time of application. - * */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ @@ -3459,15 +3375,14 @@ export type DiscountApplication = { /** The method by which the discount's value is allocated onto its entitled lines. */ export type DiscountApplicationAllocationMethod = /** The value is spread across all entitled lines. */ - | 'ACROSS' + | "ACROSS" /** The value is applied onto every entitled line. */ - | 'EACH' + | "EACH" /** The value is specifically applied onto a particular line. */ - | 'ONE'; + | "ONE"; /** * An auto-generated type for paginating through multiple DiscountApplications. - * */ export type DiscountApplicationConnection = { /** A list of edges. */ @@ -3480,11 +3395,10 @@ export type DiscountApplicationConnection = { /** * An auto-generated type which holds one DiscountApplication and a cursor during pagination. - * */ export type DiscountApplicationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of DiscountApplicationEdge. */ node: DiscountApplication; }; @@ -3494,38 +3408,35 @@ export type DiscountApplicationEdge = { * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. - * */ export type DiscountApplicationTargetSelection = /** The discount is allocated onto all the lines. */ - | 'ALL' + | "ALL" /** The discount is allocated onto only the lines that it's entitled for. */ - | 'ENTITLED' + | "ENTITLED" /** The discount is allocated onto explicitly chosen lines. */ - | 'EXPLICIT'; + | "EXPLICIT"; /** * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. - * */ export type DiscountApplicationTargetType = /** The discount applies onto line items. */ - | 'LINE_ITEM' + | "LINE_ITEM" /** The discount applies onto shipping lines. */ - | 'SHIPPING_LINE'; + | "SHIPPING_LINE"; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied. - * */ export type DiscountCodeApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Specifies whether the discount code was applied successfully. */ - applicable: Scalars['Boolean']['output']; + applicable: Scalars["Boolean"]["output"]; /** The string identifying the discount code that was used at the time of application. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ @@ -3537,40 +3448,40 @@ export type DiscountCodeApplication = DiscountApplication & { /** Represents an error in the input of a mutation. */ export type DisplayableError = { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** Represents a web address. */ export type Domain = { /** The host name of the domain (eg: `example.com`). */ - host: Scalars['String']['output']; + host: Scalars["String"]["output"]; /** Whether SSL is enabled or not. */ - sslEnabled: Scalars['Boolean']['output']; + sslEnabled: Scalars["Boolean"]["output"]; /** The URL of the domain (eg: `https://example.com`). */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** Represents a video hosted outside of Shopify. */ export type ExternalVideo = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** The embed URL of the video for the respective host. */ - embedUrl: Scalars['URL']['output']; + embedUrl: Scalars["URL"]["output"]; /** * The URL. * @deprecated Use `originUrl` instead. */ - embeddedUrl: Scalars['URL']['output']; + embeddedUrl: Scalars["URL"]["output"]; /** The host of the external video. */ host: MediaHost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The origin URL of the video on the respective host. */ - originUrl: Scalars['URL']['output']; + originUrl: Scalars["URL"]["output"]; /** The presentation for a media. */ presentation?: Maybe; /** The preview image for the media. */ @@ -3580,9 +3491,9 @@ export type ExternalVideo = Media & Node & { /** A filter that is supported on the parent field. */ export type Filter = { /** A unique identifier. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** A human-friendly string for this filter. */ - label: Scalars['String']['output']; + label: Scalars["String"]["output"]; /** An enumeration that denotes the type of data this filter represents. */ type: FilterType; /** The list of values for this filter. */ @@ -3594,33 +3505,31 @@ export type Filter = { * * For more information, refer to [Filter products in a collection with the Storefront API] * (https://shopify.dev/custom-storefronts/products-collections/filter-products). - * */ export type FilterType = /** A boolean value. */ - | 'BOOLEAN' + | "BOOLEAN" /** A list of selectable values. */ - | 'LIST' + | "LIST" /** A range of prices. */ - | 'PRICE_RANGE'; + | "PRICE_RANGE"; /** A selectable value within a filter. */ export type FilterValue = { /** The number of results that match this filter value. */ - count: Scalars['Int']['output']; + count: Scalars["Int"]["output"]; /** A unique identifier. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** * An input object that can be used to filter by this value on the parent field. * * The value is provided as a helper for building dynamic filtering UI. For * example, if you have a list of selected `FilterValue` objects, you can combine * their respective `input` values to use in a subsequent query. - * */ - input: Scalars['JSON']['output']; + input: Scalars["JSON"]["output"]; /** A human-friendly string for this filter value. */ - label: Scalars['String']['output']; + label: Scalars["String"]["output"]; }; /** Represents a single fulfillment in an order. */ @@ -3628,29 +3537,26 @@ export type Fulfillment = { /** List of the fulfillment's line items. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** The name of the tracking company. */ - trackingCompany?: Maybe; + trackingCompany?: Maybe; /** * Tracking information associated with the fulfillment, * such as the tracking number and tracking URL. - * */ trackingInfo: Array; }; - /** Represents a single fulfillment in an order. */ export type FulfillmentFulfillmentLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** Represents a single fulfillment in an order. */ export type FulfillmentTrackingInfoArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ @@ -3658,12 +3564,11 @@ export type FulfillmentLineItem = { /** The associated order's line item. */ lineItem: OrderLineItem; /** The amount fulfilled in this fulfillment. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** * An auto-generated type for paginating through multiple FulfillmentLineItems. - * */ export type FulfillmentLineItemConnection = { /** A list of edges. */ @@ -3676,11 +3581,10 @@ export type FulfillmentLineItemConnection = { /** * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. - * */ export type FulfillmentLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; @@ -3688,33 +3592,33 @@ export type FulfillmentLineItemEdge = { /** Tracking information associated with the fulfillment. */ export type FulfillmentTrackingInfo = { /** The tracking number of the fulfillment. */ - number?: Maybe; + number?: Maybe; /** The URL to track the fulfillment. */ - url?: Maybe; + url?: Maybe; }; /** The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. */ export type GenericFile = Node & { /** A word or phrase to indicate the contents of a file. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The MIME type of the file. */ - mimeType?: Maybe; + mimeType?: Maybe; /** The size of the original file in bytes. */ - originalFileSize?: Maybe; + originalFileSize?: Maybe; /** The preview image for the file. */ previewImage?: Maybe; /** The URL of the file. */ - url?: Maybe; + url?: Maybe; }; /** The input fields used to specify a geographical location. */ export type GeoCoordinateInput = { /** The coordinate's latitude value. */ - latitude: Scalars['Float']['input']; + latitude: Scalars["Float"]["input"]; /** The coordinate's longitude value. */ - longitude: Scalars['Float']['input']; + longitude: Scalars["Float"]["input"]; }; /** Represents information about the metafields associated to the specified resource. */ @@ -3725,14 +3629,12 @@ export type HasMetafields = { metafields: Array>; }; - /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldsArgs = { identifiers: Array; @@ -3741,19 +3643,19 @@ export type HasMetafieldsMetafieldsArgs = { /** The input fields to identify a metafield on an owner resource by namespace and key. */ export type HasMetafieldsIdentifier = { /** The identifier for the metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The container the metafield belongs to. */ - namespace: Scalars['String']['input']; + namespace: Scalars["String"]["input"]; }; /** Represents an image resource. */ export type Image = { /** A word or phrase to share the nature or contents of an image. */ - altText?: Maybe; + altText?: Maybe; /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - height?: Maybe; + height?: Maybe; /** A unique ID for the image. */ - id?: Maybe; + id?: Maybe; /** * The location of the original image as a URL. * @@ -3761,12 +3663,12 @@ export type Image = { * * @deprecated Use `url` instead. */ - originalSrc: Scalars['URL']['output']; + originalSrc: Scalars["URL"]["output"]; /** * The location of the image as a URL. * @deprecated Use `url` instead. */ - src: Scalars['URL']['output']; + src: Scalars["URL"]["output"]; /** * The location of the transformed image as a URL. * @@ -3775,7 +3677,7 @@ export type Image = { * * @deprecated Use `url(transform:)` instead */ - transformedSrc: Scalars['URL']['output']; + transformedSrc: Scalars["URL"]["output"]; /** * The location of the image as a URL. * @@ -3784,24 +3686,21 @@ export type Image = { * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. * * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). - * */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - width?: Maybe; + width?: Maybe; }; - /** Represents an image resource. */ export type ImageTransformedSrcArgs = { crop?: InputMaybe; - maxHeight?: InputMaybe; - maxWidth?: InputMaybe; + maxHeight?: InputMaybe; + maxWidth?: InputMaybe; preferredContentType?: InputMaybe; - scale?: InputMaybe; + scale?: InputMaybe; }; - /** Represents an image resource. */ export type ImageUrlArgs = { transform?: InputMaybe; @@ -3809,7 +3708,6 @@ export type ImageUrlArgs = { /** * An auto-generated type for paginating through multiple Images. - * */ export type ImageConnection = { /** A list of edges. */ @@ -3823,19 +3721,18 @@ export type ImageConnection = { /** List of supported image content types. */ export type ImageContentType = /** A JPG image. */ - | 'JPG' + | "JPG" /** A PNG image. */ - | 'PNG' + | "PNG" /** A WEBP image. */ - | 'WEBP'; + | "WEBP"; /** * An auto-generated type which holds one Image and a cursor during pagination. - * */ export type ImageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ImageEdge. */ node: Image; }; @@ -3845,7 +3742,6 @@ export type ImageEdge = { * * All transformation options are considered best effort. Any transformation that * the original image type doesn't support will be ignored. - * */ export type ImageTransformInput = { /** @@ -3856,332 +3752,327 @@ export type ImageTransformInput = { * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ * maxWidth: 5, maxHeight: 10, crop: LEFT }` will result * in an image with a width of 5 and height of 10, where the right side of the image is removed. - * */ crop?: InputMaybe; /** * Image height in pixels between 1 and 5760. - * */ - maxHeight?: InputMaybe; + maxHeight?: InputMaybe; /** * Image width in pixels between 1 and 5760. - * */ - maxWidth?: InputMaybe; + maxWidth?: InputMaybe; /** * Convert the source image into the preferred content type. * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. - * */ preferredContentType?: InputMaybe; /** * Image size multiplier for high-resolution retina displays. Must be within 1..3. - * */ - scale?: InputMaybe; + scale?: InputMaybe; }; /** A language. */ export type Language = { /** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */ - endonymName: Scalars['String']['output']; + endonymName: Scalars["String"]["output"]; /** The ISO code. */ isoCode: LanguageCode; /** The name of the language in the current language. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** ISO 639-1 language codes supported by Shopify. */ export type LanguageCode = /** Afrikaans. */ - | 'AF' + | "AF" /** Akan. */ - | 'AK' + | "AK" /** Amharic. */ - | 'AM' + | "AM" /** Arabic. */ - | 'AR' + | "AR" /** Assamese. */ - | 'AS' + | "AS" /** Azerbaijani. */ - | 'AZ' + | "AZ" /** Belarusian. */ - | 'BE' + | "BE" /** Bulgarian. */ - | 'BG' + | "BG" /** Bambara. */ - | 'BM' + | "BM" /** Bangla. */ - | 'BN' + | "BN" /** Tibetan. */ - | 'BO' + | "BO" /** Breton. */ - | 'BR' + | "BR" /** Bosnian. */ - | 'BS' + | "BS" /** Catalan. */ - | 'CA' + | "CA" /** Chechen. */ - | 'CE' + | "CE" /** Central Kurdish. */ - | 'CKB' + | "CKB" /** Czech. */ - | 'CS' + | "CS" /** Church Slavic. */ - | 'CU' + | "CU" /** Welsh. */ - | 'CY' + | "CY" /** Danish. */ - | 'DA' + | "DA" /** German. */ - | 'DE' + | "DE" /** Dzongkha. */ - | 'DZ' + | "DZ" /** Ewe. */ - | 'EE' + | "EE" /** Greek. */ - | 'EL' + | "EL" /** English. */ - | 'EN' + | "EN" /** Esperanto. */ - | 'EO' + | "EO" /** Spanish. */ - | 'ES' + | "ES" /** Estonian. */ - | 'ET' + | "ET" /** Basque. */ - | 'EU' + | "EU" /** Persian. */ - | 'FA' + | "FA" /** Fulah. */ - | 'FF' + | "FF" /** Finnish. */ - | 'FI' + | "FI" /** Filipino. */ - | 'FIL' + | "FIL" /** Faroese. */ - | 'FO' + | "FO" /** French. */ - | 'FR' + | "FR" /** Western Frisian. */ - | 'FY' + | "FY" /** Irish. */ - | 'GA' + | "GA" /** Scottish Gaelic. */ - | 'GD' + | "GD" /** Galician. */ - | 'GL' + | "GL" /** Gujarati. */ - | 'GU' + | "GU" /** Manx. */ - | 'GV' + | "GV" /** Hausa. */ - | 'HA' + | "HA" /** Hebrew. */ - | 'HE' + | "HE" /** Hindi. */ - | 'HI' + | "HI" /** Croatian. */ - | 'HR' + | "HR" /** Hungarian. */ - | 'HU' + | "HU" /** Armenian. */ - | 'HY' + | "HY" /** Interlingua. */ - | 'IA' + | "IA" /** Indonesian. */ - | 'ID' + | "ID" /** Igbo. */ - | 'IG' + | "IG" /** Sichuan Yi. */ - | 'II' + | "II" /** Icelandic. */ - | 'IS' + | "IS" /** Italian. */ - | 'IT' + | "IT" /** Japanese. */ - | 'JA' + | "JA" /** Javanese. */ - | 'JV' + | "JV" /** Georgian. */ - | 'KA' + | "KA" /** Kikuyu. */ - | 'KI' + | "KI" /** Kazakh. */ - | 'KK' + | "KK" /** Kalaallisut. */ - | 'KL' + | "KL" /** Khmer. */ - | 'KM' + | "KM" /** Kannada. */ - | 'KN' + | "KN" /** Korean. */ - | 'KO' + | "KO" /** Kashmiri. */ - | 'KS' + | "KS" /** Kurdish. */ - | 'KU' + | "KU" /** Cornish. */ - | 'KW' + | "KW" /** Kyrgyz. */ - | 'KY' + | "KY" /** Latin. */ - | 'LA' + | "LA" /** Luxembourgish. */ - | 'LB' + | "LB" /** Ganda. */ - | 'LG' + | "LG" /** Lingala. */ - | 'LN' + | "LN" /** Lao. */ - | 'LO' + | "LO" /** Lithuanian. */ - | 'LT' + | "LT" /** Luba-Katanga. */ - | 'LU' + | "LU" /** Latvian. */ - | 'LV' + | "LV" /** Malagasy. */ - | 'MG' + | "MG" /** Māori. */ - | 'MI' + | "MI" /** Macedonian. */ - | 'MK' + | "MK" /** Malayalam. */ - | 'ML' + | "ML" /** Mongolian. */ - | 'MN' + | "MN" /** Moldavian. */ - | 'MO' + | "MO" /** Marathi. */ - | 'MR' + | "MR" /** Malay. */ - | 'MS' + | "MS" /** Maltese. */ - | 'MT' + | "MT" /** Burmese. */ - | 'MY' + | "MY" /** Norwegian (Bokmål). */ - | 'NB' + | "NB" /** North Ndebele. */ - | 'ND' + | "ND" /** Nepali. */ - | 'NE' + | "NE" /** Dutch. */ - | 'NL' + | "NL" /** Norwegian Nynorsk. */ - | 'NN' + | "NN" /** Norwegian. */ - | 'NO' + | "NO" /** Oromo. */ - | 'OM' + | "OM" /** Odia. */ - | 'OR' + | "OR" /** Ossetic. */ - | 'OS' + | "OS" /** Punjabi. */ - | 'PA' + | "PA" /** Polish. */ - | 'PL' + | "PL" /** Pashto. */ - | 'PS' + | "PS" /** Portuguese. */ - | 'PT' + | "PT" /** Portuguese (Brazil). */ - | 'PT_BR' + | "PT_BR" /** Portuguese (Portugal). */ - | 'PT_PT' + | "PT_PT" /** Quechua. */ - | 'QU' + | "QU" /** Romansh. */ - | 'RM' + | "RM" /** Rundi. */ - | 'RN' + | "RN" /** Romanian. */ - | 'RO' + | "RO" /** Russian. */ - | 'RU' + | "RU" /** Kinyarwanda. */ - | 'RW' + | "RW" /** Sanskrit. */ - | 'SA' + | "SA" /** Sardinian. */ - | 'SC' + | "SC" /** Sindhi. */ - | 'SD' + | "SD" /** Northern Sami. */ - | 'SE' + | "SE" /** Sango. */ - | 'SG' + | "SG" /** Serbo-Croatian. */ - | 'SH' + | "SH" /** Sinhala. */ - | 'SI' + | "SI" /** Slovak. */ - | 'SK' + | "SK" /** Slovenian. */ - | 'SL' + | "SL" /** Shona. */ - | 'SN' + | "SN" /** Somali. */ - | 'SO' + | "SO" /** Albanian. */ - | 'SQ' + | "SQ" /** Serbian. */ - | 'SR' + | "SR" /** Sundanese. */ - | 'SU' + | "SU" /** Swedish. */ - | 'SV' + | "SV" /** Swahili. */ - | 'SW' + | "SW" /** Tamil. */ - | 'TA' + | "TA" /** Telugu. */ - | 'TE' + | "TE" /** Tajik. */ - | 'TG' + | "TG" /** Thai. */ - | 'TH' + | "TH" /** Tigrinya. */ - | 'TI' + | "TI" /** Turkmen. */ - | 'TK' + | "TK" /** Tongan. */ - | 'TO' + | "TO" /** Turkish. */ - | 'TR' + | "TR" /** Tatar. */ - | 'TT' + | "TT" /** Uyghur. */ - | 'UG' + | "UG" /** Ukrainian. */ - | 'UK' + | "UK" /** Urdu. */ - | 'UR' + | "UR" /** Uzbek. */ - | 'UZ' + | "UZ" /** Vietnamese. */ - | 'VI' + | "VI" /** Volapük. */ - | 'VO' + | "VO" /** Wolof. */ - | 'WO' + | "WO" /** Xhosa. */ - | 'XH' + | "XH" /** Yiddish. */ - | 'YI' + | "YI" /** Yoruba. */ - | 'YO' + | "YO" /** Chinese. */ - | 'ZH' + | "ZH" /** Chinese (Simplified). */ - | 'ZH_CN' + | "ZH_CN" /** Chinese (Traditional). */ - | 'ZH_TW' + | "ZH_TW" /** Zulu. */ - | 'ZU'; + | "ZU"; /** Information about the localized experiences configured for the shop. */ export type Localization = { @@ -4202,23 +4093,21 @@ export type Location = HasMetafields & Node & { /** The address of the location. */ address: LocationAddress; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The name of the location. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; - /** Represents a location where product inventory is held. */ export type LocationMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Represents a location where product inventory is held. */ export type LocationMetafieldsArgs = { identifiers: Array; @@ -4226,41 +4115,38 @@ export type LocationMetafieldsArgs = { /** * Represents the address of a location. - * */ export type LocationAddress = { /** The first line of the address for the location. */ - address1?: Maybe; + address1?: Maybe; /** The second line of the address for the location. */ - address2?: Maybe; + address2?: Maybe; /** The city of the location. */ - city?: Maybe; + city?: Maybe; /** The country of the location. */ - country?: Maybe; + country?: Maybe; /** The country code of the location. */ - countryCode?: Maybe; + countryCode?: Maybe; /** A formatted version of the address for the location. */ - formatted: Array; + formatted: Array; /** The latitude coordinates of the location. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinates of the location. */ - longitude?: Maybe; + longitude?: Maybe; /** The phone number of the location. */ - phone?: Maybe; + phone?: Maybe; /** The province of the location. */ - province?: Maybe; + province?: Maybe; /** * The code for the province, state, or district of the address of the location. - * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The ZIP code of the location. */ - zip?: Maybe; + zip?: Maybe; }; /** * An auto-generated type for paginating through multiple Locations. - * */ export type LocationConnection = { /** A list of edges. */ @@ -4273,11 +4159,10 @@ export type LocationConnection = { /** * An auto-generated type which holds one Location and a cursor during pagination. - * */ export type LocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of LocationEdge. */ node: Location; }; @@ -4285,29 +4170,28 @@ export type LocationEdge = { /** The set of valid sort keys for the Location query. */ export type LocationSortKeys = /** Sort by the `city` value. */ - | 'CITY' + | "CITY" /** Sort by the `distance` value. */ - | 'DISTANCE' + | "DISTANCE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `name` value. */ - | 'NAME'; + | "NAME"; /** Represents a mailing address for customers and shipping. */ export type MailingAddress = Node & { /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe; + address1?: Maybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. - * */ - address2?: Maybe; + address2?: Maybe; /** The name of the city, district, village, or town. */ - city?: Maybe; + city?: Maybe; /** The name of the customer's company or organization. */ - company?: Maybe; + company?: Maybe; /** The name of the country. */ - country?: Maybe; + country?: Maybe; /** * The two-letter code for the country of the address. * @@ -4315,60 +4199,55 @@ export type MailingAddress = Node & { * * @deprecated Use `countryCodeV2` instead. */ - countryCode?: Maybe; + countryCode?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. - * */ countryCodeV2?: Maybe; /** The first name of the customer. */ - firstName?: Maybe; + firstName?: Maybe; /** A formatted version of the address, customized by the provided arguments. */ - formatted: Array; + formatted: Array; /** A comma-separated list of the values for city, province, and country. */ - formattedArea?: Maybe; + formattedArea?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The last name of the customer. */ - lastName?: Maybe; + lastName?: Maybe; /** The latitude coordinate of the customer address. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinate of the customer address. */ - longitude?: Maybe; + longitude?: Maybe; /** The full name of the customer, based on firstName and lastName. */ - name?: Maybe; + name?: Maybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: Maybe; + phone?: Maybe; /** The region of the address, such as the province, state, or district. */ - province?: Maybe; + province?: Maybe; /** * The two-letter code for the region. * * For example, ON. - * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The zip or postal code of the address. */ - zip?: Maybe; + zip?: Maybe; }; - /** Represents a mailing address for customers and shipping. */ export type MailingAddressFormattedArgs = { - withCompany?: InputMaybe; - withName?: InputMaybe; + withCompany?: InputMaybe; + withName?: InputMaybe; }; /** * An auto-generated type for paginating through multiple MailingAddresses. - * */ export type MailingAddressConnection = { /** A list of edges. */ @@ -4381,11 +4260,10 @@ export type MailingAddressConnection = { /** * An auto-generated type which holds one MailingAddress and a cursor during pagination. - * */ export type MailingAddressEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MailingAddressEdge. */ node: MailingAddress; }; @@ -4394,58 +4272,52 @@ export type MailingAddressEdge = { export type MailingAddressInput = { /** * The first line of the address. Typically the street address or PO Box number. - * */ - address1?: InputMaybe; + address1?: InputMaybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. - * */ - address2?: InputMaybe; + address2?: InputMaybe; /** * The name of the city, district, village, or town. - * */ - city?: InputMaybe; + city?: InputMaybe; /** * The name of the customer's company or organization. - * */ - company?: InputMaybe; + company?: InputMaybe; /** The name of the country. */ - country?: InputMaybe; + country?: InputMaybe; /** The first name of the customer. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The last name of the customer. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: InputMaybe; + phone?: InputMaybe; /** The region of the address, such as the province, state, or district. */ - province?: InputMaybe; + province?: InputMaybe; /** The zip or postal code of the address. */ - zip?: InputMaybe; + zip?: InputMaybe; }; /** * Manual discount applications capture the intentions of a discount that was manually created. - * */ export type ManualDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The description of the application. */ - description?: Maybe; + description?: Maybe; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -4454,25 +4326,22 @@ export type ManualDiscountApplication = DiscountApplication & { export type Market = HasMetafields & Node & { /** * A human-readable unique string for the market automatically generated from its title. - * */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; }; - /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldsArgs = { identifiers: Array; @@ -4481,9 +4350,9 @@ export type MarketMetafieldsArgs = { /** Represents a media interface. */ export type Media = { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4494,7 +4363,6 @@ export type Media = { /** * An auto-generated type for paginating through multiple Media. - * */ export type MediaConnection = { /** A list of edges. */ @@ -4508,21 +4376,20 @@ export type MediaConnection = { /** The possible content types for a media object. */ export type MediaContentType = /** An externally hosted video. */ - | 'EXTERNAL_VIDEO' + | "EXTERNAL_VIDEO" /** A Shopify hosted image. */ - | 'IMAGE' + | "IMAGE" /** A 3d model. */ - | 'MODEL_3D' + | "MODEL_3D" /** A Shopify hosted video. */ - | 'VIDEO'; + | "VIDEO"; /** * An auto-generated type which holds one Media and a cursor during pagination. - * */ export type MediaEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MediaEdge. */ node: Media; }; @@ -4530,16 +4397,16 @@ export type MediaEdge = { /** Host for a Media Resource. */ export type MediaHost = /** Host for Vimeo embedded videos. */ - | 'VIMEO' + | "VIMEO" /** Host for YouTube embedded videos. */ - | 'YOUTUBE'; + | "YOUTUBE"; /** Represents a Shopify hosted image. */ export type MediaImage = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The image for the media. */ image?: Maybe; /** The media content type. */ @@ -4553,12 +4420,11 @@ export type MediaImage = Media & Node & { /** A media presentation. */ export type MediaPresentation = Node & { /** A JSON object representing a presentation view. */ - asJson?: Maybe; + asJson?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; - /** A media presentation. */ export type MediaPresentationAsJsonArgs = { format: MediaPresentationFormat; @@ -4567,78 +4433,82 @@ export type MediaPresentationAsJsonArgs = { /** The possible formats for a media presentation. */ export type MediaPresentationFormat = /** A media image presentation. */ - | 'IMAGE' + | "IMAGE" /** A model viewer presentation. */ - | 'MODEL_VIEWER'; + | "MODEL_VIEWER"; /** * A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy * of hyperlinks (items). - * */ export type Menu = Node & { /** The menu's handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The menu's child items. */ items: Array; /** The count of items on the menu. */ - itemsCount: Scalars['Int']['output']; + itemsCount: Scalars["Int"]["output"]; /** The menu's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** A menu item within a parent menu. */ export type MenuItem = Node & { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The menu item's child items. */ items: Array; /** The linked resource. */ resource?: Maybe; /** The ID of the linked resource. */ - resourceId?: Maybe; + resourceId?: Maybe; /** The menu item's tags to filter a collection. */ - tags: Array; + tags: Array; /** The menu item's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The menu item's type. */ type: MenuItemType; /** The menu item's URL. */ - url?: Maybe; + url?: Maybe; }; /** * The list of possible resources a `MenuItem` can reference. - * */ -export type MenuItemResource = Article | Blog | Collection | Page | Product | ShopPolicy; +export type MenuItemResource = + | Article + | Blog + | Collection + | Page + | Product + | ShopPolicy; /** A menu item type. */ export type MenuItemType = /** An article link. */ - | 'ARTICLE' + | "ARTICLE" /** A blog link. */ - | 'BLOG' + | "BLOG" /** A catalog link. */ - | 'CATALOG' + | "CATALOG" /** A collection link. */ - | 'COLLECTION' + | "COLLECTION" /** A collection link. */ - | 'COLLECTIONS' + | "COLLECTIONS" /** A frontpage link. */ - | 'FRONTPAGE' + | "FRONTPAGE" /** An http link. */ - | 'HTTP' + | "HTTP" /** A page link. */ - | 'PAGE' + | "PAGE" /** A product link. */ - | 'PRODUCT' + | "PRODUCT" /** A search link. */ - | 'SEARCH' + | "SEARCH" /** A shop policy link. */ - | 'SHOP_POLICY'; + | "SHOP_POLICY"; /** The merchandise to be purchased at checkout. */ export type Merchandise = ProductVariant; @@ -4646,19 +4516,18 @@ export type Merchandise = ProductVariant; /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. - * */ export type Metafield = Node & { /** The date and time when the storefront metafield was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The description of a metafield. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The unique identifier for the metafield within its namespace. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** The container for a group of metafields that the metafield is associated with. */ - namespace: Scalars['String']['output']; + namespace: Scalars["String"]["output"]; /** The type of resource that the metafield is attached to. */ parentResource: MetafieldParentResource; /** Returns a reference object if the metafield's type is a resource reference. */ @@ -4668,43 +4537,40 @@ export type Metafield = Node & { /** * The type name of the metafield. * Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). - * */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The date and time when the metafield was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */ - value: Scalars['String']['output']; + value: Scalars["String"]["output"]; }; - /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. - * */ export type MetafieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** Possible error codes that can be returned by `MetafieldDeleteUserError`. */ export type MetafieldDeleteErrorCode = /** The owner ID is invalid. */ - | 'INVALID_OWNER' + | "INVALID_OWNER" /** Metafield not found. */ - | 'METAFIELD_DOES_NOT_EXIST'; + | "METAFIELD_DOES_NOT_EXIST"; /** An error that occurs during the execution of cart metafield deletion. */ export type MetafieldDeleteUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** @@ -4715,29 +4581,46 @@ export type MetafieldDeleteUserError = DisplayableError & { * - `number_decimal` * - `single_line_text_field` * - `boolean` as of 2022-04. - * */ export type MetafieldFilter = { /** The key of the metafield to filter on. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The namespace of the metafield to filter on. */ - namespace: Scalars['String']['input']; + namespace: Scalars["String"]["input"]; /** The value of the metafield. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** A resource that the metafield belongs to. */ -export type MetafieldParentResource = Article | Blog | Cart | Collection | Customer | Location | Market | Order | Page | Product | ProductVariant | Shop; +export type MetafieldParentResource = + | Article + | Blog + | Cart + | Collection + | Customer + | Location + | Market + | Order + | Page + | Product + | ProductVariant + | Shop; /** * Returns the resource which is being referred to by a metafield. - * */ -export type MetafieldReference = Collection | GenericFile | MediaImage | Metaobject | Page | Product | ProductVariant | Video; +export type MetafieldReference = + | Collection + | GenericFile + | MediaImage + | Metaobject + | Page + | Product + | ProductVariant + | Video; /** * An auto-generated type for paginating through multiple MetafieldReferences. - * */ export type MetafieldReferenceConnection = { /** A list of edges. */ @@ -4750,11 +4633,10 @@ export type MetafieldReferenceConnection = { /** * An auto-generated type which holds one MetafieldReference and a cursor during pagination. - * */ export type MetafieldReferenceEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MetafieldReferenceEdge. */ node: MetafieldReference; }; @@ -4764,33 +4646,33 @@ export type MetafieldsSetUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The index of the array element that's causing the error. */ - elementIndex?: Maybe; + elementIndex?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** Possible error codes that can be returned by `MetafieldsSetUserError`. */ export type MetafieldsSetUserErrorCode = /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** The input value isn't included in the list. */ - | 'INCLUSION' + | "INCLUSION" /** The owner ID is invalid. */ - | 'INVALID_OWNER' + | "INVALID_OWNER" /** The type is invalid. */ - | 'INVALID_TYPE' + | "INVALID_TYPE" /** The value is invalid for metafield type or for definition options. */ - | 'INVALID_VALUE' + | "INVALID_VALUE" /** The input value should be less than or equal to the maximum value allowed. */ - | 'LESS_THAN_OR_EQUAL_TO' + | "LESS_THAN_OR_EQUAL_TO" /** The input value needs to be blank. */ - | 'PRESENT' + | "PRESENT" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The input value is too short. */ - | 'TOO_SHORT'; + | "TOO_SHORT"; /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type Metaobject = Node & { @@ -4799,28 +4681,25 @@ export type Metaobject = Node & { /** * All object fields with defined values. * Omitted object keys can be assumed null, and no guarantees are made about field order. - * */ fields: Array; /** The unique handle of the metaobject. Useful as a custom ID. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The type of the metaobject. Defines the namespace of its associated metafields. */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The date and time when the metaobject was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type MetaobjectFieldArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** * An auto-generated type for paginating through multiple Metaobjects. - * */ export type MetaobjectConnection = { /** A list of edges. */ @@ -4833,11 +4712,10 @@ export type MetaobjectConnection = { /** * An auto-generated type which holds one Metaobject and a cursor during pagination. - * */ export type MetaobjectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MetaobjectEdge. */ node: Metaobject; }; @@ -4845,7 +4723,7 @@ export type MetaobjectEdge = { /** Provides the value of a Metaobject field. */ export type MetaobjectField = { /** The field key. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** A referenced object if the field type is a resource reference. */ reference?: Maybe; /** A list of referenced objects if the field type is a resource reference list. */ @@ -4853,36 +4731,34 @@ export type MetaobjectField = { /** * The type name of the field. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). - * */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The field value. */ - value?: Maybe; + value?: Maybe; }; - /** Provides the value of a Metaobject field. */ export type MetaobjectFieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** The input fields used to retrieve a metaobject by handle. */ export type MetaobjectHandleInput = { /** The handle of the metaobject. */ - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; /** The type of the metaobject. */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; }; /** Represents a Shopify hosted 3D model. */ export type Model3d = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4896,30 +4772,29 @@ export type Model3d = Media & Node & { /** Represents a source for a Shopify hosted 3d model. */ export type Model3dSource = { /** The filesize of the 3d model. */ - filesize: Scalars['Int']['output']; + filesize: Scalars["Int"]["output"]; /** The format of the 3d model. */ - format: Scalars['String']['output']; + format: Scalars["String"]["output"]; /** The MIME type of the 3d model. */ - mimeType: Scalars['String']['output']; + mimeType: Scalars["String"]["output"]; /** The URL of the 3d model. */ - url: Scalars['String']['output']; + url: Scalars["String"]["output"]; }; /** The input fields for a monetary value with currency. */ export type MoneyInput = { /** Decimal money amount. */ - amount: Scalars['Decimal']['input']; + amount: Scalars["Decimal"]["input"]; /** Currency of the money. */ currencyCode: CurrencyCode; }; /** * A monetary value with currency. - * */ export type MoneyV2 = { /** Decimal money amount. */ - amount: Scalars['Decimal']['output']; + amount: Scalars["Decimal"]["output"]; /** Currency of the money. */ currencyCode: CurrencyCode; }; @@ -4933,7 +4808,6 @@ export type Mutation = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. - * */ cartBuyerIdentityUpdate?: Maybe; /** Creates a new cart. */ @@ -4952,7 +4826,6 @@ export type Mutation = { * Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. * * Allows a maximum of 25 cart metafields to be set at a time. - * */ cartMetafieldsSet?: Maybe; /** Updates the note on the cart. */ @@ -4960,7 +4833,9 @@ export type Mutation = { /** Update the customer's payment method that will be used to checkout. */ cartPaymentUpdate?: Maybe; /** Update the selected delivery options for a delivery group. */ - cartSelectedDeliveryOptionsUpdate?: Maybe; + cartSelectedDeliveryOptionsUpdate?: Maybe< + CartSelectedDeliveryOptionsUpdatePayload + >; /** Submit the cart for checkout completion. */ cartSubmitForCompletion?: Maybe; /** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */ @@ -4968,9 +4843,13 @@ export type Mutation = { /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ checkoutCompleteFree?: Maybe; /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). */ - checkoutCompleteWithCreditCardV2?: Maybe; + checkoutCompleteWithCreditCardV2?: Maybe< + CheckoutCompleteWithCreditCardV2Payload + >; /** Completes a checkout with a tokenized payment. */ - checkoutCompleteWithTokenizedPaymentV3?: Maybe; + checkoutCompleteWithTokenizedPaymentV3?: Maybe< + CheckoutCompleteWithTokenizedPaymentV3Payload + >; /** Creates a new checkout. */ checkoutCreate?: Maybe; /** Associates a customer to the checkout. */ @@ -4996,13 +4875,14 @@ export type Mutation = { /** Updates line items on a checkout. */ checkoutLineItemsUpdate?: Maybe; /** Updates the shipping address of an existing checkout. */ - checkoutShippingAddressUpdateV2?: Maybe; + checkoutShippingAddressUpdateV2?: Maybe< + CheckoutShippingAddressUpdateV2Payload + >; /** Updates the shipping lines on an existing checkout. */ checkoutShippingLineUpdate?: Maybe; /** * Creates a customer access token. * The customer access token is required to modify the customer object in any way. - * */ customerAccessTokenCreate?: Maybe; /** @@ -5010,9 +4890,10 @@ export type Mutation = { * [multipass token](https://shopify.dev/api/multipass) instead of email and * password. A customer record is created if the customer doesn't exist. If a customer * record already exists but the record is disabled, then the customer record is enabled. - * */ - customerAccessTokenCreateWithMultipass?: Maybe; + customerAccessTokenCreateWithMultipass?: Maybe< + CustomerAccessTokenCreateWithMultipassPayload + >; /** Permanently destroys a customer access token. */ customerAccessTokenDelete?: Maybe; /** @@ -5020,7 +4901,6 @@ export type Mutation = { * * Access token renewal must happen *before* a token expires. * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. - * */ customerAccessTokenRenew?: Maybe; /** Activates a customer. */ @@ -5050,332 +4930,283 @@ export type Mutation = { * * Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this * mutation presents a security risk. - * */ customerRecover?: Maybe; /** * "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." - * */ customerReset?: Maybe; /** * "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." - * */ customerResetByUrl?: Maybe; /** Updates an existing customer. */ customerUpdate?: Maybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartAttributesUpdateArgs = { attributes: Array; - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartBuyerIdentityUpdateArgs = { buyerIdentity: CartBuyerIdentityInput; - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartCreateArgs = { input?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartDiscountCodesUpdateArgs = { - cartId: Scalars['ID']['input']; - discountCodes?: InputMaybe>; + cartId: Scalars["ID"]["input"]; + discountCodes?: InputMaybe>; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesAddArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesRemoveArgs = { - cartId: Scalars['ID']['input']; - lineIds: Array; + cartId: Scalars["ID"]["input"]; + lineIds: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldDeleteArgs = { input: CartMetafieldDeleteInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldsSetArgs = { metafields: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartNoteUpdateArgs = { - cartId: Scalars['ID']['input']; - note?: InputMaybe; + cartId: Scalars["ID"]["input"]; + note?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartPaymentUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; payment: CartPaymentInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSelectedDeliveryOptionsUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; selectedDeliveryOptions: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSubmitForCompletionArgs = { - attemptToken: Scalars['String']['input']; - cartId: Scalars['ID']['input']; + attemptToken: Scalars["String"]["input"]; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutAttributesUpdateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; input: CheckoutAttributesUpdateV2Input; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteFreeArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithCreditCardV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; payment: CreditCardPaymentInputV2; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; payment: TokenizedPaymentInputV3; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCreateArgs = { input: CheckoutCreateInput; - queueToken?: InputMaybe; + queueToken?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerAssociateV2Args = { - checkoutId: Scalars['ID']['input']; - customerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerDisassociateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeApplyV2Args = { - checkoutId: Scalars['ID']['input']; - discountCode: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + discountCode: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeRemoveArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutEmailUpdateV2Args = { - checkoutId: Scalars['ID']['input']; - email: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + email: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardRemoveV2Args = { - appliedGiftCardId: Scalars['ID']['input']; - checkoutId: Scalars['ID']['input']; + appliedGiftCardId: Scalars["ID"]["input"]; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardsAppendArgs = { - checkoutId: Scalars['ID']['input']; - giftCardCodes: Array; + checkoutId: Scalars["ID"]["input"]; + giftCardCodes: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsAddArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsRemoveArgs = { - checkoutId: Scalars['ID']['input']; - lineItemIds: Array; + checkoutId: Scalars["ID"]["input"]; + lineItemIds: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsReplaceArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsUpdateArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingAddressUpdateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; shippingAddress: MailingAddressInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingLineUpdateArgs = { - checkoutId: Scalars['ID']['input']; - shippingRateHandle: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + shippingRateHandle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenCreateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateWithMultipassArgs = { - multipassToken: Scalars['String']['input']; + multipassToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenDeleteArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; input: CustomerActivateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateByUrlArgs = { - activationUrl: Scalars['URL']['input']; - password: Scalars['String']['input']; + activationUrl: Scalars["URL"]["input"]; + password: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressCreateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressDeleteArgs = { - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressUpdateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerCreateArgs = { input: CustomerCreateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerDefaultAddressUpdateArgs = { - addressId: Scalars['ID']['input']; - customerAccessToken: Scalars['String']['input']; + addressId: Scalars["ID"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerRecoverArgs = { - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; input: CustomerResetInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetByUrlArgs = { - password: Scalars['String']['input']; - resetUrl: Scalars['URL']['input']; + password: Scalars["String"]["input"]; + resetUrl: Scalars["URL"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerUpdateArgs = { customer: CustomerUpdateInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; /** @@ -5383,17 +5214,16 @@ export type MutationCustomerUpdateArgs = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type Node = { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; /** Represents a resource that can be published to the Online Store sales channel. */ export type OnlineStorePublishable = { /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; }; /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ @@ -5403,7 +5233,7 @@ export type Order = HasMetafields & Node & { /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ cancelReason?: Maybe; /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ - canceledAt?: Maybe; + canceledAt?: Maybe; /** The code of the currency used for the payment. */ currencyCode: CurrencyCode; /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order. */ @@ -5417,21 +5247,21 @@ export type Order = HasMetafields & Node & { /** A list of the custom attributes added to the order. */ customAttributes: Array; /** The locale code in which this specific order happened. */ - customerLocale?: Maybe; + customerLocale?: Maybe; /** The unique URL that the customer can use to access the order. */ - customerUrl?: Maybe; + customerUrl?: Maybe; /** Discounts that have been applied on the order. */ discountApplications: DiscountApplicationConnection; /** Whether the order has had any edits applied or not. */ - edited: Scalars['Boolean']['output']; + edited: Scalars["Boolean"]["output"]; /** The customer's email address. */ - email?: Maybe; + email?: Maybe; /** The financial status of the order. */ financialStatus?: Maybe; /** The fulfillment status for the order. */ fulfillmentStatus: OrderFulfillmentStatus; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** List of the order’s line items. */ lineItems: OrderLineItemConnection; /** Returns a metafield found by namespace and key. */ @@ -5441,33 +5271,30 @@ export type Order = HasMetafields & Node & { /** * Unique identifier for the order that appears on the order. * For example, _#1000_ or _Store1001. - * */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** A unique numeric identifier for the order for use by shop owner and customer. */ - orderNumber: Scalars['Int']['output']; + orderNumber: Scalars["Int"]["output"]; /** The total cost of duties charged at checkout. */ originalTotalDuties?: Maybe; /** The total price of the order before any applied edits. */ originalTotalPrice: MoneyV2; /** The customer's phone number for receiving SMS notifications. */ - phone?: Maybe; + phone?: Maybe; /** * The date and time when the order was imported. * This value can be set to dates in the past when importing from other systems. * If no value is provided, it will be auto-generated based on current date and time. - * */ - processedAt: Scalars['DateTime']['output']; + processedAt: Scalars["DateTime"]["output"]; /** The address to where the order will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. - * */ shippingDiscountAllocations: Array; /** The unique URL for the order's status page. */ - statusUrl: Scalars['URL']['output']; + statusUrl: Scalars["URL"]["output"]; /** Price of the order before shipping and taxes. */ subtotalPrice?: Maybe; /** @@ -5507,61 +5334,55 @@ export type Order = HasMetafields & Node & { totalTaxV2?: Maybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldsArgs = { identifiers: Array; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderSuccessfulFulfillmentsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents the reason for the order's cancellation. */ export type OrderCancelReason = /** The customer wanted to cancel the order. */ - | 'CUSTOMER' + | "CUSTOMER" /** Payment was declined. */ - | 'DECLINED' + | "DECLINED" /** The order was fraudulent. */ - | 'FRAUD' + | "FRAUD" /** There was insufficient inventory. */ - | 'INVENTORY' + | "INVENTORY" /** The order was canceled for an unlisted reason. */ - | 'OTHER'; + | "OTHER"; /** * An auto-generated type for paginating through multiple Orders. - * */ export type OrderConnection = { /** A list of edges. */ @@ -5571,16 +5392,15 @@ export type OrderConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Orders. */ - totalCount: Scalars['UnsignedInt64']['output']; + totalCount: Scalars["UnsignedInt64"]["output"]; }; /** * An auto-generated type which holds one Order and a cursor during pagination. - * */ export type OrderEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of OrderEdge. */ node: Order; }; @@ -5588,45 +5408,45 @@ export type OrderEdge = { /** Represents the order's current financial status. */ export type OrderFinancialStatus = /** Displayed as **Authorized**. */ - | 'AUTHORIZED' + | "AUTHORIZED" /** Displayed as **Paid**. */ - | 'PAID' + | "PAID" /** Displayed as **Partially paid**. */ - | 'PARTIALLY_PAID' + | "PARTIALLY_PAID" /** Displayed as **Partially refunded**. */ - | 'PARTIALLY_REFUNDED' + | "PARTIALLY_REFUNDED" /** Displayed as **Pending**. */ - | 'PENDING' + | "PENDING" /** Displayed as **Refunded**. */ - | 'REFUNDED' + | "REFUNDED" /** Displayed as **Voided**. */ - | 'VOIDED'; + | "VOIDED"; /** Represents the order's aggregated fulfillment status for display purposes. */ export type OrderFulfillmentStatus = /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ - | 'FULFILLED' + | "FULFILLED" /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ - | 'IN_PROGRESS' + | "IN_PROGRESS" /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ - | 'ON_HOLD' + | "ON_HOLD" /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ - | 'OPEN' + | "OPEN" /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ - | 'PARTIALLY_FULFILLED' + | "PARTIALLY_FULFILLED" /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ - | 'PENDING_FULFILLMENT' + | "PENDING_FULFILLMENT" /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ - | 'RESTOCKED' + | "RESTOCKED" /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ - | 'SCHEDULED' + | "SCHEDULED" /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ - | 'UNFULFILLED'; + | "UNFULFILLED"; /** Represents a single line in an order. There is one line item for each distinct product variant. */ export type OrderLineItem = { /** The number of entries associated to the line item minus the items that have been removed. */ - currentQuantity: Scalars['Int']['output']; + currentQuantity: Scalars["Int"]["output"]; /** List of custom attributes associated to the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the order line item by discount applications. */ @@ -5636,16 +5456,15 @@ export type OrderLineItem = { /** The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it's displayed in the presentment currency. */ originalTotalPrice: MoneyV2; /** The number of products variants associated to the line item. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The title of the product combined with title of the variant. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The product variant object associated to the line item. */ variant?: Maybe; }; /** * An auto-generated type for paginating through multiple OrderLineItems. - * */ export type OrderLineItemConnection = { /** A list of edges. */ @@ -5658,11 +5477,10 @@ export type OrderLineItemConnection = { /** * An auto-generated type which holds one OrderLineItem and a cursor during pagination. - * */ export type OrderLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of OrderLineItemEdge. */ node: OrderLineItem; }; @@ -5670,54 +5488,51 @@ export type OrderLineItemEdge = { /** The set of valid sort keys for the Order query. */ export type OrderSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `processed_at` value. */ - | 'PROCESSED_AT' + | "PROCESSED_AT" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `total_price` value. */ - | 'TOTAL_PRICE'; + | "TOTAL_PRICE"; /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & { /** The description of the page, complete with HTML formatting. */ - body: Scalars['HTML']['output']; + body: Scalars["HTML"]["output"]; /** Summary of the page body. */ - bodySummary: Scalars['String']['output']; + bodySummary: Scalars["String"]["output"]; /** The timestamp of the page creation. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** A human-friendly unique string for the page automatically generated from its title. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The page's SEO information. */ seo?: Maybe; /** The title of the page. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; /** The timestamp of the latest page update. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldsArgs = { identifiers: Array; @@ -5725,7 +5540,6 @@ export type PageMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Pages. - * */ export type PageConnection = { /** A list of edges. */ @@ -5738,11 +5552,10 @@ export type PageConnection = { /** * An auto-generated type which holds one Page and a cursor during pagination. - * */ export type PageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of PageEdge. */ node: Page; }; @@ -5751,33 +5564,31 @@ export type PageEdge = { * Returns information about pagination in a connection, in accordance with the * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). - * */ export type PageInfo = { /** The cursor corresponding to the last node in edges. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Whether there are more pages to fetch following the current page. */ - hasNextPage: Scalars['Boolean']['output']; + hasNextPage: Scalars["Boolean"]["output"]; /** Whether there are any pages prior to the current page. */ - hasPreviousPage: Scalars['Boolean']['output']; + hasPreviousPage: Scalars["Boolean"]["output"]; /** The cursor corresponding to the first node in edges. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** The set of valid sort keys for the Page query. */ export type PageSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** A payment applied to a checkout. */ export type Payment = Node & { @@ -5795,22 +5606,21 @@ export type Payment = Node & { /** The credit card used for the payment in the case of direct payments. */ creditCard?: Maybe; /** A message describing a processing error during asynchronous processing. */ - errorMessage?: Maybe; + errorMessage?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** * A client-side generated token to identify a payment and perform idempotent operations. * For more information, refer to * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). - * */ - idempotencyKey?: Maybe; + idempotencyKey?: Maybe; /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ - nextActionUrl?: Maybe; + nextActionUrl?: Maybe; /** Whether the payment is still processing asynchronously. */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ - test: Scalars['Boolean']['output']; + test: Scalars["Boolean"]["output"]; /** The actual transaction recorded by Shopify after having processed the payment with the gateway. */ transaction?: Maybe; }; @@ -5820,7 +5630,7 @@ export type PaymentSettings = { /** List of the card brands which the shop accepts. */ acceptedCardBrands: Array; /** The url pointing to the endpoint to vault credit cards. */ - cardVaultUrl: Scalars['URL']['output']; + cardVaultUrl: Scalars["URL"]["output"]; /** The country where the shop is located. */ countryCode: CountryCode; /** The three-letter code for the shop's primary currency. */ @@ -5828,11 +5638,10 @@ export type PaymentSettings = { /** * A list of enabled currencies (ISO 4217 format) that the shop accepts. * Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. - * */ enabledPresentmentCurrencies: Array; /** The shop’s Shopify Payments account ID. */ - shopifyPaymentsAccountId?: Maybe; + shopifyPaymentsAccountId?: Maybe; /** List of the digital wallets which the shop supports. */ supportedDigitalWallets: Array; }; @@ -5840,27 +5649,26 @@ export type PaymentSettings = { /** The valid values for the types of payment token. */ export type PaymentTokenType = /** Apple Pay token type. */ - | 'APPLE_PAY' + | "APPLE_PAY" /** Google Pay token type. */ - | 'GOOGLE_PAY' + | "GOOGLE_PAY" /** Shopify Pay token type. */ - | 'SHOPIFY_PAY' + | "SHOPIFY_PAY" /** Stripe token type. */ - | 'STRIPE_VAULT_TOKEN' + | "STRIPE_VAULT_TOKEN" /** Vault payment token type. */ - | 'VAULT'; + | "VAULT"; /** Decides the distribution of results. */ export type PredictiveSearchLimitScope = /** Return results up to limit across all types. */ - | 'ALL' + | "ALL" /** Return results up to limit per type. */ - | 'EACH'; + | "EACH"; /** * A predictive search result represents a list of products, collections, pages, articles, and query suggestions * that matches the predictive search query. - * */ export type PredictiveSearchResult = { /** The articles that match the search query. */ @@ -5878,31 +5686,30 @@ export type PredictiveSearchResult = { /** The types of search items to perform predictive search on. */ export type PredictiveSearchType = /** Returns matching articles. */ - | 'ARTICLE' + | "ARTICLE" /** Returns matching collections. */ - | 'COLLECTION' + | "COLLECTION" /** Returns matching pages. */ - | 'PAGE' + | "PAGE" /** Returns matching products. */ - | 'PRODUCT' + | "PRODUCT" /** Returns matching query strings. */ - | 'QUERY'; + | "QUERY"; /** * The input fields for a filter used to view a subset of products in a collection matching a specific price range. - * */ export type PriceRangeFilter = { /** The maximum price in the range. Empty indicates no max price. */ - max?: InputMaybe; + max?: InputMaybe; /** The minimum price in the range. Defaults to zero. */ - min?: InputMaybe; + min?: InputMaybe; }; /** The value of the percentage pricing object. */ export type PricingPercentageValue = { /** The percentage value of the object. */ - percentage: Scalars['Float']['output']; + percentage: Scalars["Float"]["output"]; }; /** The price value (fixed or percentage) for a discount application. */ @@ -5913,265 +5720,242 @@ export type PricingValue = MoneyV2 | PricingPercentageValue; * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ -export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** Indicates if at least one product variant is available for sale. */ - availableForSale: Scalars['Boolean']['output']; - /** List of collections a product belongs to. */ - collections: CollectionConnection; - /** The compare at price of the product across all variants. */ - compareAtPriceRange: ProductPriceRange; - /** The date and time when the product was created. */ - createdAt: Scalars['DateTime']['output']; - /** Stripped description of the product, single line with HTML tags removed. */ - description: Scalars['String']['output']; - /** The description of the product, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML']['output']; - /** - * The featured image for the product. - * - * This field is functionally equivalent to `images(first: 1)`. - * - */ - featuredImage?: Maybe; - /** - * A human-friendly unique string for the Product automatically generated from its title. - * They are used by the Liquid templating language to refer to objects. - * - */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** List of images associated with the product. */ - images: ImageConnection; - /** Whether the product is a gift card. */ - isGiftCard: Scalars['Boolean']['output']; - /** The media associated with the product. */ - media: MediaConnection; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of product options. */ - options: Array; - /** The price range. */ - priceRange: ProductPriceRange; - /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ - productType: Scalars['String']['output']; - /** The date and time when the product was published to the channel. */ - publishedAt: Scalars['DateTime']['output']; - /** Whether the product can only be purchased with a selling plan. */ - requiresSellingPlan: Scalars['Boolean']['output']; - /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ - sellingPlanGroups: SellingPlanGroupConnection; - /** The product's SEO information. */ - seo: Seo; - /** - * A comma separated list of tags that have been added to the product. - * Additional access scope required for private apps: unauthenticated_read_product_tags. - * - */ - tags: Array; - /** The product’s title. */ - title: Scalars['String']['output']; - /** The total quantity of inventory in stock for this Product. */ - totalInventory?: Maybe; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** - * The date and time when the product was last modified. - * A product's `updatedAt` value can change for different reasons. For example, if an order - * is placed for a product that has inventory tracking set up, then the inventory adjustment - * is counted as an update. - * - */ - updatedAt: Scalars['DateTime']['output']; - /** - * Find a product’s variant based on its selected options. - * This is useful for converting a user’s selection of product options into a single matching variant. - * If there is not a variant for the selected options, `null` will be returned. - * - */ - variantBySelectedOptions?: Maybe; - /** List of the product’s variants. */ - variants: ProductVariantConnection; - /** The product’s vendor name. */ - vendor: Scalars['String']['output']; -}; - +export type Product = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** Indicates if at least one product variant is available for sale. */ + availableForSale: Scalars["Boolean"]["output"]; + /** List of collections a product belongs to. */ + collections: CollectionConnection; + /** The compare at price of the product across all variants. */ + compareAtPriceRange: ProductPriceRange; + /** The date and time when the product was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Stripped description of the product, single line with HTML tags removed. */ + description: Scalars["String"]["output"]; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml: Scalars["HTML"]["output"]; + /** + * The featured image for the product. + * + * This field is functionally equivalent to `images(first: 1)`. + */ + featuredImage?: Maybe; + /** + * A human-friendly unique string for the Product automatically generated from its title. + * They are used by the Liquid templating language to refer to objects. + */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** List of images associated with the product. */ + images: ImageConnection; + /** Whether the product is a gift card. */ + isGiftCard: Scalars["Boolean"]["output"]; + /** The media associated with the product. */ + media: MediaConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of product options. */ + options: Array; + /** The price range. */ + priceRange: ProductPriceRange; + /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ + productType: Scalars["String"]["output"]; + /** The date and time when the product was published to the channel. */ + publishedAt: Scalars["DateTime"]["output"]; + /** Whether the product can only be purchased with a selling plan. */ + requiresSellingPlan: Scalars["Boolean"]["output"]; + /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** The product's SEO information. */ + seo: Seo; + /** + * A comma separated list of tags that have been added to the product. + * Additional access scope required for private apps: unauthenticated_read_product_tags. + */ + tags: Array; + /** The product’s title. */ + title: Scalars["String"]["output"]; + /** The total quantity of inventory in stock for this Product. */ + totalInventory?: Maybe; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** + * The date and time when the product was last modified. + * A product's `updatedAt` value can change for different reasons. For example, if an order + * is placed for a product that has inventory tracking set up, then the inventory adjustment + * is counted as an update. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * Find a product’s variant based on its selected options. + * This is useful for converting a user’s selection of product options into a single matching variant. + * If there is not a variant for the selected options, `null` will be returned. + */ + variantBySelectedOptions?: Maybe; + /** List of the product’s variants. */ + variants: ProductVariantConnection; + /** The product’s vendor name. */ + vendor: Scalars["String"]["output"]; + }; /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductImagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMediaArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMetafieldsArgs = { identifiers: Array; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductOptionsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductSellingPlanGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductVariantBySelectedOptionsArgs = { selectedOptions: Array; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductVariantsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** The set of valid sort keys for the ProductCollection query. */ export type ProductCollectionSortKeys = /** Sort by the `best-selling` value. */ - | 'BEST_SELLING' + | "BEST_SELLING" /** Sort by the `collection-default` value. */ - | 'COLLECTION_DEFAULT' + | "COLLECTION_DEFAULT" /** Sort by the `created` value. */ - | 'CREATED' + | "CREATED" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `manual` value. */ - | 'MANUAL' + | "MANUAL" /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** * An auto-generated type for paginating through multiple Products. - * */ export type ProductConnection = { /** A list of edges. */ @@ -6186,11 +5970,10 @@ export type ProductConnection = { /** * An auto-generated type which holds one Product and a cursor during pagination. - * */ export type ProductEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ProductEdge. */ node: Product; }; @@ -6199,21 +5982,20 @@ export type ProductEdge = { * The input fields for a filter used to view a subset of products in a collection. * By default, the `available` and `price` filters are enabled. Filters are customized with the Shopify Search & Discovery app. * Learn more about [customizing storefront filtering](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters). - * */ export type ProductFilter = { /** Filter on if the product is available for sale. */ - available?: InputMaybe; + available?: InputMaybe; /** A range of prices to filter with-in. */ price?: InputMaybe; /** A product metafield to filter on. */ productMetafield?: InputMaybe; /** The product type to filter on. */ - productType?: InputMaybe; + productType?: InputMaybe; /** The product vendor to filter on. */ - productVendor?: InputMaybe; + productVendor?: InputMaybe; /** A product tag to filter on. */ - tag?: InputMaybe; + tag?: InputMaybe; /** A variant metafield to filter on. */ variantMetafield?: InputMaybe; /** A variant option to filter on. */ @@ -6223,44 +6005,41 @@ export type ProductFilter = { /** The set of valid sort keys for the ProductImage query. */ export type ProductImageSortKeys = /** Sort by the `created_at` value. */ - | 'CREATED_AT' + | "CREATED_AT" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE'; + | "RELEVANCE"; /** The set of valid sort keys for the ProductMedia query. */ export type ProductMediaSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE'; + | "RELEVANCE"; /** * Product property names like "Size", "Color", and "Material" that the customers can select. * Variants are selected based on permutations of these options. * 255 characters limit each. - * */ export type ProductOption = Node & { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The product option’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The corresponding value to the product option name. */ - values: Array; + values: Array; }; /** The price range of the product. */ @@ -6274,48 +6053,45 @@ export type ProductPriceRange = { /** * The recommendation intent that is used to generate product recommendations. * You can use intent to generate product recommendations according to different strategies. - * */ export type ProductRecommendationIntent = /** Offer customers products that are complementary to a product for which recommendations are to be fetched. An example is add-on products that display in a Pair it with section. */ - | 'COMPLEMENTARY' + | "COMPLEMENTARY" /** Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section. */ - | 'RELATED'; + | "RELATED"; /** The set of valid sort keys for the Product query. */ export type ProductSortKeys = /** Sort by the `best_selling` value. */ - | 'BEST_SELLING' + | "BEST_SELLING" /** Sort by the `created_at` value. */ - | 'CREATED_AT' + | "CREATED_AT" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** Sort by the `product_type` value. */ - | 'PRODUCT_TYPE' + | "PRODUCT_TYPE" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT' + | "UPDATED_AT" /** Sort by the `vendor` value. */ - | 'VENDOR'; + | "VENDOR"; /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariant = HasMetafields & Node & { /** Indicates if the product variant is available for sale. */ - availableForSale: Scalars['Boolean']['output']; + availableForSale: Scalars["Boolean"]["output"]; /** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */ - barcode?: Maybe; + barcode?: Maybe; /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. */ compareAtPrice?: Maybe; /** @@ -6324,9 +6100,9 @@ export type ProductVariant = HasMetafields & Node & { */ compareAtPriceV2?: Maybe; /** Whether a product is out of stock but still available for purchase (used for backorders). */ - currentlyNotInStock: Scalars['Boolean']['output']; + currentlyNotInStock: Scalars["Boolean"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Image associated with the product variant. This field falls back to the product image if no image is available. */ image?: Maybe; /** Returns a metafield found by namespace and key. */ @@ -6343,78 +6119,69 @@ export type ProductVariant = HasMetafields & Node & { /** The product object that the product variant belongs to. */ product: Product; /** The total sellable quantity of the variant for online sales channels. */ - quantityAvailable?: Maybe; + quantityAvailable?: Maybe; /** Whether a customer needs to provide a shipping address when placing an order for the product variant. */ - requiresShipping: Scalars['Boolean']['output']; + requiresShipping: Scalars["Boolean"]["output"]; /** List of product options applied to the variant. */ selectedOptions: Array; /** Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. */ sellingPlanAllocations: SellingPlanAllocationConnection; /** The SKU (stock keeping unit) associated with the variant. */ - sku?: Maybe; + sku?: Maybe; /** The in-store pickup availability of this variant by location. */ storeAvailability: StoreAvailabilityConnection; /** The product variant’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The unit price value for the variant based on the variant's measurement. */ unitPrice?: Maybe; /** The unit price measurement for the variant. */ unitPriceMeasurement?: Maybe; /** The weight of the product variant in the unit system specified with `weight_unit`. */ - weight?: Maybe; + weight?: Maybe; /** Unit of measurement for weight. */ weightUnit: WeightUnit; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantMetafieldsArgs = { identifiers: Array; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantSellingPlanAllocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantStoreAvailabilityArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple ProductVariants. - * */ export type ProductVariantConnection = { /** A list of edges. */ @@ -6427,11 +6194,10 @@ export type ProductVariantConnection = { /** * An auto-generated type which holds one ProductVariant and a cursor during pagination. - * */ export type ProductVariantEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ProductVariantEdge. */ node: ProductVariant; }; @@ -6439,19 +6205,18 @@ export type ProductVariantEdge = { /** The set of valid sort keys for the ProductVariant query. */ export type ProductVariantSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `sku` value. */ - | 'SKU' + | "SKU" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRoot = { @@ -6471,12 +6236,10 @@ export type QueryRoot = { /** * Retrieve a cart by its ID. For more information, refer to * [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage). - * */ cart?: Maybe; /** * A poll for the status of the cart checkout completion and order creation. - * */ cartCompletionAttempt?: Maybe; /** Fetch a specific `Collection` by one of its unique attributes. */ @@ -6491,7 +6254,6 @@ export type QueryRoot = { /** * The customer associated with the given access token. Tokens are obtained by using the * [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate). - * */ customer?: Maybe; /** Returns the localized experiences configured for the shop. */ @@ -6500,8 +6262,6 @@ export type QueryRoot = { * List of the shop's locations that support in-store pickup. * * When sorting by distance, you must specify a location via the `near` argument. - * - * */ locations: LocationConnection; /** Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle. */ @@ -6536,13 +6296,11 @@ export type QueryRoot = { * Find recommended products related to a given `product_id`. * To learn more about how recommendations are generated, see * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). - * */ productRecommendations?: Maybe>; /** * Tags added to products. * Additional access scope required: unauthenticated_read_product_tags. - * */ productTags: StringConnection; /** List of product types for the shop's products that are published to your app. */ @@ -6559,260 +6317,230 @@ export type QueryRoot = { urlRedirects: UrlRedirectConnection; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticleArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartCompletionAttemptArgs = { - attemptId: Scalars['String']['input']; + attemptId: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMenuArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectArgs = { handle?: InputMaybe; - id?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; - sortKey?: InputMaybe; - type: Scalars['String']['input']; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodeArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPredictiveSearchArgs = { - limit?: InputMaybe; + limit?: InputMaybe; limitScope?: InputMaybe; - query: Scalars['String']['input']; + query: Scalars["String"]["input"]; searchableFields?: InputMaybe>; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductRecommendationsArgs = { intent?: InputMaybe; - productId: Scalars['ID']['input']; + productId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTagsArgs = { - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTypesArgs = { - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSearchArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; prefix?: InputMaybe; productFilters?: InputMaybe>; - query: Scalars['String']['input']; - reverse?: InputMaybe; + query: Scalars["String"]["input"]; + reverse?: InputMaybe; sortKey?: InputMaybe; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootUrlRedirectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; }; /** SEO information. */ export type Seo = { /** The meta description. */ - description?: Maybe; + description?: Maybe; /** The SEO title. */ - title?: Maybe; + title?: Maybe; }; /** * Script discount applications capture the intentions of a discount that * was created by a Shopify Script. - * */ export type ScriptDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -6822,7 +6550,7 @@ export type ScriptDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application as defined by the Script. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -6830,29 +6558,27 @@ export type ScriptDiscountApplication = DiscountApplication & { /** Specifies whether to perform a partial word match on the last search term. */ export type SearchPrefixQueryType = /** Perform a partial word match on the last search term. */ - | 'LAST' + | "LAST" /** Don't perform a partial word match on the last search term. */ - | 'NONE'; + | "NONE"; /** A search query suggestion. */ export type SearchQuerySuggestion = Trackable & { /** The text of the search query suggestion with highlighted HTML tags. */ - styledText: Scalars['String']['output']; + styledText: Scalars["String"]["output"]; /** The text of the search query suggestion. */ - text: Scalars['String']['output']; + text: Scalars["String"]["output"]; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** * A search result that matches the search query. - * */ export type SearchResultItem = Article | Page | Product; /** * An auto-generated type for paginating through multiple SearchResultItems. - * */ export type SearchResultItemConnection = { /** A list of edges. */ @@ -6864,16 +6590,15 @@ export type SearchResultItemConnection = { /** A list of available filters. */ productFilters: Array; /** The total number of results. */ - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** * An auto-generated type which holds one SearchResultItem and a cursor during pagination. - * */ export type SearchResultItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SearchResultItemEdge. */ node: SearchResultItem; }; @@ -6881,67 +6606,66 @@ export type SearchResultItemEdge = { /** The set of valid sort keys for the search query. */ export type SearchSortKeys = /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** Sort by relevance to the search terms. */ - | 'RELEVANCE'; + | "RELEVANCE"; /** The types of search items to perform search within. */ export type SearchType = /** Returns matching articles. */ - | 'ARTICLE' + | "ARTICLE" /** Returns matching pages. */ - | 'PAGE' + | "PAGE" /** Returns matching products. */ - | 'PRODUCT'; + | "PRODUCT"; /** Specifies whether to display results for unavailable products. */ export type SearchUnavailableProductsType = /** Exclude unavailable products. */ - | 'HIDE' + | "HIDE" /** Show unavailable products after all other matching results. This is the default. */ - | 'LAST' + | "LAST" /** Show unavailable products in the order that they're found. */ - | 'SHOW'; + | "SHOW"; /** Specifies the list of resource fields to search. */ export type SearchableField = /** Author of the page or article. */ - | 'AUTHOR' + | "AUTHOR" /** Body of the page or article or product description or collection description. */ - | 'BODY' + | "BODY" /** Product type. */ - | 'PRODUCT_TYPE' + | "PRODUCT_TYPE" /** Tag associated with the product or article. */ - | 'TAG' + | "TAG" /** Title of the page or article or product title or collection title. */ - | 'TITLE' + | "TITLE" /** Variant barcode. */ - | 'VARIANTS_BARCODE' + | "VARIANTS_BARCODE" /** Variant SKU. */ - | 'VARIANTS_SKU' + | "VARIANTS_SKU" /** Variant title. */ - | 'VARIANTS_TITLE' + | "VARIANTS_TITLE" /** Product vendor. */ - | 'VENDOR'; + | "VENDOR"; /** * Properties used by customers to select a product variant. * Products can have multiple options, like different sizes or colors. - * */ export type SelectedOption = { /** The product option’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The product option’s value. */ - value: Scalars['String']['output']; + value: Scalars["String"]["output"]; }; /** The input fields required for a selected option. */ export type SelectedOptionInput = { /** The product option’s name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product option’s value. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents how products and variants can be sold and purchased. */ @@ -6949,17 +6673,17 @@ export type SellingPlan = { /** The initial payment due for the purchase. */ checkoutCharge: SellingPlanCheckoutCharge; /** The description of the selling plan. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. */ options: Array; /** The price adjustments that a selling plan makes when a variant is purchased with a selling plan. */ priceAdjustments: Array; /** Whether purchasing the selling plan will result in multiple deliveries. */ - recurringDeliveries: Scalars['Boolean']['output']; + recurringDeliveries: Scalars["Boolean"]["output"]; }; /** Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. */ @@ -6976,7 +6700,6 @@ export type SellingPlanAllocation = { /** * An auto-generated type for paginating through multiple SellingPlanAllocations. - * */ export type SellingPlanAllocationConnection = { /** A list of edges. */ @@ -6989,11 +6712,10 @@ export type SellingPlanAllocationConnection = { /** * An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination. - * */ export type SellingPlanAllocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanAllocationEdge. */ node: SellingPlanAllocation; }; @@ -7021,22 +6743,23 @@ export type SellingPlanCheckoutCharge = { /** The percentage value of the price used for checkout charge. */ export type SellingPlanCheckoutChargePercentageValue = { /** The percentage value of the price used for checkout charge. */ - percentage: Scalars['Float']['output']; + percentage: Scalars["Float"]["output"]; }; /** The checkout charge when the full amount isn't charged at checkout. */ export type SellingPlanCheckoutChargeType = /** The checkout charge is a percentage of the product or variant price. */ - | 'PERCENTAGE' + | "PERCENTAGE" /** The checkout charge is a fixed price amount. */ - | 'PRICE'; + | "PRICE"; /** The portion of the price to be charged at checkout. */ -export type SellingPlanCheckoutChargeValue = MoneyV2 | SellingPlanCheckoutChargePercentageValue; +export type SellingPlanCheckoutChargeValue = + | MoneyV2 + | SellingPlanCheckoutChargePercentageValue; /** * An auto-generated type for paginating through multiple SellingPlans. - * */ export type SellingPlanConnection = { /** A list of edges. */ @@ -7049,11 +6772,10 @@ export type SellingPlanConnection = { /** * An auto-generated type which holds one SellingPlan and a cursor during pagination. - * */ export type SellingPlanEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanEdge. */ node: SellingPlan; }; @@ -7073,28 +6795,26 @@ export type SellingPlanFixedPriceAdjustment = { /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroup = { /** A display friendly name for the app that created the selling plan group. */ - appName?: Maybe; + appName?: Maybe; /** The name of the selling plan group. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. */ options: Array; /** A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */ sellingPlans: SellingPlanConnection; }; - /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroupSellingPlansArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple SellingPlanGroups. - * */ export type SellingPlanGroupConnection = { /** A list of edges. */ @@ -7107,11 +6827,10 @@ export type SellingPlanGroupConnection = { /** * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. - * */ export type SellingPlanGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanGroupEdge. */ node: SellingPlanGroup; }; @@ -7123,23 +6842,23 @@ export type SellingPlanGroupEdge = { */ export type SellingPlanGroupOption = { /** The name of the option. For example, 'Delivery every'. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. */ - values: Array; + values: Array; }; /** An option provided by a Selling Plan. */ export type SellingPlanOption = { /** The name of the option (ie "Delivery every"). */ - name?: Maybe; + name?: Maybe; /** The value of the option (ie "Month"). */ - value?: Maybe; + value?: Maybe; }; /** A percentage amount that's deducted from the original variant price. For example, 10% off. */ export type SellingPlanPercentagePriceAdjustment = { /** The percentage value of the price adjustment. */ - adjustmentPercentage: Scalars['Int']['output']; + adjustmentPercentage: Scalars["Int"]["output"]; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. */ @@ -7147,16 +6866,19 @@ export type SellingPlanPriceAdjustment = { /** The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. */ adjustmentValue: SellingPlanPriceAdjustmentValue; /** The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. */ - orderCount?: Maybe; + orderCount?: Maybe; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. */ -export type SellingPlanPriceAdjustmentValue = SellingPlanFixedAmountPriceAdjustment | SellingPlanFixedPriceAdjustment | SellingPlanPercentagePriceAdjustment; +export type SellingPlanPriceAdjustmentValue = + | SellingPlanFixedAmountPriceAdjustment + | SellingPlanFixedPriceAdjustment + | SellingPlanPercentagePriceAdjustment; /** A shipping rate to be applied to a checkout. */ export type ShippingRate = { /** Human-readable unique identifier for this shipping rate. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** Price of this shipping rate. */ price: MoneyV2; /** @@ -7165,7 +6887,7 @@ export type ShippingRate = { */ priceV2: MoneyV2; /** Title of this shipping rate. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Shop represents a collection of the general settings and information about the shop. */ @@ -7173,17 +6895,17 @@ export type Shop = HasMetafields & Node & { /** The shop's branding configuration. */ brand?: Maybe; /** A description of the shop. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A string representing the way currency is formatted when the currency isn’t specified. */ - moneyFormat: Scalars['String']['output']; + moneyFormat: Scalars["String"]["output"]; /** The shop’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Settings related to payments. */ paymentSettings: PaymentSettings; /** The primary domain of the shop’s Online Store. */ @@ -7202,14 +6924,12 @@ export type Shop = HasMetafields & Node & { termsOfService?: Maybe; }; - /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldsArgs = { identifiers: Array; @@ -7217,67 +6937,63 @@ export type ShopMetafieldsArgs = { /** * The input fields for submitting Shop Pay payment method information for checkout. - * */ export type ShopPayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** Session token for transaction. */ - sessionToken: Scalars['String']['input']; + sessionToken: Scalars["String"]["input"]; }; /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicy = Node & { /** Policy text, maximum size of 64kb. */ - body: Scalars['String']['output']; + body: Scalars["String"]["output"]; /** Policy’s handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Policy’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Public URL to the policy. */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** * A policy for the store that comes with a default value, such as a subscription policy. * If the merchant hasn't configured a policy for their store, then the policy will return the default value. * Otherwise, the policy will return the merchant-configured value. - * */ export type ShopPolicyWithDefault = { /** The text of the policy. Maximum size: 64KB. */ - body: Scalars['String']['output']; + body: Scalars["String"]["output"]; /** The handle of the policy. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** The unique ID of the policy. A default policy doesn't have an ID. */ - id?: Maybe; + id?: Maybe; /** The title of the policy. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Public URL to the policy. */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** * The availability of a product variant at a particular location. * Local pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result. - * */ export type StoreAvailability = { /** Whether the product variant is in-stock at this location. */ - available: Scalars['Boolean']['output']; + available: Scalars["Boolean"]["output"]; /** The location where this product variant is stocked at. */ location: Location; /** Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). */ - pickUpTime: Scalars['String']['output']; + pickUpTime: Scalars["String"]["output"]; /** The quantity of the product variant in-stock at this location. */ - quantityAvailable: Scalars['Int']['output']; + quantityAvailable: Scalars["Int"]["output"]; }; /** * An auto-generated type for paginating through multiple StoreAvailabilities. - * */ export type StoreAvailabilityConnection = { /** A list of edges. */ @@ -7290,18 +7006,16 @@ export type StoreAvailabilityConnection = { /** * An auto-generated type which holds one StoreAvailability and a cursor during pagination. - * */ export type StoreAvailabilityEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of StoreAvailabilityEdge. */ node: StoreAvailability; }; /** * An auto-generated type for paginating through a list of Strings. - * */ export type StringConnection = { /** A list of edges. */ @@ -7312,13 +7026,12 @@ export type StringConnection = { /** * An auto-generated type which holds one String and a cursor during pagination. - * */ export type StringEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of StringEdge. */ - node: Scalars['String']['output']; + node: Scalars["String"]["output"]; }; /** An error that occurred during cart submit for completion. */ @@ -7326,115 +7039,115 @@ export type SubmissionError = { /** The error code. */ code: SubmissionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during cart submit for completion. */ export type SubmissionErrorCode = - | 'BUYER_IDENTITY_EMAIL_IS_INVALID' - | 'BUYER_IDENTITY_EMAIL_REQUIRED' - | 'BUYER_IDENTITY_PHONE_IS_INVALID' - | 'DELIVERY_ADDRESS1_INVALID' - | 'DELIVERY_ADDRESS1_REQUIRED' - | 'DELIVERY_ADDRESS1_TOO_LONG' - | 'DELIVERY_ADDRESS2_INVALID' - | 'DELIVERY_ADDRESS2_REQUIRED' - | 'DELIVERY_ADDRESS2_TOO_LONG' - | 'DELIVERY_ADDRESS_REQUIRED' - | 'DELIVERY_CITY_INVALID' - | 'DELIVERY_CITY_REQUIRED' - | 'DELIVERY_CITY_TOO_LONG' - | 'DELIVERY_COMPANY_INVALID' - | 'DELIVERY_COMPANY_REQUIRED' - | 'DELIVERY_COMPANY_TOO_LONG' - | 'DELIVERY_COUNTRY_REQUIRED' - | 'DELIVERY_FIRST_NAME_INVALID' - | 'DELIVERY_FIRST_NAME_REQUIRED' - | 'DELIVERY_FIRST_NAME_TOO_LONG' - | 'DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY' - | 'DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE' - | 'DELIVERY_LAST_NAME_INVALID' - | 'DELIVERY_LAST_NAME_REQUIRED' - | 'DELIVERY_LAST_NAME_TOO_LONG' - | 'DELIVERY_NO_DELIVERY_AVAILABLE' - | 'DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE' - | 'DELIVERY_OPTIONS_PHONE_NUMBER_INVALID' - | 'DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED' - | 'DELIVERY_PHONE_NUMBER_INVALID' - | 'DELIVERY_PHONE_NUMBER_REQUIRED' - | 'DELIVERY_POSTAL_CODE_INVALID' - | 'DELIVERY_POSTAL_CODE_REQUIRED' - | 'DELIVERY_ZONE_NOT_FOUND' - | 'DELIVERY_ZONE_REQUIRED_FOR_COUNTRY' - | 'ERROR' - | 'MERCHANDISE_LINE_LIMIT_REACHED' - | 'MERCHANDISE_NOT_APPLICABLE' - | 'MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE' - | 'MERCHANDISE_OUT_OF_STOCK' - | 'MERCHANDISE_PRODUCT_NOT_PUBLISHED' - | 'NO_DELIVERY_GROUP_SELECTED' - | 'PAYMENTS_ADDRESS1_INVALID' - | 'PAYMENTS_ADDRESS1_REQUIRED' - | 'PAYMENTS_ADDRESS1_TOO_LONG' - | 'PAYMENTS_ADDRESS2_INVALID' - | 'PAYMENTS_ADDRESS2_REQUIRED' - | 'PAYMENTS_ADDRESS2_TOO_LONG' - | 'PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND' - | 'PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY' - | 'PAYMENTS_CITY_INVALID' - | 'PAYMENTS_CITY_REQUIRED' - | 'PAYMENTS_CITY_TOO_LONG' - | 'PAYMENTS_COMPANY_INVALID' - | 'PAYMENTS_COMPANY_REQUIRED' - | 'PAYMENTS_COMPANY_TOO_LONG' - | 'PAYMENTS_COUNTRY_REQUIRED' - | 'PAYMENTS_CREDIT_CARD_BASE_EXPIRED' - | 'PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED' - | 'PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' - | 'PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED' - | 'PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK' - | 'PAYMENTS_CREDIT_CARD_GENERIC' - | 'PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK' - | 'PAYMENTS_CREDIT_CARD_MONTH_INCLUSION' - | 'PAYMENTS_CREDIT_CARD_NAME_INVALID' - | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID' - | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT' - | 'PAYMENTS_CREDIT_CARD_SESSION_ID' - | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK' - | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' - | 'PAYMENTS_CREDIT_CARD_YEAR_EXPIRED' - | 'PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR' - | 'PAYMENTS_FIRST_NAME_INVALID' - | 'PAYMENTS_FIRST_NAME_REQUIRED' - | 'PAYMENTS_FIRST_NAME_TOO_LONG' - | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY' - | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE' - | 'PAYMENTS_LAST_NAME_INVALID' - | 'PAYMENTS_LAST_NAME_REQUIRED' - | 'PAYMENTS_LAST_NAME_TOO_LONG' - | 'PAYMENTS_METHOD_REQUIRED' - | 'PAYMENTS_METHOD_UNAVAILABLE' - | 'PAYMENTS_PHONE_NUMBER_INVALID' - | 'PAYMENTS_PHONE_NUMBER_REQUIRED' - | 'PAYMENTS_POSTAL_CODE_INVALID' - | 'PAYMENTS_POSTAL_CODE_REQUIRED' - | 'PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED' - | 'PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT' - | 'PAYMENTS_WALLET_CONTENT_MISSING' - | 'TAXES_DELIVERY_GROUP_ID_NOT_FOUND' - | 'TAXES_LINE_ID_NOT_FOUND' - | 'TAXES_MUST_BE_DEFINED'; + | "BUYER_IDENTITY_EMAIL_IS_INVALID" + | "BUYER_IDENTITY_EMAIL_REQUIRED" + | "BUYER_IDENTITY_PHONE_IS_INVALID" + | "DELIVERY_ADDRESS1_INVALID" + | "DELIVERY_ADDRESS1_REQUIRED" + | "DELIVERY_ADDRESS1_TOO_LONG" + | "DELIVERY_ADDRESS2_INVALID" + | "DELIVERY_ADDRESS2_REQUIRED" + | "DELIVERY_ADDRESS2_TOO_LONG" + | "DELIVERY_ADDRESS_REQUIRED" + | "DELIVERY_CITY_INVALID" + | "DELIVERY_CITY_REQUIRED" + | "DELIVERY_CITY_TOO_LONG" + | "DELIVERY_COMPANY_INVALID" + | "DELIVERY_COMPANY_REQUIRED" + | "DELIVERY_COMPANY_TOO_LONG" + | "DELIVERY_COUNTRY_REQUIRED" + | "DELIVERY_FIRST_NAME_INVALID" + | "DELIVERY_FIRST_NAME_REQUIRED" + | "DELIVERY_FIRST_NAME_TOO_LONG" + | "DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY" + | "DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE" + | "DELIVERY_LAST_NAME_INVALID" + | "DELIVERY_LAST_NAME_REQUIRED" + | "DELIVERY_LAST_NAME_TOO_LONG" + | "DELIVERY_NO_DELIVERY_AVAILABLE" + | "DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE" + | "DELIVERY_OPTIONS_PHONE_NUMBER_INVALID" + | "DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED" + | "DELIVERY_PHONE_NUMBER_INVALID" + | "DELIVERY_PHONE_NUMBER_REQUIRED" + | "DELIVERY_POSTAL_CODE_INVALID" + | "DELIVERY_POSTAL_CODE_REQUIRED" + | "DELIVERY_ZONE_NOT_FOUND" + | "DELIVERY_ZONE_REQUIRED_FOR_COUNTRY" + | "ERROR" + | "MERCHANDISE_LINE_LIMIT_REACHED" + | "MERCHANDISE_NOT_APPLICABLE" + | "MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE" + | "MERCHANDISE_OUT_OF_STOCK" + | "MERCHANDISE_PRODUCT_NOT_PUBLISHED" + | "NO_DELIVERY_GROUP_SELECTED" + | "PAYMENTS_ADDRESS1_INVALID" + | "PAYMENTS_ADDRESS1_REQUIRED" + | "PAYMENTS_ADDRESS1_TOO_LONG" + | "PAYMENTS_ADDRESS2_INVALID" + | "PAYMENTS_ADDRESS2_REQUIRED" + | "PAYMENTS_ADDRESS2_TOO_LONG" + | "PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND" + | "PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY" + | "PAYMENTS_CITY_INVALID" + | "PAYMENTS_CITY_REQUIRED" + | "PAYMENTS_CITY_TOO_LONG" + | "PAYMENTS_COMPANY_INVALID" + | "PAYMENTS_COMPANY_REQUIRED" + | "PAYMENTS_COMPANY_TOO_LONG" + | "PAYMENTS_COUNTRY_REQUIRED" + | "PAYMENTS_CREDIT_CARD_BASE_EXPIRED" + | "PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED" + | "PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT" + | "PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED" + | "PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK" + | "PAYMENTS_CREDIT_CARD_GENERIC" + | "PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK" + | "PAYMENTS_CREDIT_CARD_MONTH_INCLUSION" + | "PAYMENTS_CREDIT_CARD_NAME_INVALID" + | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID" + | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT" + | "PAYMENTS_CREDIT_CARD_SESSION_ID" + | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK" + | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE" + | "PAYMENTS_CREDIT_CARD_YEAR_EXPIRED" + | "PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR" + | "PAYMENTS_FIRST_NAME_INVALID" + | "PAYMENTS_FIRST_NAME_REQUIRED" + | "PAYMENTS_FIRST_NAME_TOO_LONG" + | "PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY" + | "PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE" + | "PAYMENTS_LAST_NAME_INVALID" + | "PAYMENTS_LAST_NAME_REQUIRED" + | "PAYMENTS_LAST_NAME_TOO_LONG" + | "PAYMENTS_METHOD_REQUIRED" + | "PAYMENTS_METHOD_UNAVAILABLE" + | "PAYMENTS_PHONE_NUMBER_INVALID" + | "PAYMENTS_PHONE_NUMBER_REQUIRED" + | "PAYMENTS_POSTAL_CODE_INVALID" + | "PAYMENTS_POSTAL_CODE_REQUIRED" + | "PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED" + | "PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT" + | "PAYMENTS_WALLET_CONTENT_MISSING" + | "TAXES_DELIVERY_GROUP_ID_NOT_FOUND" + | "TAXES_LINE_ID_NOT_FOUND" + | "TAXES_MUST_BE_DEFINED"; /** Cart submit for checkout completion is successful. */ export type SubmitAlreadyAccepted = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars['String']['output']; + attemptId: Scalars["String"]["output"]; }; /** Cart submit for checkout completion failed. */ export type SubmitFailed = { /** The URL of the checkout for the cart. */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** The list of errors that occurred from executing the mutation. */ errors: Array; }; @@ -7442,7 +7155,7 @@ export type SubmitFailed = { /** Cart submit for checkout completion is already accepted. */ export type SubmitSuccess = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars['String']['output']; + attemptId: Scalars["String"]["output"]; }; /** Cart submit for checkout completion is throttled. */ @@ -7451,29 +7164,27 @@ export type SubmitThrottled = { * UTC date time string that indicates the time after which clients should make their next * poll request. Any poll requests sent before this time will be ignored. Use this value to schedule the * next poll request. - * */ - pollAfter: Scalars['DateTime']['output']; + pollAfter: Scalars["DateTime"]["output"]; }; /** * Specifies the fields required to complete a checkout with * a tokenized payment. - * */ export type TokenizedPaymentInputV3 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars['String']['input']; + idempotencyKey: Scalars["String"]["input"]; /** Public Hash Key used for AndroidPay payments only. */ - identifier?: InputMaybe; + identifier?: InputMaybe; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String']['input']; + paymentData: Scalars["String"]["input"]; /** Whether to execute the payment in test mode, if possible. Test mode isn't supported in production stores. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The type of payment token. */ type: PaymentTokenType; }; @@ -7481,7 +7192,7 @@ export type TokenizedPaymentInputV3 = { /** Represents a resource that you can track the origin of the search traffic. */ export type Trackable = { /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** An object representing exchange of money for a product or service. */ @@ -7503,7 +7214,7 @@ export type Transaction = { /** The status of the transaction. */ statusV2?: Maybe; /** Whether the transaction was done in test mode or not. */ - test: Scalars['Boolean']['output']; + test: Scalars["Boolean"]["output"]; }; /** The different kinds of order transactions. */ @@ -7511,32 +7222,30 @@ export type TransactionKind = /** * An amount reserved against the cardholder's funding source. * Money does not change hands until the authorization is captured. - * */ - | 'AUTHORIZATION' + | "AUTHORIZATION" /** A transfer of the money that was reserved during the authorization stage. */ - | 'CAPTURE' + | "CAPTURE" /** Money returned to the customer when they have paid too much. */ - | 'CHANGE' + | "CHANGE" /** An authorization for a payment taken with an EMV credit card reader. */ - | 'EMV_AUTHORIZATION' + | "EMV_AUTHORIZATION" /** An authorization and capture performed together in a single step. */ - | 'SALE'; + | "SALE"; /** Transaction statuses describe the status of a transaction. */ export type TransactionStatus = /** There was an error while processing the transaction. */ - | 'ERROR' + | "ERROR" /** The transaction failed. */ - | 'FAILURE' + | "FAILURE" /** The transaction is pending. */ - | 'PENDING' + | "PENDING" /** The transaction succeeded. */ - | 'SUCCESS'; + | "SUCCESS"; /** * The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). - * */ export type UnitPriceMeasurement = { /** The type of unit of measurement for the unit price measurement. */ @@ -7544,69 +7253,68 @@ export type UnitPriceMeasurement = { /** The quantity unit for the unit price measurement. */ quantityUnit?: Maybe; /** The quantity value for the unit price measurement. */ - quantityValue: Scalars['Float']['output']; + quantityValue: Scalars["Float"]["output"]; /** The reference unit for the unit price measurement. */ referenceUnit?: Maybe; /** The reference value for the unit price measurement. */ - referenceValue: Scalars['Int']['output']; + referenceValue: Scalars["Int"]["output"]; }; /** The accepted types of unit of measurement. */ export type UnitPriceMeasurementMeasuredType = /** Unit of measurements representing areas. */ - | 'AREA' + | "AREA" /** Unit of measurements representing lengths. */ - | 'LENGTH' + | "LENGTH" /** Unit of measurements representing volumes. */ - | 'VOLUME' + | "VOLUME" /** Unit of measurements representing weights. */ - | 'WEIGHT'; + | "WEIGHT"; /** The valid units of measurement for a unit price measurement. */ export type UnitPriceMeasurementMeasuredUnit = /** 100 centiliters equals 1 liter. */ - | 'CL' + | "CL" /** 100 centimeters equals 1 meter. */ - | 'CM' + | "CM" /** Metric system unit of weight. */ - | 'G' + | "G" /** 1 kilogram equals 1000 grams. */ - | 'KG' + | "KG" /** Metric system unit of volume. */ - | 'L' + | "L" /** Metric system unit of length. */ - | 'M' + | "M" /** Metric system unit of area. */ - | 'M2' + | "M2" /** 1 cubic meter equals 1000 liters. */ - | 'M3' + | "M3" /** 1000 milligrams equals 1 gram. */ - | 'MG' + | "MG" /** 1000 milliliters equals 1 liter. */ - | 'ML' + | "ML" /** 1000 millimeters equals 1 meter. */ - | 'MM'; + | "MM"; /** Systems of weights and measures. */ export type UnitSystem = /** Imperial system of weights and measures. */ - | 'IMPERIAL_SYSTEM' + | "IMPERIAL_SYSTEM" /** Metric system of weights and measures. */ - | 'METRIC_SYSTEM'; + | "METRIC_SYSTEM"; /** A redirect on the online store. */ export type UrlRedirect = Node & { /** The ID of the URL redirect. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. */ - path: Scalars['String']['output']; + path: Scalars["String"]["output"]; /** The target location where the user will be redirected to. */ - target: Scalars['String']['output']; + target: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple UrlRedirects. - * */ export type UrlRedirectConnection = { /** A list of edges. */ @@ -7619,11 +7327,10 @@ export type UrlRedirectConnection = { /** * An auto-generated type which holds one UrlRedirect and a cursor during pagination. - * */ export type UrlRedirectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of UrlRedirectEdge. */ node: UrlRedirect; }; @@ -7631,25 +7338,25 @@ export type UrlRedirectEdge = { /** Represents an error in the input of a mutation. */ export type UserError = DisplayableError & { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** The input fields for a filter used to view a subset of products in a collection matching a specific variant option. */ export type VariantOptionFilter = { /** The name of the variant option to filter on. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The value of the variant option to filter on. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents a Shopify hosted video. */ export type Video = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -7663,91 +7370,723 @@ export type Video = Media & Node & { /** Represents a source for a Shopify hosted video. */ export type VideoSource = { /** The format of the video source. */ - format: Scalars['String']['output']; + format: Scalars["String"]["output"]; /** The height of the video. */ - height: Scalars['Int']['output']; + height: Scalars["Int"]["output"]; /** The video MIME type. */ - mimeType: Scalars['String']['output']; + mimeType: Scalars["String"]["output"]; /** The URL of the video. */ - url: Scalars['String']['output']; + url: Scalars["String"]["output"]; /** The width of the video. */ - width: Scalars['Int']['output']; + width: Scalars["Int"]["output"]; }; /** Units of measurement for weight. */ export type WeightUnit = /** Metric system unit of mass. */ - | 'GRAMS' + | "GRAMS" /** 1 kilogram equals 1000 grams. */ - | 'KILOGRAMS' + | "KILOGRAMS" /** Imperial system unit of mass. */ - | 'OUNCES' + | "OUNCES" /** 1 pound equals 16 ounces. */ - | 'POUNDS'; + | "POUNDS"; export type AddItemToCartMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array | CartLineInput; }>; - -export type AddItemToCartMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; +export type AddItemToCartMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + } | null; +}; export type AddCouponMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; - discountCodes: Array | Scalars['String']['input']; + cartId: Scalars["ID"]["input"]; + discountCodes: Array | Scalars["String"]["input"]; }>; - -export type AddCouponMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null, userErrors: Array<{ field?: Array | null, message: string }> } | null }; +export type AddCouponMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + userErrors: Array<{ field?: Array | null; message: string }>; + } | null; +}; export type UpdateItemsMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array | CartLineUpdateInput; }>; - -export type UpdateItemsMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; +export type UpdateItemsMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + } | null; +}; export type GetProductQueryVariables = Exact<{ - handle?: InputMaybe; + handle?: InputMaybe; }>; - -export type GetProductQuery = { product?: { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } } | null }; +export type GetProductQuery = { + product?: { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } | null; +}; export type ListProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; - -export type ListProductsQuery = { products: { nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; +export type ListProductsQuery = { + products: { + nodes: Array< + { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: + | { amount: any; currencyCode: CurrencyCode } + | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } + >; + }; +}; export type SearchProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; - -export type SearchProductsQuery = { products: { pageInfo: { hasNextPage: boolean }, nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; - - -export type CreateCartMutation = { payload?: { cart?: { id: string } | null } | null }; +export type SearchProductsQuery = { + products: { + pageInfo: { hasNextPage: boolean }; + nodes: Array< + { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: + | { amount: any; currencyCode: CurrencyCode } + | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } + >; + }; +}; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; + +export type CreateCartMutation = { + payload?: { cart?: { id: string } | null } | null; +}; export type GetCartQueryVariables = Exact<{ - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }>; - -export type GetCartQuery = { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null }; - -export type CartFragment = { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> }; - -export type ProductFragment = { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }; - -export type ProductVariantFragment = { availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }; +export type GetCartQuery = { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; +}; + +export type CartFragment = { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; +}; + +export type ProductFragment = { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; +}; + +export type ProductVariantFragment = { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; +}; diff --git a/shopify/utils/storefront.graphql.json b/shopify/utils/storefront.graphql.json index 3e4fbdea0..e1572a92f 100644 --- a/shopify/utils/storefront.graphql.json +++ b/shopify/utils/storefront.graphql.json @@ -35171,4 +35171,4 @@ ] } } -} \ No newline at end of file +} diff --git a/utils/http.ts b/utils/http.ts index c74a67303..0f6f5ab12 100644 --- a/utils/http.ts +++ b/utils/http.ts @@ -43,6 +43,7 @@ type URLPatternParams = URL extends : URL extends `/*${infer param}` ? { [key in param]: URLPatternParam | URLPatternParam[] } : URL extends `/${string}/${infer rest}` ? URLPatternParams<`/${rest}`> + // deno-lint-ignore ban-types : {}; type ClientOf = { diff --git a/verified-reviews/loaders/productDetailsPage.ts b/verified-reviews/loaders/productDetailsPage.ts index 7fb439c0b..917afa83a 100644 --- a/verified-reviews/loaders/productDetailsPage.ts +++ b/verified-reviews/loaders/productDetailsPage.ts @@ -13,7 +13,7 @@ export type Props = PaginationOptions; */ export default function productDetailsPage( config: Props, - req: Request, + _req: Request, ctx: AppContext, ): ExtensionOf { const client = createClient({ ...ctx }); diff --git a/verified-reviews/loaders/productList.ts b/verified-reviews/loaders/productList.ts index ec57b6569..3e9c9315b 100644 --- a/verified-reviews/loaders/productList.ts +++ b/verified-reviews/loaders/productList.ts @@ -8,8 +8,8 @@ import { createClient, getProductId } from "../utils/client.ts"; * @title Opiniões verificadas - Ratings for Products[] */ export default function productList( - config: unknown, - req: Request, + _config: unknown, + _req: Request, ctx: AppContext, ): ExtensionOf { const client = createClient({ ...ctx }); diff --git a/vnda/hooks/useCart.ts b/vnda/hooks/useCart.ts index c1678dc23..81f50308d 100644 --- a/vnda/hooks/useCart.ts +++ b/vnda/hooks/useCart.ts @@ -1,3 +1,4 @@ +// deno-lint-ignore-file no-explicit-any import type { AnalyticsItem } from "../../commerce/types.ts"; import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; diff --git a/vnda/utils/openapi/vnda.openapi.gen.ts b/vnda/utils/openapi/vnda.openapi.gen.ts index 7ef64f76a..b6742ba52 100644 --- a/vnda/utils/openapi/vnda.openapi.gen.ts +++ b/vnda/utils/openapi/vnda.openapi.gen.ts @@ -1,6 +1,9 @@ +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// // DO NOT EDIT. This file is generated by deco. // This file SHOULD be checked into source version control. // To generate this file: deno task start +// export interface OpenAPI { "GET /api/v2/seo_data": { diff --git a/vnda/utils/openapi/vnda.openapi.json b/vnda/utils/openapi/vnda.openapi.json index 04d9cec19..34cfb9001 100644 --- a/vnda/utils/openapi/vnda.openapi.json +++ b/vnda/utils/openapi/vnda.openapi.json @@ -19442,4 +19442,4 @@ "x-stoplight": { "id": "baml4bcuaujvs" } -} \ No newline at end of file +} diff --git a/vnda/utils/transform.ts b/vnda/utils/transform.ts index 0d8cdc3c7..eeb5841d5 100644 --- a/vnda/utils/transform.ts +++ b/vnda/utils/transform.ts @@ -281,6 +281,7 @@ export const toFilters = ( }; const types = Object.keys(aggregations.types ?? {}).map((typeKey) => { + // deno-lint-ignore no-explicit-any const typeValues = (aggregations.types as any)[typeKey] as { name: string; title: string; diff --git a/vtex/hooks/context.ts b/vtex/hooks/context.ts index 1ccf4388d..7a07d6e81 100644 --- a/vtex/hooks/context.ts +++ b/vtex/hooks/context.ts @@ -5,7 +5,7 @@ import { invoke } from "../runtime.ts"; import type { OrderForm } from "../utils/types.ts"; import { WishlistItem } from "../utils/types.ts"; -interface Context { +export interface Context { cart: OrderForm | null; user: User | null; wishlist: WishlistItem[] | null; diff --git a/vtex/hooks/useCart.ts b/vtex/hooks/useCart.ts index cba349097..3a120a29d 100644 --- a/vtex/hooks/useCart.ts +++ b/vtex/hooks/useCart.ts @@ -1,10 +1,10 @@ -import { InvocationFuncFor } from "deco/clients/withManifest.ts"; +// deno-lint-ignore-file no-explicit-any import type { AnalyticsItem } from "../../commerce/types.ts"; import { mapCategoriesToAnalyticsCategories } from "../../commerce/utils/productToAnalyticsItem.ts"; import { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; import type { OrderForm, OrderFormItem } from "../utils/types.ts"; -import { state as storeState } from "./context.ts"; +import { Context, state as storeState } from "./context.ts"; const { cart, loading } = storeState; @@ -59,46 +59,33 @@ export const itemToAnalyticsItem = ( ...(mapItemCategoriesToAnalyticsCategories(item)), }); -type PropsOf = T extends (props: infer P, r: any, ctx: any) => any ? P - : T extends (props: infer P, r: any) => any ? P - : T extends (props: infer P) => any ? P - : never; +type EnqueuableActions< + K extends keyof Manifest["actions"], +> = Manifest["actions"][K]["default"] extends + (...args: any[]) => Promise ? K : never; -type Actions = - | "vtex/actions/cart/updateItems.ts" - | "vtex/actions/cart/removeItems.ts" - | "vtex/actions/cart/addItems.ts" - | "vtex/actions/cart/updateCoupons.ts" - | "vtex/actions/cart/updateItemPrice.ts" - | "vtex/actions/cart/getInstallment.ts" - | "vtex/actions/cart/updateProfile.ts" - | "vtex/actions/cart/updateUser.ts" - | "vtex/actions/cart/updateItemAttachment.ts" - | "vtex/actions/cart/removeItemAttachment.ts" - | "vtex/actions/cart/updateAttachment.ts"; - -const action = - (key: Actions) => (props: PropsOf>) => - storeState.enqueue((signal) => - invoke({ cart: { key, props } }, { signal }) satisfies Promise< - { cart: OrderForm } - > - ); +const enqueue = < + K extends keyof Manifest["actions"], +>(key: EnqueuableActions) => +(props: Parameters[0]) => + storeState.enqueue((signal) => + invoke({ cart: { key, props } } as any, { signal }) as any + ); const state = { cart, loading, - updateItems: action("vtex/actions/cart/updateItems.ts"), - removeAllItems: action("vtex/actions/cart/removeItems.ts"), - addItems: action("vtex/actions/cart/addItems.ts"), - addCouponsToCart: action("vtex/actions/cart/updateCoupons.ts"), - changePrice: action("vtex/actions/cart/updateItemPrice.ts"), - getCartInstallments: action("vtex/actions/cart/getInstallment.ts"), - ignoreProfileData: action("vtex/actions/cart/updateProfile.ts"), - removeAllPersonalData: action("vtex/actions/cart/updateUser.ts"), - addItemAttachment: action("vtex/actions/cart/updateItemAttachment.ts"), - removeItemAttachment: action("vtex/actions/cart/removeItemAttachment.ts"), - sendAttachment: action("vtex/actions/cart/updateAttachment.ts"), + updateItems: enqueue("vtex/actions/cart/updateItems.ts"), + removeAllItems: enqueue("vtex/actions/cart/removeItems.ts"), + addItems: enqueue("vtex/actions/cart/addItems.ts"), + addCouponsToCart: enqueue("vtex/actions/cart/updateCoupons.ts"), + changePrice: enqueue("vtex/actions/cart/updateItemPrice.ts"), + getCartInstallments: enqueue("vtex/actions/cart/getInstallment.ts"), + ignoreProfileData: enqueue("vtex/actions/cart/updateProfile.ts"), + removeAllPersonalData: enqueue("vtex/actions/cart/updateUser.ts"), + addItemAttachment: enqueue("vtex/actions/cart/updateItemAttachment.ts"), + removeItemAttachment: enqueue("vtex/actions/cart/removeItemAttachment.ts"), + sendAttachment: enqueue("vtex/actions/cart/updateAttachment.ts"), simulate: invoke.vtex.actions.cart.simulation, mapItemsToAnalyticsItems: mapOrderFormItemsToAnalyticsItems, }; diff --git a/vtex/hooks/useWishlist.ts b/vtex/hooks/useWishlist.ts index fa497ffb5..4df933a1e 100644 --- a/vtex/hooks/useWishlist.ts +++ b/vtex/hooks/useWishlist.ts @@ -1,27 +1,23 @@ -import { InvocationFuncFor } from "deco/clients/withManifest.ts"; +// deno-lint-ignore-file no-explicit-any +import { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; import { WishlistItem } from "../utils/types.ts"; import { state as storeState } from "./context.ts"; -import { Manifest } from "../manifest.gen.ts"; const { wishlist, loading } = storeState; -type PropsOf = T extends (props: infer P, r: any, ctx: any) => any ? P - : T extends (props: infer P, r: any) => any ? P - : T extends (props: infer P) => any ? P - : never; - -type Actions = - | "vtex/actions/wishlist/addItem.ts" - | "vtex/actions/wishlist/removeItem.ts"; +type EnqueuableActions< + K extends keyof Manifest["actions"], +> = Manifest["actions"][K]["default"] extends + (...args: any[]) => Promise ? K : never; -const action = - (key: Actions) => (props: PropsOf>) => - storeState.enqueue((signal) => - invoke({ wishlist: { key, props } }, { signal }) satisfies Promise< - { wishlist: WishlistItem[] | null } - > - ); +const enqueue = < + K extends keyof Manifest["actions"], +>(key: EnqueuableActions) => +(props: Parameters[0]) => + storeState.enqueue((signal) => + invoke({ wishlist: { key, props } } as any, { signal }) as any + ); const getItem = (item: Partial) => wishlist.value?.find((id) => id.productId == item.productId); @@ -30,8 +26,8 @@ const state = { wishlist, loading, getItem, - addItem: action("vtex/actions/wishlist/addItem.ts"), - removeItem: action("vtex/actions/wishlist/removeItem.ts"), + addItem: enqueue("vtex/actions/wishlist/addItem.ts"), + removeItem: enqueue("vtex/actions/wishlist/removeItem.ts"), }; export const useWishlist = () => state; diff --git a/wake/hooks/useCart.ts b/wake/hooks/useCart.ts index 4daeeb045..e207aaad9 100644 --- a/wake/hooks/useCart.ts +++ b/wake/hooks/useCart.ts @@ -1,3 +1,4 @@ +// deno-lint-ignore-file no-explicit-any import type { AnalyticsItem } from "../../commerce/types.ts"; import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; diff --git a/wake/utils/graphql/storefront.graphql.gen.ts b/wake/utils/graphql/storefront.graphql.gen.ts index 6cb74284d..9be9d2687 100644 --- a/wake/utils/graphql/storefront.graphql.gen.ts +++ b/wake/utils/graphql/storefront.graphql.gen.ts @@ -1,97 +1,114 @@ +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno task start +// export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { [K in keyof T]: T[K] }; -export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; -export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; -export type MakeEmpty = { [_ in K]?: never }; -export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +export type Exact = { + [K in keyof T]: T[K]; +}; +export type MakeOptional = + & Omit + & { [SubKey in K]?: Maybe }; +export type MakeMaybe = + & Omit + & { [SubKey in K]: Maybe }; +export type MakeEmpty = + { [_ in K]?: never }; +export type Incremental = + | T + | { + [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; + }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string; } - String: { input: string; output: string; } - Boolean: { input: boolean; output: boolean; } - Int: { input: number; output: number; } - Float: { input: number; output: number; } - Any: { input: any; output: any; } - CEP: { input: any; output: any; } - CountryCode: { input: any; output: any; } - DateTime: { input: any; output: any; } - Decimal: { input: any; output: any; } - EmailAddress: { input: any; output: any; } - Long: { input: any; output: any; } - Upload: { input: any; output: any; } - Uuid: { input: any; output: any; } + ID: { input: string; output: string }; + String: { input: string; output: string }; + Boolean: { input: boolean; output: boolean }; + Int: { input: number; output: number }; + Float: { input: number; output: number }; + Any: { input: any; output: any }; + CEP: { input: any; output: any }; + CountryCode: { input: any; output: any }; + DateTime: { input: any; output: any }; + Decimal: { input: any; output: any }; + EmailAddress: { input: any; output: any }; + Long: { input: any; output: any }; + Upload: { input: any; output: any }; + Uuid: { input: any; output: any }; }; /** Price alert input parameters. */ export type AddPriceAlertInput = { /** The alerted's email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The alerted's name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product variant id to create the price alert. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The target price to alert. */ - targetPrice: Scalars['Decimal']['input']; + targetPrice: Scalars["Decimal"]["input"]; }; export type AddressNode = { /** Zip code. */ - cep?: Maybe; + cep?: Maybe; /** Address city. */ - city?: Maybe; + city?: Maybe; /** Address country. */ - country?: Maybe; + country?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Address state. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type Answer = { - id?: Maybe; - value?: Maybe; + id?: Maybe; + value?: Maybe; }; export type ApplyPolicy = - | 'AFTER_RESOLVER' - | 'BEFORE_RESOLVER'; + | "AFTER_RESOLVER" + | "BEFORE_RESOLVER"; /** Attributes available for the variant products from the given productId. */ export type Attribute = Node & { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The values of the attribute. */ values?: Maybe>>; }; export type AttributeFilterInput = { - attributeId: Scalars['Long']['input']; - value: Scalars['String']['input']; + attributeId: Scalars["Long"]["input"]; + value: Scalars["String"]["input"]; }; /** Input to specify which attributes to match. */ export type AttributeInput = { /** The attribute Ids to match. */ - id?: InputMaybe>; + id?: InputMaybe>; /** The attribute name to match. */ - name?: InputMaybe>>; + name?: InputMaybe>>; /** The attribute type to match. */ - type?: InputMaybe>>; + type?: InputMaybe>>; /** The attribute value to match */ - value?: InputMaybe>>; + value?: InputMaybe>>; }; export type AttributeMatrix = { @@ -104,32 +121,31 @@ export type AttributeMatrix = { }; export type AttributeMatrixInfo = { - displayType?: Maybe; - name?: Maybe; + displayType?: Maybe; + name?: Maybe; values?: Maybe>>; }; export type AttributeMatrixProduct = { - available: Scalars['Boolean']['output']; - productVariantId: Scalars['Long']['output']; - stock: Scalars['Long']['output']; + available: Scalars["Boolean"]["output"]; + productVariantId: Scalars["Long"]["output"]; + stock: Scalars["Long"]["output"]; }; export type AttributeMatrixRowColumnInfoValue = { - printUrl?: Maybe; - value?: Maybe; + printUrl?: Maybe; + value?: Maybe; }; - export type AttributeMatrixRowColumnInfoValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes available for the variant products from the given productId. */ export type AttributeSelection = { /** Check if the current product attributes can be rendered as a matrix. */ - canBeMatrix: Scalars['Boolean']['output']; + canBeMatrix: Scalars["Boolean"]["output"]; /** The candidate variant given the current input filters. Variant may be from brother product Id. */ candidateVariant?: Maybe; /** Informations about the attribute matrix. */ @@ -143,30 +159,29 @@ export type AttributeSelection = { /** Attributes available for the variant products from the given productId. */ export type AttributeSelectionOption = { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The values of the attribute. */ values?: Maybe>>; /** If the attributes varies by parent. */ - varyByParent: Scalars['Boolean']['output']; + varyByParent: Scalars["Boolean"]["output"]; }; export type AttributeSelectionOptionValue = { - alias?: Maybe; - available: Scalars['Boolean']['output']; - printUrl?: Maybe; - selected: Scalars['Boolean']['output']; + alias?: Maybe; + available: Scalars["Boolean"]["output"]; + printUrl?: Maybe; + selected: Scalars["Boolean"]["output"]; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; - export type AttributeSelectionOptionValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes values with variants */ @@ -174,7 +189,7 @@ export type AttributeValue = { /** Product variants that have the attribute. */ productVariants?: Maybe>>; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** Get query completion suggestion. */ @@ -182,57 +197,57 @@ export type Autocomplete = { /** Suggested products based on the current query. */ products?: Maybe>>; /** List of possible query completions. */ - suggestions?: Maybe>>; + suggestions?: Maybe>>; }; /** A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click. */ export type Banner = Node & { /** Banner's alternative text. */ - altText?: Maybe; + altText?: Maybe; /** Banner unique identifier. */ - bannerId: Scalars['Long']['output']; + bannerId: Scalars["Long"]["output"]; /** Banner's name. */ - bannerName?: Maybe; + bannerName?: Maybe; /** URL where the banner is stored. */ - bannerUrl?: Maybe; + bannerUrl?: Maybe; /** The date the banner was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** Field to check if the banner should be displayed on all pages. */ - displayOnAllPages: Scalars['Boolean']['output']; + displayOnAllPages: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on category pages. */ - displayOnCategories: Scalars['Boolean']['output']; + displayOnCategories: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on search pages. */ - displayOnSearches: Scalars['Boolean']['output']; + displayOnSearches: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on the website. */ - displayOnWebsite: Scalars['Boolean']['output']; + displayOnWebsite: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed to partners. */ - displayToPartners: Scalars['Boolean']['output']; + displayToPartners: Scalars["Boolean"]["output"]; /** The banner's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Field to check if the banner URL should open in another tab on click. */ - openNewTab: Scalars['Boolean']['output']; + openNewTab: Scalars["Boolean"]["output"]; /** The displaying order of the banner. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** The displaying position of the banner. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the banner on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The banner's title. */ - title?: Maybe; + title?: Maybe; /** URL to be redirected on click. */ - urlOnClick?: Maybe; + urlOnClick?: Maybe; /** The banner's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the banner attribute which the result set will be sorted on. */ export type BannerSortKeys = /** The banner's creation date. */ - | 'CREATION_DATE' + | "CREATION_DATE" /** The banner's unique identifier. */ - | 'ID'; + | "ID"; /** A connection to a list of items. */ export type BannersConnection = { @@ -247,69 +262,67 @@ export type BannersConnection = { /** An edge in a connection. */ export type BannersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; export type BestInstallment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** The custom display name of the best installment plan option. */ - displayName?: Maybe; + displayName?: Maybe; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The name of the best installment plan option. */ - name?: Maybe; + name?: Maybe; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Informations about brands and its products. */ export type Brand = Node & { /** If the brand is active at the platform. */ - active: Scalars['Boolean']['output']; + active: Scalars["Boolean"]["output"]; /** The alias for the brand's hotsite. */ - alias?: Maybe; + alias?: Maybe; /** Brand unique identifier. */ - brandId: Scalars['Long']['output']; + brandId: Scalars["Long"]["output"]; /** The date the brand was created in the database. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The brand's name. */ - name?: Maybe; + name?: Maybe; /** A list of products from the brand. */ products?: Maybe; /** The last update date. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** A web address to be redirected. */ - urlCarrossel?: Maybe; + urlCarrossel?: Maybe; /** A web address linked to the brand. */ - urlLink?: Maybe; + urlLink?: Maybe; /** The url of the brand's logo. */ - urlLogo?: Maybe; + urlLogo?: Maybe; }; - /** Informations about brands and its products. */ export type BrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; - /** Informations about brands and its products. */ export type BrandProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -317,21 +330,21 @@ export type BrandProductsArgs = { /** Filter brand results based on giving attributes. */ export type BrandFilterInput = { /** Its unique identifier (you may provide a list of IDs if needed). */ - brandIds?: InputMaybe>; + brandIds?: InputMaybe>; /** Its brand group unique identifier (you may provide a list of IDs if needed). */ - groupIds?: InputMaybe>; + groupIds?: InputMaybe>; /** The set of group brand names which the result item name must be included in. */ - groupNames?: InputMaybe>>; + groupNames?: InputMaybe>>; /** The set of brand names which the result item name must be included in. */ - names?: InputMaybe>>; + names?: InputMaybe>>; }; /** Define the brand attribute which the result set will be sorted on. */ export type BrandSortKeys = /** The brand unique identifier. */ - | 'ID' + | "ID" /** The brand name. */ - | 'NAME'; + | "NAME"; /** A connection to a list of items. */ export type BrandsConnection = { @@ -341,13 +354,13 @@ export type BrandsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** An edge in a connection. */ export type BrandsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -355,9 +368,9 @@ export type BrandsEdge = { /** Informations about breadcrumb. */ export type Breadcrumb = { /** Breadcrumb link. */ - link?: Maybe; + link?: Maybe; /** Breadcrumb text. */ - text?: Maybe; + text?: Maybe; }; /** BuyBox informations. */ @@ -365,11 +378,11 @@ export type BuyBox = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** Maximum price among sellers. */ - maximumPrice?: Maybe; + maximumPrice?: Maybe; /** Minimum price among sellers. */ - minimumPrice?: Maybe; + minimumPrice?: Maybe; /** Quantity of offers. */ - quantityOffers?: Maybe; + quantityOffers?: Maybe; /** List of sellers. */ sellers?: Maybe>>; }; @@ -377,61 +390,61 @@ export type BuyBox = { /** A buy list represents a list of items for sale in the store. */ export type BuyList = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ buyBox?: Maybe; - buyListId: Scalars['Int']['output']; + buyListId: Scalars["Int"]["output"]; buyListProducts?: Maybe>>; /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -439,13 +452,13 @@ export type BuyList = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -457,46 +470,45 @@ export type BuyList = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A buy list represents a list of items for sale in the store. */ export type BuyListImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Contains the id and quantity of a product in the buy list. */ export type BuyListProduct = { - productId: Scalars['Long']['output']; - quantity: Scalars['Int']['output']; + productId: Scalars["Long"]["output"]; + quantity: Scalars["Int"]["output"]; }; /** The products to calculate prices. */ export type CalculatePricesProductsInput = { - productVariantId: Scalars['Long']['input']; - quantity: Scalars['Int']['input']; + productVariantId: Scalars["Long"]["input"]; + quantity: Scalars["Int"]["input"]; }; /** A connection to a list of items. */ @@ -512,7 +524,7 @@ export type CategoriesConnection = { /** An edge in a connection. */ export type CategoriesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -520,45 +532,44 @@ export type CategoriesEdge = { /** Categories are used to arrange your products into different sections by similarity. */ export type Category = Node & { /** Category unique identifier. */ - categoryId: Scalars['Long']['output']; + categoryId: Scalars["Long"]["output"]; /** A list of child categories, if it exists. */ children?: Maybe>>; /** A description to the category. */ - description?: Maybe; + description?: Maybe; /** Field to check if the category is displayed in the store's menu. */ - displayMenu: Scalars['Boolean']['output']; + displayMenu: Scalars["Boolean"]["output"]; /** The hotsite alias. */ - hotsiteAlias?: Maybe; + hotsiteAlias?: Maybe; /** The URL path for the category. */ - hotsiteUrl?: Maybe; + hotsiteUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url to access the image linked to the category. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The web address to access the image linked to the category. */ - imageUrlLink?: Maybe; + imageUrlLink?: Maybe; /** The category's name. */ - name?: Maybe; + name?: Maybe; /** The parent category, if it exists. */ parent?: Maybe; /** The parent category unique identifier. */ - parentCategoryId: Scalars['Long']['output']; + parentCategoryId: Scalars["Long"]["output"]; /** The position the category will be displayed. */ - position: Scalars['Int']['output']; + position: Scalars["Int"]["output"]; /** A list of products associated with the category. */ products?: Maybe; /** A web address linked to the category. */ - urlLink?: Maybe; + urlLink?: Maybe; }; - /** Categories are used to arrange your products into different sections by similarity. */ export type CategoryProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -566,24 +577,24 @@ export type CategoryProductsArgs = { /** Define the category attribute which the result set will be sorted on. */ export type CategorySortKeys = /** The category unique identifier. */ - | 'ID' + | "ID" /** The category name. */ - | 'NAME'; + | "NAME"; export type Checkout = Node & { /** The CEP. */ - cep?: Maybe; + cep?: Maybe; /** The checkout unique identifier. */ - checkoutId: Scalars['Uuid']['output']; + checkoutId: Scalars["Uuid"]["output"]; /** Indicates if the checkout is completed. */ - completed: Scalars['Boolean']['output']; + completed: Scalars["Boolean"]["output"]; /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** The customer associated with the checkout. */ customer?: Maybe; /** The node unique identifier. */ - id?: Maybe; - login?: Maybe; + id?: Maybe; + login?: Maybe; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The checkout orders informations. */ @@ -597,67 +608,67 @@ export type Checkout = Node & { /** Selected Shipping. */ selectedShipping?: Maybe; /** The shipping fee. */ - shippingFee: Scalars['Decimal']['output']; + shippingFee: Scalars["Decimal"]["output"]; /** The subtotal value. */ - subtotal: Scalars['Decimal']['output']; + subtotal: Scalars["Decimal"]["output"]; /** The total value. */ - total: Scalars['Decimal']['output']; + total: Scalars["Decimal"]["output"]; /** The last update date. */ - updateDate: Scalars['DateTime']['output']; + updateDate: Scalars["DateTime"]["output"]; /** Url for the current checkout id. */ - url?: Maybe; + url?: Maybe; }; /** Represents an address node in the checkout. */ export type CheckoutAddress = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep: Scalars['Int']['output']; + cep: Scalars["Int"]["output"]; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The neighborhood of the address. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; /** Represents a customer node in the checkout. */ export type CheckoutCustomer = { /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** The credit limit of the customer. */ - creditLimit: Scalars['Decimal']['output']; + creditLimit: Scalars["Decimal"]["output"]; /** The credit limit balance of the customer. */ - creditLimitBalance: Scalars['Decimal']['output']; + creditLimitBalance: Scalars["Decimal"]["output"]; /** Customer's unique identifier. */ - customerId: Scalars['Long']['output']; + customerId: Scalars["Long"]["output"]; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** The email address of the customer. */ - email?: Maybe; + email?: Maybe; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; }; export type CheckoutCustomizationInput = { - customizationId: Scalars['Long']['input']; - value?: InputMaybe; + customizationId: Scalars["Long"]["input"]; + value?: InputMaybe; }; export type CheckoutMetadataInput = { - key?: InputMaybe; - value?: InputMaybe; + key?: InputMaybe; + value?: InputMaybe; }; /** Represents a node in the checkout order. */ @@ -665,17 +676,17 @@ export type CheckoutOrder = { /** The list of adjustments applied to the order. */ adjustments?: Maybe>>; /** The date of the order. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** Details of the delivery or store pickup. */ delivery?: Maybe; /** The discount value of the order. */ - discountValue: Scalars['Decimal']['output']; + discountValue: Scalars["Decimal"]["output"]; /** The dispatch time text from the shop settings. */ - dispatchTimeText?: Maybe; + dispatchTimeText?: Maybe; /** The interest value of the order. */ - interestValue: Scalars['Decimal']['output']; + interestValue: Scalars["Decimal"]["output"]; /** The ID of the order. */ - orderId: Scalars['Long']['output']; + orderId: Scalars["Long"]["output"]; /** The order status. */ orderStatus: OrderStatus; /** The payment information. */ @@ -683,39 +694,39 @@ export type CheckoutOrder = { /** The list of products in the order. */ products?: Maybe>>; /** The shipping value of the order. */ - shippingValue: Scalars['Decimal']['output']; + shippingValue: Scalars["Decimal"]["output"]; /** The total value of the order. */ - totalValue: Scalars['Decimal']['output']; + totalValue: Scalars["Decimal"]["output"]; }; /** The delivery or store Pickup Address. */ export type CheckoutOrderAddress = { /** The street address. */ - address?: Maybe; + address?: Maybe; /** The ZIP code. */ - cep?: Maybe; + cep?: Maybe; /** The city. */ - city?: Maybe; + city?: Maybe; /** Additional information or details about the address. */ - complement?: Maybe; + complement?: Maybe; /** Indicates whether the order is for store pickup. */ - isPickupStore: Scalars['Boolean']['output']; + isPickupStore: Scalars["Boolean"]["output"]; /** The name. */ - name?: Maybe; + name?: Maybe; /** The neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** . */ - pickupStoreText?: Maybe; + pickupStoreText?: Maybe; }; /** Represents an adjustment applied to checkout. */ export type CheckoutOrderAdjustment = { /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** The delivery or store pickup details. */ @@ -723,19 +734,19 @@ export type CheckoutOrderDelivery = { /** The delivery or store pickup address. */ address?: Maybe; /** The cost of delivery or pickup. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** The estimated delivery or pickup time, in days. */ - deliveryTime: Scalars['Int']['output']; + deliveryTime: Scalars["Int"]["output"]; /** The name of the recipient. */ - name?: Maybe; + name?: Maybe; }; /** The invoice payment information. */ export type CheckoutOrderInvoicePayment = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; /** The checkout order payment. */ @@ -743,7 +754,7 @@ export type CheckoutOrderPayment = { /** The bank invoice payment information. */ invoice?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; /** The Pix payment information. */ pix?: Maybe; }; @@ -751,11 +762,11 @@ export type CheckoutOrderPayment = { /** This represents a Pix payment node in the checkout order. */ export type CheckoutOrderPixPayment = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; /** Represents a node in the checkout order products. */ @@ -765,157 +776,156 @@ export type CheckoutOrderProduct = { /** The list of attributes of the product. */ attributes?: Maybe>>; /** The image URL of the product. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the product. */ - name?: Maybe; + name?: Maybe; /** The ID of the product variant. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The quantity of the product. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The value of the product. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Represents an adjustment applied to a product in the checkout order. */ export type CheckoutOrderProductAdjustment = { /** Additional information about the adjustment. */ - additionalInformation?: Maybe; + additionalInformation?: Maybe; /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Represents an attribute of a product. */ export type CheckoutOrderProductAttribute = { /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductAttributeNode = { /** The attribute name */ - name?: Maybe; + name?: Maybe; /** The attribute type */ - type: Scalars['Int']['output']; + type: Scalars["Int"]["output"]; /** The attribute value */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductInput = { - id: Scalars['Uuid']['input']; + id: Scalars["Uuid"]["input"]; products: Array>; }; export type CheckoutProductItemInput = { customization?: InputMaybe>>; metadata?: InputMaybe>>; - productVariantId: Scalars['Long']['input']; - quantity: Scalars['Int']['input']; + productVariantId: Scalars["Long"]["input"]; + quantity: Scalars["Int"]["input"]; subscription?: InputMaybe; }; export type CheckoutProductNode = { /** The product adjusted price */ - ajustedPrice: Scalars['Decimal']['output']; + ajustedPrice: Scalars["Decimal"]["output"]; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** The product brand */ - brand?: Maybe; + brand?: Maybe; /** The product category */ - category?: Maybe; + category?: Maybe; /** If the product is a gift */ - gift: Scalars['Boolean']['output']; + gift: Scalars["Boolean"]["output"]; /** The product Google category */ - googleCategory?: Maybe>>; + googleCategory?: Maybe>>; /** The product URL image */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The product informations */ - informations?: Maybe>>; + informations?: Maybe>>; /** The product installment fee */ - installmentFee: Scalars['Boolean']['output']; + installmentFee: Scalars["Boolean"]["output"]; /** The product installment value */ - installmentValue: Scalars['Decimal']['output']; + installmentValue: Scalars["Decimal"]["output"]; /** The product list price */ - listPrice: Scalars['Decimal']['output']; + listPrice: Scalars["Decimal"]["output"]; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The product name */ - name?: Maybe; + name?: Maybe; /** The product number of installments */ - numberOfInstallments: Scalars['Int']['output']; + numberOfInstallments: Scalars["Int"]["output"]; /** The product price */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** The product attributes */ productAttributes?: Maybe>>; /** The product unique identifier */ - productId: Scalars['Long']['output']; + productId: Scalars["Long"]["output"]; /** The product variant unique identifier */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The product quantity */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The product shipping deadline */ shippingDeadline?: Maybe; /** The product SKU */ - sku?: Maybe; + sku?: Maybe; /** The product URL */ - url?: Maybe; + url?: Maybe; }; - export type CheckoutProductNodeAttributeSelectionsArgs = { selected?: InputMaybe>>; }; export type CheckoutShippingDeadlineNode = { /** The shipping deadline */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The shipping description */ - description?: Maybe; + description?: Maybe; /** The shipping second description */ - secondDescription?: Maybe; + secondDescription?: Maybe; /** The shipping second title */ - secondTitle?: Maybe; + secondTitle?: Maybe; /** The shipping title */ - title?: Maybe; + title?: Maybe; }; export type CheckoutSubscriptionInput = { - recurringTypeId: Scalars['Int']['input']; - subscriptionGroupId: Scalars['Long']['input']; + recurringTypeId: Scalars["Int"]["input"]; + subscriptionGroupId: Scalars["Long"]["input"]; }; /** Contents are used to show things to the user. */ export type Content = Node & { /** The content in html to be displayed. */ - content?: Maybe; + content?: Maybe; /** Content unique identifier. */ - contentId: Scalars['Long']['output']; + contentId: Scalars["Long"]["output"]; /** The date the content was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** The content's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The content's position. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the content on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The content's title. */ - title?: Maybe; + title?: Maybe; /** The content's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the content attribute which the result set will be sorted on. */ export type ContentSortKeys = /** The content's creation date. */ - | 'CreationDate' + | "CreationDate" /** The content's unique identifier. */ - | 'ID'; + | "ID"; /** A connection to a list of items. */ export type ContentsConnection = { @@ -930,24 +940,24 @@ export type ContentsConnection = { /** An edge in a connection. */ export type ContentsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; export type CreateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber: Scalars['String']['input']; - cep: Scalars['CEP']['input']; - city: Scalars['String']['input']; - country: Scalars['CountryCode']['input']; - email: Scalars['EmailAddress']['input']; - name: Scalars['String']['input']; - neighborhood: Scalars['String']['input']; - phone: Scalars['String']['input']; - referencePoint?: InputMaybe; - state: Scalars['String']['input']; - street: Scalars['String']['input']; + addressDetails?: InputMaybe; + addressNumber: Scalars["String"]["input"]; + cep: Scalars["CEP"]["input"]; + city: Scalars["String"]["input"]; + country: Scalars["CountryCode"]["input"]; + email: Scalars["EmailAddress"]["input"]; + name: Scalars["String"]["input"]; + neighborhood: Scalars["String"]["input"]; + phone: Scalars["String"]["input"]; + referencePoint?: InputMaybe; + state: Scalars["String"]["input"]; + street: Scalars["String"]["input"]; }; /** A customer from the store. */ @@ -955,35 +965,35 @@ export type Customer = Node & { /** Customer's addresses. */ addresses?: Maybe>>; /** Customer's birth date. */ - birthDate: Scalars['DateTime']['output']; + birthDate: Scalars["DateTime"]["output"]; /** Customer's business phone number. */ - businessPhoneNumber?: Maybe; + businessPhoneNumber?: Maybe; /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Entities legal name. */ - companyName?: Maybe; + companyName?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** Creation Date. */ - creationDate: Scalars['DateTime']['output']; + creationDate: Scalars["DateTime"]["output"]; /** Customer's unique identifier. */ - customerId: Scalars['Long']['output']; + customerId: Scalars["Long"]["output"]; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** Indicates if it is a natural person or company profile. */ - customerType?: Maybe; + customerType?: Maybe; /** Customer's delivery address. */ deliveryAddress?: Maybe; /** Customer's email address. */ - email?: Maybe; + email?: Maybe; /** Customer's gender. */ - gender?: Maybe; + gender?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Customer information groups. */ informationGroups?: Maybe>>; /** Customer's mobile phone number. */ - mobilePhoneNumber?: Maybe; + mobilePhoneNumber?: Maybe; /** List of orders placed by the customer. */ orders?: Maybe; /** Statistics about the orders the customer made in a specific timeframe. */ @@ -991,335 +1001,332 @@ export type Customer = Node & { /** Get info about the associated partners. */ partners?: Maybe>>; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Customer's residential address. */ residentialAddress?: Maybe; /** Responsible's name. */ - responsibleName?: Maybe; + responsibleName?: Maybe; /** Registration number Id. */ - rg?: Maybe; + rg?: Maybe; /** State registration number. */ - stateRegistration?: Maybe; + stateRegistration?: Maybe; /** Date of the last update. */ - updateDate: Scalars['DateTime']['output']; + updateDate: Scalars["DateTime"]["output"]; /** Customer wishlist. */ wishlist?: Maybe; }; - /** A customer from the store. */ export type CustomerOrdersArgs = { - offset?: InputMaybe; + offset?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** A customer from the store. */ export type CustomerOrdersStatisticsArgs = { - dateGte?: InputMaybe; - dateLt?: InputMaybe; - onlyPaidOrders?: Scalars['Boolean']['input']; - partnerId?: InputMaybe; + dateGte?: InputMaybe; + dateLt?: InputMaybe; + onlyPaidOrders?: Scalars["Boolean"]["input"]; + partnerId?: InputMaybe; }; - /** A customer from the store. */ export type CustomerWishlistArgs = { - productsIds?: InputMaybe>>; + productsIds?: InputMaybe>>; }; export type CustomerAccessToken = { - isMaster: Scalars['Boolean']['output']; - token?: Maybe; + isMaster: Scalars["Boolean"]["output"]; + token?: Maybe; /** The user login type */ type?: Maybe; - validUntil: Scalars['DateTime']['output']; + validUntil: Scalars["DateTime"]["output"]; }; /** The input to authenticate a user. */ export type CustomerAccessTokenInput = { - email: Scalars['String']['input']; - password: Scalars['String']['input']; + email: Scalars["String"]["input"]; + password: Scalars["String"]["input"]; }; export type CustomerAddressNode = Node & { /** Address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** zip code. */ - cep?: Maybe; + cep?: Maybe; /** address city. */ - city?: Maybe; + city?: Maybe; /** Country. */ - country?: Maybe; + country?: Maybe; /** The email of the customer address. */ - email?: Maybe; + email?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the customer address. */ - name?: Maybe; + name?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The phone of the customer address. */ - phone?: Maybe; + phone?: Maybe; /** Address reference point. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** State. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type CustomerCreateInput = { /** The street address for the registered address. */ - address?: InputMaybe; + address?: InputMaybe; /** The street address for the registered address. */ - address2?: InputMaybe; + address2?: InputMaybe; /** Any additional information related to the registered address. */ - addressComplement?: InputMaybe; + addressComplement?: InputMaybe; /** The building number for the registered address. */ - addressNumber?: InputMaybe; + addressNumber?: InputMaybe; /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The CEP for the registered address. */ - cep?: InputMaybe; + cep?: InputMaybe; /** The city for the registered address. */ - city?: InputMaybe; + city?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The country for the registered address. */ - country?: InputMaybe; + country?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The neighborhood for the registered address. */ - neighborhood?: InputMaybe; + neighborhood?: InputMaybe; /** Indicates if the customer has subscribed to the newsletter. */ - newsletter?: InputMaybe; + newsletter?: InputMaybe; /** The password for the customer's account. */ - password?: InputMaybe; + password?: InputMaybe; /** The password confirmation for the customer's account. */ - passwordConfirmation?: InputMaybe; + passwordConfirmation?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The name of the receiver for the registered address. */ - receiverName?: InputMaybe; + receiverName?: InputMaybe; /** A reference point or description to help locate the registered address. */ - reference?: InputMaybe; + reference?: InputMaybe; /** Indicates if the customer is a reseller. */ - reseller?: InputMaybe; + reseller?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state for the registered address. */ - state?: InputMaybe; + state?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** The input to change the user email. */ export type CustomerEmailChangeInput = { /** The new email. */ - newEmail: Scalars['String']['input']; + newEmail: Scalars["String"]["input"]; }; export type CustomerInformationGroupFieldNode = { /** The field name. */ - name?: Maybe; + name?: Maybe; /** The field order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** If the field is required. */ - required: Scalars['Boolean']['output']; + required: Scalars["Boolean"]["output"]; /** The field value. */ - value?: Maybe; + value?: Maybe; }; export type CustomerInformationGroupNode = { /** The group exibition name. */ - exibitionName?: Maybe; + exibitionName?: Maybe; /** The group fields. */ fields?: Maybe>>; /** The group name. */ - name?: Maybe; + name?: Maybe; }; export type CustomerOrderCollectionSegment = { items?: Maybe>>; - page: Scalars['Int']['output']; - pageSize: Scalars['Int']['output']; - totalCount: Scalars['Int']['output']; + page: Scalars["Int"]["output"]; + pageSize: Scalars["Int"]["output"]; + totalCount: Scalars["Int"]["output"]; }; /** Define the order attribute which the result set will be sorted on. */ export type CustomerOrderSortKeys = /** The total order value. */ - | 'AMOUNT' + | "AMOUNT" /** The date the order was placed. */ - | 'DATE' + | "DATE" /** The order ID. */ - | 'ID' + | "ID" /** The order current status. */ - | 'STATUS'; + | "STATUS"; export type CustomerOrdersStatistics = { /** The number of products the customer made from the number of orders. */ - productsQuantity: Scalars['Int']['output']; + productsQuantity: Scalars["Int"]["output"]; /** The number of orders the customer made. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; export type CustomerPartnerNode = { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; }; /** The input to change the user password. */ export type CustomerPasswordChangeInputGraphInput = { /** The current password. */ - currentPassword: Scalars['String']['input']; + currentPassword: Scalars["String"]["input"]; /** The new password. */ - newPassword: Scalars['String']['input']; + newPassword: Scalars["String"]["input"]; }; export type CustomerSimpleCreateInputGraphInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; export type CustomerUpdateInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The Brazilian register identification number for individuals. */ - rg?: InputMaybe; + rg?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** Some products can have customizations, such as writing your name on it or other predefined options. */ export type Customization = Node & { /** Cost of customization. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** Customization unique identifier. */ - customizationId: Scalars['Long']['output']; + customizationId: Scalars["Long"]["output"]; /** Customization group's name. */ - groupName?: Maybe; + groupName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Maximum allowed size of the field. */ - maxLength: Scalars['Int']['output']; + maxLength: Scalars["Int"]["output"]; /** The customization's name. */ - name?: Maybe; + name?: Maybe; /** Priority order of customization. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Type of customization. */ - type?: Maybe; + type?: Maybe; /** Value of customization. */ - values?: Maybe>>; + values?: Maybe>>; }; /** The delivery schedule detail. */ export type DeliveryScheduleDetail = { /** The date of the delivery schedule. */ - date?: Maybe; + date?: Maybe; /** The end date and time of the delivery schedule. */ - endDateTime: Scalars['DateTime']['output']; + endDateTime: Scalars["DateTime"]["output"]; /** The end time of the delivery schedule. */ - endTime?: Maybe; + endTime?: Maybe; /** The start date and time of the delivery schedule. */ - startDateTime: Scalars['DateTime']['output']; + startDateTime: Scalars["DateTime"]["output"]; /** The start time of the delivery schedule. */ - startTime?: Maybe; + startTime?: Maybe; }; /** Input for delivery scheduling. */ export type DeliveryScheduleInput = { /** The date. */ - date: Scalars['DateTime']['input']; + date: Scalars["DateTime"]["input"]; /** The period ID. */ - periodId: Scalars['Long']['input']; + periodId: Scalars["Long"]["input"]; }; /** Define the entity type of the customer registration. */ export type EntityType = /** Legal entity, a company, business, organization. */ - | 'COMPANY' + | "COMPANY" /** An international person, a legal international entity. */ - | 'INTERNATIONAL' + | "INTERNATIONAL" /** An individual person, a physical person. */ - | 'PERSON'; + | "PERSON"; export type FilterPosition = /** Both filter position. */ - | 'BOTH' + | "BOTH" /** Horizontal filter position. */ - | 'HORIZONTAL' + | "HORIZONTAL" /** Vertical filter position. */ - | 'VERTICAL'; + | "VERTICAL"; /** The customer's gender. */ export type Gender = - | 'FEMALE' - | 'MALE'; + | "FEMALE" + | "MALE"; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type Hotsite = Node & { @@ -1328,38 +1335,37 @@ export type Hotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars['Long']['output']; + hotsiteId: Scalars["Long"]["output"]; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A list of products associated with the hotsite. */ products?: Maybe; /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type HotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -1367,11 +1373,11 @@ export type HotsiteProductsArgs = { /** Define the hotsite attribute which the result set will be sorted on. */ export type HotsiteSortKeys = /** The hotsite id. */ - | 'ID' + | "ID" /** The hotsite name. */ - | 'NAME' + | "NAME" /** The hotsite url. */ - | 'URL'; + | "URL"; export type HotsiteSorting = { direction?: Maybe; @@ -1380,13 +1386,13 @@ export type HotsiteSorting = { export type HotsiteSubtype = /** Hotsite created from a brand. */ - | 'BRAND' + | "BRAND" /** Hotsite created from a buy list (lista de compra). */ - | 'BUY_LIST' + | "BUY_LIST" /** Hotsite created from a category. */ - | 'CATEGORY' + | "CATEGORY" /** Hotsite created from a portfolio. */ - | 'PORTFOLIO'; + | "PORTFOLIO"; /** A connection to a list of items. */ export type HotsitesConnection = { @@ -1401,7 +1407,7 @@ export type HotsitesConnection = { /** An edge in a connection. */ export type HotsitesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -1409,162 +1415,160 @@ export type HotsitesEdge = { /** Informations about an image of a product. */ export type Image = { /** The name of the image file. */ - fileName?: Maybe; + fileName?: Maybe; /** Check if the image is used for the product main image. */ - mini: Scalars['Boolean']['output']; + mini: Scalars["Boolean"]["output"]; /** Numeric order the image should be displayed. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Check if the image is used for the product prints only. */ - print: Scalars['Boolean']['output']; + print: Scalars["Boolean"]["output"]; /** The url to retrieve the image */ - url?: Maybe; + url?: Maybe; }; /** The additional information about in-store pickup */ export type InStorePickupAdditionalInformationInput = { /** The document */ - document?: InputMaybe; + document?: InputMaybe; /** The name */ - name?: InputMaybe; + name?: InputMaybe; }; /** Information registred to the product. */ export type Information = { /** The information id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The information title. */ - title?: Maybe; + title?: Maybe; /** The information type. */ - type?: Maybe; + type?: Maybe; /** The information value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupFieldNode = Node & { /** The information group field display type. */ - displayType?: Maybe; + displayType?: Maybe; /** The information group field name. */ - fieldName?: Maybe; + fieldName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The information group field order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** If the information group field is required. */ - required: Scalars['Boolean']['output']; + required: Scalars["Boolean"]["output"]; /** The information group field preset values. */ values?: Maybe>>; }; export type InformationGroupFieldValueNode = { /** The information group field value order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** The information group field value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupValueInput = { /** The information group field unique identifier. */ - id?: InputMaybe; + id?: InputMaybe; /** The information group field value. */ - value?: InputMaybe; + value?: InputMaybe; }; export type Installment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type InstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; /** The name of this installment plan. */ - name?: Maybe; + name?: Maybe; }; /** The user login type. */ export type LoginType = - | 'AUTHENTICATED' - | 'NEW' - | 'SIMPLE'; + | "AUTHENTICATED" + | "NEW" + | "SIMPLE"; /** Informations about menu items. */ export type Menu = Node & { /** Menu css class to apply. */ - cssClass?: Maybe; + cssClass?: Maybe; /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu image url address. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu hierarchy level. */ - level: Scalars['Int']['output']; + level: Scalars["Int"]["output"]; /** Menu link address. */ - link?: Maybe; + link?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars['Int']['output']; + menuGroupId: Scalars["Int"]["output"]; /** Menu identifier. */ - menuId: Scalars['Int']['output']; + menuId: Scalars["Int"]["output"]; /** Menu name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Menu hierarchy level. */ - openNewTab: Scalars['Boolean']['output']; + openNewTab: Scalars["Boolean"]["output"]; /** Menu position order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Parent menu identifier. */ - parentMenuId?: Maybe; + parentMenuId?: Maybe; /** Menu extra text. */ - text?: Maybe; + text?: Maybe; }; - /** Informations about menu items. */ export type MenuFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Informations about menu groups. */ export type MenuGroup = Node & { /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu group image url. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars['Int']['output']; + menuGroupId: Scalars["Int"]["output"]; /** List of menus associated with the current group */ menus?: Maybe>>; /** Menu group name. */ - name?: Maybe; + name?: Maybe; /** Menu group partner id. */ - partnerId?: Maybe; + partnerId?: Maybe; /** Menu group position. */ - position?: Maybe; + position?: Maybe; }; - /** Informations about menu groups. */ export type MenuGroupFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Some products can have metadata, like diferent types of custom information. A basic key value pair. */ export type Metadata = { /** Metadata key. */ - key?: Maybe; + key?: Maybe; /** Metadata value. */ - value?: Maybe; + value?: Maybe; }; export type Mutation = { @@ -1655,406 +1659,367 @@ export type Mutation = { wishlistRemoveProduct?: Maybe>>; }; - export type MutationCheckoutAddCouponArgs = { - checkoutId: Scalars['Uuid']['input']; - coupon: Scalars['String']['input']; - customerAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + coupon: Scalars["String"]["input"]; + customerAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCheckoutAddMetadataArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; metadata: Array>; }; - export type MutationCheckoutAddMetadataForProductVariantArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; metadata: Array>; - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; }; - export type MutationCheckoutAddProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; - export type MutationCheckoutAddressAssociateArgs = { - addressId: Scalars['ID']['input']; - checkoutId: Scalars['Uuid']['input']; - customerAccessToken: Scalars['String']['input']; + addressId: Scalars["ID"]["input"]; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutCloneArgs = { - checkoutId: Scalars['Uuid']['input']; - copyUser?: Scalars['Boolean']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + copyUser?: Scalars["Boolean"]["input"]; + customerAccessToken?: InputMaybe; }; - export type MutationCheckoutCompleteArgs = { - checkoutId: Scalars['Uuid']['input']; - comments?: InputMaybe; - customerAccessToken?: InputMaybe; - paymentData: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + comments?: InputMaybe; + customerAccessToken?: InputMaybe; + paymentData: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCheckoutCustomerAssociateArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutGiftVariantSelectionArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - productVariantId: Scalars['Long']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + productVariantId: Scalars["Long"]["input"]; }; - export type MutationCheckoutPartnerAssociateArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - partnerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + partnerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutRemoveCouponArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; }; - export type MutationCheckoutRemoveProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; - export type MutationCheckoutSelectInstallmentArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - installmentNumber: Scalars['Int']['input']; - selectedPaymentMethodId: Scalars['Uuid']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + installmentNumber: Scalars["Int"]["input"]; + selectedPaymentMethodId: Scalars["Uuid"]["input"]; }; - export type MutationCheckoutSelectPaymentMethodArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - paymentMethodId: Scalars['ID']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + paymentMethodId: Scalars["ID"]["input"]; }; - export type MutationCheckoutSelectShippingQuoteArgs = { additionalInformation?: InputMaybe; - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; deliveryScheduleInput?: InputMaybe; - shippingQuoteId: Scalars['Uuid']['input']; + shippingQuoteId: Scalars["Uuid"]["input"]; }; - export type MutationCreateCheckoutArgs = { products?: InputMaybe>>; }; - export type MutationCreateNewsletterRegisterArgs = { input: NewsletterInput; }; - export type MutationCreateProductReviewArgs = { input: ReviewCreateInput; }; - export type MutationCreateSearchTermRecordArgs = { input: SearchRecordInput; }; - export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenInput; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCustomerAddressCreateArgs = { address: CreateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCustomerAddressUpdateArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - export type MutationCustomerCompletePartialRegistrationArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerCreateArgs = { input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerEmailChangeArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; }; - export type MutationCustomerImpersonateArgs = { - customerAccessToken: Scalars['String']['input']; - input: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; + input: Scalars["String"]["input"]; }; - export type MutationCustomerPasswordChangeArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerPasswordRecoveryArgs = { - input: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + input: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSimpleLoginStartArgs = { - input?: InputMaybe; - recaptchaToken?: InputMaybe; + input?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSimpleLoginVerifyAnwserArgs = { - anwserId: Scalars['Uuid']['input']; - input?: InputMaybe; - questionId: Scalars['Uuid']['input']; - recaptchaToken?: InputMaybe; + anwserId: Scalars["Uuid"]["input"]; + input?: InputMaybe; + questionId: Scalars["Uuid"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSocialLoginFacebookArgs = { - facebookAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + facebookAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSocialLoginGoogleArgs = { - clientId?: InputMaybe; - recaptchaToken?: InputMaybe; - userCredential?: InputMaybe; + clientId?: InputMaybe; + recaptchaToken?: InputMaybe; + userCredential?: InputMaybe; }; - export type MutationCustomerUpdateArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input: CustomerUpdateInput; }; - export type MutationPartnerAccessTokenCreateArgs = { input: PartnerAccessTokenInput; }; - export type MutationProductPriceAlertArgs = { input: AddPriceAlertInput; }; - export type MutationProductRestockAlertArgs = { input: RestockAlertInput; - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; }; - export type MutationSendGenericFormArgs = { - body?: InputMaybe; - file?: InputMaybe; - recaptchaToken?: InputMaybe; + body?: InputMaybe; + file?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationUpdateAddressArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - export type MutationWishlistAddProductArgs = { - customerAccessToken: Scalars['String']['input']; - productId: Scalars['Long']['input']; + customerAccessToken: Scalars["String"]["input"]; + productId: Scalars["Long"]["input"]; }; - export type MutationWishlistRemoveProductArgs = { - customerAccessToken: Scalars['String']['input']; - productId: Scalars['Long']['input']; + customerAccessToken: Scalars["String"]["input"]; + productId: Scalars["Long"]["input"]; }; export type NewsletterInput = { - email: Scalars['String']['input']; - informationGroupValues?: InputMaybe>>; - name: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + email: Scalars["String"]["input"]; + informationGroupValues?: InputMaybe< + Array> + >; + name: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; export type NewsletterNode = { /** Newsletter creation date. */ - createDate: Scalars['DateTime']['output']; + createDate: Scalars["DateTime"]["output"]; /** The newsletter receiver email. */ - email?: Maybe; + email?: Maybe; /** The newsletter receiver name. */ - name?: Maybe; + name?: Maybe; /** Newsletter update date. */ - updateDate?: Maybe; + updateDate?: Maybe; }; export type Node = { - id?: Maybe; + id?: Maybe; }; /** Types of operations to perform between query terms. */ export type Operation = /** Performs AND operation between query terms. */ - | 'AND' + | "AND" /** Performs OR operation between query terms. */ - | 'OR'; + | "OR"; /** Result of the operation. */ export type OperationResult = { /** If the operation is a success. */ - isSuccess: Scalars['Boolean']['output']; + isSuccess: Scalars["Boolean"]["output"]; }; export type OrderAdjustNode = { /** The adjust name. */ - name?: Maybe; + name?: Maybe; /** Note about the adjust. */ - note?: Maybe; + note?: Maybe; /** Type of adjust. */ - type?: Maybe; + type?: Maybe; /** Amount to be adjusted. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type OrderAttributeNode = { /** The attribute name. */ - name?: Maybe; + name?: Maybe; /** The attribute value. */ - value?: Maybe; + value?: Maybe; }; export type OrderCustomizationNode = { /** The customization cost. */ - cost?: Maybe; + cost?: Maybe; /** The customization name. */ - name?: Maybe; + name?: Maybe; /** The customization value. */ - value?: Maybe; + value?: Maybe; }; export type OrderDeliveryAddressNode = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep?: Maybe; + cep?: Maybe; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The country of the address. */ - country?: Maybe; + country?: Maybe; /** The neighborhood of the address. */ - neighboorhood?: Maybe; + neighboorhood?: Maybe; /** The receiver's name. */ - receiverName?: Maybe; + receiverName?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address, abbreviated. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; export type OrderInvoiceNode = { /** The invoice access key. */ - accessKey?: Maybe; + accessKey?: Maybe; /** The invoice identifier code. */ - invoiceCode?: Maybe; + invoiceCode?: Maybe; /** The invoice serial digit. */ - serialDigit?: Maybe; + serialDigit?: Maybe; /** The invoice URL. */ - url?: Maybe; + url?: Maybe; }; export type OrderNoteNode = { /** Date the note was added to the order. */ - date?: Maybe; + date?: Maybe; /** The note added to the order. */ - note?: Maybe; + note?: Maybe; /** The user who added the note to the order. */ - user?: Maybe; + user?: Maybe; }; export type OrderPackagingNode = { /** The packaging cost. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** The packaging description. */ - description?: Maybe; + description?: Maybe; /** The message added to the packaging. */ - message?: Maybe; + message?: Maybe; /** The packaging name. */ - name?: Maybe; + name?: Maybe; }; export type OrderPaymentAdditionalInfoNode = { /** Additional information key. */ - key?: Maybe; + key?: Maybe; /** Additional information value. */ - value?: Maybe; + value?: Maybe; }; export type OrderPaymentBoletoNode = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; export type OrderPaymentCardNode = { /** The brand of the card. */ - brand?: Maybe; + brand?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; export type OrderPaymentNode = { @@ -2065,32 +2030,32 @@ export type OrderPaymentNode = { /** The card information. */ card?: Maybe; /** Order discounted value. */ - discount?: Maybe; + discount?: Maybe; /** Order additional fees value. */ - fees?: Maybe; + fees?: Maybe; /** Value per installment. */ - installmentValue?: Maybe; + installmentValue?: Maybe; /** Number of installments. */ - installments?: Maybe; + installments?: Maybe; /** Message about payment transaction. */ - message?: Maybe; + message?: Maybe; /** The chosen payment option for the order. */ - paymentOption?: Maybe; + paymentOption?: Maybe; /** The pix information. */ pix?: Maybe; /** Current payment status. */ - status?: Maybe; + status?: Maybe; /** Order total value. */ - total?: Maybe; + total?: Maybe; }; export type OrderPaymentPixNode = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; export type OrderProductNode = { @@ -2099,244 +2064,243 @@ export type OrderProductNode = { /** The product attributes. */ attributes?: Maybe>>; /** The cost of the customizations, if any. */ - customizationPrice: Scalars['Decimal']['output']; + customizationPrice: Scalars["Decimal"]["output"]; /** List of customizations for the product. */ customizations?: Maybe>>; /** Amount of discount in the product price, if any. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** If the product is a gift. */ - gift?: Maybe; + gift?: Maybe; /** The product image. */ - image?: Maybe; + image?: Maybe; /** The product list price. */ - listPrice: Scalars['Decimal']['output']; + listPrice: Scalars["Decimal"]["output"]; /** The product name. */ - name?: Maybe; + name?: Maybe; /** The cost of the packagings, if any. */ - packagingPrice: Scalars['Decimal']['output']; + packagingPrice: Scalars["Decimal"]["output"]; /** List of packagings for the product. */ packagings?: Maybe>>; /** The product price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** Information about the product seller. */ productSeller?: Maybe; /** Variant unique identifier. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** Quantity of the given product in the order. */ - quantity: Scalars['Long']['output']; + quantity: Scalars["Long"]["output"]; /** The product sale price. */ - salePrice: Scalars['Decimal']['output']; + salePrice: Scalars["Decimal"]["output"]; /** The product SKU. */ - sku?: Maybe; + sku?: Maybe; /** List of trackings for the order. */ trackings?: Maybe>>; /** Value of an unit of the product. */ - unitaryValue: Scalars['Decimal']['output']; + unitaryValue: Scalars["Decimal"]["output"]; }; export type OrderSellerNode = { /** The seller's name. */ - name?: Maybe; + name?: Maybe; }; export type OrderShippingNode = { /** Limit date of delivery, in days. */ - deadline?: Maybe; + deadline?: Maybe; /** Deadline text message. */ - deadlineText?: Maybe; + deadlineText?: Maybe; /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The order pick up unique identifier. */ - pickUpId?: Maybe; + pickUpId?: Maybe; /** The products belonging to the order. */ products?: Maybe>>; /** Amount discounted from shipping costs, if any. */ - promotion?: Maybe; + promotion?: Maybe; /** Shipping company connector identifier code. */ - refConnector?: Maybe; + refConnector?: Maybe; /** Start date of shipping schedule. */ - scheduleFrom?: Maybe; + scheduleFrom?: Maybe; /** Limit date of shipping schedule. */ - scheduleUntil?: Maybe; + scheduleUntil?: Maybe; /** Shipping fee value. */ - shippingFee?: Maybe; + shippingFee?: Maybe; /** The shipping name. */ - shippingName?: Maybe; + shippingName?: Maybe; /** Shipping rate table unique identifier. */ - shippingTableId?: Maybe; + shippingTableId?: Maybe; /** The total value. */ - total?: Maybe; + total?: Maybe; /** Order package size. */ - volume?: Maybe; + volume?: Maybe; /** The order weight, in grams. */ - weight?: Maybe; + weight?: Maybe; }; export type OrderShippingProductNode = { /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The product price. */ - price?: Maybe; + price?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Quantity of the given product. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** Define the sort orientation of the result set. */ export type OrderSortDirection = /** The results will be sorted in an ascending order. */ - | 'ASC' + | "ASC" /** The results will be sorted in an descending order. */ - | 'DESC'; + | "DESC"; /** Represents the status of an order. */ export type OrderStatus = /** Order has been approved in analysis. */ - | 'APPROVED_ANALYSIS' + | "APPROVED_ANALYSIS" /** Order has been authorized. */ - | 'AUTHORIZED' + | "AUTHORIZED" /** Order is awaiting payment. */ - | 'AWAITING_PAYMENT' + | "AWAITING_PAYMENT" /** Order is awaiting change of payment method. */ - | 'AWAITING_PAYMENT_CHANGE' + | "AWAITING_PAYMENT_CHANGE" /** Order has been cancelled. */ - | 'CANCELLED' + | "CANCELLED" /** Order has been cancelled - Card Denied. */ - | 'CANCELLED_DENIED_CARD' + | "CANCELLED_DENIED_CARD" /** Order has been cancelled - Fraud. */ - | 'CANCELLED_FRAUD' + | "CANCELLED_FRAUD" /** Order has been cancelled. */ - | 'CANCELLED_ORDER_CANCELLED' + | "CANCELLED_ORDER_CANCELLED" /** Order has been cancelled - Suspected Fraud. */ - | 'CANCELLED_SUSPECT_FRAUD' + | "CANCELLED_SUSPECT_FRAUD" /** Order has been cancelled - Card Temporarily Denied. */ - | 'CANCELLED_TEMPORARILY_DENIED_CARD' + | "CANCELLED_TEMPORARILY_DENIED_CARD" /** Order has been checked. */ - | 'CHECKED_ORDER' + | "CHECKED_ORDER" /** Order has been credited. */ - | 'CREDITED' + | "CREDITED" /** Order has been delivered. */ - | 'DELIVERED' + | "DELIVERED" /** Payment denied, but the order has not been cancelled. */ - | 'DENIED_PAYMENT' + | "DENIED_PAYMENT" /** Documents needed for purchase. */ - | 'DOCUMENTS_FOR_PURCHASE' + | "DOCUMENTS_FOR_PURCHASE" /** Order has been placed. */ - | 'ORDERED' + | "ORDERED" /** Order has been paid. */ - | 'PAID' + | "PAID" /** Available for pick-up in store. */ - | 'PICK_UP_IN_STORE' + | "PICK_UP_IN_STORE" /** Order has been received - Gift Card. */ - | 'RECEIVED_GIFT_CARD' + | "RECEIVED_GIFT_CARD" /** Order has been returned. */ - | 'RETURNED' + | "RETURNED" /** Order has been sent. */ - | 'SENT' + | "SENT" /** Order has been sent - Invoiced. */ - | 'SENT_INVOICED' + | "SENT_INVOICED" /** Order has been separated. */ - | 'SEPARATED'; + | "SEPARATED"; export type OrderStatusNode = { /** The date when status has changed. */ - changeDate?: Maybe; + changeDate?: Maybe; /** Order status. */ - status?: Maybe; + status?: Maybe; /** Status unique identifier. */ - statusId: Scalars['Long']['output']; + statusId: Scalars["Long"]["output"]; }; export type OrderTrackingNode = { /** The tracking code. */ - code?: Maybe; + code?: Maybe; /** The URL for tracking. */ - url?: Maybe; + url?: Maybe; }; /** Information about pagination in a connection. */ export type PageInfo = { /** When paginating forwards, the cursor to continue. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Indicates whether more edges exist following the set defined by the clients arguments. */ - hasNextPage: Scalars['Boolean']['output']; + hasNextPage: Scalars["Boolean"]["output"]; /** Indicates whether more edges exist prior the set defined by the clients arguments. */ - hasPreviousPage: Scalars['Boolean']['output']; + hasPreviousPage: Scalars["Boolean"]["output"]; /** When paginating backwards, the cursor to continue. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** Partners are used to assign specific products or price tables depending on its scope. */ export type Partner = Node & { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner is valid until this date. */ - endDate: Scalars['DateTime']['output']; + endDate: Scalars["DateTime"]["output"]; /** The full partner logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The partner logo's URL. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's origin. */ - origin?: Maybe; + origin?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; /** Partner unique identifier. */ - partnerId: Scalars['Long']['output']; + partnerId: Scalars["Long"]["output"]; /** Portfolio identifier assigned to this partner. */ - portfolioId: Scalars['Int']['output']; + portfolioId: Scalars["Int"]["output"]; /** Price table identifier assigned to this partner. */ - priceTableId: Scalars['Int']['output']; + priceTableId: Scalars["Int"]["output"]; /** The partner is valid from this date. */ - startDate: Scalars['DateTime']['output']; + startDate: Scalars["DateTime"]["output"]; /** The type of scoped the partner is used. */ - type?: Maybe; + type?: Maybe; }; - /** Partners are used to assign specific products or price tables depending on its scope. */ export type PartnerFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type PartnerAccessToken = { - token?: Maybe; - validUntil?: Maybe; + token?: Maybe; + validUntil?: Maybe; }; /** The input to authenticate closed scope partners. */ export type PartnerAccessTokenInput = { - password: Scalars['String']['input']; - username: Scalars['String']['input']; + password: Scalars["String"]["input"]; + username: Scalars["String"]["input"]; }; /** Input for partners. */ export type PartnerByRegionInput = { /** CEP to get the regional partners. */ - cep?: InputMaybe; + cep?: InputMaybe; /** Region ID to get the regional partners. */ - regionId?: InputMaybe; + regionId?: InputMaybe; }; /** Define the partner attribute which the result set will be sorted on. */ export type PartnerSortKeys = /** The partner unique identifier. */ - | 'ID' + | "ID" /** The partner name. */ - | 'NAME'; + | "NAME"; export type PartnerSubtype = /** Partner 'client' subtype. */ - | 'CLIENT' + | "CLIENT" /** Partner 'closed' subtype. */ - | 'CLOSED' + | "CLOSED" /** Partner 'open' subtype. */ - | 'OPEN'; + | "OPEN"; /** A connection to a list of items. */ export type PartnersConnection = { @@ -2351,7 +2315,7 @@ export type PartnersConnection = { /** An edge in a connection. */ export type PartnersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2359,62 +2323,62 @@ export type PartnersEdge = { /** Informations about the physical store. */ export type PhysicalStore = { /** Additional text. */ - additionalText?: Maybe; + additionalText?: Maybe; /** Physical store address. */ - address?: Maybe; + address?: Maybe; /** Physical store address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Physical store address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** Physical store address city. */ - city?: Maybe; + city?: Maybe; /** Physical store country. */ - country?: Maybe; + country?: Maybe; /** Physical store DDD. */ - ddd: Scalars['Int']['output']; + ddd: Scalars["Int"]["output"]; /** Delivery deadline. */ - deliveryDeadline: Scalars['Int']['output']; + deliveryDeadline: Scalars["Int"]["output"]; /** Physical store email. */ - email?: Maybe; + email?: Maybe; /** Physical store latitude. */ - latitude?: Maybe; + latitude?: Maybe; /** Physical store longitude. */ - longitude?: Maybe; + longitude?: Maybe; /** Physical store name. */ - name?: Maybe; + name?: Maybe; /** Physical store address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Physical store phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Physical store ID. */ - physicalStoreId: Scalars['Int']['output']; + physicalStoreId: Scalars["Int"]["output"]; /** If the physical store allows pickup. */ - pickup: Scalars['Boolean']['output']; + pickup: Scalars["Boolean"]["output"]; /** Pickup deadline. */ - pickupDeadline: Scalars['Int']['output']; + pickupDeadline: Scalars["Int"]["output"]; /** Physical store state. */ - state?: Maybe; + state?: Maybe; /** Physical store zip code. */ - zipCode?: Maybe; + zipCode?: Maybe; }; /** Range of prices for this product. */ export type PriceRange = { /** The quantity of products in this range. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The price range. */ - range?: Maybe; + range?: Maybe; }; export type PriceTable = { /** The amount of discount in percentage. */ - discountPercentage: Scalars['Decimal']['output']; + discountPercentage: Scalars["Decimal"]["output"]; /** The id of this price table. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The listed regular price of this table. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price of this table. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; }; /** The prices of the product. */ @@ -2422,17 +2386,17 @@ export type Prices = { /** The best installment option available. */ bestInstallment?: Maybe; /** The amount of discount in percentage. */ - discountPercentage: Scalars['Decimal']['output']; + discountPercentage: Scalars["Decimal"]["output"]; /** Wether the current price is discounted. */ - discounted: Scalars['Boolean']['output']; + discounted: Scalars["Boolean"]["output"]; /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The multiplication factor used for items that are sold by quantity. */ - multiplicationFactor: Scalars['Float']['output']; + multiplicationFactor: Scalars["Float"]["output"]; /** The current working price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** * List of the product different price tables. * @@ -2446,63 +2410,63 @@ export type Prices = { /** Input to specify the range of prices to return. */ export type PricesInput = { /** The product discount must be greater than or equal to. */ - discount_gte?: InputMaybe; + discount_gte?: InputMaybe; /** The product discount must be lesser than or equal to. */ - discount_lte?: InputMaybe; + discount_lte?: InputMaybe; /** Return only products where the listed price is more than the price. */ - discounted?: InputMaybe; + discounted?: InputMaybe; /** The product price must be greater than or equal to. */ - price_gte?: InputMaybe; + price_gte?: InputMaybe; /** The product price must be lesser than or equal to. */ - price_lte?: InputMaybe; + price_lte?: InputMaybe; }; /** A product represents an item for sale in the store. */ export type Product = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** BuyBox informations. */ buyBox?: Maybe; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -2510,13 +2474,13 @@ export type Product = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** The product seller. */ @@ -2524,48 +2488,46 @@ export type Product = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A product represents an item for sale in the store. */ export type ProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type ProductAggregations = { /** List of product filters which can be used to filter subsequent queries. */ filters?: Maybe>>; /** Minimum price of the products. */ - maximumPrice: Scalars['Decimal']['output']; + maximumPrice: Scalars["Decimal"]["output"]; /** Maximum price of the products. */ - minimumPrice: Scalars['Decimal']['output']; + minimumPrice: Scalars["Decimal"]["output"]; /** List of price ranges for the selected products. */ priceRanges?: Maybe>>; }; - export type ProductAggregationsFiltersArgs = { position?: InputMaybe; }; @@ -2573,61 +2535,60 @@ export type ProductAggregationsFiltersArgs = { /** The attributes of the product. */ export type ProductAttribute = Node & { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type ProductBrand = { /** The hotsite url alias fot this brand. */ - alias?: Maybe; + alias?: Maybe; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The brand id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The url that contains the brand logo image. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The name of the brand. */ - name?: Maybe; + name?: Maybe; }; - export type ProductBrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Information about the category of a product. */ export type ProductCategory = { /** Wether the category is currently active. */ - active: Scalars['Boolean']['output']; + active: Scalars["Boolean"]["output"]; /** The categories in google format. */ - googleCategories?: Maybe; + googleCategories?: Maybe; /** The category hierarchy. */ - hierarchy?: Maybe; + hierarchy?: Maybe; /** The id of the category. */ - id: Scalars['Int']['output']; + id: Scalars["Int"]["output"]; /** Wether this category is the main category for this product. */ - main: Scalars['Boolean']['output']; + main: Scalars["Boolean"]["output"]; /** The category name. */ - name?: Maybe; + name?: Maybe; /** The category hotsite url alias. */ - url?: Maybe; + url?: Maybe; }; export type ProductCollectionSegment = { items?: Maybe>>; - page: Scalars['Int']['output']; - pageSize: Scalars['Int']['output']; - totalCount: Scalars['Int']['output']; + page: Scalars["Int"]["output"]; + pageSize: Scalars["Int"]["output"]; + totalCount: Scalars["Int"]["output"]; }; /** Filter product results based on giving attributes. */ @@ -2635,45 +2596,45 @@ export type ProductExplicitFiltersInput = { /** The set of attributes do filter. */ attributes?: InputMaybe; /** Choose if you want to retrieve only the available products in stock. */ - available?: InputMaybe; + available?: InputMaybe; /** The set of brand IDs which the result item brand ID must be included in. */ - brandId?: InputMaybe>; + brandId?: InputMaybe>; /** The set of category IDs which the result item category ID must be included in. */ - categoryId?: InputMaybe>; + categoryId?: InputMaybe>; /** The set of EANs which the result item EAN must be included. */ - ean?: InputMaybe>>; + ean?: InputMaybe>>; /** Retrieve the product variant only if it contains images. */ - hasImages?: InputMaybe; + hasImages?: InputMaybe; /** Retrieve the product variant only if it is the main product variant. */ - mainVariant?: InputMaybe; + mainVariant?: InputMaybe; /** The set of prices to filter. */ prices?: InputMaybe; /** The product unique identifier (you may provide a list of IDs if needed). */ - productId?: InputMaybe>; + productId?: InputMaybe>; /** The product variant unique identifier (you may provide a list of IDs if needed). */ - productVariantId?: InputMaybe>; + productVariantId?: InputMaybe>; /** A product ID or a list of IDs to search for other products with the same parent ID. */ - sameParentAs?: InputMaybe>; + sameParentAs?: InputMaybe>; /** The set of SKUs which the result item SKU must be included. */ - sku?: InputMaybe>>; + sku?: InputMaybe>>; /** Show products with a quantity of available products in stock greater than or equal to the given number. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** Show products with a quantity of available products in stock less than or equal to the given number. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; /** The set of stocks to filter. */ stocks?: InputMaybe; /** Retrieve products which the last update date is greater than or equal to the given date. */ - updatedAt_gte?: InputMaybe; + updatedAt_gte?: InputMaybe; /** Retrieve products which the last update date is less than or equal to the given date. */ - updatedAt_lte?: InputMaybe; + updatedAt_lte?: InputMaybe; }; /** Custom attribute defined on store's admin may also be used as a filter. */ export type ProductFilterInput = { /** The attribute name. */ - field: Scalars['String']['input']; + field: Scalars["String"]["input"]; /** The set of values which the result filter item value must be included in. */ - values: Array>; + values: Array>; }; /** Options available for the given product. */ @@ -2683,10 +2644,9 @@ export type ProductOption = Node & { /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; }; - /** Options available for the given product. */ export type ProductOptionAttributesArgs = { filter?: InputMaybe>>; @@ -2695,81 +2655,80 @@ export type ProductOptionAttributesArgs = { /** A product price alert. */ export type ProductPriceAlert = { /** The alerted's email. */ - email?: Maybe; + email?: Maybe; /** The alerted's name. */ - name?: Maybe; + name?: Maybe; /** The price alert ID. */ - priceAlertId: Scalars['Long']['output']; + priceAlertId: Scalars["Long"]["output"]; /** The product variant ID. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The request date. */ - requestDate: Scalars['DateTime']['output']; + requestDate: Scalars["DateTime"]["output"]; /** The target price. */ - targetPrice: Scalars['Decimal']['output']; + targetPrice: Scalars["Decimal"]["output"]; }; -export type ProductRecommendationAlgorithm = - | 'DEFAULT'; +export type ProductRecommendationAlgorithm = "DEFAULT"; /** Define the product attribute which the result set will be sorted on. */ export type ProductSearchSortKeys = /** The applied discount to the product variant price. */ - | 'DISCOUNT' + | "DISCOUNT" /** The product name. */ - | 'NAME' + | "NAME" /** The product variant price. */ - | 'PRICE' + | "PRICE" /** Sort in a random way. */ - | 'RANDOM' + | "RANDOM" /** The date the product was released. */ - | 'RELEASE_DATE' + | "RELEASE_DATE" /** The relevance that the search engine gave to the possible result item based on own criteria. */ - | 'RELEVANCE' + | "RELEVANCE" /** The sales number on a period of time. */ - | 'SALES' + | "SALES" /** The quantity in stock of the product variant. */ - | 'STOCK'; + | "STOCK"; /** Define the product attribute which the result set will be sorted on. */ export type ProductSortKeys = /** The applied discount to the product variant price. */ - | 'DISCOUNT' + | "DISCOUNT" /** The product name. */ - | 'NAME' + | "NAME" /** The product variant price. */ - | 'PRICE' + | "PRICE" /** Sort in a random way. */ - | 'RANDOM' + | "RANDOM" /** The date the product was released. */ - | 'RELEASE_DATE' + | "RELEASE_DATE" /** The sales number on a period of time. */ - | 'SALES' + | "SALES" /** The quantity in stock of the product variant. */ - | 'STOCK'; + | "STOCK"; export type ProductSubscription = { /** The amount of discount if this product is sold as a subscription. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** The price of the product when sold as a subscription. */ - price?: Maybe; + price?: Maybe; /** Wether this product is sold only as a subscrition. */ - subscriptionOnly: Scalars['Boolean']['output']; + subscriptionOnly: Scalars["Boolean"]["output"]; }; /** Product variants that have the attribute. */ export type ProductVariant = Node & { /** The available stock at the default distribution center. */ - aggregatedStock?: Maybe; + aggregatedStock?: Maybe; /** The product alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the selected variant attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product's EAN. */ - ean?: Maybe; + ean?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The product's images. */ images?: Maybe>>; /** The seller's product offers. */ @@ -2777,24 +2736,23 @@ export type ProductVariant = Node & { /** The product prices. */ prices?: Maybe; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Product variant name. */ - productVariantName?: Maybe; + productVariantName?: Maybe; /** List of promotions this product variant belongs to. */ promotions?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; }; - /** Product variants that have the attribute. */ export type ProductVariantImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** A connection to a list of items. */ @@ -2805,13 +2763,13 @@ export type ProductsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** An edge in a connection. */ export type ProductsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2819,24 +2777,23 @@ export type ProductsEdge = { /** Information about promotions of a product. */ export type Promotion = { /** The promotion html content. */ - content?: Maybe; + content?: Maybe; /** Where the promotion is shown (spot, product page, etc..). */ - disclosureType?: Maybe; + disclosureType?: Maybe; /** The stamp URL of the promotion. */ - fullStampUrl?: Maybe; + fullStampUrl?: Maybe; /** The promotion id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The stamp of the promotion. */ - stamp?: Maybe; + stamp?: Maybe; /** The promotion title. */ - title?: Maybe; + title?: Maybe; }; - /** Information about promotions of a product. */ export type PromotionFullStampUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type QueryRoot = { @@ -2867,7 +2824,9 @@ export type QueryRoot = { /** List of menu groups. */ menuGroups?: Maybe>>; /** Get newsletter information group fields. */ - newsletterInformationGroupFields?: Maybe>>; + newsletterInformationGroupFields?: Maybe< + Array> + >; node?: Maybe; nodes?: Maybe>>; /** Get single partner. */ @@ -2903,315 +2862,287 @@ export type QueryRoot = { uri?: Maybe; }; - export type QueryRootAddressArgs = { - cep?: InputMaybe; + cep?: InputMaybe; }; - export type QueryRootAutocompleteArgs = { - limit?: InputMaybe; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + limit?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; - export type QueryRootBannersArgs = { - after?: InputMaybe; - bannerIds?: InputMaybe>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + bannerIds?: InputMaybe>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: BannerSortKeys; }; - export type QueryRootBrandsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; brandInput?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: BrandSortKeys; }; - export type QueryRootBuyListArgs = { - id: Scalars['Long']['input']; - partnerAccessToken?: InputMaybe; + id: Scalars["Long"]["input"]; + partnerAccessToken?: InputMaybe; }; - export type QueryRootCalculatePricesArgs = { - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; products: Array>; }; - export type QueryRootCategoriesArgs = { - after?: InputMaybe; - before?: InputMaybe; - categoryIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + categoryIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: CategorySortKeys; }; - export type QueryRootCheckoutArgs = { - checkoutId: Scalars['String']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["String"]["input"]; + customerAccessToken?: InputMaybe; }; - export type QueryRootContentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - contentIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + contentIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: ContentSortKeys; }; - export type QueryRootCustomerArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; }; - export type QueryRootHotsiteArgs = { - hotsiteId?: InputMaybe; - partnerAccessToken?: InputMaybe; - url?: InputMaybe; + hotsiteId?: InputMaybe; + partnerAccessToken?: InputMaybe; + url?: InputMaybe; }; - export type QueryRootHotsitesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - hotsiteIds?: InputMaybe>; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + hotsiteIds?: InputMaybe>; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: HotsiteSortKeys; }; - export type QueryRootMenuGroupsArgs = { - partnerAccessToken?: InputMaybe; - position?: InputMaybe; - url: Scalars['String']['input']; + partnerAccessToken?: InputMaybe; + position?: InputMaybe; + url: Scalars["String"]["input"]; }; - export type QueryRootNodeArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; - export type QueryRootPartnerArgs = { - partnerAccessToken: Scalars['String']['input']; + partnerAccessToken: Scalars["String"]["input"]; }; - export type QueryRootPartnerByRegionArgs = { input: PartnerByRegionInput; }; - export type QueryRootPartnersArgs = { - after?: InputMaybe; - alias?: InputMaybe>>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - names?: InputMaybe>>; - priceTableIds?: InputMaybe>; + after?: InputMaybe; + alias?: InputMaybe>>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + names?: InputMaybe>>; + priceTableIds?: InputMaybe>; sortDirection?: SortDirection; sortKey?: PartnerSortKeys; }; - export type QueryRootPaymentMethodsArgs = { - checkoutId: Scalars['Uuid']['input']; + checkoutId: Scalars["Uuid"]["input"]; }; - export type QueryRootProductArgs = { - partnerAccessToken?: InputMaybe; - productId: Scalars['Long']['input']; + partnerAccessToken?: InputMaybe; + productId: Scalars["Long"]["input"]; }; - export type QueryRootProductOptionsArgs = { - productId: Scalars['Long']['input']; + productId: Scalars["Long"]["input"]; }; - export type QueryRootProductRecommendationsArgs = { algorithm?: ProductRecommendationAlgorithm; - partnerAccessToken?: InputMaybe; - productId: Scalars['Long']['input']; - quantity?: Scalars['Int']['input']; + partnerAccessToken?: InputMaybe; + productId: Scalars["Long"]["input"]; + quantity?: Scalars["Int"]["input"]; }; - export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters: ProductExplicitFiltersInput; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; - export type QueryRootScriptsArgs = { - name?: InputMaybe; + name?: InputMaybe; pageType?: InputMaybe>; position?: InputMaybe; - url?: InputMaybe; + url?: InputMaybe; }; - export type QueryRootSearchArgs = { operation?: Operation; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; - export type QueryRootShippingQuotesArgs = { - cep?: InputMaybe; - checkoutId?: InputMaybe; - productVariantId?: InputMaybe; - quantity?: InputMaybe; - useSelectedAddress?: InputMaybe; + cep?: InputMaybe; + checkoutId?: InputMaybe; + productVariantId?: InputMaybe; + quantity?: InputMaybe; + useSelectedAddress?: InputMaybe; }; - export type QueryRootShopSettingsArgs = { - settingNames?: InputMaybe>>; + settingNames?: InputMaybe>>; }; - export type QueryRootUriArgs = { - url: Scalars['String']['input']; + url: Scalars["String"]["input"]; }; export type Question = { answers?: Maybe>>; - question?: Maybe; - questionId?: Maybe; + question?: Maybe; + questionId?: Maybe; }; /** Back in stock registration input parameters. */ export type RestockAlertInput = { /** Email to be notified. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** Name of the person to be notified. */ - name?: InputMaybe; + name?: InputMaybe; /** The product variant id of the product to be notified. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; }; export type RestockAlertNode = { /** Email to be notified. */ - email?: Maybe; + email?: Maybe; /** Name of the person to be notified. */ - name?: Maybe; + name?: Maybe; /** The product variant id. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** Date the alert was requested. */ - requestDate: Scalars['DateTime']['output']; + requestDate: Scalars["DateTime"]["output"]; }; /** A product review written by a customer. */ export type Review = { /** The reviewer name. */ - customer?: Maybe; + customer?: Maybe; /** The reviewer e-mail. */ - email?: Maybe; + email?: Maybe; /** The review rating. */ - rating: Scalars['Int']['output']; + rating: Scalars["Int"]["output"]; /** The review content. */ - review?: Maybe; + review?: Maybe; /** The review date. */ - reviewDate: Scalars['DateTime']['output']; + reviewDate: Scalars["DateTime"]["output"]; }; /** Review input parameters. */ export type ReviewCreateInput = { /** The reviewer's email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The reviewer's name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product variant id to add the review to. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; /** The review rating. */ - rating: Scalars['Int']['input']; + rating: Scalars["Int"]["input"]; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The review content. */ - review: Scalars['String']['input']; + review: Scalars["String"]["input"]; }; /** Entity SEO information. */ export type Seo = { /** Content of SEO. */ - content?: Maybe; + content?: Maybe; /** Equivalent SEO type for HTTP. */ - httpEquiv?: Maybe; + httpEquiv?: Maybe; /** Name of SEO. */ - name?: Maybe; + name?: Maybe; /** Scheme for SEO. */ - scheme?: Maybe; + scheme?: Maybe; /** Type of SEO. */ - type?: Maybe; + type?: Maybe; }; /** Returns the scripts registered in the script manager. */ export type Script = { /** The script content. */ - content?: Maybe; + content?: Maybe; /** The script name. */ - name?: Maybe; + name?: Maybe; /** The script page type. */ pageType: ScriptPageType; /** The script position. */ position: ScriptPosition; /** The script priority. */ - priority: Scalars['Int']['output']; + priority: Scalars["Int"]["output"]; }; export type ScriptPageType = - | 'ALL' - | 'BRAND' - | 'CATEGORY' - | 'HOME' - | 'PRODUCT' - | 'SEARCH'; + | "ALL" + | "BRAND" + | "CATEGORY" + | "HOME" + | "PRODUCT" + | "SEARCH"; export type ScriptPosition = - | 'BODY_END' - | 'BODY_START' - | 'FOOTER_END' - | 'FOOTER_START' - | 'HEADER_END' - | 'HEADER_START'; + | "BODY_END" + | "BODY_START" + | "FOOTER_END" + | "FOOTER_START" + | "HEADER_END" + | "HEADER_START"; /** Search for relevant products to the searched term. */ export type Search = { @@ -3226,41 +3157,39 @@ export type Search = { /** Information about forbidden term. */ forbiddenTerm?: Maybe; /** The quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A cursor based paginated list of products from the search. */ products?: Maybe; /** An offset based paginated list of products from the search. */ productsByOffset?: Maybe; /** Redirection url in case a term in the search triggers a redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; /** Time taken to perform the search. */ - searchTime?: Maybe; + searchTime?: Maybe; }; - /** Search for relevant products to the searched term. */ export type SearchProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** Search for relevant products to the searched term. */ export type SearchProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3268,9 +3197,9 @@ export type SearchProductsByOffsetArgs = { /** Aggregated filters of a list of products. */ export type SearchFilter = { /** The name of the field. */ - field?: Maybe; + field?: Maybe; /** The origin of the field. */ - origin?: Maybe; + origin?: Maybe; /** List of the values of the field. */ values?: Maybe>>; }; @@ -3278,41 +3207,41 @@ export type SearchFilter = { /** Details of a filter value. */ export type SearchFilterItem = { /** The name of the value. */ - name?: Maybe; + name?: Maybe; /** The quantity of product with this value. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** The response data */ export type SearchRecord = { /** The date time of the processed request */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** If the record was successful */ - isSuccess: Scalars['Boolean']['output']; + isSuccess: Scalars["Boolean"]["output"]; /** The searched query */ - query?: Maybe; + query?: Maybe; }; /** The information to be saved for reports. */ export type SearchRecordInput = { /** The search operation (And, Or) */ - operation?: InputMaybe; + operation?: InputMaybe; /** The current page */ - page: Scalars['Int']['input']; + page: Scalars["Int"]["input"]; /** How many products show in page */ - pageSize: Scalars['Int']['input']; + pageSize: Scalars["Int"]["input"]; /** The client search page url */ - pageUrl?: InputMaybe; + pageUrl?: InputMaybe; /** The user search query */ - query?: InputMaybe; + query?: InputMaybe; /** How many products the search returned */ - totalResults: Scalars['Int']['input']; + totalResults: Scalars["Int"]["input"]; }; /** The selected payment method details. */ export type SelectedPaymentMethod = { /** The unique identifier for the selected payment method. */ - id: Scalars['Uuid']['output']; + id: Scalars["Uuid"]["output"]; /** The list of installments associated with the selected payment method. */ installments?: Maybe>>; /** The selected installment. */ @@ -3322,46 +3251,46 @@ export type SelectedPaymentMethod = { /** Details of an installment of the selected payment method. */ export type SelectedPaymentMethodInstallment = { /** The adjustment value applied to the installment. */ - adjustment: Scalars['Float']['output']; + adjustment: Scalars["Float"]["output"]; /** The installment number. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The total value of the installment. */ - total: Scalars['Float']['output']; + total: Scalars["Float"]["output"]; /** The individual value of each installment. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** Seller informations. */ export type Seller = { /** Seller name */ - name?: Maybe; + name?: Maybe; }; export type SellerInstallment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type SellerInstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; }; /** The seller's product offer */ export type SellerOffer = { - name?: Maybe; + name?: Maybe; /** The product prices. */ prices?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; }; /** The prices of the product. */ @@ -3369,68 +3298,68 @@ export type SellerPrices = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price. */ - price?: Maybe; + price?: Maybe; }; export type ShippingNode = { /** The shipping deadline. */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The delivery schedule detail. */ deliverySchedule?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars['Uuid']['output']; + shippingQuoteId: Scalars["Uuid"]["output"]; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** The product informations related to the shipping. */ export type ShippingProduct = { /** The product unique identifier. */ - productVariantId: Scalars['Int']['output']; + productVariantId: Scalars["Int"]["output"]; /** The shipping value related to the product. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** A shipping quote. */ export type ShippingQuote = Node & { /** The shipping deadline. */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The available time slots for scheduling the delivery of the shipping quote. */ deliverySchedules?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The products related to the shipping. */ products?: Maybe>>; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars['Uuid']['output']; + shippingQuoteId: Scalars["Uuid"]["output"]; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** Informations about the store. */ export type Shop = { /** Checkout URL */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** Store main URL */ - mainUrl?: Maybe; + mainUrl?: Maybe; /** Mobile checkout URL */ - mobileCheckoutUrl?: Maybe; + mobileCheckoutUrl?: Maybe; /** Mobile URL */ - mobileUrl?: Maybe; + mobileUrl?: Maybe; /** Store modified name */ - modifiedName?: Maybe; + modifiedName?: Maybe; /** Store name */ - name?: Maybe; + name?: Maybe; /** Physical stores */ physicalStores?: Maybe>>; }; @@ -3438,28 +3367,27 @@ export type Shop = { /** Store setting. */ export type ShopSetting = { /** Setting name */ - name?: Maybe; + name?: Maybe; /** Setting value */ - value?: Maybe; + value?: Maybe; }; /** Information about a similar product. */ export type SimilarProduct = { /** The url alias of this similar product. */ - alias?: Maybe; + alias?: Maybe; /** The file name of the similar product image. */ - image?: Maybe; + image?: Maybe; /** The URL of the similar product image. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the similar product. */ - name?: Maybe; + name?: Maybe; }; - /** Information about a similar product. */ export type SimilarProductImageUrlArgs = { - h?: InputMaybe; - w?: InputMaybe; + h?: InputMaybe; + w?: InputMaybe; }; export type SimpleLogin = { @@ -3473,8 +3401,8 @@ export type SimpleLogin = { /** The simple login type. */ export type SimpleLoginType = - | 'NEW' - | 'SIMPLE'; + | "NEW" + | "SIMPLE"; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsite = Node & { @@ -3487,17 +3415,17 @@ export type SingleHotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars['Long']['output']; + hotsiteId: Scalars["Long"]["output"]; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A list of products associated with the hotsite. Cursor pagination. */ products?: Maybe; /** A list of products associated with the hotsite. Offset pagination. */ @@ -3507,41 +3435,39 @@ export type SingleHotsite = Node & { /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3549,17 +3475,17 @@ export type SingleHotsiteProductsByOffsetArgs = { /** A product represents an item for sale in the store. */ export type SingleProduct = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ @@ -3567,41 +3493,41 @@ export type SingleProduct = Node & { /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -3609,13 +3535,13 @@ export type SingleProduct = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -3627,106 +3553,104 @@ export type SingleProduct = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A product represents an item for sale in the store. */ export type SingleProductAttributeSelectionsArgs = { selected?: InputMaybe>>; }; - /** A product represents an item for sale in the store. */ export type SingleProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Define the sort orientation of the result set. */ export type SortDirection = /** The results will be sorted in an ascending order. */ - | 'ASC' + | "ASC" /** The results will be sorted in an descending order. */ - | 'DESC'; + | "DESC"; /** Information about a product stock in a particular distribution center. */ export type Stock = { /** The id of the distribution center. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The number of physical items in stock at this DC. */ - items: Scalars['Long']['output']; + items: Scalars["Long"]["output"]; /** The name of the distribution center. */ - name?: Maybe; + name?: Maybe; }; /** Input to specify the range of stocks, distribution center ID, and distribution center name to return. */ export type StocksInput = { /** The distribution center Ids to match. */ - dcId?: InputMaybe>; + dcId?: InputMaybe>; /** The distribution center names to match. */ - dcName?: InputMaybe>>; + dcName?: InputMaybe>>; /** The product stock must be greater than or equal to. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** The product stock must be lesser than or equal to. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; }; export type SubscriptionGroup = { /** The recurring types for this subscription group. */ recurringTypes?: Maybe>>; /** The status name of the group. */ - status?: Maybe; + status?: Maybe; /** The status id of the group. */ - statusId: Scalars['Int']['output']; + statusId: Scalars["Int"]["output"]; /** The subscription group id. */ - subscriptionGroupId: Scalars['Long']['output']; + subscriptionGroupId: Scalars["Long"]["output"]; /** Wether the product is only avaible for subscription. */ - subscriptionOnly: Scalars['Boolean']['output']; + subscriptionOnly: Scalars["Boolean"]["output"]; }; export type SubscriptionRecurringType = { /** The number of days of the recurring type. */ - days: Scalars['Int']['output']; + days: Scalars["Int"]["output"]; /** The recurring type display name. */ - name?: Maybe; + name?: Maybe; /** The recurring type id. */ - recurringTypeId: Scalars['Long']['output']; + recurringTypeId: Scalars["Long"]["output"]; }; export type UpdateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber?: InputMaybe; - cep?: InputMaybe; - city?: InputMaybe; - country?: InputMaybe; - email?: InputMaybe; - name?: InputMaybe; - neighborhood?: InputMaybe; - phone?: InputMaybe; - referencePoint?: InputMaybe; - state?: InputMaybe; - street?: InputMaybe; + addressDetails?: InputMaybe; + addressNumber?: InputMaybe; + cep?: InputMaybe; + city?: InputMaybe; + country?: InputMaybe; + email?: InputMaybe; + name?: InputMaybe; + neighborhood?: InputMaybe; + phone?: InputMaybe; + referencePoint?: InputMaybe; + state?: InputMaybe; + street?: InputMaybe; }; /** Node of URI Kind. */ @@ -3738,34 +3662,34 @@ export type Uri = { /** The partner subtype. */ partnerSubtype?: Maybe; /** Product alias. */ - productAlias?: Maybe; + productAlias?: Maybe; /** Product categories IDs. */ - productCategoriesIds?: Maybe>; + productCategoriesIds?: Maybe>; /** Redirect status code. */ - redirectCode?: Maybe; + redirectCode?: Maybe; /** Url to redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; export type UriKind = - | 'BUY_LIST' - | 'HOTSITE' - | 'NOT_FOUND' - | 'PARTNER' - | 'PRODUCT' - | 'REDIRECT'; + | "BUY_LIST" + | "HOTSITE" + | "NOT_FOUND" + | "PARTNER" + | "PRODUCT" + | "REDIRECT"; export type WholesalePrices = { /** The wholesale price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** The minimum quantity required for the wholesale price to be applied */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** A representation of available time slots for scheduling a delivery. */ export type DeliverySchedule = { /** The date of the delivery schedule. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** The list of time periods available for scheduling a delivery. */ periods?: Maybe>>; }; @@ -3773,40 +3697,40 @@ export type DeliverySchedule = { /** Informations about a forbidden search term. */ export type ForbiddenTerm = { /** The suggested search term instead. */ - suggested?: Maybe; + suggested?: Maybe; /** The text to display about the term. */ - text?: Maybe; + text?: Maybe; }; export type Order = { /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** Current account value used for the order. */ - currentAccount: Scalars['Decimal']['output']; + currentAccount: Scalars["Decimal"]["output"]; /** The date when te order was placed. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** The address where the order will be delivered. */ deliveryAddress?: Maybe; /** Order discount amount, if any. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** Order interest fee, if any. */ - interestFee: Scalars['Decimal']['output']; + interestFee: Scalars["Decimal"]["output"]; /** Information about order invoices. */ invoices?: Maybe>>; /** Information about order notes. */ notes?: Maybe>>; /** Order unique identifier. */ - orderId: Scalars['Long']['output']; + orderId: Scalars["Long"]["output"]; /** The date when the order was payed. */ - paymentDate?: Maybe; + paymentDate?: Maybe; /** Information about payments. */ payments?: Maybe>>; /** Products belonging to the order. */ products?: Maybe>>; /** List of promotions applied to the order. */ - promotions?: Maybe>; + promotions?: Maybe>; /** The shipping fee. */ - shippingFee: Scalars['Decimal']['output']; + shippingFee: Scalars["Decimal"]["output"]; /** Information about order shippings. */ shippings?: Maybe>>; /** The order current status. */ @@ -3814,30 +3738,30 @@ export type Order = { /** List of the order status history. */ statusHistory?: Maybe>>; /** Order subtotal value. */ - subtotal: Scalars['Decimal']['output']; + subtotal: Scalars["Decimal"]["output"]; /** Order total value. */ - total: Scalars['Decimal']['output']; + total: Scalars["Decimal"]["output"]; /** Information about order trackings. */ trackings?: Maybe>>; }; export type PaymentMethod = Node & { /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url link that displays for the payment. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; }; /** Represents a time period available for scheduling a delivery. */ export type Period = { /** The end time of the time period. */ - end?: Maybe; + end?: Maybe; /** The unique identifier of the time period. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The start time of the time period. */ - start?: Maybe; + start?: Maybe; }; export type Wishlist = { @@ -3846,77 +3770,816 @@ export type Wishlist = { }; export type AddCouponMutationVariables = Exact<{ - checkoutId: Scalars['Uuid']['input']; - coupon: Scalars['String']['input']; + checkoutId: Scalars["Uuid"]["input"]; + coupon: Scalars["String"]["input"]; }>; - -export type AddCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type AddCouponMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type AddItemToCartMutationVariables = Exact<{ input: CheckoutProductInput; }>; - -export type AddItemToCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type AddItemToCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type RemoveCouponMutationVariables = Exact<{ - checkoutId: Scalars['Uuid']['input']; + checkoutId: Scalars["Uuid"]["input"]; }>; - -export type RemoveCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type RemoveCouponMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type RemoveItemFromCartMutationVariables = Exact<{ input: CheckoutProductInput; }>; - -export type RemoveItemFromCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type RemoveItemFromCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type GetCartQueryVariables = Exact<{ - checkoutId: Scalars['String']['input']; + checkoutId: Scalars["String"]["input"]; }>; - -export type GetCartQuery = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; - - -export type CreateCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type GetCartQuery = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; + +export type CreateCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type GetProductQueryVariables = Exact<{ - productId: Scalars['Long']['input']; + productId: Scalars["Long"]["input"]; }>; - -export type GetProductQuery = { product?: { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null } | null }; +export type GetProductQuery = { + product?: { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + breadcrumbs?: + | Array<{ text?: string | null; link?: string | null } | null> + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { + discount: boolean; + fees: boolean; + number: number; + value: any; + } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + reviews?: + | Array< + { + rating: number; + review?: string | null; + reviewDate: any; + email?: string | null; + customer?: string | null; + } | null + > + | null; + seller?: { name?: string | null } | null; + seo?: + | Array< + { + name?: string | null; + scheme?: string | null; + type?: string | null; + httpEquiv?: string | null; + content?: string | null; + } | null + > + | null; + } | null; +}; export type GetProductsQueryVariables = Exact<{ filters: ProductExplicitFiltersInput; - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; sortDirection: SortDirection; sortKey?: InputMaybe; }>; - -export type GetProductsQuery = { products?: { nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null } | null }; +export type GetProductsQuery = { + products?: { + nodes?: + | Array< + { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + { + title?: string | null; + value?: string | null; + type?: string | null; + } | null + > + | null; + images?: + | Array< + | { + url?: string | null; + fileName?: string | null; + print: boolean; + } + | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + { + discount: boolean; + fees: boolean; + number: number; + value: any; + } | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: + | Array<{ price: any; quantity: number } | null> + | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; + } | null + > + | null; + } | null; +}; export type SearchQueryVariables = Exact<{ operation: Operation; - query?: InputMaybe; - first: Scalars['Int']['input']; + query?: InputMaybe; + first: Scalars["Int"]["input"]; sortDirection?: InputMaybe; sortKey?: InputMaybe; - filters?: InputMaybe> | InputMaybe>; + filters?: InputMaybe< + Array> | InputMaybe + >; }>; - -export type SearchQuery = { search?: { pageSize: number, redirectUrl?: string | null, searchTime?: string | null, aggregations?: { filters?: Array<{ field?: string | null, origin?: string | null, values?: Array<{ quantity: number, name?: string | null } | null> | null } | null> | null } | null, breadcrumbs?: Array<{ link?: string | null, text?: string | null } | null> | null, forbiddenTerm?: { text?: string | null, suggested?: string | null } | null, products?: { totalCount: number, nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null, pageInfo: { hasNextPage: boolean, hasPreviousPage: boolean } } | null } | null }; - -export type CheckoutFragment = { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null }; - -export type ProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null }; - -export type SingleProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null }; +export type SearchQuery = { + search?: { + pageSize: number; + redirectUrl?: string | null; + searchTime?: string | null; + aggregations?: { + filters?: + | Array< + { + field?: string | null; + origin?: string | null; + values?: + | Array<{ quantity: number; name?: string | null } | null> + | null; + } | null + > + | null; + } | null; + breadcrumbs?: + | Array<{ link?: string | null; text?: string | null } | null> + | null; + forbiddenTerm?: { text?: string | null; suggested?: string | null } | null; + products?: { + totalCount: number; + nodes?: + | Array< + { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + { + title?: string | null; + value?: string | null; + type?: string | null; + } | null + > + | null; + images?: + | Array< + { + url?: string | null; + fileName?: string | null; + print: boolean; + } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + { + discount: boolean; + fees: boolean; + number: number; + value: any; + } | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: + | Array<{ price: any; quantity: number } | null> + | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; + } | null + > + | null; + pageInfo: { hasNextPage: boolean; hasPreviousPage: boolean }; + } | null; + } | null; +}; + +export type CheckoutFragment = { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; +}; + +export type ProductFragment = { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { discount: boolean; fees: boolean; number: number; value: any } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + | { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } + | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; +}; + +export type SingleProductFragment = { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + breadcrumbs?: + | Array<{ text?: string | null; link?: string | null } | null> + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { discount: boolean; fees: boolean; number: number; value: any } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + | { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } + | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + reviews?: + | Array< + { + rating: number; + review?: string | null; + reviewDate: any; + email?: string | null; + customer?: string | null; + } | null + > + | null; + seller?: { name?: string | null } | null; + seo?: + | Array< + { + name?: string | null; + scheme?: string | null; + type?: string | null; + httpEquiv?: string | null; + content?: string | null; + } | null + > + | null; +}; diff --git a/wake/utils/graphql/storefront.graphql.json b/wake/utils/graphql/storefront.graphql.json index 30fdf1822..9c72529cb 100644 --- a/wake/utils/graphql/storefront.graphql.json +++ b/wake/utils/graphql/storefront.graphql.json @@ -23344,4 +23344,4 @@ ] } } -} \ No newline at end of file +} diff --git a/wake/utils/openapi/wake.openapi.gen.ts b/wake/utils/openapi/wake.openapi.gen.ts index b6aa40323..a5e0910a7 100644 --- a/wake/utils/openapi/wake.openapi.gen.ts +++ b/wake/utils/openapi/wake.openapi.gen.ts @@ -1,6 +1,9 @@ +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// // DO NOT EDIT. This file is generated by deco. // This file SHOULD be checked into source version control. // To generate this file: deno task start +// export interface OpenAPI { /** diff --git a/wake/utils/openapi/wake.openapi.json b/wake/utils/openapi/wake.openapi.json index 53f2c4e80..ad80f0a34 100644 --- a/wake/utils/openapi/wake.openapi.json +++ b/wake/utils/openapi/wake.openapi.json @@ -45129,4 +45129,4 @@ }, "x-readme-fauxas": true, "_id": "629f940ff6822d00a2406e17:62a7691a93536400345f5633" -} \ No newline at end of file +} From 79c0dadda3fcda57ac2f3248f41abaf6d02a0fee Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 09:50:20 -0300 Subject: [PATCH 05/21] remove password protection from shopify --- shopify/handlers/sitemap.ts | 8 +++++--- shopify/loaders/proxy.ts | 14 +++++++++++--- shopify/mod.ts | 5 ++++- shopify/utils/password.ts | 9 +++++++++ vtex/handlers/sitemap.ts | 2 +- website/handlers/proxy.ts | 10 +++++----- 6 files changed, 35 insertions(+), 13 deletions(-) create mode 100644 shopify/utils/password.ts diff --git a/shopify/handlers/sitemap.ts b/shopify/handlers/sitemap.ts index 045a5da59..084e6a724 100644 --- a/shopify/handlers/sitemap.ts +++ b/shopify/handlers/sitemap.ts @@ -1,6 +1,7 @@ -import Proxy from "deco/handlers/proxy.ts"; import { ConnInfo } from "std/http/server.ts"; +import Proxy from "../../website/handlers/proxy.ts"; import { AppContext } from "../mod.ts"; +import { withDigestCookie } from "../utils/password.ts"; const xmlHeader = ''; @@ -35,9 +36,9 @@ export interface Props { */ export default function Sitemap( { include }: Props, - { storeName }: AppContext, + appCtx: AppContext, ) { - const url = `https://${storeName}.myshopify.com`; + const url = `https://${appCtx.storeName}.myshopify.com`; return async ( req: Request, ctx: ConnInfo, @@ -51,6 +52,7 @@ export default function Sitemap( const response = await Proxy({ url: publicUrl, + customHeaders: withDigestCookie(appCtx), })(req, ctx); if (!response.ok) { diff --git a/shopify/loaders/proxy.ts b/shopify/loaders/proxy.ts index 0579a44ee..2164ab4f3 100644 --- a/shopify/loaders/proxy.ts +++ b/shopify/loaders/proxy.ts @@ -1,5 +1,6 @@ import { Route } from "../../website/flags/audience.ts"; import { AppContext } from "../mod.ts"; +import { withDigestCookie } from "../utils/password.ts"; const PATHS_TO_PROXY = [ "/checkouts/*", @@ -14,11 +15,17 @@ const PATHS_TO_PROXY = [ const decoSiteMapUrl = "/sitemap/deco.xml"; const buildProxyRoutes = ( - { storeName, extraPaths, includeSiteMap, generateDecoSiteMap }: { - storeName?: string; + { + ctx, + ctx: { storeName }, + extraPaths, + includeSiteMap, + generateDecoSiteMap, + }: { extraPaths: string[]; includeSiteMap?: string[]; generateDecoSiteMap?: boolean; + ctx: AppContext; }, ) => { const publicUrl = new URL(`https://${storeName}.myshopify.com`); @@ -43,6 +50,7 @@ const buildProxyRoutes = ( __resolveType: "website/handlers/proxy.ts", url: urlToProxy, host: hostToUse, + customHeaders: withDigestCookie(ctx), }, }, }); @@ -113,8 +121,8 @@ function loader( return buildProxyRoutes({ generateDecoSiteMap, includeSiteMap, - storeName: ctx.storeName, extraPaths: extraPathsToProxy, + ctx, }); } diff --git a/shopify/mod.ts b/shopify/mod.ts index 6aa79cec9..1e45f4b32 100644 --- a/shopify/mod.ts +++ b/shopify/mod.ts @@ -13,11 +13,14 @@ export interface Props { storeName: string; /** - * @ttile Access Token + * @title Access Token * @description Shopify storefront access token. */ storefrontAccessToken: string; + /** @description Disable password protection on the store */ + storefrontDigestCookie?: string; + /** * @description Use Shopify as backend platform */ diff --git a/shopify/utils/password.ts b/shopify/utils/password.ts new file mode 100644 index 000000000..ed4e83b2f --- /dev/null +++ b/shopify/utils/password.ts @@ -0,0 +1,9 @@ +import { AppContext } from "../mod.ts"; + +export const withDigestCookie = ({ storefrontDigestCookie }: AppContext) => + storefrontDigestCookie + ? [{ + key: "cookie", + value: `storefront_digest=${storefrontDigestCookie}`, + }] + : undefined; diff --git a/vtex/handlers/sitemap.ts b/vtex/handlers/sitemap.ts index c180dd04c..711221afc 100644 --- a/vtex/handlers/sitemap.ts +++ b/vtex/handlers/sitemap.ts @@ -1,4 +1,4 @@ -import Proxy from "deco/handlers/proxy.ts"; +import Proxy from "../../website/handlers/proxy.ts"; import { ConnInfo } from "std/http/server.ts"; import { AppContext } from "../mod.ts"; diff --git a/website/handlers/proxy.ts b/website/handlers/proxy.ts index 05fd7919f..7a75fc4d0 100644 --- a/website/handlers/proxy.ts +++ b/website/handlers/proxy.ts @@ -24,11 +24,11 @@ const removeCFHeaders = (headers: Headers) => { }; const proxyTo = ( - { proxyUrl: rawProxyUrl, basePath, host: hostToUse, customHeaders = {} }: { + { proxyUrl: rawProxyUrl, basePath, host: hostToUse, customHeaders = [] }: { proxyUrl: string; basePath?: string; host?: string; - customHeaders?: Record; + customHeaders?: Header[]; }, ): Handler => async (req, _ctx) => { @@ -58,7 +58,7 @@ async (req, _ctx) => { headers.set("host", hostToUse ?? to.host); headers.set("x-forwarded-host", url.host); - for (const [key, value] of Object.entries(customHeaders ?? {})) { + for (const { key, value } of customHeaders) { headers.set(key, value); } @@ -134,6 +134,6 @@ export interface Props { * @title Proxy * @description Proxies request to the target url. */ -export default function Proxy({ url, basePath, host }: Props) { - return proxyTo({ proxyUrl: url, basePath, host }); +export default function Proxy({ url, basePath, host, customHeaders }: Props) { + return proxyTo({ proxyUrl: url, basePath, host, customHeaders }); } From cbb41d87c6d5072f0e897bb982a01c33454cde52 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 09:51:04 -0300 Subject: [PATCH 06/21] lint --- deno.json | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/deno.json b/deno.json index f407d7ac5..587304aeb 100644 --- a/deno.json +++ b/deno.json @@ -14,10 +14,13 @@ "githooks": { "pre-commit": "check" }, - "exclude": ["static", "README.md"], + "exclude": [ + "static", + "README.md" + ], "importMap": "./import_map.json", "compilerOptions": { "jsx": "react-jsx", "jsxImportSource": "preact" } -} +} \ No newline at end of file From c5d53b12ab35968aa0954f6fcd6f14501cf82298 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 10:01:28 -0300 Subject: [PATCH 07/21] setup githooks --- scripts/start.ts | 3 + shopify/utils/storefront.graphql.gen.ts | 4951 ++++++++---------- wake/utils/graphql/storefront.graphql.gen.ts | 3347 +++++------- 3 files changed, 3657 insertions(+), 4644 deletions(-) diff --git a/scripts/start.ts b/scripts/start.ts index 0aed54525..7aeb6383c 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -9,6 +9,9 @@ import camel from "npm:camelcase"; import { walk } from "std/fs/mod.ts"; import { dirname, join } from "std/path/mod.ts"; import { basename } from "std/path/win32.ts"; +import { setupGithooks } from "https://deno.land/x/githooks@0.0.4/githooks.ts"; + +await setupGithooks(); const OPENAPI_EXTENSION = ".openapi.json"; const GRAPHQL_EXTENSION = ".graphql.json"; diff --git a/shopify/utils/storefront.graphql.gen.ts b/shopify/utils/storefront.graphql.gen.ts index 90d02748f..da0898fbd 100644 --- a/shopify/utils/storefront.graphql.gen.ts +++ b/shopify/utils/storefront.graphql.gen.ts @@ -6,87 +6,80 @@ // export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { - [K in keyof T]: T[K]; -}; -export type MakeOptional = - & Omit - & { [SubKey in K]?: Maybe }; -export type MakeMaybe = - & Omit - & { [SubKey in K]: Maybe }; -export type MakeEmpty = - { [_ in K]?: never }; -export type Incremental = - | T - | { - [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; - }; +export type Exact = { [K in keyof T]: T[K] }; +export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; +export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; +export type MakeEmpty = { [_ in K]?: never }; +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string }; - String: { input: string; output: string }; - Boolean: { input: boolean; output: boolean }; - Int: { input: number; output: number }; - Float: { input: number; output: number }; - Color: { input: any; output: any }; - DateTime: { input: any; output: any }; - Decimal: { input: any; output: any }; - HTML: { input: any; output: any }; - JSON: { input: any; output: any }; - URL: { input: any; output: any }; - UnsignedInt64: { input: any; output: any }; + ID: { input: string; output: string; } + String: { input: string; output: string; } + Boolean: { input: boolean; output: boolean; } + Int: { input: number; output: number; } + Float: { input: number; output: number; } + Color: { input: any; output: any; } + DateTime: { input: any; output: any; } + Decimal: { input: any; output: any; } + HTML: { input: any; output: any; } + JSON: { input: any; output: any; } + URL: { input: any; output: any; } + UnsignedInt64: { input: any; output: any; } }; /** * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). * Versions are commonly referred to by their handle (for example, `2021-10`). + * */ export type ApiVersion = { /** The human-readable name of the version. */ - displayName: Scalars["String"]["output"]; + displayName: Scalars['String']['output']; /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** * Whether the version is actively supported by Shopify. Supported API versions * are guaranteed to be stable. Unsupported API versions include unstable, * release candidate, and end-of-life versions that are marked as unsupported. * For more information, refer to * [Versioning](https://shopify.dev/api/usage/versioning). + * */ - supported: Scalars["Boolean"]["output"]; + supported: Scalars['Boolean']['output']; }; /** * The input fields for submitting Apple Pay payment method information for checkout. + * */ export type ApplePayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** The data for the Apple Pay wallet. */ - data: Scalars["String"]["input"]; + data: Scalars['String']['input']; /** The header data for the Apple Pay wallet. */ header: ApplePayWalletHeaderInput; /** The last digits of the card used to create the payment. */ - lastDigits?: InputMaybe; + lastDigits?: InputMaybe; /** The signature for the Apple Pay wallet. */ - signature: Scalars["String"]["input"]; + signature: Scalars['String']['input']; /** The version for the Apple Pay wallet. */ - version: Scalars["String"]["input"]; + version: Scalars['String']['input']; }; /** * The input fields for submitting wallet payment method information for checkout. + * */ export type ApplePayWalletHeaderInput = { /** The application data for the Apple Pay wallet. */ - applicationData?: InputMaybe; + applicationData?: InputMaybe; /** The ephemeral public key for the Apple Pay wallet. */ - ephemeralPublicKey: Scalars["String"]["input"]; + ephemeralPublicKey: Scalars['String']['input']; /** The public key hash for the Apple Pay wallet. */ - publicKeyHash: Scalars["String"]["input"]; + publicKeyHash: Scalars['String']['input']; /** The transaction ID for the Apple Pay wallet. */ - transactionId: Scalars["String"]["input"]; + transactionId: Scalars['String']['input']; }; /** Details about the gift card used on the checkout. */ @@ -106,90 +99,91 @@ export type AppliedGiftCard = Node & { */ balanceV2: MoneyV2; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The last characters of the gift card. */ - lastCharacters: Scalars["String"]["output"]; + lastCharacters: Scalars['String']['output']; /** The amount that was applied to the checkout in its currency. */ presentmentAmountUsed: MoneyV2; }; /** An article in an online store blog. */ -export type Article = - & HasMetafields - & Node - & OnlineStorePublishable - & Trackable - & { - /** - * The article's author. - * @deprecated Use `authorV2` instead. - */ - author: ArticleAuthor; - /** The article's author. */ - authorV2?: Maybe; - /** The blog that the article belongs to. */ - blog: Blog; - /** List of comments posted on the article. */ - comments: CommentConnection; - /** Stripped content of the article, single line with HTML tags removed. */ - content: Scalars["String"]["output"]; - /** The content of the article, complete with HTML formatting. */ - contentHtml: Scalars["HTML"]["output"]; - /** Stripped excerpt of the article, single line with HTML tags removed. */ - excerpt?: Maybe; - /** The excerpt of the article, complete with HTML formatting. */ - excerptHtml?: Maybe; - /** A human-friendly unique string for the Article automatically generated from its title. */ - handle: Scalars["String"]["output"]; - /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; - /** The image associated with the article. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** The date and time when the article was published. */ - publishedAt: Scalars["DateTime"]["output"]; - /** The article’s SEO information. */ - seo?: Maybe; - /** - * A categorization that a article can be tagged with. - */ - tags: Array; - /** The article’s name. */ - title: Scalars["String"]["output"]; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - }; +export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** + * The article's author. + * @deprecated Use `authorV2` instead. + */ + author: ArticleAuthor; + /** The article's author. */ + authorV2?: Maybe; + /** The blog that the article belongs to. */ + blog: Blog; + /** List of comments posted on the article. */ + comments: CommentConnection; + /** Stripped content of the article, single line with HTML tags removed. */ + content: Scalars['String']['output']; + /** The content of the article, complete with HTML formatting. */ + contentHtml: Scalars['HTML']['output']; + /** Stripped excerpt of the article, single line with HTML tags removed. */ + excerpt?: Maybe; + /** The excerpt of the article, complete with HTML formatting. */ + excerptHtml?: Maybe; + /** A human-friendly unique string for the Article automatically generated from its title. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The image associated with the article. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The date and time when the article was published. */ + publishedAt: Scalars['DateTime']['output']; + /** The article’s SEO information. */ + seo?: Maybe; + /** + * A categorization that a article can be tagged with. + * + */ + tags: Array; + /** The article’s name. */ + title: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; +}; + /** An article in an online store blog. */ export type ArticleCommentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** An article in an online store blog. */ export type ArticleContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; + /** An article in an online store blog. */ export type ArticleExcerptArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; + /** An article in an online store blog. */ export type ArticleMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** An article in an online store blog. */ export type ArticleMetafieldsArgs = { identifiers: Array; @@ -198,19 +192,20 @@ export type ArticleMetafieldsArgs = { /** The author of an article. */ export type ArticleAuthor = { /** The author's bio. */ - bio?: Maybe; + bio?: Maybe; /** The author’s email. */ - email: Scalars["String"]["output"]; + email: Scalars['String']['output']; /** The author's first name. */ - firstName: Scalars["String"]["output"]; + firstName: Scalars['String']['output']; /** The author's last name. */ - lastName: Scalars["String"]["output"]; + lastName: Scalars['String']['output']; /** The author's full name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; }; /** * An auto-generated type for paginating through multiple Articles. + * */ export type ArticleConnection = { /** A list of edges. */ @@ -223,10 +218,11 @@ export type ArticleConnection = { /** * An auto-generated type which holds one Article and a cursor during pagination. + * */ export type ArticleEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of ArticleEdge. */ node: Article; }; @@ -234,41 +230,43 @@ export type ArticleEdge = { /** The set of valid sort keys for the Article query. */ export type ArticleSortKeys = /** Sort by the `author` value. */ - | "AUTHOR" + | 'AUTHOR' /** Sort by the `blog_title` value. */ - | "BLOG_TITLE" + | 'BLOG_TITLE' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `published_at` value. */ - | "PUBLISHED_AT" + | 'PUBLISHED_AT' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE" + | 'TITLE' /** Sort by the `updated_at` value. */ - | "UPDATED_AT"; + | 'UPDATED_AT'; /** Represents a generic custom attribute. */ export type Attribute = { /** Key or name of the attribute. */ - key: Scalars["String"]["output"]; + key: Scalars['String']['output']; /** Value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** The input fields for an attribute. */ export type AttributeInput = { /** Key or name of the attribute. */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** Value of the attribute. */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** * Automatic discount applications capture the intentions of a discount that was automatically applied. + * */ export type AutomaticDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -278,7 +276,7 @@ export type AutomaticDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; @@ -289,8 +287,9 @@ export type AvailableShippingRates = { * Whether or not the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. + * */ - ready: Scalars["Boolean"]["output"]; + ready: Scalars['Boolean']['output']; /** The fetched shipping rates. `null` until the `ready` field is `true`. */ shippingRates?: Maybe>; }; @@ -300,6 +299,7 @@ export type AvailableShippingRates = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * */ export type BaseCartLine = { /** An attribute associated with the cart line. */ @@ -316,27 +316,30 @@ export type BaseCartLine = { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; + /** * An object with an ID field to support global identification, in accordance with the * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * */ export type BaseCartLineAttributeArgs = { - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; }; /** * An auto-generated type for paginating through multiple BaseCartLines. + * */ export type BaseCartLineConnection = { /** A list of edges. */ @@ -349,10 +352,11 @@ export type BaseCartLineConnection = { /** * An auto-generated type which holds one BaseCartLine and a cursor during pagination. + * */ export type BaseCartLineEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of BaseCartLineEdge. */ node: BaseCartLine; }; @@ -367,44 +371,49 @@ export type Blog = HasMetafields & Node & OnlineStorePublishable & { authors: Array; /** * A human-friendly unique string for the Blog automatically generated from its title. + * */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The blog's SEO information. */ seo?: Maybe; /** The blogs’s title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; }; + /** An online store blog. */ export type BlogArticleByHandleArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** An online store blog. */ export type BlogArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** An online store blog. */ export type BlogMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** An online store blog. */ export type BlogMetafieldsArgs = { identifiers: Array; @@ -412,6 +421,7 @@ export type BlogMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Blogs. + * */ export type BlogConnection = { /** A list of edges. */ @@ -424,10 +434,11 @@ export type BlogConnection = { /** * An auto-generated type which holds one Blog and a cursor during pagination. + * */ export type BlogEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of BlogEdge. */ node: Blog; }; @@ -435,19 +446,21 @@ export type BlogEdge = { /** The set of valid sort keys for the Blog query. */ export type BlogSortKeys = /** Sort by the `handle` value. */ - | "HANDLE" + | 'HANDLE' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE"; + | 'TITLE'; /** * The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets). + * */ export type Brand = { /** The colors of the store's brand. */ @@ -457,25 +470,27 @@ export type Brand = { /** The store's default logo. */ logo?: Maybe; /** The store's short description. */ - shortDescription?: Maybe; + shortDescription?: Maybe; /** The store's slogan. */ - slogan?: Maybe; + slogan?: Maybe; /** The store's preferred logo for square UI elements. */ squareLogo?: Maybe; }; /** * A group of related colors for the shop's brand. + * */ export type BrandColorGroup = { /** The background color. */ - background?: Maybe; + background?: Maybe; /** The foreground color. */ - foreground?: Maybe; + foreground?: Maybe; }; /** * The colors of the shop's brand. + * */ export type BrandColors = { /** The shop's primary brand colors. */ @@ -487,23 +502,24 @@ export type BrandColors = { /** Card brand, such as Visa or Mastercard, which can be used for payments. */ export type CardBrand = /** American Express. */ - | "AMERICAN_EXPRESS" + | 'AMERICAN_EXPRESS' /** Diners Club. */ - | "DINERS_CLUB" + | 'DINERS_CLUB' /** Discover. */ - | "DISCOVER" + | 'DISCOVER' /** JCB. */ - | "JCB" + | 'JCB' /** Mastercard. */ - | "MASTERCARD" + | 'MASTERCARD' /** Visa. */ - | "VISA"; + | 'VISA'; /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type Cart = HasMetafields & Node & { /** An attribute associated with the cart. */ @@ -513,18 +529,20 @@ export type Cart = HasMetafields & Node & { /** Information about the buyer that's interacting with the cart. */ buyerIdentity: CartBuyerIdentity; /** The URL of the checkout for the cart. */ - checkoutUrl: Scalars["URL"]["output"]; + checkoutUrl: Scalars['URL']['output']; /** * The estimated costs that the buyer will pay at checkout. The costs are subject * to change and changes will be reflected at checkout. The `cost` field uses the * `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * */ cost: CartCost; /** The date and time when the cart was created. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** * The delivery groups available for the cart, based on the buyer identity default * delivery address preference or the default address of the logged-in customer. + * */ deliveryGroups: CartDeliveryGroupConnection; /** The discounts that have been applied to the entire cart. */ @@ -541,7 +559,7 @@ export type Cart = HasMetafields & Node & { */ estimatedCost: CartEstimatedCost; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** A list of lines containing information about the items the customer intends to purchase. */ lines: BaseCartLineConnection; /** Returns a metafield found by namespace and key. */ @@ -549,67 +567,77 @@ export type Cart = HasMetafields & Node & { /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A note that's associated with the cart. For example, the note can be a personalized message to the buyer. */ - note?: Maybe; + note?: Maybe; /** The total number of items in the cart. */ - totalQuantity: Scalars["Int"]["output"]; + totalQuantity: Scalars['Int']['output']; /** The date and time when the cart was updated. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; }; + /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type CartAttributeArgs = { - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; }; + /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type CartDeliveryGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type CartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type CartMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. + * */ export type CartMetafieldsArgs = { identifiers: Array; @@ -628,7 +656,7 @@ export type CartAutomaticDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; }; /** Represents information about the buyer that is interacting with the cart. */ @@ -641,17 +669,19 @@ export type CartBuyerIdentity = { * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. + * */ deliveryAddressPreferences: Array; /** The email address of the buyer that's interacting with the cart. */ - email?: Maybe; + email?: Maybe; /** The phone number of the buyer that's interacting with the cart. */ - phone?: Maybe; + phone?: Maybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. + * */ - walletPreferences: Array; + walletPreferences: Array; }; /** @@ -659,28 +689,31 @@ export type CartBuyerIdentity = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. + * */ export type CartBuyerIdentityInput = { /** The country where the buyer is located. */ countryCode?: InputMaybe; /** The access token used to identify the customer associated with the cart. */ - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; /** * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. + * */ deliveryAddressPreferences?: InputMaybe>; /** The email address of the buyer that is interacting with the cart. */ - email?: InputMaybe; + email?: InputMaybe; /** The phone number of the buyer that is interacting with the cart. */ - phone?: InputMaybe; + phone?: InputMaybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. * Accepted value: `["shop_pay"]`. + * */ - walletPreferences?: InputMaybe>; + walletPreferences?: InputMaybe>; }; /** Return type for `cartBuyerIdentityUpdate` mutation. */ @@ -693,17 +726,20 @@ export type CartBuyerIdentityUpdatePayload = { /** * Represents how credit card details are provided for a direct payment. + * */ -export type CartCardSource = /** +export type CartCardSource = + /** * The credit card was provided by a third party and vaulted on their system. * Using this value requires a separate permission from Shopify. + * */ - "SAVED_CREDIT_CARD"; + | 'SAVED_CREDIT_CARD'; /** The discount that has been applied to the cart line using a discount code. */ export type CartCodeDiscountAllocation = CartDiscountAllocation & { /** The code used to apply the discount. */ - code: Scalars["String"]["output"]; + code: Scalars['String']['output']; /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; }; @@ -716,48 +752,45 @@ export type CartCompletionActionRequired = { /** The action required to complete the cart completion attempt. */ action?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; }; /** The result of a cart completion attempt. */ -export type CartCompletionAttemptResult = - | CartCompletionActionRequired - | CartCompletionFailed - | CartCompletionProcessing - | CartCompletionSuccess; +export type CartCompletionAttemptResult = CartCompletionActionRequired | CartCompletionFailed | CartCompletionProcessing | CartCompletionSuccess; /** A failed completion to checkout a cart. */ export type CartCompletionFailed = { /** The errors that caused the checkout to fail. */ errors: Array; /** The ID of the cart completion attempt. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; }; /** A cart checkout completion that's still processing. */ export type CartCompletionProcessing = { /** The ID of the cart completion attempt. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; /** The number of milliseconds to wait before polling again. */ - pollDelay: Scalars["Int"]["output"]; + pollDelay: Scalars['Int']['output']; }; /** A successful completion to checkout a cart and a created order. */ export type CartCompletionSuccess = { /** The date and time when the job completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; /** The ID of the order that's created in Shopify. */ - orderId: Scalars["ID"]["output"]; + orderId: Scalars['ID']['output']; /** The URL of the order confirmation in Shopify. */ - orderUrl: Scalars["URL"]["output"]; + orderUrl: Scalars['URL']['output']; }; /** * The costs that the buyer will pay at checkout. * The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * */ export type CartCost = { /** @@ -765,24 +798,25 @@ export type CartCost = { * checkout. The checkout charge amount doesn't include any deferred payments * that'll be paid at a later date. If the cart has no deferred payments, then * the checkout charge amount is equivalent to `subtotalAmount`. + * */ checkoutChargeAmount: MoneyV2; /** The amount, before taxes and cart-level discounts, for the customer to pay. */ subtotalAmount: MoneyV2; /** Whether the subtotal amount is estimated. */ - subtotalAmountEstimated: Scalars["Boolean"]["output"]; + subtotalAmountEstimated: Scalars['Boolean']['output']; /** The total amount for the customer to pay. */ totalAmount: MoneyV2; /** Whether the total amount is estimated. */ - totalAmountEstimated: Scalars["Boolean"]["output"]; + totalAmountEstimated: Scalars['Boolean']['output']; /** The duty amount for the customer to pay at checkout. */ totalDutyAmount?: Maybe; /** Whether the total duty amount is estimated. */ - totalDutyAmountEstimated: Scalars["Boolean"]["output"]; + totalDutyAmountEstimated: Scalars['Boolean']['output']; /** The tax amount for the customer to pay at checkout. */ totalTaxAmount?: Maybe; /** Whether the total tax amount is estimated. */ - totalTaxAmountEstimated: Scalars["Boolean"]["output"]; + totalTaxAmountEstimated: Scalars['Boolean']['output']; }; /** Return type for `cartCreate` mutation. */ @@ -798,7 +832,7 @@ export type CartCustomDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; }; /** Information about the options available for one or more line items to be delivered to a specific address. */ @@ -810,22 +844,24 @@ export type CartDeliveryGroup = { /** The delivery options available for the delivery group. */ deliveryOptions: Array; /** The ID for the delivery group. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The selected delivery option for the delivery group. */ selectedDeliveryOption?: Maybe; }; + /** Information about the options available for one or more line items to be delivered to a specific address. */ export type CartDeliveryGroupCartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple CartDeliveryGroups. + * */ export type CartDeliveryGroupConnection = { /** A list of edges. */ @@ -838,10 +874,11 @@ export type CartDeliveryGroupConnection = { /** * An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination. + * */ export type CartDeliveryGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of CartDeliveryGroupEdge. */ node: CartDeliveryGroup; }; @@ -849,21 +886,22 @@ export type CartDeliveryGroupEdge = { /** Information about a delivery option. */ export type CartDeliveryOption = { /** The code of the delivery option. */ - code?: Maybe; + code?: Maybe; /** The method for the delivery option. */ deliveryMethodType: DeliveryMethodType; /** The description of the delivery option. */ - description?: Maybe; + description?: Maybe; /** The estimated cost for the delivery option. */ estimatedCost: MoneyV2; /** The unique identifier of the delivery option. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** The title of the delivery option. */ - title?: Maybe; + title?: Maybe; }; /** * The input fields for submitting direct payment method information for checkout. + * */ export type CartDirectPaymentMethodInput = { /** The customer's billing address. */ @@ -871,7 +909,7 @@ export type CartDirectPaymentMethodInput = { /** The source of the credit card payment. */ cardSource?: InputMaybe; /** The session ID for the direct payment method used to create the payment. */ - sessionId: Scalars["String"]["input"]; + sessionId: Scalars['String']['input']; }; /** The discounts that have been applied to the cart line. */ @@ -883,9 +921,9 @@ export type CartDiscountAllocation = { /** The discount codes applied to the cart. */ export type CartDiscountCode = { /** Whether the discount code is applicable to the cart's current contents. */ - applicable: Scalars["Boolean"]["output"]; + applicable: Scalars['Boolean']['output']; /** The code for the discount. */ - code: Scalars["String"]["output"]; + code: Scalars['String']['output']; }; /** Return type for `cartDiscountCodesUpdate` mutation. */ @@ -899,27 +937,27 @@ export type CartDiscountCodesUpdatePayload = { /** Possible error codes that can be returned by `CartUserError`. */ export type CartErrorCode = /** The input value is invalid. */ - | "INVALID" + | 'INVALID' /** Delivery group was not found in cart. */ - | "INVALID_DELIVERY_GROUP" + | 'INVALID_DELIVERY_GROUP' /** Delivery option was not valid. */ - | "INVALID_DELIVERY_OPTION" + | 'INVALID_DELIVERY_OPTION' /** Merchandise line was not found in cart. */ - | "INVALID_MERCHANDISE_LINE" + | 'INVALID_MERCHANDISE_LINE' /** The metafields were not valid. */ - | "INVALID_METAFIELDS" + | 'INVALID_METAFIELDS' /** The payment wasn't valid. */ - | "INVALID_PAYMENT" + | 'INVALID_PAYMENT' /** Cannot update payment on an empty cart */ - | "INVALID_PAYMENT_EMPTY_CART" + | 'INVALID_PAYMENT_EMPTY_CART' /** The input value should be less than the maximum value allowed. */ - | "LESS_THAN" + | 'LESS_THAN' /** Missing discount code. */ - | "MISSING_DISCOUNT_CODE" + | 'MISSING_DISCOUNT_CODE' /** Missing note. */ - | "MISSING_NOTE" + | 'MISSING_NOTE' /** The payment method is not supported. */ - | "PAYMENT_METHOD_NOT_SUPPORTED"; + | 'PAYMENT_METHOD_NOT_SUPPORTED'; /** * The estimated costs that the buyer will pay at checkout. @@ -927,6 +965,7 @@ export type CartErrorCode = * [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) * to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * */ export type CartEstimatedCost = { /** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`. */ @@ -943,6 +982,7 @@ export type CartEstimatedCost = { /** * The input fields for submitting a billing address without a selected payment method. + * */ export type CartFreePaymentMethodInput = { /** The customer's billing address. */ @@ -957,35 +997,40 @@ export type CartInput = { * The customer associated with the cart. Used to determine [international pricing] * (https://shopify.dev/custom-storefronts/internationalization/international-pricing). * Buyer identity should match the customer's shipping address. + * */ buyerIdentity?: InputMaybe; /** * The case-insensitive discount codes that the customer added at checkout. + * */ - discountCodes?: InputMaybe>; + discountCodes?: InputMaybe>; /** A list of merchandise lines to add to the cart. */ lines?: InputMaybe>; /** The metafields to associate with this cart. */ metafields?: InputMaybe>; /** * A note that's associated with the cart. For example, the note can be a personalized message to the buyer. + * */ - note?: InputMaybe; + note?: InputMaybe; }; /** The input fields for a cart metafield value to set. */ export type CartInputMetafieldInput = { /** The key name of the metafield. */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). + * */ - type: Scalars["String"]["input"]; + type: Scalars['String']['input']; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. + * */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** Represents information about the merchandise in the cart. */ @@ -1004,18 +1049,19 @@ export type CartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; + /** Represents information about the merchandise in the cart. */ export type CartLineAttributeArgs = { - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; }; /** The cost of the merchandise line that the buyer will pay at checkout. */ @@ -1032,6 +1078,7 @@ export type CartLineCost = { /** * The estimated cost of the merchandise line that the buyer will pay at checkout. + * */ export type CartLineEstimatedCost = { /** The amount of the merchandise line. */ @@ -1049,11 +1096,11 @@ export type CartLineInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise that the buyer intends to purchase. */ - merchandiseId: Scalars["ID"]["input"]; + merchandiseId: Scalars['ID']['input']; /** The quantity of the merchandise. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** The input fields to update a line item on a cart. */ @@ -1061,13 +1108,13 @@ export type CartLineUpdateInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise line. */ - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; /** The ID of the merchandise for the line item. */ - merchandiseId?: InputMaybe; + merchandiseId?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** Return type for `cartLinesAdd` mutation. */ @@ -1099,16 +1146,17 @@ export type CartMetafieldDeleteInput = { /** * The key name of the cart metafield. Can either be a composite key (`namespace.key`) or a simple key * that relies on the default app-reserved namespace. + * */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** The ID of the cart resource. */ - ownerId: Scalars["ID"]["input"]; + ownerId: Scalars['ID']['input']; }; /** Return type for `cartMetafieldDelete` mutation. */ export type CartMetafieldDeletePayload = { /** The ID of the deleted cart metafield. */ - deletedId?: Maybe; + deletedId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -1116,18 +1164,20 @@ export type CartMetafieldDeletePayload = { /** The input fields for a cart metafield value to set. */ export type CartMetafieldsSetInput = { /** The key name of the cart metafield. */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** The ID of the cart resource. */ - ownerId: Scalars["ID"]["input"]; + ownerId: Scalars['ID']['input']; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). + * */ - type: Scalars["String"]["input"]; + type: Scalars['String']['input']; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. + * */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** Return type for `cartMetafieldsSet` mutation. */ @@ -1148,26 +1198,31 @@ export type CartNoteUpdatePayload = { /** * The input fields for updating the payment method that will be used to checkout. + * */ export type CartPaymentInput = { /** The amount that the customer will be charged at checkout. */ amount: MoneyInput; /** * The input fields to use when checking out a cart with a direct payment method (like a credit card). + * */ directPaymentMethod?: InputMaybe; /** * The input fields to use to checkout a cart without providing a payment method. * Use this payment method input if the total cost of the cart is 0. + * */ freePaymentMethod?: InputMaybe; /** * An ID of the order placed on the originating platform. * Note that this value doesn't correspond to the Shopify Order ID. + * */ - sourceIdentifier?: InputMaybe; + sourceIdentifier?: InputMaybe; /** * The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay). + * */ walletPaymentMethod?: InputMaybe; }; @@ -1182,12 +1237,13 @@ export type CartPaymentUpdatePayload = { /** * The input fields for updating the selected delivery options for a delivery group. + * */ export type CartSelectedDeliveryOptionInput = { /** The ID of the cart delivery group. */ - deliveryGroupId: Scalars["ID"]["input"]; + deliveryGroupId: Scalars['ID']['input']; /** The handle of the selected delivery option. */ - deliveryOptionHandle: Scalars["String"]["input"]; + deliveryOptionHandle: Scalars['String']['input']; }; /** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */ @@ -1207,24 +1263,21 @@ export type CartSubmitForCompletionPayload = { }; /** The result of cart submit completion. */ -export type CartSubmitForCompletionResult = - | SubmitAlreadyAccepted - | SubmitFailed - | SubmitSuccess - | SubmitThrottled; +export type CartSubmitForCompletionResult = SubmitAlreadyAccepted | SubmitFailed | SubmitSuccess | SubmitThrottled; /** Represents an error that happens during execution of a cart mutation. */ export type CartUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** * The input fields for submitting wallet payment method information for checkout. + * */ export type CartWalletPaymentMethodInput = { /** The payment method information for the Apple Pay wallet. */ @@ -1241,14 +1294,15 @@ export type Checkout = Node & { * The available shipping rates for this Checkout. * Should only be used when checkout `requiresShipping` is `true` and * the shipping address is valid. + * */ availableShippingRates?: Maybe; /** The identity of the customer associated with the checkout. */ buyerIdentity: CheckoutBuyerIdentity; /** The date and time when the checkout was completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The date and time when the checkout was created. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** The currency code for the checkout. */ currencyCode: CurrencyCode; /** A list of extra information that's added to the checkout. */ @@ -1256,19 +1310,19 @@ export type Checkout = Node & { /** Discounts that have been applied on the checkout. */ discountApplications: DiscountApplicationConnection; /** The email attached to this checkout. */ - email?: Maybe; + email?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection; /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ lineItemsSubtotalPrice: MoneyV2; /** The note associated with the checkout. */ - note?: Maybe; + note?: Maybe; /** The resulting order from a paid checkout. */ order?: Maybe; /** The Order Status Page for this Checkout, null when checkout isn't completed. */ - orderStatusUrl?: Maybe; + orderStatusUrl?: Maybe; /** The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards. */ paymentDue: MoneyV2; /** @@ -1281,14 +1335,16 @@ export type Checkout = Node & { * have asynchronous operations that can take time to finish. If you want * to complete a checkout or ensure all the fields are populated and up to * date, polling is required until the value is true. + * */ - ready: Scalars["Boolean"]["output"]; + ready: Scalars['Boolean']['output']; /** States whether or not the fulfillment requires shipping. */ - requiresShipping: Scalars["Boolean"]["output"]; + requiresShipping: Scalars['Boolean']['output']; /** The shipping address to where the line items will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. + * */ shippingDiscountAllocations: Array; /** Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object. */ @@ -1301,9 +1357,9 @@ export type Checkout = Node & { */ subtotalPriceV2: MoneyV2; /** Whether the checkout is tax exempt. */ - taxExempt: Scalars["Boolean"]["output"]; + taxExempt: Scalars['Boolean']['output']; /** Whether taxes are included in the line item and shipping line prices. */ - taxesIncluded: Scalars["Boolean"]["output"]; + taxesIncluded: Scalars['Boolean']['output']; /** The sum of all the duties applied to the line items in the checkout. */ totalDuties?: Maybe; /** The sum of all the prices of all the items in the checkout, including taxes and duties. */ @@ -1321,27 +1377,29 @@ export type Checkout = Node & { */ totalTaxV2: MoneyV2; /** The date and time when the checkout was last updated. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; /** The url pointing to the checkout accessible from the web. */ - webUrl: Scalars["URL"]["output"]; + webUrl: Scalars['URL']['output']; }; + /** A container for all the information required to checkout items and pay. */ export type CheckoutDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** A container for all the information required to checkout items and pay. */ export type CheckoutLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** The input fields required to update a checkout's attributes. */ @@ -1351,12 +1409,13 @@ export type CheckoutAttributesUpdateV2Input = { * The required attributes are city, province, and country. * Full validation of the addresses is still done at completion time. Defaults to `false` with * each operation. + * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; }; /** Return type for `checkoutAttributesUpdateV2` mutation. */ @@ -1384,6 +1443,7 @@ export type CheckoutBuyerIdentityInput = { * The country code of one of the shop's * [enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup). * For example, `CA`. Including this field creates a checkout in the specified country's currency. + * */ countryCode: CountryCode; }; @@ -1437,18 +1497,19 @@ export type CheckoutCreateInput = { * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. * The required attributes are city, province, and country. * Full validation of addresses is still done at completion time. Defaults to `null`. + * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** The identity of the customer associated with the checkout. */ buyerIdentity?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The email with which the customer wants to checkout. */ - email?: InputMaybe; + email?: InputMaybe; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; /** The shipping address to where the line items will be shipped. */ shippingAddress?: InputMaybe; }; @@ -1460,7 +1521,7 @@ export type CheckoutCreatePayload = { /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** The checkout queue token. Available only to selected stores. */ - queueToken?: Maybe; + queueToken?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. @@ -1538,97 +1599,97 @@ export type CheckoutEmailUpdateV2Payload = { /** Possible error codes that can be returned by `CheckoutUserError`. */ export type CheckoutErrorCode = /** Checkout is already completed. */ - | "ALREADY_COMPLETED" + | 'ALREADY_COMPLETED' /** Input email contains an invalid domain name. */ - | "BAD_DOMAIN" + | 'BAD_DOMAIN' /** The input value is blank. */ - | "BLANK" + | 'BLANK' /** Cart does not meet discount requirements notice. */ - | "CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE" + | 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE' /** Customer already used once per customer discount notice. */ - | "CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE" + | 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE' /** Discount already applied. */ - | "DISCOUNT_ALREADY_APPLIED" + | 'DISCOUNT_ALREADY_APPLIED' /** Discount code isn't working right now. Please contact us for help. */ - | "DISCOUNT_CODE_APPLICATION_FAILED" + | 'DISCOUNT_CODE_APPLICATION_FAILED' /** Discount disabled. */ - | "DISCOUNT_DISABLED" + | 'DISCOUNT_DISABLED' /** Discount expired. */ - | "DISCOUNT_EXPIRED" + | 'DISCOUNT_EXPIRED' /** Discount limit reached. */ - | "DISCOUNT_LIMIT_REACHED" + | 'DISCOUNT_LIMIT_REACHED' /** Discount not found. */ - | "DISCOUNT_NOT_FOUND" + | 'DISCOUNT_NOT_FOUND' /** Checkout is already completed. */ - | "EMPTY" + | 'EMPTY' /** Queue token has expired. */ - | "EXPIRED_QUEUE_TOKEN" + | 'EXPIRED_QUEUE_TOKEN' /** Gift card has already been applied. */ - | "GIFT_CARD_ALREADY_APPLIED" + | 'GIFT_CARD_ALREADY_APPLIED' /** Gift card code is invalid. */ - | "GIFT_CARD_CODE_INVALID" + | 'GIFT_CARD_CODE_INVALID' /** Gift card currency does not match checkout currency. */ - | "GIFT_CARD_CURRENCY_MISMATCH" + | 'GIFT_CARD_CURRENCY_MISMATCH' /** Gift card has no funds left. */ - | "GIFT_CARD_DEPLETED" + | 'GIFT_CARD_DEPLETED' /** Gift card is disabled. */ - | "GIFT_CARD_DISABLED" + | 'GIFT_CARD_DISABLED' /** Gift card is expired. */ - | "GIFT_CARD_EXPIRED" + | 'GIFT_CARD_EXPIRED' /** Gift card was not found. */ - | "GIFT_CARD_NOT_FOUND" + | 'GIFT_CARD_NOT_FOUND' /** Gift card cannot be applied to a checkout that contains a gift card. */ - | "GIFT_CARD_UNUSABLE" + | 'GIFT_CARD_UNUSABLE' /** The input value should be greater than or equal to the minimum value allowed. */ - | "GREATER_THAN_OR_EQUAL_TO" + | 'GREATER_THAN_OR_EQUAL_TO' /** Higher value discount applied. */ - | "HIGHER_VALUE_DISCOUNT_APPLIED" + | 'HIGHER_VALUE_DISCOUNT_APPLIED' /** The input value is invalid. */ - | "INVALID" + | 'INVALID' /** Cannot specify country and presentment currency code. */ - | "INVALID_COUNTRY_AND_CURRENCY" + | 'INVALID_COUNTRY_AND_CURRENCY' /** Input Zip is invalid for country provided. */ - | "INVALID_FOR_COUNTRY" + | 'INVALID_FOR_COUNTRY' /** Input Zip is invalid for country and province provided. */ - | "INVALID_FOR_COUNTRY_AND_PROVINCE" + | 'INVALID_FOR_COUNTRY_AND_PROVINCE' /** Invalid province in country. */ - | "INVALID_PROVINCE_IN_COUNTRY" + | 'INVALID_PROVINCE_IN_COUNTRY' /** Queue token is invalid. */ - | "INVALID_QUEUE_TOKEN" + | 'INVALID_QUEUE_TOKEN' /** Invalid region in country. */ - | "INVALID_REGION_IN_COUNTRY" + | 'INVALID_REGION_IN_COUNTRY' /** Invalid state in country. */ - | "INVALID_STATE_IN_COUNTRY" + | 'INVALID_STATE_IN_COUNTRY' /** The input value should be less than the maximum value allowed. */ - | "LESS_THAN" + | 'LESS_THAN' /** The input value should be less than or equal to the maximum value allowed. */ - | "LESS_THAN_OR_EQUAL_TO" + | 'LESS_THAN_OR_EQUAL_TO' /** Line item was not found in checkout. */ - | "LINE_ITEM_NOT_FOUND" + | 'LINE_ITEM_NOT_FOUND' /** Checkout is locked. */ - | "LOCKED" + | 'LOCKED' /** Maximum number of discount codes limit reached. */ - | "MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED" + | 'MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED' /** Missing payment input. */ - | "MISSING_PAYMENT_INPUT" + | 'MISSING_PAYMENT_INPUT' /** Not enough in stock. */ - | "NOT_ENOUGH_IN_STOCK" + | 'NOT_ENOUGH_IN_STOCK' /** Input value is not supported. */ - | "NOT_SUPPORTED" + | 'NOT_SUPPORTED' /** The input value needs to be blank. */ - | "PRESENT" + | 'PRESENT' /** Product is not published for this customer. */ - | "PRODUCT_NOT_AVAILABLE" + | 'PRODUCT_NOT_AVAILABLE' /** Shipping rate expired. */ - | "SHIPPING_RATE_EXPIRED" + | 'SHIPPING_RATE_EXPIRED' /** Throttled during checkout. */ - | "THROTTLED_DURING_CHECKOUT" + | 'THROTTLED_DURING_CHECKOUT' /** The input value is too long. */ - | "TOO_LONG" + | 'TOO_LONG' /** The amount of the payment does not match the value to be paid. */ - | "TOTAL_PRICE_MISMATCH" + | 'TOTAL_PRICE_MISMATCH' /** Unable to apply discount. */ - | "UNABLE_TO_APPLY"; + | 'UNABLE_TO_APPLY'; /** Return type for `checkoutGiftCardRemoveV2` mutation. */ export type CheckoutGiftCardRemoveV2Payload = { @@ -1663,11 +1724,11 @@ export type CheckoutLineItem = Node & { /** The discounts that have been allocated onto the checkout line item by discount applications. */ discountAllocations: Array; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The quantity of the line item. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** Title of the line item. Defaults to the product's title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** Unit price of the line item. */ unitPrice?: Maybe; /** Product variant of the line item. */ @@ -1676,6 +1737,7 @@ export type CheckoutLineItem = Node & { /** * An auto-generated type for paginating through multiple CheckoutLineItems. + * */ export type CheckoutLineItemConnection = { /** A list of edges. */ @@ -1688,10 +1750,11 @@ export type CheckoutLineItemConnection = { /** * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. + * */ export type CheckoutLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of CheckoutLineItemEdge. */ node: CheckoutLineItem; }; @@ -1701,9 +1764,9 @@ export type CheckoutLineItemInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The quantity of the line item. */ - quantity: Scalars["Int"]["input"]; + quantity: Scalars['Int']['input']; /** The ID of the product variant for the line item. */ - variantId: Scalars["ID"]["input"]; + variantId: Scalars['ID']['input']; }; /** The input fields to update a line item on the checkout. */ @@ -1711,11 +1774,11 @@ export type CheckoutLineItemUpdateInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The ID of the line item. */ - id?: InputMaybe; + id?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The variant ID of the line item. */ - variantId?: InputMaybe; + variantId?: InputMaybe; }; /** Return type for `checkoutLineItemsAdd` mutation. */ @@ -1796,93 +1859,99 @@ export type CheckoutUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. + * */ -export type Collection = - & HasMetafields - & Node - & OnlineStorePublishable - & Trackable - & { - /** Stripped description of the collection, single line with HTML tags removed. */ - description: Scalars["String"]["output"]; - /** The description of the collection, complete with HTML formatting. */ - descriptionHtml: Scalars["HTML"]["output"]; - /** - * A human-friendly unique string for the collection automatically generated from its title. - * Limit of 255 characters. - */ - handle: Scalars["String"]["output"]; - /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; - /** Image associated with the collection. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of products in the collection. */ - products: ProductConnection; - /** The collection's SEO information. */ - seo: Seo; - /** The collection’s name. Limit of 255 characters. */ - title: Scalars["String"]["output"]; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** The date and time when the collection was last modified. */ - updatedAt: Scalars["DateTime"]["output"]; - }; +export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** Stripped description of the collection, single line with HTML tags removed. */ + description: Scalars['String']['output']; + /** The description of the collection, complete with HTML formatting. */ + descriptionHtml: Scalars['HTML']['output']; + /** + * A human-friendly unique string for the collection automatically generated from its title. + * Limit of 255 characters. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Image associated with the collection. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of products in the collection. */ + products: ProductConnection; + /** The collection's SEO information. */ + seo: Seo; + /** The collection’s name. Limit of 255 characters. */ + title: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** The date and time when the collection was last modified. */ + updatedAt: Scalars['DateTime']['output']; +}; + /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. + * */ export type CollectionDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; + /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. + * */ export type CollectionMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. + * */ export type CollectionMetafieldsArgs = { identifiers: Array; }; + /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. + * */ export type CollectionProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * An auto-generated type for paginating through multiple Collections. + * */ export type CollectionConnection = { /** A list of edges. */ @@ -1892,15 +1961,16 @@ export type CollectionConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Collections. */ - totalCount: Scalars["UnsignedInt64"]["output"]; + totalCount: Scalars['UnsignedInt64']['output']; }; /** * An auto-generated type which holds one Collection and a cursor during pagination. + * */ export type CollectionEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of CollectionEdge. */ node: Collection; }; @@ -1908,44 +1978,47 @@ export type CollectionEdge = { /** The set of valid sort keys for the Collection query. */ export type CollectionSortKeys = /** Sort by the `id` value. */ - | "ID" + | 'ID' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE" + | 'TITLE' /** Sort by the `updated_at` value. */ - | "UPDATED_AT"; + | 'UPDATED_AT'; /** A comment on an article. */ export type Comment = Node & { /** The comment’s author. */ author: CommentAuthor; /** Stripped content of the comment, single line with HTML tags removed. */ - content: Scalars["String"]["output"]; + content: Scalars['String']['output']; /** The content of the comment, complete with HTML formatting. */ - contentHtml: Scalars["HTML"]["output"]; + contentHtml: Scalars['HTML']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; }; + /** A comment on an article. */ export type CommentContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; /** The author of a comment. */ export type CommentAuthor = { /** The author's email. */ - email: Scalars["String"]["output"]; + email: Scalars['String']['output']; /** The author’s name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; }; /** * An auto-generated type for paginating through multiple Comments. + * */ export type CommentConnection = { /** A list of edges. */ @@ -1958,10 +2031,11 @@ export type CommentConnection = { /** * An auto-generated type which holds one Comment and a cursor during pagination. + * */ export type CommentEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of CommentEdge. */ node: Comment; }; @@ -1969,7 +2043,7 @@ export type CommentEdge = { /** The action for the 3DS payment redirect. */ export type CompletePaymentChallenge = { /** The URL for the 3DS payment redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; /** An error that occurred during a cart completion attempt. */ @@ -1977,24 +2051,24 @@ export type CompletionError = { /** The error code. */ code: CompletionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during a cart completion attempt. */ export type CompletionErrorCode = - | "ERROR" - | "INVENTORY_RESERVATION_ERROR" - | "PAYMENT_AMOUNT_TOO_SMALL" - | "PAYMENT_CALL_ISSUER" - | "PAYMENT_CARD_DECLINED" - | "PAYMENT_ERROR" - | "PAYMENT_GATEWAY_NOT_ENABLED_ERROR" - | "PAYMENT_INSUFFICIENT_FUNDS" - | "PAYMENT_INVALID_BILLING_ADDRESS" - | "PAYMENT_INVALID_CREDIT_CARD" - | "PAYMENT_INVALID_CURRENCY" - | "PAYMENT_INVALID_PAYMENT_METHOD" - | "PAYMENT_TRANSIENT_ERROR"; + | 'ERROR' + | 'INVENTORY_RESERVATION_ERROR' + | 'PAYMENT_AMOUNT_TOO_SMALL' + | 'PAYMENT_CALL_ISSUER' + | 'PAYMENT_CARD_DECLINED' + | 'PAYMENT_ERROR' + | 'PAYMENT_GATEWAY_NOT_ENABLED_ERROR' + | 'PAYMENT_INSUFFICIENT_FUNDS' + | 'PAYMENT_INVALID_BILLING_ADDRESS' + | 'PAYMENT_INVALID_CREDIT_CARD' + | 'PAYMENT_INVALID_CURRENCY' + | 'PAYMENT_INVALID_PAYMENT_METHOD' + | 'PAYMENT_TRANSIENT_ERROR'; /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLine = BaseCartLine & Node & { @@ -2012,20 +2086,21 @@ export type ComponentizableCartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The components of the line item. */ lineComponents: Array; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; + /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLineAttributeArgs = { - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; }; /** A country. */ @@ -2039,7 +2114,7 @@ export type Country = { /** The market that includes this country. */ market?: Maybe; /** The name of the country. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The unit system used in the country. */ unitSystem: UnitSystem; }; @@ -2049,974 +2124,982 @@ export type Country = { * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision * of another country. For example, the territories associated with Spain are represented by the country code `ES`, * and the territories associated with the United States of America are represented by the country code `US`. + * */ export type CountryCode = /** Ascension Island. */ - | "AC" + | 'AC' /** Andorra. */ - | "AD" + | 'AD' /** United Arab Emirates. */ - | "AE" + | 'AE' /** Afghanistan. */ - | "AF" + | 'AF' /** Antigua & Barbuda. */ - | "AG" + | 'AG' /** Anguilla. */ - | "AI" + | 'AI' /** Albania. */ - | "AL" + | 'AL' /** Armenia. */ - | "AM" + | 'AM' /** Netherlands Antilles. */ - | "AN" + | 'AN' /** Angola. */ - | "AO" + | 'AO' /** Argentina. */ - | "AR" + | 'AR' /** Austria. */ - | "AT" + | 'AT' /** Australia. */ - | "AU" + | 'AU' /** Aruba. */ - | "AW" + | 'AW' /** Åland Islands. */ - | "AX" + | 'AX' /** Azerbaijan. */ - | "AZ" + | 'AZ' /** Bosnia & Herzegovina. */ - | "BA" + | 'BA' /** Barbados. */ - | "BB" + | 'BB' /** Bangladesh. */ - | "BD" + | 'BD' /** Belgium. */ - | "BE" + | 'BE' /** Burkina Faso. */ - | "BF" + | 'BF' /** Bulgaria. */ - | "BG" + | 'BG' /** Bahrain. */ - | "BH" + | 'BH' /** Burundi. */ - | "BI" + | 'BI' /** Benin. */ - | "BJ" + | 'BJ' /** St. Barthélemy. */ - | "BL" + | 'BL' /** Bermuda. */ - | "BM" + | 'BM' /** Brunei. */ - | "BN" + | 'BN' /** Bolivia. */ - | "BO" + | 'BO' /** Caribbean Netherlands. */ - | "BQ" + | 'BQ' /** Brazil. */ - | "BR" + | 'BR' /** Bahamas. */ - | "BS" + | 'BS' /** Bhutan. */ - | "BT" + | 'BT' /** Bouvet Island. */ - | "BV" + | 'BV' /** Botswana. */ - | "BW" + | 'BW' /** Belarus. */ - | "BY" + | 'BY' /** Belize. */ - | "BZ" + | 'BZ' /** Canada. */ - | "CA" + | 'CA' /** Cocos (Keeling) Islands. */ - | "CC" + | 'CC' /** Congo - Kinshasa. */ - | "CD" + | 'CD' /** Central African Republic. */ - | "CF" + | 'CF' /** Congo - Brazzaville. */ - | "CG" + | 'CG' /** Switzerland. */ - | "CH" + | 'CH' /** Côte d’Ivoire. */ - | "CI" + | 'CI' /** Cook Islands. */ - | "CK" + | 'CK' /** Chile. */ - | "CL" + | 'CL' /** Cameroon. */ - | "CM" + | 'CM' /** China. */ - | "CN" + | 'CN' /** Colombia. */ - | "CO" + | 'CO' /** Costa Rica. */ - | "CR" + | 'CR' /** Cuba. */ - | "CU" + | 'CU' /** Cape Verde. */ - | "CV" + | 'CV' /** Curaçao. */ - | "CW" + | 'CW' /** Christmas Island. */ - | "CX" + | 'CX' /** Cyprus. */ - | "CY" + | 'CY' /** Czechia. */ - | "CZ" + | 'CZ' /** Germany. */ - | "DE" + | 'DE' /** Djibouti. */ - | "DJ" + | 'DJ' /** Denmark. */ - | "DK" + | 'DK' /** Dominica. */ - | "DM" + | 'DM' /** Dominican Republic. */ - | "DO" + | 'DO' /** Algeria. */ - | "DZ" + | 'DZ' /** Ecuador. */ - | "EC" + | 'EC' /** Estonia. */ - | "EE" + | 'EE' /** Egypt. */ - | "EG" + | 'EG' /** Western Sahara. */ - | "EH" + | 'EH' /** Eritrea. */ - | "ER" + | 'ER' /** Spain. */ - | "ES" + | 'ES' /** Ethiopia. */ - | "ET" + | 'ET' /** Finland. */ - | "FI" + | 'FI' /** Fiji. */ - | "FJ" + | 'FJ' /** Falkland Islands. */ - | "FK" + | 'FK' /** Faroe Islands. */ - | "FO" + | 'FO' /** France. */ - | "FR" + | 'FR' /** Gabon. */ - | "GA" + | 'GA' /** United Kingdom. */ - | "GB" + | 'GB' /** Grenada. */ - | "GD" + | 'GD' /** Georgia. */ - | "GE" + | 'GE' /** French Guiana. */ - | "GF" + | 'GF' /** Guernsey. */ - | "GG" + | 'GG' /** Ghana. */ - | "GH" + | 'GH' /** Gibraltar. */ - | "GI" + | 'GI' /** Greenland. */ - | "GL" + | 'GL' /** Gambia. */ - | "GM" + | 'GM' /** Guinea. */ - | "GN" + | 'GN' /** Guadeloupe. */ - | "GP" + | 'GP' /** Equatorial Guinea. */ - | "GQ" + | 'GQ' /** Greece. */ - | "GR" + | 'GR' /** South Georgia & South Sandwich Islands. */ - | "GS" + | 'GS' /** Guatemala. */ - | "GT" + | 'GT' /** Guinea-Bissau. */ - | "GW" + | 'GW' /** Guyana. */ - | "GY" + | 'GY' /** Hong Kong SAR. */ - | "HK" + | 'HK' /** Heard & McDonald Islands. */ - | "HM" + | 'HM' /** Honduras. */ - | "HN" + | 'HN' /** Croatia. */ - | "HR" + | 'HR' /** Haiti. */ - | "HT" + | 'HT' /** Hungary. */ - | "HU" + | 'HU' /** Indonesia. */ - | "ID" + | 'ID' /** Ireland. */ - | "IE" + | 'IE' /** Israel. */ - | "IL" + | 'IL' /** Isle of Man. */ - | "IM" + | 'IM' /** India. */ - | "IN" + | 'IN' /** British Indian Ocean Territory. */ - | "IO" + | 'IO' /** Iraq. */ - | "IQ" + | 'IQ' /** Iran. */ - | "IR" + | 'IR' /** Iceland. */ - | "IS" + | 'IS' /** Italy. */ - | "IT" + | 'IT' /** Jersey. */ - | "JE" + | 'JE' /** Jamaica. */ - | "JM" + | 'JM' /** Jordan. */ - | "JO" + | 'JO' /** Japan. */ - | "JP" + | 'JP' /** Kenya. */ - | "KE" + | 'KE' /** Kyrgyzstan. */ - | "KG" + | 'KG' /** Cambodia. */ - | "KH" + | 'KH' /** Kiribati. */ - | "KI" + | 'KI' /** Comoros. */ - | "KM" + | 'KM' /** St. Kitts & Nevis. */ - | "KN" + | 'KN' /** North Korea. */ - | "KP" + | 'KP' /** South Korea. */ - | "KR" + | 'KR' /** Kuwait. */ - | "KW" + | 'KW' /** Cayman Islands. */ - | "KY" + | 'KY' /** Kazakhstan. */ - | "KZ" + | 'KZ' /** Laos. */ - | "LA" + | 'LA' /** Lebanon. */ - | "LB" + | 'LB' /** St. Lucia. */ - | "LC" + | 'LC' /** Liechtenstein. */ - | "LI" + | 'LI' /** Sri Lanka. */ - | "LK" + | 'LK' /** Liberia. */ - | "LR" + | 'LR' /** Lesotho. */ - | "LS" + | 'LS' /** Lithuania. */ - | "LT" + | 'LT' /** Luxembourg. */ - | "LU" + | 'LU' /** Latvia. */ - | "LV" + | 'LV' /** Libya. */ - | "LY" + | 'LY' /** Morocco. */ - | "MA" + | 'MA' /** Monaco. */ - | "MC" + | 'MC' /** Moldova. */ - | "MD" + | 'MD' /** Montenegro. */ - | "ME" + | 'ME' /** St. Martin. */ - | "MF" + | 'MF' /** Madagascar. */ - | "MG" + | 'MG' /** North Macedonia. */ - | "MK" + | 'MK' /** Mali. */ - | "ML" + | 'ML' /** Myanmar (Burma). */ - | "MM" + | 'MM' /** Mongolia. */ - | "MN" + | 'MN' /** Macao SAR. */ - | "MO" + | 'MO' /** Martinique. */ - | "MQ" + | 'MQ' /** Mauritania. */ - | "MR" + | 'MR' /** Montserrat. */ - | "MS" + | 'MS' /** Malta. */ - | "MT" + | 'MT' /** Mauritius. */ - | "MU" + | 'MU' /** Maldives. */ - | "MV" + | 'MV' /** Malawi. */ - | "MW" + | 'MW' /** Mexico. */ - | "MX" + | 'MX' /** Malaysia. */ - | "MY" + | 'MY' /** Mozambique. */ - | "MZ" + | 'MZ' /** Namibia. */ - | "NA" + | 'NA' /** New Caledonia. */ - | "NC" + | 'NC' /** Niger. */ - | "NE" + | 'NE' /** Norfolk Island. */ - | "NF" + | 'NF' /** Nigeria. */ - | "NG" + | 'NG' /** Nicaragua. */ - | "NI" + | 'NI' /** Netherlands. */ - | "NL" + | 'NL' /** Norway. */ - | "NO" + | 'NO' /** Nepal. */ - | "NP" + | 'NP' /** Nauru. */ - | "NR" + | 'NR' /** Niue. */ - | "NU" + | 'NU' /** New Zealand. */ - | "NZ" + | 'NZ' /** Oman. */ - | "OM" + | 'OM' /** Panama. */ - | "PA" + | 'PA' /** Peru. */ - | "PE" + | 'PE' /** French Polynesia. */ - | "PF" + | 'PF' /** Papua New Guinea. */ - | "PG" + | 'PG' /** Philippines. */ - | "PH" + | 'PH' /** Pakistan. */ - | "PK" + | 'PK' /** Poland. */ - | "PL" + | 'PL' /** St. Pierre & Miquelon. */ - | "PM" + | 'PM' /** Pitcairn Islands. */ - | "PN" + | 'PN' /** Palestinian Territories. */ - | "PS" + | 'PS' /** Portugal. */ - | "PT" + | 'PT' /** Paraguay. */ - | "PY" + | 'PY' /** Qatar. */ - | "QA" + | 'QA' /** Réunion. */ - | "RE" + | 'RE' /** Romania. */ - | "RO" + | 'RO' /** Serbia. */ - | "RS" + | 'RS' /** Russia. */ - | "RU" + | 'RU' /** Rwanda. */ - | "RW" + | 'RW' /** Saudi Arabia. */ - | "SA" + | 'SA' /** Solomon Islands. */ - | "SB" + | 'SB' /** Seychelles. */ - | "SC" + | 'SC' /** Sudan. */ - | "SD" + | 'SD' /** Sweden. */ - | "SE" + | 'SE' /** Singapore. */ - | "SG" + | 'SG' /** St. Helena. */ - | "SH" + | 'SH' /** Slovenia. */ - | "SI" + | 'SI' /** Svalbard & Jan Mayen. */ - | "SJ" + | 'SJ' /** Slovakia. */ - | "SK" + | 'SK' /** Sierra Leone. */ - | "SL" + | 'SL' /** San Marino. */ - | "SM" + | 'SM' /** Senegal. */ - | "SN" + | 'SN' /** Somalia. */ - | "SO" + | 'SO' /** Suriname. */ - | "SR" + | 'SR' /** South Sudan. */ - | "SS" + | 'SS' /** São Tomé & Príncipe. */ - | "ST" + | 'ST' /** El Salvador. */ - | "SV" + | 'SV' /** Sint Maarten. */ - | "SX" + | 'SX' /** Syria. */ - | "SY" + | 'SY' /** Eswatini. */ - | "SZ" + | 'SZ' /** Tristan da Cunha. */ - | "TA" + | 'TA' /** Turks & Caicos Islands. */ - | "TC" + | 'TC' /** Chad. */ - | "TD" + | 'TD' /** French Southern Territories. */ - | "TF" + | 'TF' /** Togo. */ - | "TG" + | 'TG' /** Thailand. */ - | "TH" + | 'TH' /** Tajikistan. */ - | "TJ" + | 'TJ' /** Tokelau. */ - | "TK" + | 'TK' /** Timor-Leste. */ - | "TL" + | 'TL' /** Turkmenistan. */ - | "TM" + | 'TM' /** Tunisia. */ - | "TN" + | 'TN' /** Tonga. */ - | "TO" + | 'TO' /** Turkey. */ - | "TR" + | 'TR' /** Trinidad & Tobago. */ - | "TT" + | 'TT' /** Tuvalu. */ - | "TV" + | 'TV' /** Taiwan. */ - | "TW" + | 'TW' /** Tanzania. */ - | "TZ" + | 'TZ' /** Ukraine. */ - | "UA" + | 'UA' /** Uganda. */ - | "UG" + | 'UG' /** U.S. Outlying Islands. */ - | "UM" + | 'UM' /** United States. */ - | "US" + | 'US' /** Uruguay. */ - | "UY" + | 'UY' /** Uzbekistan. */ - | "UZ" + | 'UZ' /** Vatican City. */ - | "VA" + | 'VA' /** St. Vincent & Grenadines. */ - | "VC" + | 'VC' /** Venezuela. */ - | "VE" + | 'VE' /** British Virgin Islands. */ - | "VG" + | 'VG' /** Vietnam. */ - | "VN" + | 'VN' /** Vanuatu. */ - | "VU" + | 'VU' /** Wallis & Futuna. */ - | "WF" + | 'WF' /** Samoa. */ - | "WS" + | 'WS' /** Kosovo. */ - | "XK" + | 'XK' /** Yemen. */ - | "YE" + | 'YE' /** Mayotte. */ - | "YT" + | 'YT' /** South Africa. */ - | "ZA" + | 'ZA' /** Zambia. */ - | "ZM" + | 'ZM' /** Zimbabwe. */ - | "ZW" + | 'ZW' /** Unknown Region. */ - | "ZZ"; + | 'ZZ'; /** Credit card information used for a payment. */ export type CreditCard = { /** The brand of the credit card. */ - brand?: Maybe; + brand?: Maybe; /** The expiry month of the credit card. */ - expiryMonth?: Maybe; + expiryMonth?: Maybe; /** The expiry year of the credit card. */ - expiryYear?: Maybe; + expiryYear?: Maybe; /** The credit card's BIN number. */ - firstDigits?: Maybe; + firstDigits?: Maybe; /** The first name of the card holder. */ - firstName?: Maybe; + firstName?: Maybe; /** The last 4 digits of the credit card. */ - lastDigits?: Maybe; + lastDigits?: Maybe; /** The last name of the card holder. */ - lastName?: Maybe; + lastName?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; /** * Specifies the fields required to complete a checkout with * a Shopify vaulted credit card payment. + * */ export type CreditCardPaymentInputV2 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars["String"]["input"]; + idempotencyKey: Scalars['String']['input']; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars["String"]["input"]; + vaultId: Scalars['String']['input']; }; /** The part of the image that should remain after cropping. */ export type CropRegion = /** Keep the bottom of the image. */ - | "BOTTOM" + | 'BOTTOM' /** Keep the center of the image. */ - | "CENTER" + | 'CENTER' /** Keep the left of the image. */ - | "LEFT" + | 'LEFT' /** Keep the right of the image. */ - | "RIGHT" + | 'RIGHT' /** Keep the top of the image. */ - | "TOP"; + | 'TOP'; /** A currency. */ export type Currency = { /** The ISO code of the currency. */ isoCode: CurrencyCode; /** The name of the currency. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The symbol of the currency. */ - symbol: Scalars["String"]["output"]; + symbol: Scalars['String']['output']; }; /** * The three-letter currency codes that represent the world currencies used in * stores. These include standard ISO 4217 codes, legacy codes, * and non-standard codes. + * */ export type CurrencyCode = /** United Arab Emirates Dirham (AED). */ - | "AED" + | 'AED' /** Afghan Afghani (AFN). */ - | "AFN" + | 'AFN' /** Albanian Lek (ALL). */ - | "ALL" + | 'ALL' /** Armenian Dram (AMD). */ - | "AMD" + | 'AMD' /** Netherlands Antillean Guilder. */ - | "ANG" + | 'ANG' /** Angolan Kwanza (AOA). */ - | "AOA" + | 'AOA' /** Argentine Pesos (ARS). */ - | "ARS" + | 'ARS' /** Australian Dollars (AUD). */ - | "AUD" + | 'AUD' /** Aruban Florin (AWG). */ - | "AWG" + | 'AWG' /** Azerbaijani Manat (AZN). */ - | "AZN" + | 'AZN' /** Bosnia and Herzegovina Convertible Mark (BAM). */ - | "BAM" + | 'BAM' /** Barbadian Dollar (BBD). */ - | "BBD" + | 'BBD' /** Bangladesh Taka (BDT). */ - | "BDT" + | 'BDT' /** Bulgarian Lev (BGN). */ - | "BGN" + | 'BGN' /** Bahraini Dinar (BHD). */ - | "BHD" + | 'BHD' /** Burundian Franc (BIF). */ - | "BIF" + | 'BIF' /** Bermudian Dollar (BMD). */ - | "BMD" + | 'BMD' /** Brunei Dollar (BND). */ - | "BND" + | 'BND' /** Bolivian Boliviano (BOB). */ - | "BOB" + | 'BOB' /** Brazilian Real (BRL). */ - | "BRL" + | 'BRL' /** Bahamian Dollar (BSD). */ - | "BSD" + | 'BSD' /** Bhutanese Ngultrum (BTN). */ - | "BTN" + | 'BTN' /** Botswana Pula (BWP). */ - | "BWP" + | 'BWP' /** Belarusian Ruble (BYN). */ - | "BYN" + | 'BYN' /** Belarusian Ruble (BYR). */ - | "BYR" + | 'BYR' /** Belize Dollar (BZD). */ - | "BZD" + | 'BZD' /** Canadian Dollars (CAD). */ - | "CAD" + | 'CAD' /** Congolese franc (CDF). */ - | "CDF" + | 'CDF' /** Swiss Francs (CHF). */ - | "CHF" + | 'CHF' /** Chilean Peso (CLP). */ - | "CLP" + | 'CLP' /** Chinese Yuan Renminbi (CNY). */ - | "CNY" + | 'CNY' /** Colombian Peso (COP). */ - | "COP" + | 'COP' /** Costa Rican Colones (CRC). */ - | "CRC" + | 'CRC' /** Cape Verdean escudo (CVE). */ - | "CVE" + | 'CVE' /** Czech Koruny (CZK). */ - | "CZK" + | 'CZK' /** Djiboutian Franc (DJF). */ - | "DJF" + | 'DJF' /** Danish Kroner (DKK). */ - | "DKK" + | 'DKK' /** Dominican Peso (DOP). */ - | "DOP" + | 'DOP' /** Algerian Dinar (DZD). */ - | "DZD" + | 'DZD' /** Egyptian Pound (EGP). */ - | "EGP" + | 'EGP' /** Eritrean Nakfa (ERN). */ - | "ERN" + | 'ERN' /** Ethiopian Birr (ETB). */ - | "ETB" + | 'ETB' /** Euro (EUR). */ - | "EUR" + | 'EUR' /** Fijian Dollars (FJD). */ - | "FJD" + | 'FJD' /** Falkland Islands Pounds (FKP). */ - | "FKP" + | 'FKP' /** United Kingdom Pounds (GBP). */ - | "GBP" + | 'GBP' /** Georgian Lari (GEL). */ - | "GEL" + | 'GEL' /** Ghanaian Cedi (GHS). */ - | "GHS" + | 'GHS' /** Gibraltar Pounds (GIP). */ - | "GIP" + | 'GIP' /** Gambian Dalasi (GMD). */ - | "GMD" + | 'GMD' /** Guinean Franc (GNF). */ - | "GNF" + | 'GNF' /** Guatemalan Quetzal (GTQ). */ - | "GTQ" + | 'GTQ' /** Guyanese Dollar (GYD). */ - | "GYD" + | 'GYD' /** Hong Kong Dollars (HKD). */ - | "HKD" + | 'HKD' /** Honduran Lempira (HNL). */ - | "HNL" + | 'HNL' /** Croatian Kuna (HRK). */ - | "HRK" + | 'HRK' /** Haitian Gourde (HTG). */ - | "HTG" + | 'HTG' /** Hungarian Forint (HUF). */ - | "HUF" + | 'HUF' /** Indonesian Rupiah (IDR). */ - | "IDR" + | 'IDR' /** Israeli New Shekel (NIS). */ - | "ILS" + | 'ILS' /** Indian Rupees (INR). */ - | "INR" + | 'INR' /** Iraqi Dinar (IQD). */ - | "IQD" + | 'IQD' /** Iranian Rial (IRR). */ - | "IRR" + | 'IRR' /** Icelandic Kronur (ISK). */ - | "ISK" + | 'ISK' /** Jersey Pound. */ - | "JEP" + | 'JEP' /** Jamaican Dollars (JMD). */ - | "JMD" + | 'JMD' /** Jordanian Dinar (JOD). */ - | "JOD" + | 'JOD' /** Japanese Yen (JPY). */ - | "JPY" + | 'JPY' /** Kenyan Shilling (KES). */ - | "KES" + | 'KES' /** Kyrgyzstani Som (KGS). */ - | "KGS" + | 'KGS' /** Cambodian Riel. */ - | "KHR" + | 'KHR' /** Kiribati Dollar (KID). */ - | "KID" + | 'KID' /** Comorian Franc (KMF). */ - | "KMF" + | 'KMF' /** South Korean Won (KRW). */ - | "KRW" + | 'KRW' /** Kuwaiti Dinar (KWD). */ - | "KWD" + | 'KWD' /** Cayman Dollars (KYD). */ - | "KYD" + | 'KYD' /** Kazakhstani Tenge (KZT). */ - | "KZT" + | 'KZT' /** Laotian Kip (LAK). */ - | "LAK" + | 'LAK' /** Lebanese Pounds (LBP). */ - | "LBP" + | 'LBP' /** Sri Lankan Rupees (LKR). */ - | "LKR" + | 'LKR' /** Liberian Dollar (LRD). */ - | "LRD" + | 'LRD' /** Lesotho Loti (LSL). */ - | "LSL" + | 'LSL' /** Lithuanian Litai (LTL). */ - | "LTL" + | 'LTL' /** Latvian Lati (LVL). */ - | "LVL" + | 'LVL' /** Libyan Dinar (LYD). */ - | "LYD" + | 'LYD' /** Moroccan Dirham. */ - | "MAD" + | 'MAD' /** Moldovan Leu (MDL). */ - | "MDL" + | 'MDL' /** Malagasy Ariary (MGA). */ - | "MGA" + | 'MGA' /** Macedonia Denar (MKD). */ - | "MKD" + | 'MKD' /** Burmese Kyat (MMK). */ - | "MMK" + | 'MMK' /** Mongolian Tugrik. */ - | "MNT" + | 'MNT' /** Macanese Pataca (MOP). */ - | "MOP" + | 'MOP' /** Mauritanian Ouguiya (MRU). */ - | "MRU" + | 'MRU' /** Mauritian Rupee (MUR). */ - | "MUR" + | 'MUR' /** Maldivian Rufiyaa (MVR). */ - | "MVR" + | 'MVR' /** Malawian Kwacha (MWK). */ - | "MWK" + | 'MWK' /** Mexican Pesos (MXN). */ - | "MXN" + | 'MXN' /** Malaysian Ringgits (MYR). */ - | "MYR" + | 'MYR' /** Mozambican Metical. */ - | "MZN" + | 'MZN' /** Namibian Dollar. */ - | "NAD" + | 'NAD' /** Nigerian Naira (NGN). */ - | "NGN" + | 'NGN' /** Nicaraguan Córdoba (NIO). */ - | "NIO" + | 'NIO' /** Norwegian Kroner (NOK). */ - | "NOK" + | 'NOK' /** Nepalese Rupee (NPR). */ - | "NPR" + | 'NPR' /** New Zealand Dollars (NZD). */ - | "NZD" + | 'NZD' /** Omani Rial (OMR). */ - | "OMR" + | 'OMR' /** Panamian Balboa (PAB). */ - | "PAB" + | 'PAB' /** Peruvian Nuevo Sol (PEN). */ - | "PEN" + | 'PEN' /** Papua New Guinean Kina (PGK). */ - | "PGK" + | 'PGK' /** Philippine Peso (PHP). */ - | "PHP" + | 'PHP' /** Pakistani Rupee (PKR). */ - | "PKR" + | 'PKR' /** Polish Zlotych (PLN). */ - | "PLN" + | 'PLN' /** Paraguayan Guarani (PYG). */ - | "PYG" + | 'PYG' /** Qatari Rial (QAR). */ - | "QAR" + | 'QAR' /** Romanian Lei (RON). */ - | "RON" + | 'RON' /** Serbian dinar (RSD). */ - | "RSD" + | 'RSD' /** Russian Rubles (RUB). */ - | "RUB" + | 'RUB' /** Rwandan Franc (RWF). */ - | "RWF" + | 'RWF' /** Saudi Riyal (SAR). */ - | "SAR" + | 'SAR' /** Solomon Islands Dollar (SBD). */ - | "SBD" + | 'SBD' /** Seychellois Rupee (SCR). */ - | "SCR" + | 'SCR' /** Sudanese Pound (SDG). */ - | "SDG" + | 'SDG' /** Swedish Kronor (SEK). */ - | "SEK" + | 'SEK' /** Singapore Dollars (SGD). */ - | "SGD" + | 'SGD' /** Saint Helena Pounds (SHP). */ - | "SHP" + | 'SHP' /** Sierra Leonean Leone (SLL). */ - | "SLL" + | 'SLL' /** Somali Shilling (SOS). */ - | "SOS" + | 'SOS' /** Surinamese Dollar (SRD). */ - | "SRD" + | 'SRD' /** South Sudanese Pound (SSP). */ - | "SSP" + | 'SSP' /** Sao Tome And Principe Dobra (STD). */ - | "STD" + | 'STD' /** Sao Tome And Principe Dobra (STN). */ - | "STN" + | 'STN' /** Syrian Pound (SYP). */ - | "SYP" + | 'SYP' /** Swazi Lilangeni (SZL). */ - | "SZL" + | 'SZL' /** Thai baht (THB). */ - | "THB" + | 'THB' /** Tajikistani Somoni (TJS). */ - | "TJS" + | 'TJS' /** Turkmenistani Manat (TMT). */ - | "TMT" + | 'TMT' /** Tunisian Dinar (TND). */ - | "TND" + | 'TND' /** Tongan Pa'anga (TOP). */ - | "TOP" + | 'TOP' /** Turkish Lira (TRY). */ - | "TRY" + | 'TRY' /** Trinidad and Tobago Dollars (TTD). */ - | "TTD" + | 'TTD' /** Taiwan Dollars (TWD). */ - | "TWD" + | 'TWD' /** Tanzanian Shilling (TZS). */ - | "TZS" + | 'TZS' /** Ukrainian Hryvnia (UAH). */ - | "UAH" + | 'UAH' /** Ugandan Shilling (UGX). */ - | "UGX" + | 'UGX' /** United States Dollars (USD). */ - | "USD" + | 'USD' /** Uruguayan Pesos (UYU). */ - | "UYU" + | 'UYU' /** Uzbekistan som (UZS). */ - | "UZS" + | 'UZS' /** Venezuelan Bolivares (VED). */ - | "VED" + | 'VED' /** Venezuelan Bolivares (VEF). */ - | "VEF" + | 'VEF' /** Venezuelan Bolivares (VES). */ - | "VES" + | 'VES' /** Vietnamese đồng (VND). */ - | "VND" + | 'VND' /** Vanuatu Vatu (VUV). */ - | "VUV" + | 'VUV' /** Samoan Tala (WST). */ - | "WST" + | 'WST' /** Central African CFA Franc (XAF). */ - | "XAF" + | 'XAF' /** East Caribbean Dollar (XCD). */ - | "XCD" + | 'XCD' /** West African CFA franc (XOF). */ - | "XOF" + | 'XOF' /** CFP Franc (XPF). */ - | "XPF" + | 'XPF' /** Unrecognized currency. */ - | "XXX" + | 'XXX' /** Yemeni Rial (YER). */ - | "YER" + | 'YER' /** South African Rand (ZAR). */ - | "ZAR" + | 'ZAR' /** Zambian Kwacha (ZMW). */ - | "ZMW"; + | 'ZMW'; /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type Customer = HasMetafields & { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing: Scalars["Boolean"]["output"]; + acceptsMarketing: Scalars['Boolean']['output']; /** A list of addresses for the customer. */ addresses: MailingAddressConnection; /** The date and time when the customer was created. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** The customer’s default address. */ defaultAddress?: Maybe; /** The customer’s name, email or phone number. */ - displayName: Scalars["String"]["output"]; + displayName: Scalars['String']['output']; /** The customer’s email address. */ - email?: Maybe; + email?: Maybe; /** The customer’s first name. */ - firstName?: Maybe; + firstName?: Maybe; /** A unique ID for the customer. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The customer's most recently updated, incomplete checkout. */ lastIncompleteCheckout?: Maybe; /** The customer’s last name. */ - lastName?: Maybe; + lastName?: Maybe; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The number of orders that the customer has made at the store in their lifetime. */ - numberOfOrders: Scalars["UnsignedInt64"]["output"]; + numberOfOrders: Scalars['UnsignedInt64']['output']; /** The orders associated with the customer. */ orders: OrderConnection; /** The customer’s phone number. */ - phone?: Maybe; + phone?: Maybe; /** * A comma separated list of tags that have been added to the customer. * Additional access scope required: unauthenticated_read_customer_tags. + * */ - tags: Array; + tags: Array; /** The date and time when the customer information was updated. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; }; + /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerAddressesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldsArgs = { identifiers: Array; }; + /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerOrdersArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ export type CustomerAccessToken = { /** The customer’s access token. */ - accessToken: Scalars["String"]["output"]; + accessToken: Scalars['String']['output']; /** The date and time when the customer access token expires. */ - expiresAt: Scalars["DateTime"]["output"]; + expiresAt: Scalars['DateTime']['output']; }; /** The input fields required to create a customer access token. */ export type CustomerAccessTokenCreateInput = { /** The email associated to the customer. */ - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; /** The login password to be used by the customer. */ - password: Scalars["String"]["input"]; + password: Scalars['String']['input']; }; /** Return type for `customerAccessTokenCreate` mutation. */ @@ -3043,9 +3126,9 @@ export type CustomerAccessTokenCreateWithMultipassPayload = { /** Return type for `customerAccessTokenDelete` mutation. */ export type CustomerAccessTokenDeletePayload = { /** The destroyed access token. */ - deletedAccessToken?: Maybe; + deletedAccessToken?: Maybe; /** ID of the destroyed customer access token. */ - deletedCustomerAccessTokenId?: Maybe; + deletedCustomerAccessTokenId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -3071,9 +3154,9 @@ export type CustomerActivateByUrlPayload = { /** The input fields to activate a customer. */ export type CustomerActivateInput = { /** The activation token required to activate the customer. */ - activationToken: Scalars["String"]["input"]; + activationToken: Scalars['String']['input']; /** New password that will be set during activation. */ - password: Scalars["String"]["input"]; + password: Scalars['String']['input']; }; /** Return type for `customerActivate` mutation. */ @@ -3109,7 +3192,7 @@ export type CustomerAddressDeletePayload = { /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** ID of the deleted customer address. */ - deletedCustomerAddressId?: Maybe; + deletedCustomerAddressId?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. @@ -3133,21 +3216,22 @@ export type CustomerAddressUpdatePayload = { /** The input fields to create a new customer. */ export type CustomerCreateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password: Scalars["String"]["input"]; + password: Scalars['String']['input']; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerCreate` mutation. */ @@ -3179,35 +3263,35 @@ export type CustomerDefaultAddressUpdatePayload = { /** Possible error codes that can be returned by `CustomerUserError`. */ export type CustomerErrorCode = /** Customer already enabled. */ - | "ALREADY_ENABLED" + | 'ALREADY_ENABLED' /** Input email contains an invalid domain name. */ - | "BAD_DOMAIN" + | 'BAD_DOMAIN' /** The input value is blank. */ - | "BLANK" + | 'BLANK' /** Input contains HTML tags. */ - | "CONTAINS_HTML_TAGS" + | 'CONTAINS_HTML_TAGS' /** Input contains URL. */ - | "CONTAINS_URL" + | 'CONTAINS_URL' /** Customer is disabled. */ - | "CUSTOMER_DISABLED" + | 'CUSTOMER_DISABLED' /** The input value is invalid. */ - | "INVALID" + | 'INVALID' /** Multipass token is not valid. */ - | "INVALID_MULTIPASS_REQUEST" + | 'INVALID_MULTIPASS_REQUEST' /** Address does not exist. */ - | "NOT_FOUND" + | 'NOT_FOUND' /** Input password starts or ends with whitespace. */ - | "PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE" + | 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE' /** The input value is already taken. */ - | "TAKEN" + | 'TAKEN' /** Invalid activation token. */ - | "TOKEN_INVALID" + | 'TOKEN_INVALID' /** The input value is too long. */ - | "TOO_LONG" + | 'TOO_LONG' /** The input value is too short. */ - | "TOO_SHORT" + | 'TOO_SHORT' /** Unidentified customer. */ - | "UNIDENTIFIED_CUSTOMER"; + | 'UNIDENTIFIED_CUSTOMER'; /** Return type for `customerRecover` mutation. */ export type CustomerRecoverPayload = { @@ -3238,9 +3322,9 @@ export type CustomerResetByUrlPayload = { /** The input fields to reset a customer's password. */ export type CustomerResetInput = { /** New password that will be set as part of the reset password process. */ - password: Scalars["String"]["input"]; + password: Scalars['String']['input']; /** The reset token required to reset the customer’s password. */ - resetToken: Scalars["String"]["input"]; + resetToken: Scalars['String']['input']; }; /** Return type for `customerReset` mutation. */ @@ -3261,21 +3345,22 @@ export type CustomerResetPayload = { /** The input fields to update the Customer information. */ export type CustomerUpdateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email?: InputMaybe; + email?: InputMaybe; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password?: InputMaybe; + password?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. + * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerUpdate` mutation. */ @@ -3285,6 +3370,7 @@ export type CustomerUpdatePayload = { /** * The newly created customer access token. If the customer's password is updated, all previous access tokens * (including the one used to perform this mutation) become invalid, and a new token is generated. + * */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ @@ -3301,9 +3387,9 @@ export type CustomerUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** A delivery address of the buyer that is interacting with the cart. */ @@ -3311,12 +3397,14 @@ export type DeliveryAddress = MailingAddress; /** * The input fields for delivery address preferences. + * */ export type DeliveryAddressInput = { /** * The ID of a customer address that is associated with the buyer that is interacting with the cart. + * */ - customerAddressId?: InputMaybe; + customerAddressId?: InputMaybe; /** A delivery address preference of a buyer that is interacting with the cart. */ deliveryAddress?: InputMaybe; }; @@ -3324,31 +3412,32 @@ export type DeliveryAddressInput = { /** List of different delivery method types. */ export type DeliveryMethodType = /** Local Delivery. */ - | "LOCAL" + | 'LOCAL' /** None. */ - | "NONE" + | 'NONE' /** Shipping to a Pickup Point. */ - | "PICKUP_POINT" + | 'PICKUP_POINT' /** Local Pickup. */ - | "PICK_UP" + | 'PICK_UP' /** Retail. */ - | "RETAIL" + | 'RETAIL' /** Shipping. */ - | "SHIPPING"; + | 'SHIPPING'; /** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ export type DigitalWallet = /** Android Pay. */ - | "ANDROID_PAY" + | 'ANDROID_PAY' /** Apple Pay. */ - | "APPLE_PAY" + | 'APPLE_PAY' /** Google Pay. */ - | "GOOGLE_PAY" + | 'GOOGLE_PAY' /** Shopify Pay. */ - | "SHOPIFY_PAY"; + | 'SHOPIFY_PAY'; /** * An amount discounting the line that has been allocated by a discount. + * */ export type DiscountAllocation = { /** Amount of discount allocated. */ @@ -3360,6 +3449,7 @@ export type DiscountAllocation = { /** * Discount applications capture the intentions of a discount source at * the time of application. + * */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ @@ -3375,14 +3465,15 @@ export type DiscountApplication = { /** The method by which the discount's value is allocated onto its entitled lines. */ export type DiscountApplicationAllocationMethod = /** The value is spread across all entitled lines. */ - | "ACROSS" + | 'ACROSS' /** The value is applied onto every entitled line. */ - | "EACH" + | 'EACH' /** The value is specifically applied onto a particular line. */ - | "ONE"; + | 'ONE'; /** * An auto-generated type for paginating through multiple DiscountApplications. + * */ export type DiscountApplicationConnection = { /** A list of edges. */ @@ -3395,10 +3486,11 @@ export type DiscountApplicationConnection = { /** * An auto-generated type which holds one DiscountApplication and a cursor during pagination. + * */ export type DiscountApplicationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of DiscountApplicationEdge. */ node: DiscountApplication; }; @@ -3408,35 +3500,38 @@ export type DiscountApplicationEdge = { * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. + * */ export type DiscountApplicationTargetSelection = /** The discount is allocated onto all the lines. */ - | "ALL" + | 'ALL' /** The discount is allocated onto only the lines that it's entitled for. */ - | "ENTITLED" + | 'ENTITLED' /** The discount is allocated onto explicitly chosen lines. */ - | "EXPLICIT"; + | 'EXPLICIT'; /** * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. + * */ export type DiscountApplicationTargetType = /** The discount applies onto line items. */ - | "LINE_ITEM" + | 'LINE_ITEM' /** The discount applies onto shipping lines. */ - | "SHIPPING_LINE"; + | 'SHIPPING_LINE'; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied. + * */ export type DiscountCodeApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Specifies whether the discount code was applied successfully. */ - applicable: Scalars["Boolean"]["output"]; + applicable: Scalars['Boolean']['output']; /** The string identifying the discount code that was used at the time of application. */ - code: Scalars["String"]["output"]; + code: Scalars['String']['output']; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ @@ -3448,40 +3543,40 @@ export type DiscountCodeApplication = DiscountApplication & { /** Represents an error in the input of a mutation. */ export type DisplayableError = { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** Represents a web address. */ export type Domain = { /** The host name of the domain (eg: `example.com`). */ - host: Scalars["String"]["output"]; + host: Scalars['String']['output']; /** Whether SSL is enabled or not. */ - sslEnabled: Scalars["Boolean"]["output"]; + sslEnabled: Scalars['Boolean']['output']; /** The URL of the domain (eg: `https://example.com`). */ - url: Scalars["URL"]["output"]; + url: Scalars['URL']['output']; }; /** Represents a video hosted outside of Shopify. */ export type ExternalVideo = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** The embed URL of the video for the respective host. */ - embedUrl: Scalars["URL"]["output"]; + embedUrl: Scalars['URL']['output']; /** * The URL. * @deprecated Use `originUrl` instead. */ - embeddedUrl: Scalars["URL"]["output"]; + embeddedUrl: Scalars['URL']['output']; /** The host of the external video. */ host: MediaHost; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The origin URL of the video on the respective host. */ - originUrl: Scalars["URL"]["output"]; + originUrl: Scalars['URL']['output']; /** The presentation for a media. */ presentation?: Maybe; /** The preview image for the media. */ @@ -3491,9 +3586,9 @@ export type ExternalVideo = Media & Node & { /** A filter that is supported on the parent field. */ export type Filter = { /** A unique identifier. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; /** A human-friendly string for this filter. */ - label: Scalars["String"]["output"]; + label: Scalars['String']['output']; /** An enumeration that denotes the type of data this filter represents. */ type: FilterType; /** The list of values for this filter. */ @@ -3505,31 +3600,33 @@ export type Filter = { * * For more information, refer to [Filter products in a collection with the Storefront API] * (https://shopify.dev/custom-storefronts/products-collections/filter-products). + * */ export type FilterType = /** A boolean value. */ - | "BOOLEAN" + | 'BOOLEAN' /** A list of selectable values. */ - | "LIST" + | 'LIST' /** A range of prices. */ - | "PRICE_RANGE"; + | 'PRICE_RANGE'; /** A selectable value within a filter. */ export type FilterValue = { /** The number of results that match this filter value. */ - count: Scalars["Int"]["output"]; + count: Scalars['Int']['output']; /** A unique identifier. */ - id: Scalars["String"]["output"]; + id: Scalars['String']['output']; /** * An input object that can be used to filter by this value on the parent field. * * The value is provided as a helper for building dynamic filtering UI. For * example, if you have a list of selected `FilterValue` objects, you can combine * their respective `input` values to use in a subsequent query. + * */ - input: Scalars["JSON"]["output"]; + input: Scalars['JSON']['output']; /** A human-friendly string for this filter value. */ - label: Scalars["String"]["output"]; + label: Scalars['String']['output']; }; /** Represents a single fulfillment in an order. */ @@ -3537,26 +3634,29 @@ export type Fulfillment = { /** List of the fulfillment's line items. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** The name of the tracking company. */ - trackingCompany?: Maybe; + trackingCompany?: Maybe; /** * Tracking information associated with the fulfillment, * such as the tracking number and tracking URL. + * */ trackingInfo: Array; }; + /** Represents a single fulfillment in an order. */ export type FulfillmentFulfillmentLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** Represents a single fulfillment in an order. */ export type FulfillmentTrackingInfoArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ @@ -3564,11 +3664,12 @@ export type FulfillmentLineItem = { /** The associated order's line item. */ lineItem: OrderLineItem; /** The amount fulfilled in this fulfillment. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; }; /** * An auto-generated type for paginating through multiple FulfillmentLineItems. + * */ export type FulfillmentLineItemConnection = { /** A list of edges. */ @@ -3581,10 +3682,11 @@ export type FulfillmentLineItemConnection = { /** * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. + * */ export type FulfillmentLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; @@ -3592,33 +3694,33 @@ export type FulfillmentLineItemEdge = { /** Tracking information associated with the fulfillment. */ export type FulfillmentTrackingInfo = { /** The tracking number of the fulfillment. */ - number?: Maybe; + number?: Maybe; /** The URL to track the fulfillment. */ - url?: Maybe; + url?: Maybe; }; /** The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. */ export type GenericFile = Node & { /** A word or phrase to indicate the contents of a file. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The MIME type of the file. */ - mimeType?: Maybe; + mimeType?: Maybe; /** The size of the original file in bytes. */ - originalFileSize?: Maybe; + originalFileSize?: Maybe; /** The preview image for the file. */ previewImage?: Maybe; /** The URL of the file. */ - url?: Maybe; + url?: Maybe; }; /** The input fields used to specify a geographical location. */ export type GeoCoordinateInput = { /** The coordinate's latitude value. */ - latitude: Scalars["Float"]["input"]; + latitude: Scalars['Float']['input']; /** The coordinate's longitude value. */ - longitude: Scalars["Float"]["input"]; + longitude: Scalars['Float']['input']; }; /** Represents information about the metafields associated to the specified resource. */ @@ -3629,12 +3731,14 @@ export type HasMetafields = { metafields: Array>; }; + /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldsArgs = { identifiers: Array; @@ -3643,19 +3747,19 @@ export type HasMetafieldsMetafieldsArgs = { /** The input fields to identify a metafield on an owner resource by namespace and key. */ export type HasMetafieldsIdentifier = { /** The identifier for the metafield. */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** The container the metafield belongs to. */ - namespace: Scalars["String"]["input"]; + namespace: Scalars['String']['input']; }; /** Represents an image resource. */ export type Image = { /** A word or phrase to share the nature or contents of an image. */ - altText?: Maybe; + altText?: Maybe; /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - height?: Maybe; + height?: Maybe; /** A unique ID for the image. */ - id?: Maybe; + id?: Maybe; /** * The location of the original image as a URL. * @@ -3663,12 +3767,12 @@ export type Image = { * * @deprecated Use `url` instead. */ - originalSrc: Scalars["URL"]["output"]; + originalSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * @deprecated Use `url` instead. */ - src: Scalars["URL"]["output"]; + src: Scalars['URL']['output']; /** * The location of the transformed image as a URL. * @@ -3677,7 +3781,7 @@ export type Image = { * * @deprecated Use `url(transform:)` instead */ - transformedSrc: Scalars["URL"]["output"]; + transformedSrc: Scalars['URL']['output']; /** * The location of the image as a URL. * @@ -3686,21 +3790,24 @@ export type Image = { * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. * * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). + * */ - url: Scalars["URL"]["output"]; + url: Scalars['URL']['output']; /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - width?: Maybe; + width?: Maybe; }; + /** Represents an image resource. */ export type ImageTransformedSrcArgs = { crop?: InputMaybe; - maxHeight?: InputMaybe; - maxWidth?: InputMaybe; + maxHeight?: InputMaybe; + maxWidth?: InputMaybe; preferredContentType?: InputMaybe; - scale?: InputMaybe; + scale?: InputMaybe; }; + /** Represents an image resource. */ export type ImageUrlArgs = { transform?: InputMaybe; @@ -3708,6 +3815,7 @@ export type ImageUrlArgs = { /** * An auto-generated type for paginating through multiple Images. + * */ export type ImageConnection = { /** A list of edges. */ @@ -3721,18 +3829,19 @@ export type ImageConnection = { /** List of supported image content types. */ export type ImageContentType = /** A JPG image. */ - | "JPG" + | 'JPG' /** A PNG image. */ - | "PNG" + | 'PNG' /** A WEBP image. */ - | "WEBP"; + | 'WEBP'; /** * An auto-generated type which holds one Image and a cursor during pagination. + * */ export type ImageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of ImageEdge. */ node: Image; }; @@ -3742,6 +3851,7 @@ export type ImageEdge = { * * All transformation options are considered best effort. Any transformation that * the original image type doesn't support will be ignored. + * */ export type ImageTransformInput = { /** @@ -3752,327 +3862,332 @@ export type ImageTransformInput = { * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ * maxWidth: 5, maxHeight: 10, crop: LEFT }` will result * in an image with a width of 5 and height of 10, where the right side of the image is removed. + * */ crop?: InputMaybe; /** * Image height in pixels between 1 and 5760. + * */ - maxHeight?: InputMaybe; + maxHeight?: InputMaybe; /** * Image width in pixels between 1 and 5760. + * */ - maxWidth?: InputMaybe; + maxWidth?: InputMaybe; /** * Convert the source image into the preferred content type. * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. + * */ preferredContentType?: InputMaybe; /** * Image size multiplier for high-resolution retina displays. Must be within 1..3. + * */ - scale?: InputMaybe; + scale?: InputMaybe; }; /** A language. */ export type Language = { /** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */ - endonymName: Scalars["String"]["output"]; + endonymName: Scalars['String']['output']; /** The ISO code. */ isoCode: LanguageCode; /** The name of the language in the current language. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; }; /** ISO 639-1 language codes supported by Shopify. */ export type LanguageCode = /** Afrikaans. */ - | "AF" + | 'AF' /** Akan. */ - | "AK" + | 'AK' /** Amharic. */ - | "AM" + | 'AM' /** Arabic. */ - | "AR" + | 'AR' /** Assamese. */ - | "AS" + | 'AS' /** Azerbaijani. */ - | "AZ" + | 'AZ' /** Belarusian. */ - | "BE" + | 'BE' /** Bulgarian. */ - | "BG" + | 'BG' /** Bambara. */ - | "BM" + | 'BM' /** Bangla. */ - | "BN" + | 'BN' /** Tibetan. */ - | "BO" + | 'BO' /** Breton. */ - | "BR" + | 'BR' /** Bosnian. */ - | "BS" + | 'BS' /** Catalan. */ - | "CA" + | 'CA' /** Chechen. */ - | "CE" + | 'CE' /** Central Kurdish. */ - | "CKB" + | 'CKB' /** Czech. */ - | "CS" + | 'CS' /** Church Slavic. */ - | "CU" + | 'CU' /** Welsh. */ - | "CY" + | 'CY' /** Danish. */ - | "DA" + | 'DA' /** German. */ - | "DE" + | 'DE' /** Dzongkha. */ - | "DZ" + | 'DZ' /** Ewe. */ - | "EE" + | 'EE' /** Greek. */ - | "EL" + | 'EL' /** English. */ - | "EN" + | 'EN' /** Esperanto. */ - | "EO" + | 'EO' /** Spanish. */ - | "ES" + | 'ES' /** Estonian. */ - | "ET" + | 'ET' /** Basque. */ - | "EU" + | 'EU' /** Persian. */ - | "FA" + | 'FA' /** Fulah. */ - | "FF" + | 'FF' /** Finnish. */ - | "FI" + | 'FI' /** Filipino. */ - | "FIL" + | 'FIL' /** Faroese. */ - | "FO" + | 'FO' /** French. */ - | "FR" + | 'FR' /** Western Frisian. */ - | "FY" + | 'FY' /** Irish. */ - | "GA" + | 'GA' /** Scottish Gaelic. */ - | "GD" + | 'GD' /** Galician. */ - | "GL" + | 'GL' /** Gujarati. */ - | "GU" + | 'GU' /** Manx. */ - | "GV" + | 'GV' /** Hausa. */ - | "HA" + | 'HA' /** Hebrew. */ - | "HE" + | 'HE' /** Hindi. */ - | "HI" + | 'HI' /** Croatian. */ - | "HR" + | 'HR' /** Hungarian. */ - | "HU" + | 'HU' /** Armenian. */ - | "HY" + | 'HY' /** Interlingua. */ - | "IA" + | 'IA' /** Indonesian. */ - | "ID" + | 'ID' /** Igbo. */ - | "IG" + | 'IG' /** Sichuan Yi. */ - | "II" + | 'II' /** Icelandic. */ - | "IS" + | 'IS' /** Italian. */ - | "IT" + | 'IT' /** Japanese. */ - | "JA" + | 'JA' /** Javanese. */ - | "JV" + | 'JV' /** Georgian. */ - | "KA" + | 'KA' /** Kikuyu. */ - | "KI" + | 'KI' /** Kazakh. */ - | "KK" + | 'KK' /** Kalaallisut. */ - | "KL" + | 'KL' /** Khmer. */ - | "KM" + | 'KM' /** Kannada. */ - | "KN" + | 'KN' /** Korean. */ - | "KO" + | 'KO' /** Kashmiri. */ - | "KS" + | 'KS' /** Kurdish. */ - | "KU" + | 'KU' /** Cornish. */ - | "KW" + | 'KW' /** Kyrgyz. */ - | "KY" + | 'KY' /** Latin. */ - | "LA" + | 'LA' /** Luxembourgish. */ - | "LB" + | 'LB' /** Ganda. */ - | "LG" + | 'LG' /** Lingala. */ - | "LN" + | 'LN' /** Lao. */ - | "LO" + | 'LO' /** Lithuanian. */ - | "LT" + | 'LT' /** Luba-Katanga. */ - | "LU" + | 'LU' /** Latvian. */ - | "LV" + | 'LV' /** Malagasy. */ - | "MG" + | 'MG' /** Māori. */ - | "MI" + | 'MI' /** Macedonian. */ - | "MK" + | 'MK' /** Malayalam. */ - | "ML" + | 'ML' /** Mongolian. */ - | "MN" + | 'MN' /** Moldavian. */ - | "MO" + | 'MO' /** Marathi. */ - | "MR" + | 'MR' /** Malay. */ - | "MS" + | 'MS' /** Maltese. */ - | "MT" + | 'MT' /** Burmese. */ - | "MY" + | 'MY' /** Norwegian (Bokmål). */ - | "NB" + | 'NB' /** North Ndebele. */ - | "ND" + | 'ND' /** Nepali. */ - | "NE" + | 'NE' /** Dutch. */ - | "NL" + | 'NL' /** Norwegian Nynorsk. */ - | "NN" + | 'NN' /** Norwegian. */ - | "NO" + | 'NO' /** Oromo. */ - | "OM" + | 'OM' /** Odia. */ - | "OR" + | 'OR' /** Ossetic. */ - | "OS" + | 'OS' /** Punjabi. */ - | "PA" + | 'PA' /** Polish. */ - | "PL" + | 'PL' /** Pashto. */ - | "PS" + | 'PS' /** Portuguese. */ - | "PT" + | 'PT' /** Portuguese (Brazil). */ - | "PT_BR" + | 'PT_BR' /** Portuguese (Portugal). */ - | "PT_PT" + | 'PT_PT' /** Quechua. */ - | "QU" + | 'QU' /** Romansh. */ - | "RM" + | 'RM' /** Rundi. */ - | "RN" + | 'RN' /** Romanian. */ - | "RO" + | 'RO' /** Russian. */ - | "RU" + | 'RU' /** Kinyarwanda. */ - | "RW" + | 'RW' /** Sanskrit. */ - | "SA" + | 'SA' /** Sardinian. */ - | "SC" + | 'SC' /** Sindhi. */ - | "SD" + | 'SD' /** Northern Sami. */ - | "SE" + | 'SE' /** Sango. */ - | "SG" + | 'SG' /** Serbo-Croatian. */ - | "SH" + | 'SH' /** Sinhala. */ - | "SI" + | 'SI' /** Slovak. */ - | "SK" + | 'SK' /** Slovenian. */ - | "SL" + | 'SL' /** Shona. */ - | "SN" + | 'SN' /** Somali. */ - | "SO" + | 'SO' /** Albanian. */ - | "SQ" + | 'SQ' /** Serbian. */ - | "SR" + | 'SR' /** Sundanese. */ - | "SU" + | 'SU' /** Swedish. */ - | "SV" + | 'SV' /** Swahili. */ - | "SW" + | 'SW' /** Tamil. */ - | "TA" + | 'TA' /** Telugu. */ - | "TE" + | 'TE' /** Tajik. */ - | "TG" + | 'TG' /** Thai. */ - | "TH" + | 'TH' /** Tigrinya. */ - | "TI" + | 'TI' /** Turkmen. */ - | "TK" + | 'TK' /** Tongan. */ - | "TO" + | 'TO' /** Turkish. */ - | "TR" + | 'TR' /** Tatar. */ - | "TT" + | 'TT' /** Uyghur. */ - | "UG" + | 'UG' /** Ukrainian. */ - | "UK" + | 'UK' /** Urdu. */ - | "UR" + | 'UR' /** Uzbek. */ - | "UZ" + | 'UZ' /** Vietnamese. */ - | "VI" + | 'VI' /** Volapük. */ - | "VO" + | 'VO' /** Wolof. */ - | "WO" + | 'WO' /** Xhosa. */ - | "XH" + | 'XH' /** Yiddish. */ - | "YI" + | 'YI' /** Yoruba. */ - | "YO" + | 'YO' /** Chinese. */ - | "ZH" + | 'ZH' /** Chinese (Simplified). */ - | "ZH_CN" + | 'ZH_CN' /** Chinese (Traditional). */ - | "ZH_TW" + | 'ZH_TW' /** Zulu. */ - | "ZU"; + | 'ZU'; /** Information about the localized experiences configured for the shop. */ export type Localization = { @@ -4093,21 +4208,23 @@ export type Location = HasMetafields & Node & { /** The address of the location. */ address: LocationAddress; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The name of the location. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; }; + /** Represents a location where product inventory is held. */ export type LocationMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** Represents a location where product inventory is held. */ export type LocationMetafieldsArgs = { identifiers: Array; @@ -4115,38 +4232,41 @@ export type LocationMetafieldsArgs = { /** * Represents the address of a location. + * */ export type LocationAddress = { /** The first line of the address for the location. */ - address1?: Maybe; + address1?: Maybe; /** The second line of the address for the location. */ - address2?: Maybe; + address2?: Maybe; /** The city of the location. */ - city?: Maybe; + city?: Maybe; /** The country of the location. */ - country?: Maybe; + country?: Maybe; /** The country code of the location. */ - countryCode?: Maybe; + countryCode?: Maybe; /** A formatted version of the address for the location. */ - formatted: Array; + formatted: Array; /** The latitude coordinates of the location. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinates of the location. */ - longitude?: Maybe; + longitude?: Maybe; /** The phone number of the location. */ - phone?: Maybe; + phone?: Maybe; /** The province of the location. */ - province?: Maybe; + province?: Maybe; /** * The code for the province, state, or district of the address of the location. + * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The ZIP code of the location. */ - zip?: Maybe; + zip?: Maybe; }; /** * An auto-generated type for paginating through multiple Locations. + * */ export type LocationConnection = { /** A list of edges. */ @@ -4159,10 +4279,11 @@ export type LocationConnection = { /** * An auto-generated type which holds one Location and a cursor during pagination. + * */ export type LocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of LocationEdge. */ node: Location; }; @@ -4170,28 +4291,29 @@ export type LocationEdge = { /** The set of valid sort keys for the Location query. */ export type LocationSortKeys = /** Sort by the `city` value. */ - | "CITY" + | 'CITY' /** Sort by the `distance` value. */ - | "DISTANCE" + | 'DISTANCE' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `name` value. */ - | "NAME"; + | 'NAME'; /** Represents a mailing address for customers and shipping. */ export type MailingAddress = Node & { /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe; + address1?: Maybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. + * */ - address2?: Maybe; + address2?: Maybe; /** The name of the city, district, village, or town. */ - city?: Maybe; + city?: Maybe; /** The name of the customer's company or organization. */ - company?: Maybe; + company?: Maybe; /** The name of the country. */ - country?: Maybe; + country?: Maybe; /** * The two-letter code for the country of the address. * @@ -4199,55 +4321,60 @@ export type MailingAddress = Node & { * * @deprecated Use `countryCodeV2` instead. */ - countryCode?: Maybe; + countryCode?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. + * */ countryCodeV2?: Maybe; /** The first name of the customer. */ - firstName?: Maybe; + firstName?: Maybe; /** A formatted version of the address, customized by the provided arguments. */ - formatted: Array; + formatted: Array; /** A comma-separated list of the values for city, province, and country. */ - formattedArea?: Maybe; + formattedArea?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The last name of the customer. */ - lastName?: Maybe; + lastName?: Maybe; /** The latitude coordinate of the customer address. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinate of the customer address. */ - longitude?: Maybe; + longitude?: Maybe; /** The full name of the customer, based on firstName and lastName. */ - name?: Maybe; + name?: Maybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ - phone?: Maybe; + phone?: Maybe; /** The region of the address, such as the province, state, or district. */ - province?: Maybe; + province?: Maybe; /** * The two-letter code for the region. * * For example, ON. + * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The zip or postal code of the address. */ - zip?: Maybe; + zip?: Maybe; }; + /** Represents a mailing address for customers and shipping. */ export type MailingAddressFormattedArgs = { - withCompany?: InputMaybe; - withName?: InputMaybe; + withCompany?: InputMaybe; + withName?: InputMaybe; }; /** * An auto-generated type for paginating through multiple MailingAddresses. + * */ export type MailingAddressConnection = { /** A list of edges. */ @@ -4260,10 +4387,11 @@ export type MailingAddressConnection = { /** * An auto-generated type which holds one MailingAddress and a cursor during pagination. + * */ export type MailingAddressEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of MailingAddressEdge. */ node: MailingAddress; }; @@ -4272,52 +4400,58 @@ export type MailingAddressEdge = { export type MailingAddressInput = { /** * The first line of the address. Typically the street address or PO Box number. + * */ - address1?: InputMaybe; + address1?: InputMaybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. + * */ - address2?: InputMaybe; + address2?: InputMaybe; /** * The name of the city, district, village, or town. + * */ - city?: InputMaybe; + city?: InputMaybe; /** * The name of the customer's company or organization. + * */ - company?: InputMaybe; + company?: InputMaybe; /** The name of the country. */ - country?: InputMaybe; + country?: InputMaybe; /** The first name of the customer. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The last name of the customer. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. + * */ - phone?: InputMaybe; + phone?: InputMaybe; /** The region of the address, such as the province, state, or district. */ - province?: InputMaybe; + province?: InputMaybe; /** The zip or postal code of the address. */ - zip?: InputMaybe; + zip?: InputMaybe; }; /** * Manual discount applications capture the intentions of a discount that was manually created. + * */ export type ManualDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The description of the application. */ - description?: Maybe; + description?: Maybe; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; @@ -4326,22 +4460,25 @@ export type ManualDiscountApplication = DiscountApplication & { export type Market = HasMetafields & Node & { /** * A human-readable unique string for the market automatically generated from its title. + * */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; }; + /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldsArgs = { identifiers: Array; @@ -4350,9 +4487,9 @@ export type MarketMetafieldsArgs = { /** Represents a media interface. */ export type Media = { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4363,6 +4500,7 @@ export type Media = { /** * An auto-generated type for paginating through multiple Media. + * */ export type MediaConnection = { /** A list of edges. */ @@ -4376,20 +4514,21 @@ export type MediaConnection = { /** The possible content types for a media object. */ export type MediaContentType = /** An externally hosted video. */ - | "EXTERNAL_VIDEO" + | 'EXTERNAL_VIDEO' /** A Shopify hosted image. */ - | "IMAGE" + | 'IMAGE' /** A 3d model. */ - | "MODEL_3D" + | 'MODEL_3D' /** A Shopify hosted video. */ - | "VIDEO"; + | 'VIDEO'; /** * An auto-generated type which holds one Media and a cursor during pagination. + * */ export type MediaEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of MediaEdge. */ node: Media; }; @@ -4397,16 +4536,16 @@ export type MediaEdge = { /** Host for a Media Resource. */ export type MediaHost = /** Host for Vimeo embedded videos. */ - | "VIMEO" + | 'VIMEO' /** Host for YouTube embedded videos. */ - | "YOUTUBE"; + | 'YOUTUBE'; /** Represents a Shopify hosted image. */ export type MediaImage = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The image for the media. */ image?: Maybe; /** The media content type. */ @@ -4420,11 +4559,12 @@ export type MediaImage = Media & Node & { /** A media presentation. */ export type MediaPresentation = Node & { /** A JSON object representing a presentation view. */ - asJson?: Maybe; + asJson?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; }; + /** A media presentation. */ export type MediaPresentationAsJsonArgs = { format: MediaPresentationFormat; @@ -4433,82 +4573,78 @@ export type MediaPresentationAsJsonArgs = { /** The possible formats for a media presentation. */ export type MediaPresentationFormat = /** A media image presentation. */ - | "IMAGE" + | 'IMAGE' /** A model viewer presentation. */ - | "MODEL_VIEWER"; + | 'MODEL_VIEWER'; /** * A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy * of hyperlinks (items). + * */ export type Menu = Node & { /** The menu's handle. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The menu's child items. */ items: Array; /** The count of items on the menu. */ - itemsCount: Scalars["Int"]["output"]; + itemsCount: Scalars['Int']['output']; /** The menu's title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; }; /** A menu item within a parent menu. */ export type MenuItem = Node & { /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The menu item's child items. */ items: Array; /** The linked resource. */ resource?: Maybe; /** The ID of the linked resource. */ - resourceId?: Maybe; + resourceId?: Maybe; /** The menu item's tags to filter a collection. */ - tags: Array; + tags: Array; /** The menu item's title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The menu item's type. */ type: MenuItemType; /** The menu item's URL. */ - url?: Maybe; + url?: Maybe; }; /** * The list of possible resources a `MenuItem` can reference. + * */ -export type MenuItemResource = - | Article - | Blog - | Collection - | Page - | Product - | ShopPolicy; +export type MenuItemResource = Article | Blog | Collection | Page | Product | ShopPolicy; /** A menu item type. */ export type MenuItemType = /** An article link. */ - | "ARTICLE" + | 'ARTICLE' /** A blog link. */ - | "BLOG" + | 'BLOG' /** A catalog link. */ - | "CATALOG" + | 'CATALOG' /** A collection link. */ - | "COLLECTION" + | 'COLLECTION' /** A collection link. */ - | "COLLECTIONS" + | 'COLLECTIONS' /** A frontpage link. */ - | "FRONTPAGE" + | 'FRONTPAGE' /** An http link. */ - | "HTTP" + | 'HTTP' /** A page link. */ - | "PAGE" + | 'PAGE' /** A product link. */ - | "PRODUCT" + | 'PRODUCT' /** A search link. */ - | "SEARCH" + | 'SEARCH' /** A shop policy link. */ - | "SHOP_POLICY"; + | 'SHOP_POLICY'; /** The merchandise to be purchased at checkout. */ export type Merchandise = ProductVariant; @@ -4516,18 +4652,19 @@ export type Merchandise = ProductVariant; /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. + * */ export type Metafield = Node & { /** The date and time when the storefront metafield was created. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** The description of a metafield. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The unique identifier for the metafield within its namespace. */ - key: Scalars["String"]["output"]; + key: Scalars['String']['output']; /** The container for a group of metafields that the metafield is associated with. */ - namespace: Scalars["String"]["output"]; + namespace: Scalars['String']['output']; /** The type of resource that the metafield is attached to. */ parentResource: MetafieldParentResource; /** Returns a reference object if the metafield's type is a resource reference. */ @@ -4537,40 +4674,43 @@ export type Metafield = Node & { /** * The type name of the metafield. * Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). + * */ - type: Scalars["String"]["output"]; + type: Scalars['String']['output']; /** The date and time when the metafield was last updated. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */ - value: Scalars["String"]["output"]; + value: Scalars['String']['output']; }; + /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. + * */ export type MetafieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** Possible error codes that can be returned by `MetafieldDeleteUserError`. */ export type MetafieldDeleteErrorCode = /** The owner ID is invalid. */ - | "INVALID_OWNER" + | 'INVALID_OWNER' /** Metafield not found. */ - | "METAFIELD_DOES_NOT_EXIST"; + | 'METAFIELD_DOES_NOT_EXIST'; /** An error that occurs during the execution of cart metafield deletion. */ export type MetafieldDeleteUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** @@ -4581,46 +4721,29 @@ export type MetafieldDeleteUserError = DisplayableError & { * - `number_decimal` * - `single_line_text_field` * - `boolean` as of 2022-04. + * */ export type MetafieldFilter = { /** The key of the metafield to filter on. */ - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; /** The namespace of the metafield to filter on. */ - namespace: Scalars["String"]["input"]; + namespace: Scalars['String']['input']; /** The value of the metafield. */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** A resource that the metafield belongs to. */ -export type MetafieldParentResource = - | Article - | Blog - | Cart - | Collection - | Customer - | Location - | Market - | Order - | Page - | Product - | ProductVariant - | Shop; +export type MetafieldParentResource = Article | Blog | Cart | Collection | Customer | Location | Market | Order | Page | Product | ProductVariant | Shop; /** * Returns the resource which is being referred to by a metafield. + * */ -export type MetafieldReference = - | Collection - | GenericFile - | MediaImage - | Metaobject - | Page - | Product - | ProductVariant - | Video; +export type MetafieldReference = Collection | GenericFile | MediaImage | Metaobject | Page | Product | ProductVariant | Video; /** * An auto-generated type for paginating through multiple MetafieldReferences. + * */ export type MetafieldReferenceConnection = { /** A list of edges. */ @@ -4633,10 +4756,11 @@ export type MetafieldReferenceConnection = { /** * An auto-generated type which holds one MetafieldReference and a cursor during pagination. + * */ export type MetafieldReferenceEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of MetafieldReferenceEdge. */ node: MetafieldReference; }; @@ -4646,33 +4770,33 @@ export type MetafieldsSetUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The index of the array element that's causing the error. */ - elementIndex?: Maybe; + elementIndex?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** Possible error codes that can be returned by `MetafieldsSetUserError`. */ export type MetafieldsSetUserErrorCode = /** The input value is blank. */ - | "BLANK" + | 'BLANK' /** The input value isn't included in the list. */ - | "INCLUSION" + | 'INCLUSION' /** The owner ID is invalid. */ - | "INVALID_OWNER" + | 'INVALID_OWNER' /** The type is invalid. */ - | "INVALID_TYPE" + | 'INVALID_TYPE' /** The value is invalid for metafield type or for definition options. */ - | "INVALID_VALUE" + | 'INVALID_VALUE' /** The input value should be less than or equal to the maximum value allowed. */ - | "LESS_THAN_OR_EQUAL_TO" + | 'LESS_THAN_OR_EQUAL_TO' /** The input value needs to be blank. */ - | "PRESENT" + | 'PRESENT' /** The input value is too long. */ - | "TOO_LONG" + | 'TOO_LONG' /** The input value is too short. */ - | "TOO_SHORT"; + | 'TOO_SHORT'; /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type Metaobject = Node & { @@ -4681,25 +4805,28 @@ export type Metaobject = Node & { /** * All object fields with defined values. * Omitted object keys can be assumed null, and no guarantees are made about field order. + * */ fields: Array; /** The unique handle of the metaobject. Useful as a custom ID. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The type of the metaobject. Defines the namespace of its associated metafields. */ - type: Scalars["String"]["output"]; + type: Scalars['String']['output']; /** The date and time when the metaobject was last updated. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; }; + /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type MetaobjectFieldArgs = { - key: Scalars["String"]["input"]; + key: Scalars['String']['input']; }; /** * An auto-generated type for paginating through multiple Metaobjects. + * */ export type MetaobjectConnection = { /** A list of edges. */ @@ -4712,10 +4839,11 @@ export type MetaobjectConnection = { /** * An auto-generated type which holds one Metaobject and a cursor during pagination. + * */ export type MetaobjectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of MetaobjectEdge. */ node: Metaobject; }; @@ -4723,7 +4851,7 @@ export type MetaobjectEdge = { /** Provides the value of a Metaobject field. */ export type MetaobjectField = { /** The field key. */ - key: Scalars["String"]["output"]; + key: Scalars['String']['output']; /** A referenced object if the field type is a resource reference. */ reference?: Maybe; /** A list of referenced objects if the field type is a resource reference list. */ @@ -4731,34 +4859,36 @@ export type MetaobjectField = { /** * The type name of the field. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). + * */ - type: Scalars["String"]["output"]; + type: Scalars['String']['output']; /** The field value. */ - value?: Maybe; + value?: Maybe; }; + /** Provides the value of a Metaobject field. */ export type MetaobjectFieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** The input fields used to retrieve a metaobject by handle. */ export type MetaobjectHandleInput = { /** The handle of the metaobject. */ - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; /** The type of the metaobject. */ - type: Scalars["String"]["input"]; + type: Scalars['String']['input']; }; /** Represents a Shopify hosted 3D model. */ export type Model3d = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4772,29 +4902,30 @@ export type Model3d = Media & Node & { /** Represents a source for a Shopify hosted 3d model. */ export type Model3dSource = { /** The filesize of the 3d model. */ - filesize: Scalars["Int"]["output"]; + filesize: Scalars['Int']['output']; /** The format of the 3d model. */ - format: Scalars["String"]["output"]; + format: Scalars['String']['output']; /** The MIME type of the 3d model. */ - mimeType: Scalars["String"]["output"]; + mimeType: Scalars['String']['output']; /** The URL of the 3d model. */ - url: Scalars["String"]["output"]; + url: Scalars['String']['output']; }; /** The input fields for a monetary value with currency. */ export type MoneyInput = { /** Decimal money amount. */ - amount: Scalars["Decimal"]["input"]; + amount: Scalars['Decimal']['input']; /** Currency of the money. */ currencyCode: CurrencyCode; }; /** * A monetary value with currency. + * */ export type MoneyV2 = { /** Decimal money amount. */ - amount: Scalars["Decimal"]["output"]; + amount: Scalars['Decimal']['output']; /** Currency of the money. */ currencyCode: CurrencyCode; }; @@ -4808,6 +4939,7 @@ export type Mutation = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. + * */ cartBuyerIdentityUpdate?: Maybe; /** Creates a new cart. */ @@ -4826,6 +4958,7 @@ export type Mutation = { * Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. * * Allows a maximum of 25 cart metafields to be set at a time. + * */ cartMetafieldsSet?: Maybe; /** Updates the note on the cart. */ @@ -4833,9 +4966,7 @@ export type Mutation = { /** Update the customer's payment method that will be used to checkout. */ cartPaymentUpdate?: Maybe; /** Update the selected delivery options for a delivery group. */ - cartSelectedDeliveryOptionsUpdate?: Maybe< - CartSelectedDeliveryOptionsUpdatePayload - >; + cartSelectedDeliveryOptionsUpdate?: Maybe; /** Submit the cart for checkout completion. */ cartSubmitForCompletion?: Maybe; /** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */ @@ -4843,13 +4974,9 @@ export type Mutation = { /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ checkoutCompleteFree?: Maybe; /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). */ - checkoutCompleteWithCreditCardV2?: Maybe< - CheckoutCompleteWithCreditCardV2Payload - >; + checkoutCompleteWithCreditCardV2?: Maybe; /** Completes a checkout with a tokenized payment. */ - checkoutCompleteWithTokenizedPaymentV3?: Maybe< - CheckoutCompleteWithTokenizedPaymentV3Payload - >; + checkoutCompleteWithTokenizedPaymentV3?: Maybe; /** Creates a new checkout. */ checkoutCreate?: Maybe; /** Associates a customer to the checkout. */ @@ -4875,14 +5002,13 @@ export type Mutation = { /** Updates line items on a checkout. */ checkoutLineItemsUpdate?: Maybe; /** Updates the shipping address of an existing checkout. */ - checkoutShippingAddressUpdateV2?: Maybe< - CheckoutShippingAddressUpdateV2Payload - >; + checkoutShippingAddressUpdateV2?: Maybe; /** Updates the shipping lines on an existing checkout. */ checkoutShippingLineUpdate?: Maybe; /** * Creates a customer access token. * The customer access token is required to modify the customer object in any way. + * */ customerAccessTokenCreate?: Maybe; /** @@ -4890,10 +5016,9 @@ export type Mutation = { * [multipass token](https://shopify.dev/api/multipass) instead of email and * password. A customer record is created if the customer doesn't exist. If a customer * record already exists but the record is disabled, then the customer record is enabled. + * */ - customerAccessTokenCreateWithMultipass?: Maybe< - CustomerAccessTokenCreateWithMultipassPayload - >; + customerAccessTokenCreateWithMultipass?: Maybe; /** Permanently destroys a customer access token. */ customerAccessTokenDelete?: Maybe; /** @@ -4901,6 +5026,7 @@ export type Mutation = { * * Access token renewal must happen *before* a token expires. * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. + * */ customerAccessTokenRenew?: Maybe; /** Activates a customer. */ @@ -4930,283 +5056,332 @@ export type Mutation = { * * Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this * mutation presents a security risk. + * */ customerRecover?: Maybe; /** * "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * */ customerReset?: Maybe; /** * "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * */ customerResetByUrl?: Maybe; /** Updates an existing customer. */ customerUpdate?: Maybe; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartAttributesUpdateArgs = { attributes: Array; - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartBuyerIdentityUpdateArgs = { buyerIdentity: CartBuyerIdentityInput; - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartCreateArgs = { input?: InputMaybe; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartDiscountCodesUpdateArgs = { - cartId: Scalars["ID"]["input"]; - discountCodes?: InputMaybe>; + cartId: Scalars['ID']['input']; + discountCodes?: InputMaybe>; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesAddArgs = { - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; lines: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesRemoveArgs = { - cartId: Scalars["ID"]["input"]; - lineIds: Array; + cartId: Scalars['ID']['input']; + lineIds: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesUpdateArgs = { - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; lines: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldDeleteArgs = { input: CartMetafieldDeleteInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldsSetArgs = { metafields: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartNoteUpdateArgs = { - cartId: Scalars["ID"]["input"]; - note?: InputMaybe; + cartId: Scalars['ID']['input']; + note?: InputMaybe; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartPaymentUpdateArgs = { - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; payment: CartPaymentInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSelectedDeliveryOptionsUpdateArgs = { - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; selectedDeliveryOptions: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSubmitForCompletionArgs = { - attemptToken: Scalars["String"]["input"]; - cartId: Scalars["ID"]["input"]; + attemptToken: Scalars['String']['input']; + cartId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutAttributesUpdateV2Args = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; input: CheckoutAttributesUpdateV2Input; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteFreeArgs = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithCreditCardV2Args = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; payment: CreditCardPaymentInputV2; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; payment: TokenizedPaymentInputV3; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCreateArgs = { input: CheckoutCreateInput; - queueToken?: InputMaybe; + queueToken?: InputMaybe; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerAssociateV2Args = { - checkoutId: Scalars["ID"]["input"]; - customerAccessToken: Scalars["String"]["input"]; + checkoutId: Scalars['ID']['input']; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerDisassociateV2Args = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeApplyV2Args = { - checkoutId: Scalars["ID"]["input"]; - discountCode: Scalars["String"]["input"]; + checkoutId: Scalars['ID']['input']; + discountCode: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeRemoveArgs = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutEmailUpdateV2Args = { - checkoutId: Scalars["ID"]["input"]; - email: Scalars["String"]["input"]; + checkoutId: Scalars['ID']['input']; + email: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardRemoveV2Args = { - appliedGiftCardId: Scalars["ID"]["input"]; - checkoutId: Scalars["ID"]["input"]; + appliedGiftCardId: Scalars['ID']['input']; + checkoutId: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardsAppendArgs = { - checkoutId: Scalars["ID"]["input"]; - giftCardCodes: Array; + checkoutId: Scalars['ID']['input']; + giftCardCodes: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsAddArgs = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; lineItems: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsRemoveArgs = { - checkoutId: Scalars["ID"]["input"]; - lineItemIds: Array; + checkoutId: Scalars['ID']['input']; + lineItemIds: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsReplaceArgs = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; lineItems: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsUpdateArgs = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; lineItems: Array; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingAddressUpdateV2Args = { - checkoutId: Scalars["ID"]["input"]; + checkoutId: Scalars['ID']['input']; shippingAddress: MailingAddressInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingLineUpdateArgs = { - checkoutId: Scalars["ID"]["input"]; - shippingRateHandle: Scalars["String"]["input"]; + checkoutId: Scalars['ID']['input']; + shippingRateHandle: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenCreateInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateWithMultipassArgs = { - multipassToken: Scalars["String"]["input"]; + multipassToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenDeleteArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; input: CustomerActivateInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateByUrlArgs = { - activationUrl: Scalars["URL"]["input"]; - password: Scalars["String"]["input"]; + activationUrl: Scalars['URL']['input']; + password: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressCreateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressDeleteArgs = { - customerAccessToken: Scalars["String"]["input"]; - id: Scalars["ID"]["input"]; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressUpdateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars["String"]["input"]; - id: Scalars["ID"]["input"]; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerCreateArgs = { input: CustomerCreateInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerDefaultAddressUpdateArgs = { - addressId: Scalars["ID"]["input"]; - customerAccessToken: Scalars["String"]["input"]; + addressId: Scalars['ID']['input']; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerRecoverArgs = { - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; input: CustomerResetInput; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetByUrlArgs = { - password: Scalars["String"]["input"]; - resetUrl: Scalars["URL"]["input"]; + password: Scalars['String']['input']; + resetUrl: Scalars['URL']['input']; }; + /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerUpdateArgs = { customer: CustomerUpdateInput; - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; /** @@ -5214,16 +5389,17 @@ export type MutationCustomerUpdateArgs = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * */ export type Node = { /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; }; /** Represents a resource that can be published to the Online Store sales channel. */ export type OnlineStorePublishable = { /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; }; /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ @@ -5233,7 +5409,7 @@ export type Order = HasMetafields & Node & { /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ cancelReason?: Maybe; /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ - canceledAt?: Maybe; + canceledAt?: Maybe; /** The code of the currency used for the payment. */ currencyCode: CurrencyCode; /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order. */ @@ -5247,21 +5423,21 @@ export type Order = HasMetafields & Node & { /** A list of the custom attributes added to the order. */ customAttributes: Array; /** The locale code in which this specific order happened. */ - customerLocale?: Maybe; + customerLocale?: Maybe; /** The unique URL that the customer can use to access the order. */ - customerUrl?: Maybe; + customerUrl?: Maybe; /** Discounts that have been applied on the order. */ discountApplications: DiscountApplicationConnection; /** Whether the order has had any edits applied or not. */ - edited: Scalars["Boolean"]["output"]; + edited: Scalars['Boolean']['output']; /** The customer's email address. */ - email?: Maybe; + email?: Maybe; /** The financial status of the order. */ financialStatus?: Maybe; /** The fulfillment status for the order. */ fulfillmentStatus: OrderFulfillmentStatus; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** List of the order’s line items. */ lineItems: OrderLineItemConnection; /** Returns a metafield found by namespace and key. */ @@ -5271,30 +5447,33 @@ export type Order = HasMetafields & Node & { /** * Unique identifier for the order that appears on the order. * For example, _#1000_ or _Store1001. + * */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** A unique numeric identifier for the order for use by shop owner and customer. */ - orderNumber: Scalars["Int"]["output"]; + orderNumber: Scalars['Int']['output']; /** The total cost of duties charged at checkout. */ originalTotalDuties?: Maybe; /** The total price of the order before any applied edits. */ originalTotalPrice: MoneyV2; /** The customer's phone number for receiving SMS notifications. */ - phone?: Maybe; + phone?: Maybe; /** * The date and time when the order was imported. * This value can be set to dates in the past when importing from other systems. * If no value is provided, it will be auto-generated based on current date and time. + * */ - processedAt: Scalars["DateTime"]["output"]; + processedAt: Scalars['DateTime']['output']; /** The address to where the order will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. + * */ shippingDiscountAllocations: Array; /** The unique URL for the order's status page. */ - statusUrl: Scalars["URL"]["output"]; + statusUrl: Scalars['URL']['output']; /** Price of the order before shipping and taxes. */ subtotalPrice?: Maybe; /** @@ -5334,55 +5513,61 @@ export type Order = HasMetafields & Node & { totalTaxV2?: Maybe; }; + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldsArgs = { identifiers: Array; }; + /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderSuccessfulFulfillmentsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents the reason for the order's cancellation. */ export type OrderCancelReason = /** The customer wanted to cancel the order. */ - | "CUSTOMER" + | 'CUSTOMER' /** Payment was declined. */ - | "DECLINED" + | 'DECLINED' /** The order was fraudulent. */ - | "FRAUD" + | 'FRAUD' /** There was insufficient inventory. */ - | "INVENTORY" + | 'INVENTORY' /** The order was canceled for an unlisted reason. */ - | "OTHER"; + | 'OTHER'; /** * An auto-generated type for paginating through multiple Orders. + * */ export type OrderConnection = { /** A list of edges. */ @@ -5392,15 +5577,16 @@ export type OrderConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Orders. */ - totalCount: Scalars["UnsignedInt64"]["output"]; + totalCount: Scalars['UnsignedInt64']['output']; }; /** * An auto-generated type which holds one Order and a cursor during pagination. + * */ export type OrderEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of OrderEdge. */ node: Order; }; @@ -5408,45 +5594,45 @@ export type OrderEdge = { /** Represents the order's current financial status. */ export type OrderFinancialStatus = /** Displayed as **Authorized**. */ - | "AUTHORIZED" + | 'AUTHORIZED' /** Displayed as **Paid**. */ - | "PAID" + | 'PAID' /** Displayed as **Partially paid**. */ - | "PARTIALLY_PAID" + | 'PARTIALLY_PAID' /** Displayed as **Partially refunded**. */ - | "PARTIALLY_REFUNDED" + | 'PARTIALLY_REFUNDED' /** Displayed as **Pending**. */ - | "PENDING" + | 'PENDING' /** Displayed as **Refunded**. */ - | "REFUNDED" + | 'REFUNDED' /** Displayed as **Voided**. */ - | "VOIDED"; + | 'VOIDED'; /** Represents the order's aggregated fulfillment status for display purposes. */ export type OrderFulfillmentStatus = /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ - | "FULFILLED" + | 'FULFILLED' /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ - | "IN_PROGRESS" + | 'IN_PROGRESS' /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ - | "ON_HOLD" + | 'ON_HOLD' /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ - | "OPEN" + | 'OPEN' /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ - | "PARTIALLY_FULFILLED" + | 'PARTIALLY_FULFILLED' /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ - | "PENDING_FULFILLMENT" + | 'PENDING_FULFILLMENT' /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ - | "RESTOCKED" + | 'RESTOCKED' /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ - | "SCHEDULED" + | 'SCHEDULED' /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ - | "UNFULFILLED"; + | 'UNFULFILLED'; /** Represents a single line in an order. There is one line item for each distinct product variant. */ export type OrderLineItem = { /** The number of entries associated to the line item minus the items that have been removed. */ - currentQuantity: Scalars["Int"]["output"]; + currentQuantity: Scalars['Int']['output']; /** List of custom attributes associated to the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the order line item by discount applications. */ @@ -5456,15 +5642,16 @@ export type OrderLineItem = { /** The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it's displayed in the presentment currency. */ originalTotalPrice: MoneyV2; /** The number of products variants associated to the line item. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The title of the product combined with title of the variant. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The product variant object associated to the line item. */ variant?: Maybe; }; /** * An auto-generated type for paginating through multiple OrderLineItems. + * */ export type OrderLineItemConnection = { /** A list of edges. */ @@ -5477,10 +5664,11 @@ export type OrderLineItemConnection = { /** * An auto-generated type which holds one OrderLineItem and a cursor during pagination. + * */ export type OrderLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of OrderLineItemEdge. */ node: OrderLineItem; }; @@ -5488,51 +5676,54 @@ export type OrderLineItemEdge = { /** The set of valid sort keys for the Order query. */ export type OrderSortKeys = /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `processed_at` value. */ - | "PROCESSED_AT" + | 'PROCESSED_AT' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `total_price` value. */ - | "TOTAL_PRICE"; + | 'TOTAL_PRICE'; /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & { /** The description of the page, complete with HTML formatting. */ - body: Scalars["HTML"]["output"]; + body: Scalars['HTML']['output']; /** Summary of the page body. */ - bodySummary: Scalars["String"]["output"]; + bodySummary: Scalars['String']['output']; /** The timestamp of the page creation. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** A human-friendly unique string for the page automatically generated from its title. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The page's SEO information. */ seo?: Maybe; /** The title of the page. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; /** The timestamp of the latest page update. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; }; + /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldsArgs = { identifiers: Array; @@ -5540,6 +5731,7 @@ export type PageMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Pages. + * */ export type PageConnection = { /** A list of edges. */ @@ -5552,10 +5744,11 @@ export type PageConnection = { /** * An auto-generated type which holds one Page and a cursor during pagination. + * */ export type PageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of PageEdge. */ node: Page; }; @@ -5564,31 +5757,33 @@ export type PageEdge = { * Returns information about pagination in a connection, in accordance with the * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). + * */ export type PageInfo = { /** The cursor corresponding to the last node in edges. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Whether there are more pages to fetch following the current page. */ - hasNextPage: Scalars["Boolean"]["output"]; + hasNextPage: Scalars['Boolean']['output']; /** Whether there are any pages prior to the current page. */ - hasPreviousPage: Scalars["Boolean"]["output"]; + hasPreviousPage: Scalars['Boolean']['output']; /** The cursor corresponding to the first node in edges. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** The set of valid sort keys for the Page query. */ export type PageSortKeys = /** Sort by the `id` value. */ - | "ID" + | 'ID' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE" + | 'TITLE' /** Sort by the `updated_at` value. */ - | "UPDATED_AT"; + | 'UPDATED_AT'; /** A payment applied to a checkout. */ export type Payment = Node & { @@ -5606,21 +5801,22 @@ export type Payment = Node & { /** The credit card used for the payment in the case of direct payments. */ creditCard?: Maybe; /** A message describing a processing error during asynchronous processing. */ - errorMessage?: Maybe; + errorMessage?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** * A client-side generated token to identify a payment and perform idempotent operations. * For more information, refer to * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). + * */ - idempotencyKey?: Maybe; + idempotencyKey?: Maybe; /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ - nextActionUrl?: Maybe; + nextActionUrl?: Maybe; /** Whether the payment is still processing asynchronously. */ - ready: Scalars["Boolean"]["output"]; + ready: Scalars['Boolean']['output']; /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ - test: Scalars["Boolean"]["output"]; + test: Scalars['Boolean']['output']; /** The actual transaction recorded by Shopify after having processed the payment with the gateway. */ transaction?: Maybe; }; @@ -5630,7 +5826,7 @@ export type PaymentSettings = { /** List of the card brands which the shop accepts. */ acceptedCardBrands: Array; /** The url pointing to the endpoint to vault credit cards. */ - cardVaultUrl: Scalars["URL"]["output"]; + cardVaultUrl: Scalars['URL']['output']; /** The country where the shop is located. */ countryCode: CountryCode; /** The three-letter code for the shop's primary currency. */ @@ -5638,10 +5834,11 @@ export type PaymentSettings = { /** * A list of enabled currencies (ISO 4217 format) that the shop accepts. * Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. + * */ enabledPresentmentCurrencies: Array; /** The shop’s Shopify Payments account ID. */ - shopifyPaymentsAccountId?: Maybe; + shopifyPaymentsAccountId?: Maybe; /** List of the digital wallets which the shop supports. */ supportedDigitalWallets: Array; }; @@ -5649,26 +5846,27 @@ export type PaymentSettings = { /** The valid values for the types of payment token. */ export type PaymentTokenType = /** Apple Pay token type. */ - | "APPLE_PAY" + | 'APPLE_PAY' /** Google Pay token type. */ - | "GOOGLE_PAY" + | 'GOOGLE_PAY' /** Shopify Pay token type. */ - | "SHOPIFY_PAY" + | 'SHOPIFY_PAY' /** Stripe token type. */ - | "STRIPE_VAULT_TOKEN" + | 'STRIPE_VAULT_TOKEN' /** Vault payment token type. */ - | "VAULT"; + | 'VAULT'; /** Decides the distribution of results. */ export type PredictiveSearchLimitScope = /** Return results up to limit across all types. */ - | "ALL" + | 'ALL' /** Return results up to limit per type. */ - | "EACH"; + | 'EACH'; /** * A predictive search result represents a list of products, collections, pages, articles, and query suggestions * that matches the predictive search query. + * */ export type PredictiveSearchResult = { /** The articles that match the search query. */ @@ -5686,30 +5884,31 @@ export type PredictiveSearchResult = { /** The types of search items to perform predictive search on. */ export type PredictiveSearchType = /** Returns matching articles. */ - | "ARTICLE" + | 'ARTICLE' /** Returns matching collections. */ - | "COLLECTION" + | 'COLLECTION' /** Returns matching pages. */ - | "PAGE" + | 'PAGE' /** Returns matching products. */ - | "PRODUCT" + | 'PRODUCT' /** Returns matching query strings. */ - | "QUERY"; + | 'QUERY'; /** * The input fields for a filter used to view a subset of products in a collection matching a specific price range. + * */ export type PriceRangeFilter = { /** The maximum price in the range. Empty indicates no max price. */ - max?: InputMaybe; + max?: InputMaybe; /** The minimum price in the range. Defaults to zero. */ - min?: InputMaybe; + min?: InputMaybe; }; /** The value of the percentage pricing object. */ export type PricingPercentageValue = { /** The percentage value of the object. */ - percentage: Scalars["Float"]["output"]; + percentage: Scalars['Float']['output']; }; /** The price value (fixed or percentage) for a discount application. */ @@ -5720,242 +5919,265 @@ export type PricingValue = MoneyV2 | PricingPercentageValue; * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ -export type Product = - & HasMetafields - & Node - & OnlineStorePublishable - & Trackable - & { - /** Indicates if at least one product variant is available for sale. */ - availableForSale: Scalars["Boolean"]["output"]; - /** List of collections a product belongs to. */ - collections: CollectionConnection; - /** The compare at price of the product across all variants. */ - compareAtPriceRange: ProductPriceRange; - /** The date and time when the product was created. */ - createdAt: Scalars["DateTime"]["output"]; - /** Stripped description of the product, single line with HTML tags removed. */ - description: Scalars["String"]["output"]; - /** The description of the product, complete with HTML formatting. */ - descriptionHtml: Scalars["HTML"]["output"]; - /** - * The featured image for the product. - * - * This field is functionally equivalent to `images(first: 1)`. - */ - featuredImage?: Maybe; - /** - * A human-friendly unique string for the Product automatically generated from its title. - * They are used by the Liquid templating language to refer to objects. - */ - handle: Scalars["String"]["output"]; - /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; - /** List of images associated with the product. */ - images: ImageConnection; - /** Whether the product is a gift card. */ - isGiftCard: Scalars["Boolean"]["output"]; - /** The media associated with the product. */ - media: MediaConnection; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of product options. */ - options: Array; - /** The price range. */ - priceRange: ProductPriceRange; - /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ - productType: Scalars["String"]["output"]; - /** The date and time when the product was published to the channel. */ - publishedAt: Scalars["DateTime"]["output"]; - /** Whether the product can only be purchased with a selling plan. */ - requiresSellingPlan: Scalars["Boolean"]["output"]; - /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ - sellingPlanGroups: SellingPlanGroupConnection; - /** The product's SEO information. */ - seo: Seo; - /** - * A comma separated list of tags that have been added to the product. - * Additional access scope required for private apps: unauthenticated_read_product_tags. - */ - tags: Array; - /** The product’s title. */ - title: Scalars["String"]["output"]; - /** The total quantity of inventory in stock for this Product. */ - totalInventory?: Maybe; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** - * The date and time when the product was last modified. - * A product's `updatedAt` value can change for different reasons. For example, if an order - * is placed for a product that has inventory tracking set up, then the inventory adjustment - * is counted as an update. - */ - updatedAt: Scalars["DateTime"]["output"]; - /** - * Find a product’s variant based on its selected options. - * This is useful for converting a user’s selection of product options into a single matching variant. - * If there is not a variant for the selected options, `null` will be returned. - */ - variantBySelectedOptions?: Maybe; - /** List of the product’s variants. */ - variants: ProductVariantConnection; - /** The product’s vendor name. */ - vendor: Scalars["String"]["output"]; - }; +export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** Indicates if at least one product variant is available for sale. */ + availableForSale: Scalars['Boolean']['output']; + /** List of collections a product belongs to. */ + collections: CollectionConnection; + /** The compare at price of the product across all variants. */ + compareAtPriceRange: ProductPriceRange; + /** The date and time when the product was created. */ + createdAt: Scalars['DateTime']['output']; + /** Stripped description of the product, single line with HTML tags removed. */ + description: Scalars['String']['output']; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml: Scalars['HTML']['output']; + /** + * The featured image for the product. + * + * This field is functionally equivalent to `images(first: 1)`. + * + */ + featuredImage?: Maybe; + /** + * A human-friendly unique string for the Product automatically generated from its title. + * They are used by the Liquid templating language to refer to objects. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** List of images associated with the product. */ + images: ImageConnection; + /** Whether the product is a gift card. */ + isGiftCard: Scalars['Boolean']['output']; + /** The media associated with the product. */ + media: MediaConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of product options. */ + options: Array; + /** The price range. */ + priceRange: ProductPriceRange; + /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ + productType: Scalars['String']['output']; + /** The date and time when the product was published to the channel. */ + publishedAt: Scalars['DateTime']['output']; + /** Whether the product can only be purchased with a selling plan. */ + requiresSellingPlan: Scalars['Boolean']['output']; + /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** The product's SEO information. */ + seo: Seo; + /** + * A comma separated list of tags that have been added to the product. + * Additional access scope required for private apps: unauthenticated_read_product_tags. + * + */ + tags: Array; + /** The product’s title. */ + title: Scalars['String']['output']; + /** The total quantity of inventory in stock for this Product. */ + totalInventory?: Maybe; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** + * The date and time when the product was last modified. + * A product's `updatedAt` value can change for different reasons. For example, if an order + * is placed for a product that has inventory tracking set up, then the inventory adjustment + * is counted as an update. + * + */ + updatedAt: Scalars['DateTime']['output']; + /** + * Find a product’s variant based on its selected options. + * This is useful for converting a user’s selection of product options into a single matching variant. + * If there is not a variant for the selected options, `null` will be returned. + * + */ + variantBySelectedOptions?: Maybe; + /** List of the product’s variants. */ + variants: ProductVariantConnection; + /** The product’s vendor name. */ + vendor: Scalars['String']['output']; +}; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductImagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductMediaArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductMetafieldsArgs = { identifiers: Array; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductOptionsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductSellingPlanGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductVariantBySelectedOptionsArgs = { selectedOptions: Array; }; + /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). + * */ export type ProductVariantsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** The set of valid sort keys for the ProductCollection query. */ export type ProductCollectionSortKeys = /** Sort by the `best-selling` value. */ - | "BEST_SELLING" + | 'BEST_SELLING' /** Sort by the `collection-default` value. */ - | "COLLECTION_DEFAULT" + | 'COLLECTION_DEFAULT' /** Sort by the `created` value. */ - | "CREATED" + | 'CREATED' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `manual` value. */ - | "MANUAL" + | 'MANUAL' /** Sort by the `price` value. */ - | "PRICE" + | 'PRICE' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE"; + | 'TITLE'; /** * An auto-generated type for paginating through multiple Products. + * */ export type ProductConnection = { /** A list of edges. */ @@ -5970,10 +6192,11 @@ export type ProductConnection = { /** * An auto-generated type which holds one Product and a cursor during pagination. + * */ export type ProductEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of ProductEdge. */ node: Product; }; @@ -5982,20 +6205,21 @@ export type ProductEdge = { * The input fields for a filter used to view a subset of products in a collection. * By default, the `available` and `price` filters are enabled. Filters are customized with the Shopify Search & Discovery app. * Learn more about [customizing storefront filtering](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters). + * */ export type ProductFilter = { /** Filter on if the product is available for sale. */ - available?: InputMaybe; + available?: InputMaybe; /** A range of prices to filter with-in. */ price?: InputMaybe; /** A product metafield to filter on. */ productMetafield?: InputMaybe; /** The product type to filter on. */ - productType?: InputMaybe; + productType?: InputMaybe; /** The product vendor to filter on. */ - productVendor?: InputMaybe; + productVendor?: InputMaybe; /** A product tag to filter on. */ - tag?: InputMaybe; + tag?: InputMaybe; /** A variant metafield to filter on. */ variantMetafield?: InputMaybe; /** A variant option to filter on. */ @@ -6005,41 +6229,44 @@ export type ProductFilter = { /** The set of valid sort keys for the ProductImage query. */ export type ProductImageSortKeys = /** Sort by the `created_at` value. */ - | "CREATED_AT" + | 'CREATED_AT' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `position` value. */ - | "POSITION" + | 'POSITION' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE"; + | 'RELEVANCE'; /** The set of valid sort keys for the ProductMedia query. */ export type ProductMediaSortKeys = /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `position` value. */ - | "POSITION" + | 'POSITION' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE"; + | 'RELEVANCE'; /** * Product property names like "Size", "Color", and "Material" that the customers can select. * Variants are selected based on permutations of these options. * 255 characters limit each. + * */ export type ProductOption = Node & { /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The product option’s name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The corresponding value to the product option name. */ - values: Array; + values: Array; }; /** The price range of the product. */ @@ -6053,45 +6280,48 @@ export type ProductPriceRange = { /** * The recommendation intent that is used to generate product recommendations. * You can use intent to generate product recommendations according to different strategies. + * */ export type ProductRecommendationIntent = /** Offer customers products that are complementary to a product for which recommendations are to be fetched. An example is add-on products that display in a Pair it with section. */ - | "COMPLEMENTARY" + | 'COMPLEMENTARY' /** Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section. */ - | "RELATED"; + | 'RELATED'; /** The set of valid sort keys for the Product query. */ export type ProductSortKeys = /** Sort by the `best_selling` value. */ - | "BEST_SELLING" + | 'BEST_SELLING' /** Sort by the `created_at` value. */ - | "CREATED_AT" + | 'CREATED_AT' /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `price` value. */ - | "PRICE" + | 'PRICE' /** Sort by the `product_type` value. */ - | "PRODUCT_TYPE" + | 'PRODUCT_TYPE' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `title` value. */ - | "TITLE" + | 'TITLE' /** Sort by the `updated_at` value. */ - | "UPDATED_AT" + | 'UPDATED_AT' /** Sort by the `vendor` value. */ - | "VENDOR"; + | 'VENDOR'; /** * A product variant represents a different version of a product, such as differing sizes or differing colors. + * */ export type ProductVariant = HasMetafields & Node & { /** Indicates if the product variant is available for sale. */ - availableForSale: Scalars["Boolean"]["output"]; + availableForSale: Scalars['Boolean']['output']; /** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */ - barcode?: Maybe; + barcode?: Maybe; /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. */ compareAtPrice?: Maybe; /** @@ -6100,9 +6330,9 @@ export type ProductVariant = HasMetafields & Node & { */ compareAtPriceV2?: Maybe; /** Whether a product is out of stock but still available for purchase (used for backorders). */ - currentlyNotInStock: Scalars["Boolean"]["output"]; + currentlyNotInStock: Scalars['Boolean']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Image associated with the product variant. This field falls back to the product image if no image is available. */ image?: Maybe; /** Returns a metafield found by namespace and key. */ @@ -6119,69 +6349,78 @@ export type ProductVariant = HasMetafields & Node & { /** The product object that the product variant belongs to. */ product: Product; /** The total sellable quantity of the variant for online sales channels. */ - quantityAvailable?: Maybe; + quantityAvailable?: Maybe; /** Whether a customer needs to provide a shipping address when placing an order for the product variant. */ - requiresShipping: Scalars["Boolean"]["output"]; + requiresShipping: Scalars['Boolean']['output']; /** List of product options applied to the variant. */ selectedOptions: Array; /** Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. */ sellingPlanAllocations: SellingPlanAllocationConnection; /** The SKU (stock keeping unit) associated with the variant. */ - sku?: Maybe; + sku?: Maybe; /** The in-store pickup availability of this variant by location. */ storeAvailability: StoreAvailabilityConnection; /** The product variant’s title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The unit price value for the variant based on the variant's measurement. */ unitPrice?: Maybe; /** The unit price measurement for the variant. */ unitPriceMeasurement?: Maybe; /** The weight of the product variant in the unit system specified with `weight_unit`. */ - weight?: Maybe; + weight?: Maybe; /** Unit of measurement for weight. */ weightUnit: WeightUnit; }; + /** * A product variant represents a different version of a product, such as differing sizes or differing colors. + * */ export type ProductVariantMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** * A product variant represents a different version of a product, such as differing sizes or differing colors. + * */ export type ProductVariantMetafieldsArgs = { identifiers: Array; }; + /** * A product variant represents a different version of a product, such as differing sizes or differing colors. + * */ export type ProductVariantSellingPlanAllocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; + /** * A product variant represents a different version of a product, such as differing sizes or differing colors. + * */ export type ProductVariantStoreAvailabilityArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple ProductVariants. + * */ export type ProductVariantConnection = { /** A list of edges. */ @@ -6194,10 +6433,11 @@ export type ProductVariantConnection = { /** * An auto-generated type which holds one ProductVariant and a cursor during pagination. + * */ export type ProductVariantEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of ProductVariantEdge. */ node: ProductVariant; }; @@ -6205,18 +6445,19 @@ export type ProductVariantEdge = { /** The set of valid sort keys for the ProductVariant query. */ export type ProductVariantSortKeys = /** Sort by the `id` value. */ - | "ID" + | 'ID' /** Sort by the `position` value. */ - | "POSITION" + | 'POSITION' /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. + * */ - | "RELEVANCE" + | 'RELEVANCE' /** Sort by the `sku` value. */ - | "SKU" + | 'SKU' /** Sort by the `title` value. */ - | "TITLE"; + | 'TITLE'; /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRoot = { @@ -6236,10 +6477,12 @@ export type QueryRoot = { /** * Retrieve a cart by its ID. For more information, refer to * [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage). + * */ cart?: Maybe; /** * A poll for the status of the cart checkout completion and order creation. + * */ cartCompletionAttempt?: Maybe; /** Fetch a specific `Collection` by one of its unique attributes. */ @@ -6254,6 +6497,7 @@ export type QueryRoot = { /** * The customer associated with the given access token. Tokens are obtained by using the * [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate). + * */ customer?: Maybe; /** Returns the localized experiences configured for the shop. */ @@ -6262,6 +6506,8 @@ export type QueryRoot = { * List of the shop's locations that support in-store pickup. * * When sorting by distance, you must specify a location via the `near` argument. + * + * */ locations: LocationConnection; /** Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle. */ @@ -6296,11 +6542,13 @@ export type QueryRoot = { * Find recommended products related to a given `product_id`. * To learn more about how recommendations are generated, see * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). + * */ productRecommendations?: Maybe>; /** * Tags added to products. * Additional access scope required: unauthenticated_read_product_tags. + * */ productTags: StringConnection; /** List of product types for the shop's products that are published to your app. */ @@ -6317,230 +6565,260 @@ export type QueryRoot = { urlRedirects: UrlRedirectConnection; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticleArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogByHandleArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartCompletionAttemptArgs = { - attemptId: Scalars["String"]["input"]; + attemptId: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionByHandleArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMenuArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectArgs = { handle?: InputMaybe; - id?: InputMaybe; + id?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; - sortKey?: InputMaybe; - type: Scalars["String"]["input"]; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodeArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageByHandleArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPredictiveSearchArgs = { - limit?: InputMaybe; + limit?: InputMaybe; limitScope?: InputMaybe; - query: Scalars["String"]["input"]; + query: Scalars['String']['input']; searchableFields?: InputMaybe>; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductByHandleArgs = { - handle: Scalars["String"]["input"]; + handle: Scalars['String']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductRecommendationsArgs = { intent?: InputMaybe; - productId: Scalars["ID"]["input"]; + productId: Scalars['ID']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTagsArgs = { - first: Scalars["Int"]["input"]; + first: Scalars['Int']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTypesArgs = { - first: Scalars["Int"]["input"]; + first: Scalars['Int']['input']; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSearchArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; prefix?: InputMaybe; productFilters?: InputMaybe>; - query: Scalars["String"]["input"]; - reverse?: InputMaybe; + query: Scalars['String']['input']; + reverse?: InputMaybe; sortKey?: InputMaybe; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; + /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootUrlRedirectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; }; /** SEO information. */ export type Seo = { /** The meta description. */ - description?: Maybe; + description?: Maybe; /** The SEO title. */ - title?: Maybe; + title?: Maybe; }; /** * Script discount applications capture the intentions of a discount that * was created by a Shopify Script. + * */ export type ScriptDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -6550,7 +6828,7 @@ export type ScriptDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application as defined by the Script. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** The value of the discount application. */ value: PricingValue; }; @@ -6558,27 +6836,29 @@ export type ScriptDiscountApplication = DiscountApplication & { /** Specifies whether to perform a partial word match on the last search term. */ export type SearchPrefixQueryType = /** Perform a partial word match on the last search term. */ - | "LAST" + | 'LAST' /** Don't perform a partial word match on the last search term. */ - | "NONE"; + | 'NONE'; /** A search query suggestion. */ export type SearchQuerySuggestion = Trackable & { /** The text of the search query suggestion with highlighted HTML tags. */ - styledText: Scalars["String"]["output"]; + styledText: Scalars['String']['output']; /** The text of the search query suggestion. */ - text: Scalars["String"]["output"]; + text: Scalars['String']['output']; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** * A search result that matches the search query. + * */ export type SearchResultItem = Article | Page | Product; /** * An auto-generated type for paginating through multiple SearchResultItems. + * */ export type SearchResultItemConnection = { /** A list of edges. */ @@ -6590,15 +6870,16 @@ export type SearchResultItemConnection = { /** A list of available filters. */ productFilters: Array; /** The total number of results. */ - totalCount: Scalars["Int"]["output"]; + totalCount: Scalars['Int']['output']; }; /** * An auto-generated type which holds one SearchResultItem and a cursor during pagination. + * */ export type SearchResultItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of SearchResultItemEdge. */ node: SearchResultItem; }; @@ -6606,66 +6887,67 @@ export type SearchResultItemEdge = { /** The set of valid sort keys for the search query. */ export type SearchSortKeys = /** Sort by the `price` value. */ - | "PRICE" + | 'PRICE' /** Sort by relevance to the search terms. */ - | "RELEVANCE"; + | 'RELEVANCE'; /** The types of search items to perform search within. */ export type SearchType = /** Returns matching articles. */ - | "ARTICLE" + | 'ARTICLE' /** Returns matching pages. */ - | "PAGE" + | 'PAGE' /** Returns matching products. */ - | "PRODUCT"; + | 'PRODUCT'; /** Specifies whether to display results for unavailable products. */ export type SearchUnavailableProductsType = /** Exclude unavailable products. */ - | "HIDE" + | 'HIDE' /** Show unavailable products after all other matching results. This is the default. */ - | "LAST" + | 'LAST' /** Show unavailable products in the order that they're found. */ - | "SHOW"; + | 'SHOW'; /** Specifies the list of resource fields to search. */ export type SearchableField = /** Author of the page or article. */ - | "AUTHOR" + | 'AUTHOR' /** Body of the page or article or product description or collection description. */ - | "BODY" + | 'BODY' /** Product type. */ - | "PRODUCT_TYPE" + | 'PRODUCT_TYPE' /** Tag associated with the product or article. */ - | "TAG" + | 'TAG' /** Title of the page or article or product title or collection title. */ - | "TITLE" + | 'TITLE' /** Variant barcode. */ - | "VARIANTS_BARCODE" + | 'VARIANTS_BARCODE' /** Variant SKU. */ - | "VARIANTS_SKU" + | 'VARIANTS_SKU' /** Variant title. */ - | "VARIANTS_TITLE" + | 'VARIANTS_TITLE' /** Product vendor. */ - | "VENDOR"; + | 'VENDOR'; /** * Properties used by customers to select a product variant. * Products can have multiple options, like different sizes or colors. + * */ export type SelectedOption = { /** The product option’s name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The product option’s value. */ - value: Scalars["String"]["output"]; + value: Scalars['String']['output']; }; /** The input fields required for a selected option. */ export type SelectedOptionInput = { /** The product option’s name. */ - name: Scalars["String"]["input"]; + name: Scalars['String']['input']; /** The product option’s value. */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** Represents how products and variants can be sold and purchased. */ @@ -6673,17 +6955,17 @@ export type SellingPlan = { /** The initial payment due for the purchase. */ checkoutCharge: SellingPlanCheckoutCharge; /** The description of the selling plan. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. */ options: Array; /** The price adjustments that a selling plan makes when a variant is purchased with a selling plan. */ priceAdjustments: Array; /** Whether purchasing the selling plan will result in multiple deliveries. */ - recurringDeliveries: Scalars["Boolean"]["output"]; + recurringDeliveries: Scalars['Boolean']['output']; }; /** Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. */ @@ -6700,6 +6982,7 @@ export type SellingPlanAllocation = { /** * An auto-generated type for paginating through multiple SellingPlanAllocations. + * */ export type SellingPlanAllocationConnection = { /** A list of edges. */ @@ -6712,10 +6995,11 @@ export type SellingPlanAllocationConnection = { /** * An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination. + * */ export type SellingPlanAllocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of SellingPlanAllocationEdge. */ node: SellingPlanAllocation; }; @@ -6743,23 +7027,22 @@ export type SellingPlanCheckoutCharge = { /** The percentage value of the price used for checkout charge. */ export type SellingPlanCheckoutChargePercentageValue = { /** The percentage value of the price used for checkout charge. */ - percentage: Scalars["Float"]["output"]; + percentage: Scalars['Float']['output']; }; /** The checkout charge when the full amount isn't charged at checkout. */ export type SellingPlanCheckoutChargeType = /** The checkout charge is a percentage of the product or variant price. */ - | "PERCENTAGE" + | 'PERCENTAGE' /** The checkout charge is a fixed price amount. */ - | "PRICE"; + | 'PRICE'; /** The portion of the price to be charged at checkout. */ -export type SellingPlanCheckoutChargeValue = - | MoneyV2 - | SellingPlanCheckoutChargePercentageValue; +export type SellingPlanCheckoutChargeValue = MoneyV2 | SellingPlanCheckoutChargePercentageValue; /** * An auto-generated type for paginating through multiple SellingPlans. + * */ export type SellingPlanConnection = { /** A list of edges. */ @@ -6772,10 +7055,11 @@ export type SellingPlanConnection = { /** * An auto-generated type which holds one SellingPlan and a cursor during pagination. + * */ export type SellingPlanEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of SellingPlanEdge. */ node: SellingPlan; }; @@ -6795,26 +7079,28 @@ export type SellingPlanFixedPriceAdjustment = { /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroup = { /** A display friendly name for the app that created the selling plan group. */ - appName?: Maybe; + appName?: Maybe; /** The name of the selling plan group. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. */ options: Array; /** A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */ sellingPlans: SellingPlanConnection; }; + /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroupSellingPlansArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple SellingPlanGroups. + * */ export type SellingPlanGroupConnection = { /** A list of edges. */ @@ -6827,10 +7113,11 @@ export type SellingPlanGroupConnection = { /** * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. + * */ export type SellingPlanGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of SellingPlanGroupEdge. */ node: SellingPlanGroup; }; @@ -6842,23 +7129,23 @@ export type SellingPlanGroupEdge = { */ export type SellingPlanGroupOption = { /** The name of the option. For example, 'Delivery every'. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. */ - values: Array; + values: Array; }; /** An option provided by a Selling Plan. */ export type SellingPlanOption = { /** The name of the option (ie "Delivery every"). */ - name?: Maybe; + name?: Maybe; /** The value of the option (ie "Month"). */ - value?: Maybe; + value?: Maybe; }; /** A percentage amount that's deducted from the original variant price. For example, 10% off. */ export type SellingPlanPercentagePriceAdjustment = { /** The percentage value of the price adjustment. */ - adjustmentPercentage: Scalars["Int"]["output"]; + adjustmentPercentage: Scalars['Int']['output']; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. */ @@ -6866,19 +7153,16 @@ export type SellingPlanPriceAdjustment = { /** The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. */ adjustmentValue: SellingPlanPriceAdjustmentValue; /** The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. */ - orderCount?: Maybe; + orderCount?: Maybe; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. */ -export type SellingPlanPriceAdjustmentValue = - | SellingPlanFixedAmountPriceAdjustment - | SellingPlanFixedPriceAdjustment - | SellingPlanPercentagePriceAdjustment; +export type SellingPlanPriceAdjustmentValue = SellingPlanFixedAmountPriceAdjustment | SellingPlanFixedPriceAdjustment | SellingPlanPercentagePriceAdjustment; /** A shipping rate to be applied to a checkout. */ export type ShippingRate = { /** Human-readable unique identifier for this shipping rate. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** Price of this shipping rate. */ price: MoneyV2; /** @@ -6887,7 +7171,7 @@ export type ShippingRate = { */ priceV2: MoneyV2; /** Title of this shipping rate. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; }; /** Shop represents a collection of the general settings and information about the shop. */ @@ -6895,17 +7179,17 @@ export type Shop = HasMetafields & Node & { /** The shop's branding configuration. */ brand?: Maybe; /** A description of the shop. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A string representing the way currency is formatted when the currency isn’t specified. */ - moneyFormat: Scalars["String"]["output"]; + moneyFormat: Scalars['String']['output']; /** The shop’s name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** Settings related to payments. */ paymentSettings: PaymentSettings; /** The primary domain of the shop’s Online Store. */ @@ -6924,12 +7208,14 @@ export type Shop = HasMetafields & Node & { termsOfService?: Maybe; }; + /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldArgs = { - key: Scalars["String"]["input"]; - namespace: Scalars["String"]["input"]; + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; }; + /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldsArgs = { identifiers: Array; @@ -6937,63 +7223,67 @@ export type ShopMetafieldsArgs = { /** * The input fields for submitting Shop Pay payment method information for checkout. + * */ export type ShopPayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** Session token for transaction. */ - sessionToken: Scalars["String"]["input"]; + sessionToken: Scalars['String']['input']; }; /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicy = Node & { /** Policy text, maximum size of 64kb. */ - body: Scalars["String"]["output"]; + body: Scalars['String']['output']; /** Policy’s handle. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** Policy’s title. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** Public URL to the policy. */ - url: Scalars["URL"]["output"]; + url: Scalars['URL']['output']; }; /** * A policy for the store that comes with a default value, such as a subscription policy. * If the merchant hasn't configured a policy for their store, then the policy will return the default value. * Otherwise, the policy will return the merchant-configured value. + * */ export type ShopPolicyWithDefault = { /** The text of the policy. Maximum size: 64KB. */ - body: Scalars["String"]["output"]; + body: Scalars['String']['output']; /** The handle of the policy. */ - handle: Scalars["String"]["output"]; + handle: Scalars['String']['output']; /** The unique ID of the policy. A default policy doesn't have an ID. */ - id?: Maybe; + id?: Maybe; /** The title of the policy. */ - title: Scalars["String"]["output"]; + title: Scalars['String']['output']; /** Public URL to the policy. */ - url: Scalars["URL"]["output"]; + url: Scalars['URL']['output']; }; /** * The availability of a product variant at a particular location. * Local pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result. + * */ export type StoreAvailability = { /** Whether the product variant is in-stock at this location. */ - available: Scalars["Boolean"]["output"]; + available: Scalars['Boolean']['output']; /** The location where this product variant is stocked at. */ location: Location; /** Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). */ - pickUpTime: Scalars["String"]["output"]; + pickUpTime: Scalars['String']['output']; /** The quantity of the product variant in-stock at this location. */ - quantityAvailable: Scalars["Int"]["output"]; + quantityAvailable: Scalars['Int']['output']; }; /** * An auto-generated type for paginating through multiple StoreAvailabilities. + * */ export type StoreAvailabilityConnection = { /** A list of edges. */ @@ -7006,16 +7296,18 @@ export type StoreAvailabilityConnection = { /** * An auto-generated type which holds one StoreAvailability and a cursor during pagination. + * */ export type StoreAvailabilityEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of StoreAvailabilityEdge. */ node: StoreAvailability; }; /** * An auto-generated type for paginating through a list of Strings. + * */ export type StringConnection = { /** A list of edges. */ @@ -7026,12 +7318,13 @@ export type StringConnection = { /** * An auto-generated type which holds one String and a cursor during pagination. + * */ export type StringEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of StringEdge. */ - node: Scalars["String"]["output"]; + node: Scalars['String']['output']; }; /** An error that occurred during cart submit for completion. */ @@ -7039,115 +7332,115 @@ export type SubmissionError = { /** The error code. */ code: SubmissionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during cart submit for completion. */ export type SubmissionErrorCode = - | "BUYER_IDENTITY_EMAIL_IS_INVALID" - | "BUYER_IDENTITY_EMAIL_REQUIRED" - | "BUYER_IDENTITY_PHONE_IS_INVALID" - | "DELIVERY_ADDRESS1_INVALID" - | "DELIVERY_ADDRESS1_REQUIRED" - | "DELIVERY_ADDRESS1_TOO_LONG" - | "DELIVERY_ADDRESS2_INVALID" - | "DELIVERY_ADDRESS2_REQUIRED" - | "DELIVERY_ADDRESS2_TOO_LONG" - | "DELIVERY_ADDRESS_REQUIRED" - | "DELIVERY_CITY_INVALID" - | "DELIVERY_CITY_REQUIRED" - | "DELIVERY_CITY_TOO_LONG" - | "DELIVERY_COMPANY_INVALID" - | "DELIVERY_COMPANY_REQUIRED" - | "DELIVERY_COMPANY_TOO_LONG" - | "DELIVERY_COUNTRY_REQUIRED" - | "DELIVERY_FIRST_NAME_INVALID" - | "DELIVERY_FIRST_NAME_REQUIRED" - | "DELIVERY_FIRST_NAME_TOO_LONG" - | "DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY" - | "DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE" - | "DELIVERY_LAST_NAME_INVALID" - | "DELIVERY_LAST_NAME_REQUIRED" - | "DELIVERY_LAST_NAME_TOO_LONG" - | "DELIVERY_NO_DELIVERY_AVAILABLE" - | "DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE" - | "DELIVERY_OPTIONS_PHONE_NUMBER_INVALID" - | "DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED" - | "DELIVERY_PHONE_NUMBER_INVALID" - | "DELIVERY_PHONE_NUMBER_REQUIRED" - | "DELIVERY_POSTAL_CODE_INVALID" - | "DELIVERY_POSTAL_CODE_REQUIRED" - | "DELIVERY_ZONE_NOT_FOUND" - | "DELIVERY_ZONE_REQUIRED_FOR_COUNTRY" - | "ERROR" - | "MERCHANDISE_LINE_LIMIT_REACHED" - | "MERCHANDISE_NOT_APPLICABLE" - | "MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE" - | "MERCHANDISE_OUT_OF_STOCK" - | "MERCHANDISE_PRODUCT_NOT_PUBLISHED" - | "NO_DELIVERY_GROUP_SELECTED" - | "PAYMENTS_ADDRESS1_INVALID" - | "PAYMENTS_ADDRESS1_REQUIRED" - | "PAYMENTS_ADDRESS1_TOO_LONG" - | "PAYMENTS_ADDRESS2_INVALID" - | "PAYMENTS_ADDRESS2_REQUIRED" - | "PAYMENTS_ADDRESS2_TOO_LONG" - | "PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND" - | "PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY" - | "PAYMENTS_CITY_INVALID" - | "PAYMENTS_CITY_REQUIRED" - | "PAYMENTS_CITY_TOO_LONG" - | "PAYMENTS_COMPANY_INVALID" - | "PAYMENTS_COMPANY_REQUIRED" - | "PAYMENTS_COMPANY_TOO_LONG" - | "PAYMENTS_COUNTRY_REQUIRED" - | "PAYMENTS_CREDIT_CARD_BASE_EXPIRED" - | "PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED" - | "PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT" - | "PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED" - | "PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK" - | "PAYMENTS_CREDIT_CARD_GENERIC" - | "PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK" - | "PAYMENTS_CREDIT_CARD_MONTH_INCLUSION" - | "PAYMENTS_CREDIT_CARD_NAME_INVALID" - | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID" - | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT" - | "PAYMENTS_CREDIT_CARD_SESSION_ID" - | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK" - | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE" - | "PAYMENTS_CREDIT_CARD_YEAR_EXPIRED" - | "PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR" - | "PAYMENTS_FIRST_NAME_INVALID" - | "PAYMENTS_FIRST_NAME_REQUIRED" - | "PAYMENTS_FIRST_NAME_TOO_LONG" - | "PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY" - | "PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE" - | "PAYMENTS_LAST_NAME_INVALID" - | "PAYMENTS_LAST_NAME_REQUIRED" - | "PAYMENTS_LAST_NAME_TOO_LONG" - | "PAYMENTS_METHOD_REQUIRED" - | "PAYMENTS_METHOD_UNAVAILABLE" - | "PAYMENTS_PHONE_NUMBER_INVALID" - | "PAYMENTS_PHONE_NUMBER_REQUIRED" - | "PAYMENTS_POSTAL_CODE_INVALID" - | "PAYMENTS_POSTAL_CODE_REQUIRED" - | "PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED" - | "PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT" - | "PAYMENTS_WALLET_CONTENT_MISSING" - | "TAXES_DELIVERY_GROUP_ID_NOT_FOUND" - | "TAXES_LINE_ID_NOT_FOUND" - | "TAXES_MUST_BE_DEFINED"; + | 'BUYER_IDENTITY_EMAIL_IS_INVALID' + | 'BUYER_IDENTITY_EMAIL_REQUIRED' + | 'BUYER_IDENTITY_PHONE_IS_INVALID' + | 'DELIVERY_ADDRESS1_INVALID' + | 'DELIVERY_ADDRESS1_REQUIRED' + | 'DELIVERY_ADDRESS1_TOO_LONG' + | 'DELIVERY_ADDRESS2_INVALID' + | 'DELIVERY_ADDRESS2_REQUIRED' + | 'DELIVERY_ADDRESS2_TOO_LONG' + | 'DELIVERY_ADDRESS_REQUIRED' + | 'DELIVERY_CITY_INVALID' + | 'DELIVERY_CITY_REQUIRED' + | 'DELIVERY_CITY_TOO_LONG' + | 'DELIVERY_COMPANY_INVALID' + | 'DELIVERY_COMPANY_REQUIRED' + | 'DELIVERY_COMPANY_TOO_LONG' + | 'DELIVERY_COUNTRY_REQUIRED' + | 'DELIVERY_FIRST_NAME_INVALID' + | 'DELIVERY_FIRST_NAME_REQUIRED' + | 'DELIVERY_FIRST_NAME_TOO_LONG' + | 'DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY' + | 'DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE' + | 'DELIVERY_LAST_NAME_INVALID' + | 'DELIVERY_LAST_NAME_REQUIRED' + | 'DELIVERY_LAST_NAME_TOO_LONG' + | 'DELIVERY_NO_DELIVERY_AVAILABLE' + | 'DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE' + | 'DELIVERY_OPTIONS_PHONE_NUMBER_INVALID' + | 'DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED' + | 'DELIVERY_PHONE_NUMBER_INVALID' + | 'DELIVERY_PHONE_NUMBER_REQUIRED' + | 'DELIVERY_POSTAL_CODE_INVALID' + | 'DELIVERY_POSTAL_CODE_REQUIRED' + | 'DELIVERY_ZONE_NOT_FOUND' + | 'DELIVERY_ZONE_REQUIRED_FOR_COUNTRY' + | 'ERROR' + | 'MERCHANDISE_LINE_LIMIT_REACHED' + | 'MERCHANDISE_NOT_APPLICABLE' + | 'MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE' + | 'MERCHANDISE_OUT_OF_STOCK' + | 'MERCHANDISE_PRODUCT_NOT_PUBLISHED' + | 'NO_DELIVERY_GROUP_SELECTED' + | 'PAYMENTS_ADDRESS1_INVALID' + | 'PAYMENTS_ADDRESS1_REQUIRED' + | 'PAYMENTS_ADDRESS1_TOO_LONG' + | 'PAYMENTS_ADDRESS2_INVALID' + | 'PAYMENTS_ADDRESS2_REQUIRED' + | 'PAYMENTS_ADDRESS2_TOO_LONG' + | 'PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND' + | 'PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY' + | 'PAYMENTS_CITY_INVALID' + | 'PAYMENTS_CITY_REQUIRED' + | 'PAYMENTS_CITY_TOO_LONG' + | 'PAYMENTS_COMPANY_INVALID' + | 'PAYMENTS_COMPANY_REQUIRED' + | 'PAYMENTS_COMPANY_TOO_LONG' + | 'PAYMENTS_COUNTRY_REQUIRED' + | 'PAYMENTS_CREDIT_CARD_BASE_EXPIRED' + | 'PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED' + | 'PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' + | 'PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED' + | 'PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK' + | 'PAYMENTS_CREDIT_CARD_GENERIC' + | 'PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK' + | 'PAYMENTS_CREDIT_CARD_MONTH_INCLUSION' + | 'PAYMENTS_CREDIT_CARD_NAME_INVALID' + | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID' + | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT' + | 'PAYMENTS_CREDIT_CARD_SESSION_ID' + | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK' + | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' + | 'PAYMENTS_CREDIT_CARD_YEAR_EXPIRED' + | 'PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR' + | 'PAYMENTS_FIRST_NAME_INVALID' + | 'PAYMENTS_FIRST_NAME_REQUIRED' + | 'PAYMENTS_FIRST_NAME_TOO_LONG' + | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY' + | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE' + | 'PAYMENTS_LAST_NAME_INVALID' + | 'PAYMENTS_LAST_NAME_REQUIRED' + | 'PAYMENTS_LAST_NAME_TOO_LONG' + | 'PAYMENTS_METHOD_REQUIRED' + | 'PAYMENTS_METHOD_UNAVAILABLE' + | 'PAYMENTS_PHONE_NUMBER_INVALID' + | 'PAYMENTS_PHONE_NUMBER_REQUIRED' + | 'PAYMENTS_POSTAL_CODE_INVALID' + | 'PAYMENTS_POSTAL_CODE_REQUIRED' + | 'PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED' + | 'PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT' + | 'PAYMENTS_WALLET_CONTENT_MISSING' + | 'TAXES_DELIVERY_GROUP_ID_NOT_FOUND' + | 'TAXES_LINE_ID_NOT_FOUND' + | 'TAXES_MUST_BE_DEFINED'; /** Cart submit for checkout completion is successful. */ export type SubmitAlreadyAccepted = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars["String"]["output"]; + attemptId: Scalars['String']['output']; }; /** Cart submit for checkout completion failed. */ export type SubmitFailed = { /** The URL of the checkout for the cart. */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** The list of errors that occurred from executing the mutation. */ errors: Array; }; @@ -7155,7 +7448,7 @@ export type SubmitFailed = { /** Cart submit for checkout completion is already accepted. */ export type SubmitSuccess = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars["String"]["output"]; + attemptId: Scalars['String']['output']; }; /** Cart submit for checkout completion is throttled. */ @@ -7164,27 +7457,29 @@ export type SubmitThrottled = { * UTC date time string that indicates the time after which clients should make their next * poll request. Any poll requests sent before this time will be ignored. Use this value to schedule the * next poll request. + * */ - pollAfter: Scalars["DateTime"]["output"]; + pollAfter: Scalars['DateTime']['output']; }; /** * Specifies the fields required to complete a checkout with * a tokenized payment. + * */ export type TokenizedPaymentInputV3 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars["String"]["input"]; + idempotencyKey: Scalars['String']['input']; /** Public Hash Key used for AndroidPay payments only. */ - identifier?: InputMaybe; + identifier?: InputMaybe; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars["String"]["input"]; + paymentData: Scalars['String']['input']; /** Whether to execute the payment in test mode, if possible. Test mode isn't supported in production stores. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The type of payment token. */ type: PaymentTokenType; }; @@ -7192,7 +7487,7 @@ export type TokenizedPaymentInputV3 = { /** Represents a resource that you can track the origin of the search traffic. */ export type Trackable = { /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** An object representing exchange of money for a product or service. */ @@ -7214,7 +7509,7 @@ export type Transaction = { /** The status of the transaction. */ statusV2?: Maybe; /** Whether the transaction was done in test mode or not. */ - test: Scalars["Boolean"]["output"]; + test: Scalars['Boolean']['output']; }; /** The different kinds of order transactions. */ @@ -7222,30 +7517,32 @@ export type TransactionKind = /** * An amount reserved against the cardholder's funding source. * Money does not change hands until the authorization is captured. + * */ - | "AUTHORIZATION" + | 'AUTHORIZATION' /** A transfer of the money that was reserved during the authorization stage. */ - | "CAPTURE" + | 'CAPTURE' /** Money returned to the customer when they have paid too much. */ - | "CHANGE" + | 'CHANGE' /** An authorization for a payment taken with an EMV credit card reader. */ - | "EMV_AUTHORIZATION" + | 'EMV_AUTHORIZATION' /** An authorization and capture performed together in a single step. */ - | "SALE"; + | 'SALE'; /** Transaction statuses describe the status of a transaction. */ export type TransactionStatus = /** There was an error while processing the transaction. */ - | "ERROR" + | 'ERROR' /** The transaction failed. */ - | "FAILURE" + | 'FAILURE' /** The transaction is pending. */ - | "PENDING" + | 'PENDING' /** The transaction succeeded. */ - | "SUCCESS"; + | 'SUCCESS'; /** * The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). + * */ export type UnitPriceMeasurement = { /** The type of unit of measurement for the unit price measurement. */ @@ -7253,68 +7550,69 @@ export type UnitPriceMeasurement = { /** The quantity unit for the unit price measurement. */ quantityUnit?: Maybe; /** The quantity value for the unit price measurement. */ - quantityValue: Scalars["Float"]["output"]; + quantityValue: Scalars['Float']['output']; /** The reference unit for the unit price measurement. */ referenceUnit?: Maybe; /** The reference value for the unit price measurement. */ - referenceValue: Scalars["Int"]["output"]; + referenceValue: Scalars['Int']['output']; }; /** The accepted types of unit of measurement. */ export type UnitPriceMeasurementMeasuredType = /** Unit of measurements representing areas. */ - | "AREA" + | 'AREA' /** Unit of measurements representing lengths. */ - | "LENGTH" + | 'LENGTH' /** Unit of measurements representing volumes. */ - | "VOLUME" + | 'VOLUME' /** Unit of measurements representing weights. */ - | "WEIGHT"; + | 'WEIGHT'; /** The valid units of measurement for a unit price measurement. */ export type UnitPriceMeasurementMeasuredUnit = /** 100 centiliters equals 1 liter. */ - | "CL" + | 'CL' /** 100 centimeters equals 1 meter. */ - | "CM" + | 'CM' /** Metric system unit of weight. */ - | "G" + | 'G' /** 1 kilogram equals 1000 grams. */ - | "KG" + | 'KG' /** Metric system unit of volume. */ - | "L" + | 'L' /** Metric system unit of length. */ - | "M" + | 'M' /** Metric system unit of area. */ - | "M2" + | 'M2' /** 1 cubic meter equals 1000 liters. */ - | "M3" + | 'M3' /** 1000 milligrams equals 1 gram. */ - | "MG" + | 'MG' /** 1000 milliliters equals 1 liter. */ - | "ML" + | 'ML' /** 1000 millimeters equals 1 meter. */ - | "MM"; + | 'MM'; /** Systems of weights and measures. */ export type UnitSystem = /** Imperial system of weights and measures. */ - | "IMPERIAL_SYSTEM" + | 'IMPERIAL_SYSTEM' /** Metric system of weights and measures. */ - | "METRIC_SYSTEM"; + | 'METRIC_SYSTEM'; /** A redirect on the online store. */ export type UrlRedirect = Node & { /** The ID of the URL redirect. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. */ - path: Scalars["String"]["output"]; + path: Scalars['String']['output']; /** The target location where the user will be redirected to. */ - target: Scalars["String"]["output"]; + target: Scalars['String']['output']; }; /** * An auto-generated type for paginating through multiple UrlRedirects. + * */ export type UrlRedirectConnection = { /** A list of edges. */ @@ -7327,10 +7625,11 @@ export type UrlRedirectConnection = { /** * An auto-generated type which holds one UrlRedirect and a cursor during pagination. + * */ export type UrlRedirectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of UrlRedirectEdge. */ node: UrlRedirect; }; @@ -7338,25 +7637,25 @@ export type UrlRedirectEdge = { /** Represents an error in the input of a mutation. */ export type UserError = DisplayableError & { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars["String"]["output"]; + message: Scalars['String']['output']; }; /** The input fields for a filter used to view a subset of products in a collection matching a specific variant option. */ export type VariantOptionFilter = { /** The name of the variant option to filter on. */ - name: Scalars["String"]["input"]; + name: Scalars['String']['input']; /** The value of the variant option to filter on. */ - value: Scalars["String"]["input"]; + value: Scalars['String']['input']; }; /** Represents a Shopify hosted video. */ export type Video = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars["ID"]["output"]; + id: Scalars['ID']['output']; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -7370,723 +7669,91 @@ export type Video = Media & Node & { /** Represents a source for a Shopify hosted video. */ export type VideoSource = { /** The format of the video source. */ - format: Scalars["String"]["output"]; + format: Scalars['String']['output']; /** The height of the video. */ - height: Scalars["Int"]["output"]; + height: Scalars['Int']['output']; /** The video MIME type. */ - mimeType: Scalars["String"]["output"]; + mimeType: Scalars['String']['output']; /** The URL of the video. */ - url: Scalars["String"]["output"]; + url: Scalars['String']['output']; /** The width of the video. */ - width: Scalars["Int"]["output"]; + width: Scalars['Int']['output']; }; /** Units of measurement for weight. */ export type WeightUnit = /** Metric system unit of mass. */ - | "GRAMS" + | 'GRAMS' /** 1 kilogram equals 1000 grams. */ - | "KILOGRAMS" + | 'KILOGRAMS' /** Imperial system unit of mass. */ - | "OUNCES" + | 'OUNCES' /** 1 pound equals 16 ounces. */ - | "POUNDS"; + | 'POUNDS'; export type AddItemToCartMutationVariables = Exact<{ - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; lines: Array | CartLineInput; }>; -export type AddItemToCartMutation = { - payload?: { - cart?: { - id: string; - checkoutUrl: any; - totalQuantity: number; - lines: { - nodes: Array< - { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } | { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } - >; - }; - cost: { - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - totalAmount: { amount: any; currencyCode: CurrencyCode }; - checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; - }; - discountCodes: Array<{ code: string; applicable: boolean }>; - discountAllocations: Array< - { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { - discountedAmount: { amount: any; currencyCode: CurrencyCode }; - } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } - >; - } | null; - } | null; -}; + +export type AddItemToCartMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; export type AddCouponMutationVariables = Exact<{ - cartId: Scalars["ID"]["input"]; - discountCodes: Array | Scalars["String"]["input"]; + cartId: Scalars['ID']['input']; + discountCodes: Array | Scalars['String']['input']; }>; -export type AddCouponMutation = { - payload?: { - cart?: { - id: string; - checkoutUrl: any; - totalQuantity: number; - lines: { - nodes: Array< - { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } | { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } - >; - }; - cost: { - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - totalAmount: { amount: any; currencyCode: CurrencyCode }; - checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; - }; - discountCodes: Array<{ code: string; applicable: boolean }>; - discountAllocations: Array< - { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { - discountedAmount: { amount: any; currencyCode: CurrencyCode }; - } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } - >; - } | null; - userErrors: Array<{ field?: Array | null; message: string }>; - } | null; -}; + +export type AddCouponMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null, userErrors: Array<{ field?: Array | null, message: string }> } | null }; export type UpdateItemsMutationVariables = Exact<{ - cartId: Scalars["ID"]["input"]; + cartId: Scalars['ID']['input']; lines: Array | CartLineUpdateInput; }>; -export type UpdateItemsMutation = { - payload?: { - cart?: { - id: string; - checkoutUrl: any; - totalQuantity: number; - lines: { - nodes: Array< - { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } | { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } - >; - }; - cost: { - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - totalAmount: { amount: any; currencyCode: CurrencyCode }; - checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; - }; - discountCodes: Array<{ code: string; applicable: boolean }>; - discountAllocations: Array< - { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { - discountedAmount: { amount: any; currencyCode: CurrencyCode }; - } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } - >; - } | null; - } | null; -}; + +export type UpdateItemsMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; export type GetProductQueryVariables = Exact<{ - handle?: InputMaybe; + handle?: InputMaybe; }>; -export type GetProductQuery = { - product?: { - availableForSale: boolean; - createdAt: any; - description: string; - descriptionHtml: any; - handle: string; - id: string; - isGiftCard: boolean; - onlineStoreUrl?: any | null; - productType: string; - publishedAt: any; - requiresSellingPlan: boolean; - tags: Array; - title: string; - totalInventory?: number | null; - updatedAt: any; - vendor: string; - featuredImage?: { altText?: string | null; url: any } | null; - images: { nodes: Array<{ altText?: string | null; url: any }> }; - media: { - nodes: Array< - { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } - >; - }; - options: Array<{ name: string; values: Array }>; - priceRange: { - minVariantPrice: { amount: any; currencyCode: CurrencyCode }; - maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; - }; - seo: { title?: string | null; description?: string | null }; - variants: { - nodes: Array< - { - availableForSale: boolean; - barcode?: string | null; - currentlyNotInStock: boolean; - id: string; - quantityAvailable?: number | null; - requiresShipping: boolean; - sku?: string | null; - title: string; - weight?: number | null; - weightUnit: WeightUnit; - compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; - image?: { altText?: string | null; url: any } | null; - price: { amount: any; currencyCode: CurrencyCode }; - selectedOptions: Array<{ name: string; value: string }>; - unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; - unitPriceMeasurement?: { - measuredType?: UnitPriceMeasurementMeasuredType | null; - quantityValue: number; - referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; - quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; - } | null; - } - >; - }; - } | null; -}; + +export type GetProductQuery = { product?: { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } } | null }; export type ListProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; -export type ListProductsQuery = { - products: { - nodes: Array< - { - availableForSale: boolean; - createdAt: any; - description: string; - descriptionHtml: any; - handle: string; - id: string; - isGiftCard: boolean; - onlineStoreUrl?: any | null; - productType: string; - publishedAt: any; - requiresSellingPlan: boolean; - tags: Array; - title: string; - totalInventory?: number | null; - updatedAt: any; - vendor: string; - featuredImage?: { altText?: string | null; url: any } | null; - images: { nodes: Array<{ altText?: string | null; url: any }> }; - media: { - nodes: Array< - { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } - >; - }; - options: Array<{ name: string; values: Array }>; - priceRange: { - minVariantPrice: { amount: any; currencyCode: CurrencyCode }; - maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; - }; - seo: { title?: string | null; description?: string | null }; - variants: { - nodes: Array< - { - availableForSale: boolean; - barcode?: string | null; - currentlyNotInStock: boolean; - id: string; - quantityAvailable?: number | null; - requiresShipping: boolean; - sku?: string | null; - title: string; - weight?: number | null; - weightUnit: WeightUnit; - compareAtPrice?: - | { amount: any; currencyCode: CurrencyCode } - | null; - image?: { altText?: string | null; url: any } | null; - price: { amount: any; currencyCode: CurrencyCode }; - selectedOptions: Array<{ name: string; value: string }>; - unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; - unitPriceMeasurement?: { - measuredType?: UnitPriceMeasurementMeasuredType | null; - quantityValue: number; - referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; - quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; - } | null; - } - >; - }; - } - >; - }; -}; + +export type ListProductsQuery = { products: { nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; export type SearchProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; -export type SearchProductsQuery = { - products: { - pageInfo: { hasNextPage: boolean }; - nodes: Array< - { - availableForSale: boolean; - createdAt: any; - description: string; - descriptionHtml: any; - handle: string; - id: string; - isGiftCard: boolean; - onlineStoreUrl?: any | null; - productType: string; - publishedAt: any; - requiresSellingPlan: boolean; - tags: Array; - title: string; - totalInventory?: number | null; - updatedAt: any; - vendor: string; - featuredImage?: { altText?: string | null; url: any } | null; - images: { nodes: Array<{ altText?: string | null; url: any }> }; - media: { - nodes: Array< - { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } - >; - }; - options: Array<{ name: string; values: Array }>; - priceRange: { - minVariantPrice: { amount: any; currencyCode: CurrencyCode }; - maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; - }; - seo: { title?: string | null; description?: string | null }; - variants: { - nodes: Array< - { - availableForSale: boolean; - barcode?: string | null; - currentlyNotInStock: boolean; - id: string; - quantityAvailable?: number | null; - requiresShipping: boolean; - sku?: string | null; - title: string; - weight?: number | null; - weightUnit: WeightUnit; - compareAtPrice?: - | { amount: any; currencyCode: CurrencyCode } - | null; - image?: { altText?: string | null; url: any } | null; - price: { amount: any; currencyCode: CurrencyCode }; - selectedOptions: Array<{ name: string; value: string }>; - unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; - unitPriceMeasurement?: { - measuredType?: UnitPriceMeasurementMeasuredType | null; - quantityValue: number; - referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; - quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; - } | null; - } - >; - }; - } - >; - }; -}; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; - -export type CreateCartMutation = { - payload?: { cart?: { id: string } | null } | null; -}; + +export type SearchProductsQuery = { products: { pageInfo: { hasNextPage: boolean }, nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; + + +export type CreateCartMutation = { payload?: { cart?: { id: string } | null } | null }; export type GetCartQueryVariables = Exact<{ - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; }>; -export type GetCartQuery = { - cart?: { - id: string; - checkoutUrl: any; - totalQuantity: number; - lines: { - nodes: Array< - { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } | { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } - >; - }; - cost: { - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - totalAmount: { amount: any; currencyCode: CurrencyCode }; - checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; - }; - discountCodes: Array<{ code: string; applicable: boolean }>; - discountAllocations: Array< - { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { - discountedAmount: { amount: any; currencyCode: CurrencyCode }; - } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } - >; - } | null; -}; - -export type CartFragment = { - id: string; - checkoutUrl: any; - totalQuantity: number; - lines: { - nodes: Array< - { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } | { - id: string; - quantity: number; - merchandise: { - id: string; - title: string; - image?: { url: any; altText?: string | null } | null; - product: { title: string }; - price: { amount: any; currencyCode: CurrencyCode }; - }; - cost: { - totalAmount: { amount: any; currencyCode: CurrencyCode }; - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; - compareAtAmountPerQuantity?: { - amount: any; - currencyCode: CurrencyCode; - } | null; - }; - } - >; - }; - cost: { - subtotalAmount: { amount: any; currencyCode: CurrencyCode }; - totalAmount: { amount: any; currencyCode: CurrencyCode }; - checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; - }; - discountCodes: Array<{ code: string; applicable: boolean }>; - discountAllocations: Array< - { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { - discountedAmount: { amount: any; currencyCode: CurrencyCode }; - } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } - >; -}; - -export type ProductFragment = { - availableForSale: boolean; - createdAt: any; - description: string; - descriptionHtml: any; - handle: string; - id: string; - isGiftCard: boolean; - onlineStoreUrl?: any | null; - productType: string; - publishedAt: any; - requiresSellingPlan: boolean; - tags: Array; - title: string; - totalInventory?: number | null; - updatedAt: any; - vendor: string; - featuredImage?: { altText?: string | null; url: any } | null; - images: { nodes: Array<{ altText?: string | null; url: any }> }; - media: { - nodes: Array< - { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } | { - alt?: string | null; - mediaContentType: MediaContentType; - previewImage?: { altText?: string | null; url: any } | null; - } - >; - }; - options: Array<{ name: string; values: Array }>; - priceRange: { - minVariantPrice: { amount: any; currencyCode: CurrencyCode }; - maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; - }; - seo: { title?: string | null; description?: string | null }; - variants: { - nodes: Array< - { - availableForSale: boolean; - barcode?: string | null; - currentlyNotInStock: boolean; - id: string; - quantityAvailable?: number | null; - requiresShipping: boolean; - sku?: string | null; - title: string; - weight?: number | null; - weightUnit: WeightUnit; - compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; - image?: { altText?: string | null; url: any } | null; - price: { amount: any; currencyCode: CurrencyCode }; - selectedOptions: Array<{ name: string; value: string }>; - unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; - unitPriceMeasurement?: { - measuredType?: UnitPriceMeasurementMeasuredType | null; - quantityValue: number; - referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; - quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; - } | null; - } - >; - }; -}; - -export type ProductVariantFragment = { - availableForSale: boolean; - barcode?: string | null; - currentlyNotInStock: boolean; - id: string; - quantityAvailable?: number | null; - requiresShipping: boolean; - sku?: string | null; - title: string; - weight?: number | null; - weightUnit: WeightUnit; - compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; - image?: { altText?: string | null; url: any } | null; - price: { amount: any; currencyCode: CurrencyCode }; - selectedOptions: Array<{ name: string; value: string }>; - unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; - unitPriceMeasurement?: { - measuredType?: UnitPriceMeasurementMeasuredType | null; - quantityValue: number; - referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; - quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; - } | null; -}; + +export type GetCartQuery = { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null }; + +export type CartFragment = { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> }; + +export type ProductFragment = { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }; + +export type ProductVariantFragment = { availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }; diff --git a/wake/utils/graphql/storefront.graphql.gen.ts b/wake/utils/graphql/storefront.graphql.gen.ts index 9be9d2687..46a86fa2f 100644 --- a/wake/utils/graphql/storefront.graphql.gen.ts +++ b/wake/utils/graphql/storefront.graphql.gen.ts @@ -6,109 +6,98 @@ // export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { - [K in keyof T]: T[K]; -}; -export type MakeOptional = - & Omit - & { [SubKey in K]?: Maybe }; -export type MakeMaybe = - & Omit - & { [SubKey in K]: Maybe }; -export type MakeEmpty = - { [_ in K]?: never }; -export type Incremental = - | T - | { - [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; - }; +export type Exact = { [K in keyof T]: T[K] }; +export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; +export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; +export type MakeEmpty = { [_ in K]?: never }; +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string }; - String: { input: string; output: string }; - Boolean: { input: boolean; output: boolean }; - Int: { input: number; output: number }; - Float: { input: number; output: number }; - Any: { input: any; output: any }; - CEP: { input: any; output: any }; - CountryCode: { input: any; output: any }; - DateTime: { input: any; output: any }; - Decimal: { input: any; output: any }; - EmailAddress: { input: any; output: any }; - Long: { input: any; output: any }; - Upload: { input: any; output: any }; - Uuid: { input: any; output: any }; + ID: { input: string; output: string; } + String: { input: string; output: string; } + Boolean: { input: boolean; output: boolean; } + Int: { input: number; output: number; } + Float: { input: number; output: number; } + Any: { input: any; output: any; } + CEP: { input: any; output: any; } + CountryCode: { input: any; output: any; } + DateTime: { input: any; output: any; } + Decimal: { input: any; output: any; } + EmailAddress: { input: any; output: any; } + Long: { input: any; output: any; } + Upload: { input: any; output: any; } + Uuid: { input: any; output: any; } }; /** Price alert input parameters. */ export type AddPriceAlertInput = { /** The alerted's email. */ - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; /** The alerted's name. */ - name: Scalars["String"]["input"]; + name: Scalars['String']['input']; /** The product variant id to create the price alert. */ - productVariantId: Scalars["Long"]["input"]; + productVariantId: Scalars['Long']['input']; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The target price to alert. */ - targetPrice: Scalars["Decimal"]["input"]; + targetPrice: Scalars['Decimal']['input']; }; export type AddressNode = { /** Zip code. */ - cep?: Maybe; + cep?: Maybe; /** Address city. */ - city?: Maybe; + city?: Maybe; /** Address country. */ - country?: Maybe; + country?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Address state. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type Answer = { - id?: Maybe; - value?: Maybe; + id?: Maybe; + value?: Maybe; }; export type ApplyPolicy = - | "AFTER_RESOLVER" - | "BEFORE_RESOLVER"; + | 'AFTER_RESOLVER' + | 'BEFORE_RESOLVER'; /** Attributes available for the variant products from the given productId. */ export type Attribute = Node & { /** The id of the attribute. */ - attributeId: Scalars["Long"]["output"]; + attributeId: Scalars['Long']['output']; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The values of the attribute. */ values?: Maybe>>; }; export type AttributeFilterInput = { - attributeId: Scalars["Long"]["input"]; - value: Scalars["String"]["input"]; + attributeId: Scalars['Long']['input']; + value: Scalars['String']['input']; }; /** Input to specify which attributes to match. */ export type AttributeInput = { /** The attribute Ids to match. */ - id?: InputMaybe>; + id?: InputMaybe>; /** The attribute name to match. */ - name?: InputMaybe>>; + name?: InputMaybe>>; /** The attribute type to match. */ - type?: InputMaybe>>; + type?: InputMaybe>>; /** The attribute value to match */ - value?: InputMaybe>>; + value?: InputMaybe>>; }; export type AttributeMatrix = { @@ -121,31 +110,32 @@ export type AttributeMatrix = { }; export type AttributeMatrixInfo = { - displayType?: Maybe; - name?: Maybe; + displayType?: Maybe; + name?: Maybe; values?: Maybe>>; }; export type AttributeMatrixProduct = { - available: Scalars["Boolean"]["output"]; - productVariantId: Scalars["Long"]["output"]; - stock: Scalars["Long"]["output"]; + available: Scalars['Boolean']['output']; + productVariantId: Scalars['Long']['output']; + stock: Scalars['Long']['output']; }; export type AttributeMatrixRowColumnInfoValue = { - printUrl?: Maybe; - value?: Maybe; + printUrl?: Maybe; + value?: Maybe; }; + export type AttributeMatrixRowColumnInfoValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes available for the variant products from the given productId. */ export type AttributeSelection = { /** Check if the current product attributes can be rendered as a matrix. */ - canBeMatrix: Scalars["Boolean"]["output"]; + canBeMatrix: Scalars['Boolean']['output']; /** The candidate variant given the current input filters. Variant may be from brother product Id. */ candidateVariant?: Maybe; /** Informations about the attribute matrix. */ @@ -159,29 +149,30 @@ export type AttributeSelection = { /** Attributes available for the variant products from the given productId. */ export type AttributeSelectionOption = { /** The id of the attribute. */ - attributeId: Scalars["Long"]["output"]; + attributeId: Scalars['Long']['output']; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The values of the attribute. */ values?: Maybe>>; /** If the attributes varies by parent. */ - varyByParent: Scalars["Boolean"]["output"]; + varyByParent: Scalars['Boolean']['output']; }; export type AttributeSelectionOptionValue = { - alias?: Maybe; - available: Scalars["Boolean"]["output"]; - printUrl?: Maybe; - selected: Scalars["Boolean"]["output"]; + alias?: Maybe; + available: Scalars['Boolean']['output']; + printUrl?: Maybe; + selected: Scalars['Boolean']['output']; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; + export type AttributeSelectionOptionValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes values with variants */ @@ -189,7 +180,7 @@ export type AttributeValue = { /** Product variants that have the attribute. */ productVariants?: Maybe>>; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** Get query completion suggestion. */ @@ -197,57 +188,57 @@ export type Autocomplete = { /** Suggested products based on the current query. */ products?: Maybe>>; /** List of possible query completions. */ - suggestions?: Maybe>>; + suggestions?: Maybe>>; }; /** A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click. */ export type Banner = Node & { /** Banner's alternative text. */ - altText?: Maybe; + altText?: Maybe; /** Banner unique identifier. */ - bannerId: Scalars["Long"]["output"]; + bannerId: Scalars['Long']['output']; /** Banner's name. */ - bannerName?: Maybe; + bannerName?: Maybe; /** URL where the banner is stored. */ - bannerUrl?: Maybe; + bannerUrl?: Maybe; /** The date the banner was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** Field to check if the banner should be displayed on all pages. */ - displayOnAllPages: Scalars["Boolean"]["output"]; + displayOnAllPages: Scalars['Boolean']['output']; /** Field to check if the banner should be displayed on category pages. */ - displayOnCategories: Scalars["Boolean"]["output"]; + displayOnCategories: Scalars['Boolean']['output']; /** Field to check if the banner should be displayed on search pages. */ - displayOnSearches: Scalars["Boolean"]["output"]; + displayOnSearches: Scalars['Boolean']['output']; /** Field to check if the banner should be displayed on the website. */ - displayOnWebsite: Scalars["Boolean"]["output"]; + displayOnWebsite: Scalars['Boolean']['output']; /** Field to check if the banner should be displayed to partners. */ - displayToPartners: Scalars["Boolean"]["output"]; + displayToPartners: Scalars['Boolean']['output']; /** The banner's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Field to check if the banner URL should open in another tab on click. */ - openNewTab: Scalars["Boolean"]["output"]; + openNewTab: Scalars['Boolean']['output']; /** The displaying order of the banner. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** The displaying position of the banner. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the banner on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The banner's title. */ - title?: Maybe; + title?: Maybe; /** URL to be redirected on click. */ - urlOnClick?: Maybe; + urlOnClick?: Maybe; /** The banner's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the banner attribute which the result set will be sorted on. */ export type BannerSortKeys = /** The banner's creation date. */ - | "CREATION_DATE" + | 'CREATION_DATE' /** The banner's unique identifier. */ - | "ID"; + | 'ID'; /** A connection to a list of items. */ export type BannersConnection = { @@ -262,67 +253,69 @@ export type BannersConnection = { /** An edge in a connection. */ export type BannersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; export type BestInstallment = { /** Wether the installment has discount. */ - discount: Scalars["Boolean"]["output"]; + discount: Scalars['Boolean']['output']; /** The custom display name of the best installment plan option. */ - displayName?: Maybe; + displayName?: Maybe; /** Wether the installment has fees. */ - fees: Scalars["Boolean"]["output"]; + fees: Scalars['Boolean']['output']; /** The name of the best installment plan option. */ - name?: Maybe; + name?: Maybe; /** The number of installments. */ - number: Scalars["Int"]["output"]; + number: Scalars['Int']['output']; /** The value of the installment. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; /** Informations about brands and its products. */ export type Brand = Node & { /** If the brand is active at the platform. */ - active: Scalars["Boolean"]["output"]; + active: Scalars['Boolean']['output']; /** The alias for the brand's hotsite. */ - alias?: Maybe; + alias?: Maybe; /** Brand unique identifier. */ - brandId: Scalars["Long"]["output"]; + brandId: Scalars['Long']['output']; /** The date the brand was created in the database. */ - createdAt: Scalars["DateTime"]["output"]; + createdAt: Scalars['DateTime']['output']; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The brand's name. */ - name?: Maybe; + name?: Maybe; /** A list of products from the brand. */ products?: Maybe; /** The last update date. */ - updatedAt: Scalars["DateTime"]["output"]; + updatedAt: Scalars['DateTime']['output']; /** A web address to be redirected. */ - urlCarrossel?: Maybe; + urlCarrossel?: Maybe; /** A web address linked to the brand. */ - urlLink?: Maybe; + urlLink?: Maybe; /** The url of the brand's logo. */ - urlLogo?: Maybe; + urlLogo?: Maybe; }; + /** Informations about brands and its products. */ export type BrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; + /** Informations about brands and its products. */ export type BrandProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -330,21 +323,21 @@ export type BrandProductsArgs = { /** Filter brand results based on giving attributes. */ export type BrandFilterInput = { /** Its unique identifier (you may provide a list of IDs if needed). */ - brandIds?: InputMaybe>; + brandIds?: InputMaybe>; /** Its brand group unique identifier (you may provide a list of IDs if needed). */ - groupIds?: InputMaybe>; + groupIds?: InputMaybe>; /** The set of group brand names which the result item name must be included in. */ - groupNames?: InputMaybe>>; + groupNames?: InputMaybe>>; /** The set of brand names which the result item name must be included in. */ - names?: InputMaybe>>; + names?: InputMaybe>>; }; /** Define the brand attribute which the result set will be sorted on. */ export type BrandSortKeys = /** The brand unique identifier. */ - | "ID" + | 'ID' /** The brand name. */ - | "NAME"; + | 'NAME'; /** A connection to a list of items. */ export type BrandsConnection = { @@ -354,13 +347,13 @@ export type BrandsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars["Int"]["output"]; + totalCount: Scalars['Int']['output']; }; /** An edge in a connection. */ export type BrandsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; @@ -368,9 +361,9 @@ export type BrandsEdge = { /** Informations about breadcrumb. */ export type Breadcrumb = { /** Breadcrumb link. */ - link?: Maybe; + link?: Maybe; /** Breadcrumb text. */ - text?: Maybe; + text?: Maybe; }; /** BuyBox informations. */ @@ -378,11 +371,11 @@ export type BuyBox = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** Maximum price among sellers. */ - maximumPrice?: Maybe; + maximumPrice?: Maybe; /** Minimum price among sellers. */ - minimumPrice?: Maybe; + minimumPrice?: Maybe; /** Quantity of offers. */ - quantityOffers?: Maybe; + quantityOffers?: Maybe; /** List of sellers. */ sellers?: Maybe>>; }; @@ -390,61 +383,61 @@ export type BuyBox = { /** A buy list represents a list of items for sale in the store. */ export type BuyList = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ buyBox?: Maybe; - buyListId: Scalars["Int"]["output"]; + buyListId: Scalars['Int']['output']; buyListProducts?: Maybe>>; /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -452,13 +445,13 @@ export type BuyList = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -470,45 +463,46 @@ export type BuyList = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; + /** A buy list represents a list of items for sale in the store. */ export type BuyListImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Contains the id and quantity of a product in the buy list. */ export type BuyListProduct = { - productId: Scalars["Long"]["output"]; - quantity: Scalars["Int"]["output"]; + productId: Scalars['Long']['output']; + quantity: Scalars['Int']['output']; }; /** The products to calculate prices. */ export type CalculatePricesProductsInput = { - productVariantId: Scalars["Long"]["input"]; - quantity: Scalars["Int"]["input"]; + productVariantId: Scalars['Long']['input']; + quantity: Scalars['Int']['input']; }; /** A connection to a list of items. */ @@ -524,7 +518,7 @@ export type CategoriesConnection = { /** An edge in a connection. */ export type CategoriesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; @@ -532,44 +526,45 @@ export type CategoriesEdge = { /** Categories are used to arrange your products into different sections by similarity. */ export type Category = Node & { /** Category unique identifier. */ - categoryId: Scalars["Long"]["output"]; + categoryId: Scalars['Long']['output']; /** A list of child categories, if it exists. */ children?: Maybe>>; /** A description to the category. */ - description?: Maybe; + description?: Maybe; /** Field to check if the category is displayed in the store's menu. */ - displayMenu: Scalars["Boolean"]["output"]; + displayMenu: Scalars['Boolean']['output']; /** The hotsite alias. */ - hotsiteAlias?: Maybe; + hotsiteAlias?: Maybe; /** The URL path for the category. */ - hotsiteUrl?: Maybe; + hotsiteUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url to access the image linked to the category. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The web address to access the image linked to the category. */ - imageUrlLink?: Maybe; + imageUrlLink?: Maybe; /** The category's name. */ - name?: Maybe; + name?: Maybe; /** The parent category, if it exists. */ parent?: Maybe; /** The parent category unique identifier. */ - parentCategoryId: Scalars["Long"]["output"]; + parentCategoryId: Scalars['Long']['output']; /** The position the category will be displayed. */ - position: Scalars["Int"]["output"]; + position: Scalars['Int']['output']; /** A list of products associated with the category. */ products?: Maybe; /** A web address linked to the category. */ - urlLink?: Maybe; + urlLink?: Maybe; }; + /** Categories are used to arrange your products into different sections by similarity. */ export type CategoryProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -577,24 +572,24 @@ export type CategoryProductsArgs = { /** Define the category attribute which the result set will be sorted on. */ export type CategorySortKeys = /** The category unique identifier. */ - | "ID" + | 'ID' /** The category name. */ - | "NAME"; + | 'NAME'; export type Checkout = Node & { /** The CEP. */ - cep?: Maybe; + cep?: Maybe; /** The checkout unique identifier. */ - checkoutId: Scalars["Uuid"]["output"]; + checkoutId: Scalars['Uuid']['output']; /** Indicates if the checkout is completed. */ - completed: Scalars["Boolean"]["output"]; + completed: Scalars['Boolean']['output']; /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** The customer associated with the checkout. */ customer?: Maybe; /** The node unique identifier. */ - id?: Maybe; - login?: Maybe; + id?: Maybe; + login?: Maybe; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The checkout orders informations. */ @@ -608,67 +603,67 @@ export type Checkout = Node & { /** Selected Shipping. */ selectedShipping?: Maybe; /** The shipping fee. */ - shippingFee: Scalars["Decimal"]["output"]; + shippingFee: Scalars['Decimal']['output']; /** The subtotal value. */ - subtotal: Scalars["Decimal"]["output"]; + subtotal: Scalars['Decimal']['output']; /** The total value. */ - total: Scalars["Decimal"]["output"]; + total: Scalars['Decimal']['output']; /** The last update date. */ - updateDate: Scalars["DateTime"]["output"]; + updateDate: Scalars['DateTime']['output']; /** Url for the current checkout id. */ - url?: Maybe; + url?: Maybe; }; /** Represents an address node in the checkout. */ export type CheckoutAddress = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep: Scalars["Int"]["output"]; + cep: Scalars['Int']['output']; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The neighborhood of the address. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; /** Represents a customer node in the checkout. */ export type CheckoutCustomer = { /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** The credit limit of the customer. */ - creditLimit: Scalars["Decimal"]["output"]; + creditLimit: Scalars['Decimal']['output']; /** The credit limit balance of the customer. */ - creditLimitBalance: Scalars["Decimal"]["output"]; + creditLimitBalance: Scalars['Decimal']['output']; /** Customer's unique identifier. */ - customerId: Scalars["Long"]["output"]; + customerId: Scalars['Long']['output']; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** The email address of the customer. */ - email?: Maybe; + email?: Maybe; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; }; export type CheckoutCustomizationInput = { - customizationId: Scalars["Long"]["input"]; - value?: InputMaybe; + customizationId: Scalars['Long']['input']; + value?: InputMaybe; }; export type CheckoutMetadataInput = { - key?: InputMaybe; - value?: InputMaybe; + key?: InputMaybe; + value?: InputMaybe; }; /** Represents a node in the checkout order. */ @@ -676,17 +671,17 @@ export type CheckoutOrder = { /** The list of adjustments applied to the order. */ adjustments?: Maybe>>; /** The date of the order. */ - date: Scalars["DateTime"]["output"]; + date: Scalars['DateTime']['output']; /** Details of the delivery or store pickup. */ delivery?: Maybe; /** The discount value of the order. */ - discountValue: Scalars["Decimal"]["output"]; + discountValue: Scalars['Decimal']['output']; /** The dispatch time text from the shop settings. */ - dispatchTimeText?: Maybe; + dispatchTimeText?: Maybe; /** The interest value of the order. */ - interestValue: Scalars["Decimal"]["output"]; + interestValue: Scalars['Decimal']['output']; /** The ID of the order. */ - orderId: Scalars["Long"]["output"]; + orderId: Scalars['Long']['output']; /** The order status. */ orderStatus: OrderStatus; /** The payment information. */ @@ -694,39 +689,39 @@ export type CheckoutOrder = { /** The list of products in the order. */ products?: Maybe>>; /** The shipping value of the order. */ - shippingValue: Scalars["Decimal"]["output"]; + shippingValue: Scalars['Decimal']['output']; /** The total value of the order. */ - totalValue: Scalars["Decimal"]["output"]; + totalValue: Scalars['Decimal']['output']; }; /** The delivery or store Pickup Address. */ export type CheckoutOrderAddress = { /** The street address. */ - address?: Maybe; + address?: Maybe; /** The ZIP code. */ - cep?: Maybe; + cep?: Maybe; /** The city. */ - city?: Maybe; + city?: Maybe; /** Additional information or details about the address. */ - complement?: Maybe; + complement?: Maybe; /** Indicates whether the order is for store pickup. */ - isPickupStore: Scalars["Boolean"]["output"]; + isPickupStore: Scalars['Boolean']['output']; /** The name. */ - name?: Maybe; + name?: Maybe; /** The neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** . */ - pickupStoreText?: Maybe; + pickupStoreText?: Maybe; }; /** Represents an adjustment applied to checkout. */ export type CheckoutOrderAdjustment = { /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; /** The delivery or store pickup details. */ @@ -734,19 +729,19 @@ export type CheckoutOrderDelivery = { /** The delivery or store pickup address. */ address?: Maybe; /** The cost of delivery or pickup. */ - cost: Scalars["Decimal"]["output"]; + cost: Scalars['Decimal']['output']; /** The estimated delivery or pickup time, in days. */ - deliveryTime: Scalars["Int"]["output"]; + deliveryTime: Scalars['Int']['output']; /** The name of the recipient. */ - name?: Maybe; + name?: Maybe; }; /** The invoice payment information. */ export type CheckoutOrderInvoicePayment = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; /** The checkout order payment. */ @@ -754,7 +749,7 @@ export type CheckoutOrderPayment = { /** The bank invoice payment information. */ invoice?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; /** The Pix payment information. */ pix?: Maybe; }; @@ -762,11 +757,11 @@ export type CheckoutOrderPayment = { /** This represents a Pix payment node in the checkout order. */ export type CheckoutOrderPixPayment = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; /** Represents a node in the checkout order products. */ @@ -776,156 +771,157 @@ export type CheckoutOrderProduct = { /** The list of attributes of the product. */ attributes?: Maybe>>; /** The image URL of the product. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the product. */ - name?: Maybe; + name?: Maybe; /** The ID of the product variant. */ - productVariantId: Scalars["Long"]["output"]; + productVariantId: Scalars['Long']['output']; /** The quantity of the product. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The value of the product. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; /** Represents an adjustment applied to a product in the checkout order. */ export type CheckoutOrderProductAdjustment = { /** Additional information about the adjustment. */ - additionalInformation?: Maybe; + additionalInformation?: Maybe; /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; /** Represents an attribute of a product. */ export type CheckoutOrderProductAttribute = { /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductAttributeNode = { /** The attribute name */ - name?: Maybe; + name?: Maybe; /** The attribute type */ - type: Scalars["Int"]["output"]; + type: Scalars['Int']['output']; /** The attribute value */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductInput = { - id: Scalars["Uuid"]["input"]; + id: Scalars['Uuid']['input']; products: Array>; }; export type CheckoutProductItemInput = { customization?: InputMaybe>>; metadata?: InputMaybe>>; - productVariantId: Scalars["Long"]["input"]; - quantity: Scalars["Int"]["input"]; + productVariantId: Scalars['Long']['input']; + quantity: Scalars['Int']['input']; subscription?: InputMaybe; }; export type CheckoutProductNode = { /** The product adjusted price */ - ajustedPrice: Scalars["Decimal"]["output"]; + ajustedPrice: Scalars['Decimal']['output']; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** The product brand */ - brand?: Maybe; + brand?: Maybe; /** The product category */ - category?: Maybe; + category?: Maybe; /** If the product is a gift */ - gift: Scalars["Boolean"]["output"]; + gift: Scalars['Boolean']['output']; /** The product Google category */ - googleCategory?: Maybe>>; + googleCategory?: Maybe>>; /** The product URL image */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The product informations */ - informations?: Maybe>>; + informations?: Maybe>>; /** The product installment fee */ - installmentFee: Scalars["Boolean"]["output"]; + installmentFee: Scalars['Boolean']['output']; /** The product installment value */ - installmentValue: Scalars["Decimal"]["output"]; + installmentValue: Scalars['Decimal']['output']; /** The product list price */ - listPrice: Scalars["Decimal"]["output"]; + listPrice: Scalars['Decimal']['output']; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The product name */ - name?: Maybe; + name?: Maybe; /** The product number of installments */ - numberOfInstallments: Scalars["Int"]["output"]; + numberOfInstallments: Scalars['Int']['output']; /** The product price */ - price: Scalars["Decimal"]["output"]; + price: Scalars['Decimal']['output']; /** The product attributes */ productAttributes?: Maybe>>; /** The product unique identifier */ - productId: Scalars["Long"]["output"]; + productId: Scalars['Long']['output']; /** The product variant unique identifier */ - productVariantId: Scalars["Long"]["output"]; + productVariantId: Scalars['Long']['output']; /** The product quantity */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The product shipping deadline */ shippingDeadline?: Maybe; /** The product SKU */ - sku?: Maybe; + sku?: Maybe; /** The product URL */ - url?: Maybe; + url?: Maybe; }; + export type CheckoutProductNodeAttributeSelectionsArgs = { selected?: InputMaybe>>; }; export type CheckoutShippingDeadlineNode = { /** The shipping deadline */ - deadline: Scalars["Int"]["output"]; + deadline: Scalars['Int']['output']; /** The shipping description */ - description?: Maybe; + description?: Maybe; /** The shipping second description */ - secondDescription?: Maybe; + secondDescription?: Maybe; /** The shipping second title */ - secondTitle?: Maybe; + secondTitle?: Maybe; /** The shipping title */ - title?: Maybe; + title?: Maybe; }; export type CheckoutSubscriptionInput = { - recurringTypeId: Scalars["Int"]["input"]; - subscriptionGroupId: Scalars["Long"]["input"]; + recurringTypeId: Scalars['Int']['input']; + subscriptionGroupId: Scalars['Long']['input']; }; /** Contents are used to show things to the user. */ export type Content = Node & { /** The content in html to be displayed. */ - content?: Maybe; + content?: Maybe; /** Content unique identifier. */ - contentId: Scalars["Long"]["output"]; + contentId: Scalars['Long']['output']; /** The date the content was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** The content's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The content's position. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the content on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The content's title. */ - title?: Maybe; + title?: Maybe; /** The content's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the content attribute which the result set will be sorted on. */ export type ContentSortKeys = /** The content's creation date. */ - | "CreationDate" + | 'CreationDate' /** The content's unique identifier. */ - | "ID"; + | 'ID'; /** A connection to a list of items. */ export type ContentsConnection = { @@ -940,24 +936,24 @@ export type ContentsConnection = { /** An edge in a connection. */ export type ContentsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; export type CreateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber: Scalars["String"]["input"]; - cep: Scalars["CEP"]["input"]; - city: Scalars["String"]["input"]; - country: Scalars["CountryCode"]["input"]; - email: Scalars["EmailAddress"]["input"]; - name: Scalars["String"]["input"]; - neighborhood: Scalars["String"]["input"]; - phone: Scalars["String"]["input"]; - referencePoint?: InputMaybe; - state: Scalars["String"]["input"]; - street: Scalars["String"]["input"]; + addressDetails?: InputMaybe; + addressNumber: Scalars['String']['input']; + cep: Scalars['CEP']['input']; + city: Scalars['String']['input']; + country: Scalars['CountryCode']['input']; + email: Scalars['EmailAddress']['input']; + name: Scalars['String']['input']; + neighborhood: Scalars['String']['input']; + phone: Scalars['String']['input']; + referencePoint?: InputMaybe; + state: Scalars['String']['input']; + street: Scalars['String']['input']; }; /** A customer from the store. */ @@ -965,35 +961,35 @@ export type Customer = Node & { /** Customer's addresses. */ addresses?: Maybe>>; /** Customer's birth date. */ - birthDate: Scalars["DateTime"]["output"]; + birthDate: Scalars['DateTime']['output']; /** Customer's business phone number. */ - businessPhoneNumber?: Maybe; + businessPhoneNumber?: Maybe; /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Entities legal name. */ - companyName?: Maybe; + companyName?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** Creation Date. */ - creationDate: Scalars["DateTime"]["output"]; + creationDate: Scalars['DateTime']['output']; /** Customer's unique identifier. */ - customerId: Scalars["Long"]["output"]; + customerId: Scalars['Long']['output']; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** Indicates if it is a natural person or company profile. */ - customerType?: Maybe; + customerType?: Maybe; /** Customer's delivery address. */ deliveryAddress?: Maybe; /** Customer's email address. */ - email?: Maybe; + email?: Maybe; /** Customer's gender. */ - gender?: Maybe; + gender?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Customer information groups. */ informationGroups?: Maybe>>; /** Customer's mobile phone number. */ - mobilePhoneNumber?: Maybe; + mobilePhoneNumber?: Maybe; /** List of orders placed by the customer. */ orders?: Maybe; /** Statistics about the orders the customer made in a specific timeframe. */ @@ -1001,332 +997,335 @@ export type Customer = Node & { /** Get info about the associated partners. */ partners?: Maybe>>; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Customer's residential address. */ residentialAddress?: Maybe; /** Responsible's name. */ - responsibleName?: Maybe; + responsibleName?: Maybe; /** Registration number Id. */ - rg?: Maybe; + rg?: Maybe; /** State registration number. */ - stateRegistration?: Maybe; + stateRegistration?: Maybe; /** Date of the last update. */ - updateDate: Scalars["DateTime"]["output"]; + updateDate: Scalars['DateTime']['output']; /** Customer wishlist. */ wishlist?: Maybe; }; + /** A customer from the store. */ export type CustomerOrdersArgs = { - offset?: InputMaybe; + offset?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; + /** A customer from the store. */ export type CustomerOrdersStatisticsArgs = { - dateGte?: InputMaybe; - dateLt?: InputMaybe; - onlyPaidOrders?: Scalars["Boolean"]["input"]; - partnerId?: InputMaybe; + dateGte?: InputMaybe; + dateLt?: InputMaybe; + onlyPaidOrders?: Scalars['Boolean']['input']; + partnerId?: InputMaybe; }; + /** A customer from the store. */ export type CustomerWishlistArgs = { - productsIds?: InputMaybe>>; + productsIds?: InputMaybe>>; }; export type CustomerAccessToken = { - isMaster: Scalars["Boolean"]["output"]; - token?: Maybe; + isMaster: Scalars['Boolean']['output']; + token?: Maybe; /** The user login type */ type?: Maybe; - validUntil: Scalars["DateTime"]["output"]; + validUntil: Scalars['DateTime']['output']; }; /** The input to authenticate a user. */ export type CustomerAccessTokenInput = { - email: Scalars["String"]["input"]; - password: Scalars["String"]["input"]; + email: Scalars['String']['input']; + password: Scalars['String']['input']; }; export type CustomerAddressNode = Node & { /** Address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** zip code. */ - cep?: Maybe; + cep?: Maybe; /** address city. */ - city?: Maybe; + city?: Maybe; /** Country. */ - country?: Maybe; + country?: Maybe; /** The email of the customer address. */ - email?: Maybe; + email?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the customer address. */ - name?: Maybe; + name?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The phone of the customer address. */ - phone?: Maybe; + phone?: Maybe; /** Address reference point. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** State. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type CustomerCreateInput = { /** The street address for the registered address. */ - address?: InputMaybe; + address?: InputMaybe; /** The street address for the registered address. */ - address2?: InputMaybe; + address2?: InputMaybe; /** Any additional information related to the registered address. */ - addressComplement?: InputMaybe; + addressComplement?: InputMaybe; /** The building number for the registered address. */ - addressNumber?: InputMaybe; + addressNumber?: InputMaybe; /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The CEP for the registered address. */ - cep?: InputMaybe; + cep?: InputMaybe; /** The city for the registered address. */ - city?: InputMaybe; + city?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The country for the registered address. */ - country?: InputMaybe; + country?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The neighborhood for the registered address. */ - neighborhood?: InputMaybe; + neighborhood?: InputMaybe; /** Indicates if the customer has subscribed to the newsletter. */ - newsletter?: InputMaybe; + newsletter?: InputMaybe; /** The password for the customer's account. */ - password?: InputMaybe; + password?: InputMaybe; /** The password confirmation for the customer's account. */ - passwordConfirmation?: InputMaybe; + passwordConfirmation?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The name of the receiver for the registered address. */ - receiverName?: InputMaybe; + receiverName?: InputMaybe; /** A reference point or description to help locate the registered address. */ - reference?: InputMaybe; + reference?: InputMaybe; /** Indicates if the customer is a reseller. */ - reseller?: InputMaybe; + reseller?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state for the registered address. */ - state?: InputMaybe; + state?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** The input to change the user email. */ export type CustomerEmailChangeInput = { /** The new email. */ - newEmail: Scalars["String"]["input"]; + newEmail: Scalars['String']['input']; }; export type CustomerInformationGroupFieldNode = { /** The field name. */ - name?: Maybe; + name?: Maybe; /** The field order. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** If the field is required. */ - required: Scalars["Boolean"]["output"]; + required: Scalars['Boolean']['output']; /** The field value. */ - value?: Maybe; + value?: Maybe; }; export type CustomerInformationGroupNode = { /** The group exibition name. */ - exibitionName?: Maybe; + exibitionName?: Maybe; /** The group fields. */ fields?: Maybe>>; /** The group name. */ - name?: Maybe; + name?: Maybe; }; export type CustomerOrderCollectionSegment = { items?: Maybe>>; - page: Scalars["Int"]["output"]; - pageSize: Scalars["Int"]["output"]; - totalCount: Scalars["Int"]["output"]; + page: Scalars['Int']['output']; + pageSize: Scalars['Int']['output']; + totalCount: Scalars['Int']['output']; }; /** Define the order attribute which the result set will be sorted on. */ export type CustomerOrderSortKeys = /** The total order value. */ - | "AMOUNT" + | 'AMOUNT' /** The date the order was placed. */ - | "DATE" + | 'DATE' /** The order ID. */ - | "ID" + | 'ID' /** The order current status. */ - | "STATUS"; + | 'STATUS'; export type CustomerOrdersStatistics = { /** The number of products the customer made from the number of orders. */ - productsQuantity: Scalars["Int"]["output"]; + productsQuantity: Scalars['Int']['output']; /** The number of orders the customer made. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; }; export type CustomerPartnerNode = { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; }; /** The input to change the user password. */ export type CustomerPasswordChangeInputGraphInput = { /** The current password. */ - currentPassword: Scalars["String"]["input"]; + currentPassword: Scalars['String']['input']; /** The new password. */ - newPassword: Scalars["String"]["input"]; + newPassword: Scalars['String']['input']; }; export type CustomerSimpleCreateInputGraphInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; export type CustomerUpdateInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The Brazilian register identification number for individuals. */ - rg?: InputMaybe; + rg?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** Some products can have customizations, such as writing your name on it or other predefined options. */ export type Customization = Node & { /** Cost of customization. */ - cost: Scalars["Decimal"]["output"]; + cost: Scalars['Decimal']['output']; /** Customization unique identifier. */ - customizationId: Scalars["Long"]["output"]; + customizationId: Scalars['Long']['output']; /** Customization group's name. */ - groupName?: Maybe; + groupName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Maximum allowed size of the field. */ - maxLength: Scalars["Int"]["output"]; + maxLength: Scalars['Int']['output']; /** The customization's name. */ - name?: Maybe; + name?: Maybe; /** Priority order of customization. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** Type of customization. */ - type?: Maybe; + type?: Maybe; /** Value of customization. */ - values?: Maybe>>; + values?: Maybe>>; }; /** The delivery schedule detail. */ export type DeliveryScheduleDetail = { /** The date of the delivery schedule. */ - date?: Maybe; + date?: Maybe; /** The end date and time of the delivery schedule. */ - endDateTime: Scalars["DateTime"]["output"]; + endDateTime: Scalars['DateTime']['output']; /** The end time of the delivery schedule. */ - endTime?: Maybe; + endTime?: Maybe; /** The start date and time of the delivery schedule. */ - startDateTime: Scalars["DateTime"]["output"]; + startDateTime: Scalars['DateTime']['output']; /** The start time of the delivery schedule. */ - startTime?: Maybe; + startTime?: Maybe; }; /** Input for delivery scheduling. */ export type DeliveryScheduleInput = { /** The date. */ - date: Scalars["DateTime"]["input"]; + date: Scalars['DateTime']['input']; /** The period ID. */ - periodId: Scalars["Long"]["input"]; + periodId: Scalars['Long']['input']; }; /** Define the entity type of the customer registration. */ export type EntityType = /** Legal entity, a company, business, organization. */ - | "COMPANY" + | 'COMPANY' /** An international person, a legal international entity. */ - | "INTERNATIONAL" + | 'INTERNATIONAL' /** An individual person, a physical person. */ - | "PERSON"; + | 'PERSON'; export type FilterPosition = /** Both filter position. */ - | "BOTH" + | 'BOTH' /** Horizontal filter position. */ - | "HORIZONTAL" + | 'HORIZONTAL' /** Vertical filter position. */ - | "VERTICAL"; + | 'VERTICAL'; /** The customer's gender. */ export type Gender = - | "FEMALE" - | "MALE"; + | 'FEMALE' + | 'MALE'; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type Hotsite = Node & { @@ -1335,37 +1334,38 @@ export type Hotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars["Long"]["output"]; + hotsiteId: Scalars['Long']['output']; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars["Int"]["output"]; + pageSize: Scalars['Int']['output']; /** A list of products associated with the hotsite. */ products?: Maybe; /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; + /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type HotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -1373,11 +1373,11 @@ export type HotsiteProductsArgs = { /** Define the hotsite attribute which the result set will be sorted on. */ export type HotsiteSortKeys = /** The hotsite id. */ - | "ID" + | 'ID' /** The hotsite name. */ - | "NAME" + | 'NAME' /** The hotsite url. */ - | "URL"; + | 'URL'; export type HotsiteSorting = { direction?: Maybe; @@ -1386,13 +1386,13 @@ export type HotsiteSorting = { export type HotsiteSubtype = /** Hotsite created from a brand. */ - | "BRAND" + | 'BRAND' /** Hotsite created from a buy list (lista de compra). */ - | "BUY_LIST" + | 'BUY_LIST' /** Hotsite created from a category. */ - | "CATEGORY" + | 'CATEGORY' /** Hotsite created from a portfolio. */ - | "PORTFOLIO"; + | 'PORTFOLIO'; /** A connection to a list of items. */ export type HotsitesConnection = { @@ -1407,7 +1407,7 @@ export type HotsitesConnection = { /** An edge in a connection. */ export type HotsitesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; @@ -1415,160 +1415,162 @@ export type HotsitesEdge = { /** Informations about an image of a product. */ export type Image = { /** The name of the image file. */ - fileName?: Maybe; + fileName?: Maybe; /** Check if the image is used for the product main image. */ - mini: Scalars["Boolean"]["output"]; + mini: Scalars['Boolean']['output']; /** Numeric order the image should be displayed. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** Check if the image is used for the product prints only. */ - print: Scalars["Boolean"]["output"]; + print: Scalars['Boolean']['output']; /** The url to retrieve the image */ - url?: Maybe; + url?: Maybe; }; /** The additional information about in-store pickup */ export type InStorePickupAdditionalInformationInput = { /** The document */ - document?: InputMaybe; + document?: InputMaybe; /** The name */ - name?: InputMaybe; + name?: InputMaybe; }; /** Information registred to the product. */ export type Information = { /** The information id. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The information title. */ - title?: Maybe; + title?: Maybe; /** The information type. */ - type?: Maybe; + type?: Maybe; /** The information value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupFieldNode = Node & { /** The information group field display type. */ - displayType?: Maybe; + displayType?: Maybe; /** The information group field name. */ - fieldName?: Maybe; + fieldName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The information group field order. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** If the information group field is required. */ - required: Scalars["Boolean"]["output"]; + required: Scalars['Boolean']['output']; /** The information group field preset values. */ values?: Maybe>>; }; export type InformationGroupFieldValueNode = { /** The information group field value order. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** The information group field value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupValueInput = { /** The information group field unique identifier. */ - id?: InputMaybe; + id?: InputMaybe; /** The information group field value. */ - value?: InputMaybe; + value?: InputMaybe; }; export type Installment = { /** Wether the installment has discount. */ - discount: Scalars["Boolean"]["output"]; + discount: Scalars['Boolean']['output']; /** Wether the installment has fees. */ - fees: Scalars["Boolean"]["output"]; + fees: Scalars['Boolean']['output']; /** The number of installments. */ - number: Scalars["Int"]["output"]; + number: Scalars['Int']['output']; /** The value of the installment. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; export type InstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; /** The name of this installment plan. */ - name?: Maybe; + name?: Maybe; }; /** The user login type. */ export type LoginType = - | "AUTHENTICATED" - | "NEW" - | "SIMPLE"; + | 'AUTHENTICATED' + | 'NEW' + | 'SIMPLE'; /** Informations about menu items. */ export type Menu = Node & { /** Menu css class to apply. */ - cssClass?: Maybe; + cssClass?: Maybe; /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu image url address. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu hierarchy level. */ - level: Scalars["Int"]["output"]; + level: Scalars['Int']['output']; /** Menu link address. */ - link?: Maybe; + link?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars["Int"]["output"]; + menuGroupId: Scalars['Int']['output']; /** Menu identifier. */ - menuId: Scalars["Int"]["output"]; + menuId: Scalars['Int']['output']; /** Menu name. */ - name: Scalars["String"]["output"]; + name: Scalars['String']['output']; /** Menu hierarchy level. */ - openNewTab: Scalars["Boolean"]["output"]; + openNewTab: Scalars['Boolean']['output']; /** Menu position order. */ - order: Scalars["Int"]["output"]; + order: Scalars['Int']['output']; /** Parent menu identifier. */ - parentMenuId?: Maybe; + parentMenuId?: Maybe; /** Menu extra text. */ - text?: Maybe; + text?: Maybe; }; + /** Informations about menu items. */ export type MenuFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Informations about menu groups. */ export type MenuGroup = Node & { /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu group image url. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars["Int"]["output"]; + menuGroupId: Scalars['Int']['output']; /** List of menus associated with the current group */ menus?: Maybe>>; /** Menu group name. */ - name?: Maybe; + name?: Maybe; /** Menu group partner id. */ - partnerId?: Maybe; + partnerId?: Maybe; /** Menu group position. */ - position?: Maybe; + position?: Maybe; }; + /** Informations about menu groups. */ export type MenuGroupFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Some products can have metadata, like diferent types of custom information. A basic key value pair. */ export type Metadata = { /** Metadata key. */ - key?: Maybe; + key?: Maybe; /** Metadata value. */ - value?: Maybe; + value?: Maybe; }; export type Mutation = { @@ -1659,367 +1661,406 @@ export type Mutation = { wishlistRemoveProduct?: Maybe>>; }; + export type MutationCheckoutAddCouponArgs = { - checkoutId: Scalars["Uuid"]["input"]; - coupon: Scalars["String"]["input"]; - customerAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + coupon: Scalars['String']['input']; + customerAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCheckoutAddMetadataArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; metadata: Array>; }; + export type MutationCheckoutAddMetadataForProductVariantArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; metadata: Array>; - productVariantId: Scalars["Long"]["input"]; + productVariantId: Scalars['Long']['input']; }; + export type MutationCheckoutAddProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; + export type MutationCheckoutAddressAssociateArgs = { - addressId: Scalars["ID"]["input"]; - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken: Scalars["String"]["input"]; + addressId: Scalars['ID']['input']; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken: Scalars['String']['input']; }; + export type MutationCheckoutCloneArgs = { - checkoutId: Scalars["Uuid"]["input"]; - copyUser?: Scalars["Boolean"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + copyUser?: Scalars['Boolean']['input']; + customerAccessToken?: InputMaybe; }; + export type MutationCheckoutCompleteArgs = { - checkoutId: Scalars["Uuid"]["input"]; - comments?: InputMaybe; - customerAccessToken?: InputMaybe; - paymentData: Scalars["String"]["input"]; - recaptchaToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + comments?: InputMaybe; + customerAccessToken?: InputMaybe; + paymentData: Scalars['String']['input']; + recaptchaToken?: InputMaybe; }; + export type MutationCheckoutCustomerAssociateArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken: Scalars["String"]["input"]; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken: Scalars['String']['input']; }; + export type MutationCheckoutGiftVariantSelectionArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; - productVariantId: Scalars["Long"]["input"]; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + productVariantId: Scalars['Long']['input']; }; + export type MutationCheckoutPartnerAssociateArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; - partnerAccessToken: Scalars["String"]["input"]; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + partnerAccessToken: Scalars['String']['input']; }; + export type MutationCheckoutRemoveCouponArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; }; + export type MutationCheckoutRemoveProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; + export type MutationCheckoutSelectInstallmentArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; - installmentNumber: Scalars["Int"]["input"]; - selectedPaymentMethodId: Scalars["Uuid"]["input"]; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + installmentNumber: Scalars['Int']['input']; + selectedPaymentMethodId: Scalars['Uuid']['input']; }; + export type MutationCheckoutSelectPaymentMethodArgs = { - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; - paymentMethodId: Scalars["ID"]["input"]; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + paymentMethodId: Scalars['ID']['input']; }; + export type MutationCheckoutSelectShippingQuoteArgs = { additionalInformation?: InputMaybe; - checkoutId: Scalars["Uuid"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; deliveryScheduleInput?: InputMaybe; - shippingQuoteId: Scalars["Uuid"]["input"]; + shippingQuoteId: Scalars['Uuid']['input']; }; + export type MutationCreateCheckoutArgs = { products?: InputMaybe>>; }; + export type MutationCreateNewsletterRegisterArgs = { input: NewsletterInput; }; + export type MutationCreateProductReviewArgs = { input: ReviewCreateInput; }; + export type MutationCreateSearchTermRecordArgs = { input: SearchRecordInput; }; + export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenInput; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + export type MutationCustomerAddressCreateArgs = { address: CreateCustomerAddressInput; - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; }; + export type MutationCustomerAddressUpdateArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars["String"]["input"]; - id: Scalars["ID"]["input"]; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; }; + export type MutationCustomerCompletePartialRegistrationArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerCreateArgs = { input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerEmailChangeArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; input?: InputMaybe; }; + export type MutationCustomerImpersonateArgs = { - customerAccessToken: Scalars["String"]["input"]; - input: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; + input: Scalars['String']['input']; }; + export type MutationCustomerPasswordChangeArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerPasswordRecoveryArgs = { - input: Scalars["String"]["input"]; - recaptchaToken?: InputMaybe; + input: Scalars['String']['input']; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerSimpleLoginStartArgs = { - input?: InputMaybe; - recaptchaToken?: InputMaybe; + input?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerSimpleLoginVerifyAnwserArgs = { - anwserId: Scalars["Uuid"]["input"]; - input?: InputMaybe; - questionId: Scalars["Uuid"]["input"]; - recaptchaToken?: InputMaybe; + anwserId: Scalars['Uuid']['input']; + input?: InputMaybe; + questionId: Scalars['Uuid']['input']; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerSocialLoginFacebookArgs = { - facebookAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + facebookAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationCustomerSocialLoginGoogleArgs = { - clientId?: InputMaybe; - recaptchaToken?: InputMaybe; - userCredential?: InputMaybe; + clientId?: InputMaybe; + recaptchaToken?: InputMaybe; + userCredential?: InputMaybe; }; + export type MutationCustomerUpdateArgs = { - customerAccessToken: Scalars["String"]["input"]; + customerAccessToken: Scalars['String']['input']; input: CustomerUpdateInput; }; + export type MutationPartnerAccessTokenCreateArgs = { input: PartnerAccessTokenInput; }; + export type MutationProductPriceAlertArgs = { input: AddPriceAlertInput; }; + export type MutationProductRestockAlertArgs = { input: RestockAlertInput; - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; }; + export type MutationSendGenericFormArgs = { - body?: InputMaybe; - file?: InputMaybe; - recaptchaToken?: InputMaybe; + body?: InputMaybe; + file?: InputMaybe; + recaptchaToken?: InputMaybe; }; + export type MutationUpdateAddressArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars["String"]["input"]; - id: Scalars["ID"]["input"]; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; }; + export type MutationWishlistAddProductArgs = { - customerAccessToken: Scalars["String"]["input"]; - productId: Scalars["Long"]["input"]; + customerAccessToken: Scalars['String']['input']; + productId: Scalars['Long']['input']; }; + export type MutationWishlistRemoveProductArgs = { - customerAccessToken: Scalars["String"]["input"]; - productId: Scalars["Long"]["input"]; + customerAccessToken: Scalars['String']['input']; + productId: Scalars['Long']['input']; }; export type NewsletterInput = { - email: Scalars["String"]["input"]; - informationGroupValues?: InputMaybe< - Array> - >; - name: Scalars["String"]["input"]; - recaptchaToken?: InputMaybe; + email: Scalars['String']['input']; + informationGroupValues?: InputMaybe>>; + name: Scalars['String']['input']; + recaptchaToken?: InputMaybe; }; export type NewsletterNode = { /** Newsletter creation date. */ - createDate: Scalars["DateTime"]["output"]; + createDate: Scalars['DateTime']['output']; /** The newsletter receiver email. */ - email?: Maybe; + email?: Maybe; /** The newsletter receiver name. */ - name?: Maybe; + name?: Maybe; /** Newsletter update date. */ - updateDate?: Maybe; + updateDate?: Maybe; }; export type Node = { - id?: Maybe; + id?: Maybe; }; /** Types of operations to perform between query terms. */ export type Operation = /** Performs AND operation between query terms. */ - | "AND" + | 'AND' /** Performs OR operation between query terms. */ - | "OR"; + | 'OR'; /** Result of the operation. */ export type OperationResult = { /** If the operation is a success. */ - isSuccess: Scalars["Boolean"]["output"]; + isSuccess: Scalars['Boolean']['output']; }; export type OrderAdjustNode = { /** The adjust name. */ - name?: Maybe; + name?: Maybe; /** Note about the adjust. */ - note?: Maybe; + note?: Maybe; /** Type of adjust. */ - type?: Maybe; + type?: Maybe; /** Amount to be adjusted. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; export type OrderAttributeNode = { /** The attribute name. */ - name?: Maybe; + name?: Maybe; /** The attribute value. */ - value?: Maybe; + value?: Maybe; }; export type OrderCustomizationNode = { /** The customization cost. */ - cost?: Maybe; + cost?: Maybe; /** The customization name. */ - name?: Maybe; + name?: Maybe; /** The customization value. */ - value?: Maybe; + value?: Maybe; }; export type OrderDeliveryAddressNode = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep?: Maybe; + cep?: Maybe; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The country of the address. */ - country?: Maybe; + country?: Maybe; /** The neighborhood of the address. */ - neighboorhood?: Maybe; + neighboorhood?: Maybe; /** The receiver's name. */ - receiverName?: Maybe; + receiverName?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address, abbreviated. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; export type OrderInvoiceNode = { /** The invoice access key. */ - accessKey?: Maybe; + accessKey?: Maybe; /** The invoice identifier code. */ - invoiceCode?: Maybe; + invoiceCode?: Maybe; /** The invoice serial digit. */ - serialDigit?: Maybe; + serialDigit?: Maybe; /** The invoice URL. */ - url?: Maybe; + url?: Maybe; }; export type OrderNoteNode = { /** Date the note was added to the order. */ - date?: Maybe; + date?: Maybe; /** The note added to the order. */ - note?: Maybe; + note?: Maybe; /** The user who added the note to the order. */ - user?: Maybe; + user?: Maybe; }; export type OrderPackagingNode = { /** The packaging cost. */ - cost: Scalars["Decimal"]["output"]; + cost: Scalars['Decimal']['output']; /** The packaging description. */ - description?: Maybe; + description?: Maybe; /** The message added to the packaging. */ - message?: Maybe; + message?: Maybe; /** The packaging name. */ - name?: Maybe; + name?: Maybe; }; export type OrderPaymentAdditionalInfoNode = { /** Additional information key. */ - key?: Maybe; + key?: Maybe; /** Additional information value. */ - value?: Maybe; + value?: Maybe; }; export type OrderPaymentBoletoNode = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; export type OrderPaymentCardNode = { /** The brand of the card. */ - brand?: Maybe; + brand?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; export type OrderPaymentNode = { @@ -2030,32 +2071,32 @@ export type OrderPaymentNode = { /** The card information. */ card?: Maybe; /** Order discounted value. */ - discount?: Maybe; + discount?: Maybe; /** Order additional fees value. */ - fees?: Maybe; + fees?: Maybe; /** Value per installment. */ - installmentValue?: Maybe; + installmentValue?: Maybe; /** Number of installments. */ - installments?: Maybe; + installments?: Maybe; /** Message about payment transaction. */ - message?: Maybe; + message?: Maybe; /** The chosen payment option for the order. */ - paymentOption?: Maybe; + paymentOption?: Maybe; /** The pix information. */ pix?: Maybe; /** Current payment status. */ - status?: Maybe; + status?: Maybe; /** Order total value. */ - total?: Maybe; + total?: Maybe; }; export type OrderPaymentPixNode = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; export type OrderProductNode = { @@ -2064,243 +2105,244 @@ export type OrderProductNode = { /** The product attributes. */ attributes?: Maybe>>; /** The cost of the customizations, if any. */ - customizationPrice: Scalars["Decimal"]["output"]; + customizationPrice: Scalars['Decimal']['output']; /** List of customizations for the product. */ customizations?: Maybe>>; /** Amount of discount in the product price, if any. */ - discount: Scalars["Decimal"]["output"]; + discount: Scalars['Decimal']['output']; /** If the product is a gift. */ - gift?: Maybe; + gift?: Maybe; /** The product image. */ - image?: Maybe; + image?: Maybe; /** The product list price. */ - listPrice: Scalars["Decimal"]["output"]; + listPrice: Scalars['Decimal']['output']; /** The product name. */ - name?: Maybe; + name?: Maybe; /** The cost of the packagings, if any. */ - packagingPrice: Scalars["Decimal"]["output"]; + packagingPrice: Scalars['Decimal']['output']; /** List of packagings for the product. */ packagings?: Maybe>>; /** The product price. */ - price: Scalars["Decimal"]["output"]; + price: Scalars['Decimal']['output']; /** Information about the product seller. */ productSeller?: Maybe; /** Variant unique identifier. */ - productVariantId: Scalars["Long"]["output"]; + productVariantId: Scalars['Long']['output']; /** Quantity of the given product in the order. */ - quantity: Scalars["Long"]["output"]; + quantity: Scalars['Long']['output']; /** The product sale price. */ - salePrice: Scalars["Decimal"]["output"]; + salePrice: Scalars['Decimal']['output']; /** The product SKU. */ - sku?: Maybe; + sku?: Maybe; /** List of trackings for the order. */ trackings?: Maybe>>; /** Value of an unit of the product. */ - unitaryValue: Scalars["Decimal"]["output"]; + unitaryValue: Scalars['Decimal']['output']; }; export type OrderSellerNode = { /** The seller's name. */ - name?: Maybe; + name?: Maybe; }; export type OrderShippingNode = { /** Limit date of delivery, in days. */ - deadline?: Maybe; + deadline?: Maybe; /** Deadline text message. */ - deadlineText?: Maybe; + deadlineText?: Maybe; /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The order pick up unique identifier. */ - pickUpId?: Maybe; + pickUpId?: Maybe; /** The products belonging to the order. */ products?: Maybe>>; /** Amount discounted from shipping costs, if any. */ - promotion?: Maybe; + promotion?: Maybe; /** Shipping company connector identifier code. */ - refConnector?: Maybe; + refConnector?: Maybe; /** Start date of shipping schedule. */ - scheduleFrom?: Maybe; + scheduleFrom?: Maybe; /** Limit date of shipping schedule. */ - scheduleUntil?: Maybe; + scheduleUntil?: Maybe; /** Shipping fee value. */ - shippingFee?: Maybe; + shippingFee?: Maybe; /** The shipping name. */ - shippingName?: Maybe; + shippingName?: Maybe; /** Shipping rate table unique identifier. */ - shippingTableId?: Maybe; + shippingTableId?: Maybe; /** The total value. */ - total?: Maybe; + total?: Maybe; /** Order package size. */ - volume?: Maybe; + volume?: Maybe; /** The order weight, in grams. */ - weight?: Maybe; + weight?: Maybe; }; export type OrderShippingProductNode = { /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The product price. */ - price?: Maybe; + price?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Quantity of the given product. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; }; /** Define the sort orientation of the result set. */ export type OrderSortDirection = /** The results will be sorted in an ascending order. */ - | "ASC" + | 'ASC' /** The results will be sorted in an descending order. */ - | "DESC"; + | 'DESC'; /** Represents the status of an order. */ export type OrderStatus = /** Order has been approved in analysis. */ - | "APPROVED_ANALYSIS" + | 'APPROVED_ANALYSIS' /** Order has been authorized. */ - | "AUTHORIZED" + | 'AUTHORIZED' /** Order is awaiting payment. */ - | "AWAITING_PAYMENT" + | 'AWAITING_PAYMENT' /** Order is awaiting change of payment method. */ - | "AWAITING_PAYMENT_CHANGE" + | 'AWAITING_PAYMENT_CHANGE' /** Order has been cancelled. */ - | "CANCELLED" + | 'CANCELLED' /** Order has been cancelled - Card Denied. */ - | "CANCELLED_DENIED_CARD" + | 'CANCELLED_DENIED_CARD' /** Order has been cancelled - Fraud. */ - | "CANCELLED_FRAUD" + | 'CANCELLED_FRAUD' /** Order has been cancelled. */ - | "CANCELLED_ORDER_CANCELLED" + | 'CANCELLED_ORDER_CANCELLED' /** Order has been cancelled - Suspected Fraud. */ - | "CANCELLED_SUSPECT_FRAUD" + | 'CANCELLED_SUSPECT_FRAUD' /** Order has been cancelled - Card Temporarily Denied. */ - | "CANCELLED_TEMPORARILY_DENIED_CARD" + | 'CANCELLED_TEMPORARILY_DENIED_CARD' /** Order has been checked. */ - | "CHECKED_ORDER" + | 'CHECKED_ORDER' /** Order has been credited. */ - | "CREDITED" + | 'CREDITED' /** Order has been delivered. */ - | "DELIVERED" + | 'DELIVERED' /** Payment denied, but the order has not been cancelled. */ - | "DENIED_PAYMENT" + | 'DENIED_PAYMENT' /** Documents needed for purchase. */ - | "DOCUMENTS_FOR_PURCHASE" + | 'DOCUMENTS_FOR_PURCHASE' /** Order has been placed. */ - | "ORDERED" + | 'ORDERED' /** Order has been paid. */ - | "PAID" + | 'PAID' /** Available for pick-up in store. */ - | "PICK_UP_IN_STORE" + | 'PICK_UP_IN_STORE' /** Order has been received - Gift Card. */ - | "RECEIVED_GIFT_CARD" + | 'RECEIVED_GIFT_CARD' /** Order has been returned. */ - | "RETURNED" + | 'RETURNED' /** Order has been sent. */ - | "SENT" + | 'SENT' /** Order has been sent - Invoiced. */ - | "SENT_INVOICED" + | 'SENT_INVOICED' /** Order has been separated. */ - | "SEPARATED"; + | 'SEPARATED'; export type OrderStatusNode = { /** The date when status has changed. */ - changeDate?: Maybe; + changeDate?: Maybe; /** Order status. */ - status?: Maybe; + status?: Maybe; /** Status unique identifier. */ - statusId: Scalars["Long"]["output"]; + statusId: Scalars['Long']['output']; }; export type OrderTrackingNode = { /** The tracking code. */ - code?: Maybe; + code?: Maybe; /** The URL for tracking. */ - url?: Maybe; + url?: Maybe; }; /** Information about pagination in a connection. */ export type PageInfo = { /** When paginating forwards, the cursor to continue. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Indicates whether more edges exist following the set defined by the clients arguments. */ - hasNextPage: Scalars["Boolean"]["output"]; + hasNextPage: Scalars['Boolean']['output']; /** Indicates whether more edges exist prior the set defined by the clients arguments. */ - hasPreviousPage: Scalars["Boolean"]["output"]; + hasPreviousPage: Scalars['Boolean']['output']; /** When paginating backwards, the cursor to continue. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** Partners are used to assign specific products or price tables depending on its scope. */ export type Partner = Node & { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner is valid until this date. */ - endDate: Scalars["DateTime"]["output"]; + endDate: Scalars['DateTime']['output']; /** The full partner logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The partner logo's URL. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's origin. */ - origin?: Maybe; + origin?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; /** Partner unique identifier. */ - partnerId: Scalars["Long"]["output"]; + partnerId: Scalars['Long']['output']; /** Portfolio identifier assigned to this partner. */ - portfolioId: Scalars["Int"]["output"]; + portfolioId: Scalars['Int']['output']; /** Price table identifier assigned to this partner. */ - priceTableId: Scalars["Int"]["output"]; + priceTableId: Scalars['Int']['output']; /** The partner is valid from this date. */ - startDate: Scalars["DateTime"]["output"]; + startDate: Scalars['DateTime']['output']; /** The type of scoped the partner is used. */ - type?: Maybe; + type?: Maybe; }; + /** Partners are used to assign specific products or price tables depending on its scope. */ export type PartnerFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type PartnerAccessToken = { - token?: Maybe; - validUntil?: Maybe; + token?: Maybe; + validUntil?: Maybe; }; /** The input to authenticate closed scope partners. */ export type PartnerAccessTokenInput = { - password: Scalars["String"]["input"]; - username: Scalars["String"]["input"]; + password: Scalars['String']['input']; + username: Scalars['String']['input']; }; /** Input for partners. */ export type PartnerByRegionInput = { /** CEP to get the regional partners. */ - cep?: InputMaybe; + cep?: InputMaybe; /** Region ID to get the regional partners. */ - regionId?: InputMaybe; + regionId?: InputMaybe; }; /** Define the partner attribute which the result set will be sorted on. */ export type PartnerSortKeys = /** The partner unique identifier. */ - | "ID" + | 'ID' /** The partner name. */ - | "NAME"; + | 'NAME'; export type PartnerSubtype = /** Partner 'client' subtype. */ - | "CLIENT" + | 'CLIENT' /** Partner 'closed' subtype. */ - | "CLOSED" + | 'CLOSED' /** Partner 'open' subtype. */ - | "OPEN"; + | 'OPEN'; /** A connection to a list of items. */ export type PartnersConnection = { @@ -2315,7 +2357,7 @@ export type PartnersConnection = { /** An edge in a connection. */ export type PartnersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2323,62 +2365,62 @@ export type PartnersEdge = { /** Informations about the physical store. */ export type PhysicalStore = { /** Additional text. */ - additionalText?: Maybe; + additionalText?: Maybe; /** Physical store address. */ - address?: Maybe; + address?: Maybe; /** Physical store address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Physical store address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** Physical store address city. */ - city?: Maybe; + city?: Maybe; /** Physical store country. */ - country?: Maybe; + country?: Maybe; /** Physical store DDD. */ - ddd: Scalars["Int"]["output"]; + ddd: Scalars['Int']['output']; /** Delivery deadline. */ - deliveryDeadline: Scalars["Int"]["output"]; + deliveryDeadline: Scalars['Int']['output']; /** Physical store email. */ - email?: Maybe; + email?: Maybe; /** Physical store latitude. */ - latitude?: Maybe; + latitude?: Maybe; /** Physical store longitude. */ - longitude?: Maybe; + longitude?: Maybe; /** Physical store name. */ - name?: Maybe; + name?: Maybe; /** Physical store address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Physical store phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Physical store ID. */ - physicalStoreId: Scalars["Int"]["output"]; + physicalStoreId: Scalars['Int']['output']; /** If the physical store allows pickup. */ - pickup: Scalars["Boolean"]["output"]; + pickup: Scalars['Boolean']['output']; /** Pickup deadline. */ - pickupDeadline: Scalars["Int"]["output"]; + pickupDeadline: Scalars['Int']['output']; /** Physical store state. */ - state?: Maybe; + state?: Maybe; /** Physical store zip code. */ - zipCode?: Maybe; + zipCode?: Maybe; }; /** Range of prices for this product. */ export type PriceRange = { /** The quantity of products in this range. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; /** The price range. */ - range?: Maybe; + range?: Maybe; }; export type PriceTable = { /** The amount of discount in percentage. */ - discountPercentage: Scalars["Decimal"]["output"]; + discountPercentage: Scalars['Decimal']['output']; /** The id of this price table. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The listed regular price of this table. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price of this table. */ - price: Scalars["Decimal"]["output"]; + price: Scalars['Decimal']['output']; }; /** The prices of the product. */ @@ -2386,17 +2428,17 @@ export type Prices = { /** The best installment option available. */ bestInstallment?: Maybe; /** The amount of discount in percentage. */ - discountPercentage: Scalars["Decimal"]["output"]; + discountPercentage: Scalars['Decimal']['output']; /** Wether the current price is discounted. */ - discounted: Scalars["Boolean"]["output"]; + discounted: Scalars['Boolean']['output']; /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The multiplication factor used for items that are sold by quantity. */ - multiplicationFactor: Scalars["Float"]["output"]; + multiplicationFactor: Scalars['Float']['output']; /** The current working price. */ - price: Scalars["Decimal"]["output"]; + price: Scalars['Decimal']['output']; /** * List of the product different price tables. * @@ -2410,63 +2452,63 @@ export type Prices = { /** Input to specify the range of prices to return. */ export type PricesInput = { /** The product discount must be greater than or equal to. */ - discount_gte?: InputMaybe; + discount_gte?: InputMaybe; /** The product discount must be lesser than or equal to. */ - discount_lte?: InputMaybe; + discount_lte?: InputMaybe; /** Return only products where the listed price is more than the price. */ - discounted?: InputMaybe; + discounted?: InputMaybe; /** The product price must be greater than or equal to. */ - price_gte?: InputMaybe; + price_gte?: InputMaybe; /** The product price must be lesser than or equal to. */ - price_lte?: InputMaybe; + price_lte?: InputMaybe; }; /** A product represents an item for sale in the store. */ export type Product = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** BuyBox informations. */ buyBox?: Maybe; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -2474,13 +2516,13 @@ export type Product = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** The product seller. */ @@ -2488,46 +2530,48 @@ export type Product = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; + /** A product represents an item for sale in the store. */ export type ProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type ProductAggregations = { /** List of product filters which can be used to filter subsequent queries. */ filters?: Maybe>>; /** Minimum price of the products. */ - maximumPrice: Scalars["Decimal"]["output"]; + maximumPrice: Scalars['Decimal']['output']; /** Maximum price of the products. */ - minimumPrice: Scalars["Decimal"]["output"]; + minimumPrice: Scalars['Decimal']['output']; /** List of price ranges for the selected products. */ priceRanges?: Maybe>>; }; + export type ProductAggregationsFiltersArgs = { position?: InputMaybe; }; @@ -2535,60 +2579,61 @@ export type ProductAggregationsFiltersArgs = { /** The attributes of the product. */ export type ProductAttribute = Node & { /** The id of the attribute. */ - attributeId: Scalars["Long"]["output"]; + attributeId: Scalars['Long']['output']; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type ProductBrand = { /** The hotsite url alias fot this brand. */ - alias?: Maybe; + alias?: Maybe; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The brand id. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The url that contains the brand logo image. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The name of the brand. */ - name?: Maybe; + name?: Maybe; }; + export type ProductBrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Information about the category of a product. */ export type ProductCategory = { /** Wether the category is currently active. */ - active: Scalars["Boolean"]["output"]; + active: Scalars['Boolean']['output']; /** The categories in google format. */ - googleCategories?: Maybe; + googleCategories?: Maybe; /** The category hierarchy. */ - hierarchy?: Maybe; + hierarchy?: Maybe; /** The id of the category. */ - id: Scalars["Int"]["output"]; + id: Scalars['Int']['output']; /** Wether this category is the main category for this product. */ - main: Scalars["Boolean"]["output"]; + main: Scalars['Boolean']['output']; /** The category name. */ - name?: Maybe; + name?: Maybe; /** The category hotsite url alias. */ - url?: Maybe; + url?: Maybe; }; export type ProductCollectionSegment = { items?: Maybe>>; - page: Scalars["Int"]["output"]; - pageSize: Scalars["Int"]["output"]; - totalCount: Scalars["Int"]["output"]; + page: Scalars['Int']['output']; + pageSize: Scalars['Int']['output']; + totalCount: Scalars['Int']['output']; }; /** Filter product results based on giving attributes. */ @@ -2596,45 +2641,45 @@ export type ProductExplicitFiltersInput = { /** The set of attributes do filter. */ attributes?: InputMaybe; /** Choose if you want to retrieve only the available products in stock. */ - available?: InputMaybe; + available?: InputMaybe; /** The set of brand IDs which the result item brand ID must be included in. */ - brandId?: InputMaybe>; + brandId?: InputMaybe>; /** The set of category IDs which the result item category ID must be included in. */ - categoryId?: InputMaybe>; + categoryId?: InputMaybe>; /** The set of EANs which the result item EAN must be included. */ - ean?: InputMaybe>>; + ean?: InputMaybe>>; /** Retrieve the product variant only if it contains images. */ - hasImages?: InputMaybe; + hasImages?: InputMaybe; /** Retrieve the product variant only if it is the main product variant. */ - mainVariant?: InputMaybe; + mainVariant?: InputMaybe; /** The set of prices to filter. */ prices?: InputMaybe; /** The product unique identifier (you may provide a list of IDs if needed). */ - productId?: InputMaybe>; + productId?: InputMaybe>; /** The product variant unique identifier (you may provide a list of IDs if needed). */ - productVariantId?: InputMaybe>; + productVariantId?: InputMaybe>; /** A product ID or a list of IDs to search for other products with the same parent ID. */ - sameParentAs?: InputMaybe>; + sameParentAs?: InputMaybe>; /** The set of SKUs which the result item SKU must be included. */ - sku?: InputMaybe>>; + sku?: InputMaybe>>; /** Show products with a quantity of available products in stock greater than or equal to the given number. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** Show products with a quantity of available products in stock less than or equal to the given number. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; /** The set of stocks to filter. */ stocks?: InputMaybe; /** Retrieve products which the last update date is greater than or equal to the given date. */ - updatedAt_gte?: InputMaybe; + updatedAt_gte?: InputMaybe; /** Retrieve products which the last update date is less than or equal to the given date. */ - updatedAt_lte?: InputMaybe; + updatedAt_lte?: InputMaybe; }; /** Custom attribute defined on store's admin may also be used as a filter. */ export type ProductFilterInput = { /** The attribute name. */ - field: Scalars["String"]["input"]; + field: Scalars['String']['input']; /** The set of values which the result filter item value must be included in. */ - values: Array>; + values: Array>; }; /** Options available for the given product. */ @@ -2644,9 +2689,10 @@ export type ProductOption = Node & { /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; }; + /** Options available for the given product. */ export type ProductOptionAttributesArgs = { filter?: InputMaybe>>; @@ -2655,80 +2701,81 @@ export type ProductOptionAttributesArgs = { /** A product price alert. */ export type ProductPriceAlert = { /** The alerted's email. */ - email?: Maybe; + email?: Maybe; /** The alerted's name. */ - name?: Maybe; + name?: Maybe; /** The price alert ID. */ - priceAlertId: Scalars["Long"]["output"]; + priceAlertId: Scalars['Long']['output']; /** The product variant ID. */ - productVariantId: Scalars["Long"]["output"]; + productVariantId: Scalars['Long']['output']; /** The request date. */ - requestDate: Scalars["DateTime"]["output"]; + requestDate: Scalars['DateTime']['output']; /** The target price. */ - targetPrice: Scalars["Decimal"]["output"]; + targetPrice: Scalars['Decimal']['output']; }; -export type ProductRecommendationAlgorithm = "DEFAULT"; +export type ProductRecommendationAlgorithm = + | 'DEFAULT'; /** Define the product attribute which the result set will be sorted on. */ export type ProductSearchSortKeys = /** The applied discount to the product variant price. */ - | "DISCOUNT" + | 'DISCOUNT' /** The product name. */ - | "NAME" + | 'NAME' /** The product variant price. */ - | "PRICE" + | 'PRICE' /** Sort in a random way. */ - | "RANDOM" + | 'RANDOM' /** The date the product was released. */ - | "RELEASE_DATE" + | 'RELEASE_DATE' /** The relevance that the search engine gave to the possible result item based on own criteria. */ - | "RELEVANCE" + | 'RELEVANCE' /** The sales number on a period of time. */ - | "SALES" + | 'SALES' /** The quantity in stock of the product variant. */ - | "STOCK"; + | 'STOCK'; /** Define the product attribute which the result set will be sorted on. */ export type ProductSortKeys = /** The applied discount to the product variant price. */ - | "DISCOUNT" + | 'DISCOUNT' /** The product name. */ - | "NAME" + | 'NAME' /** The product variant price. */ - | "PRICE" + | 'PRICE' /** Sort in a random way. */ - | "RANDOM" + | 'RANDOM' /** The date the product was released. */ - | "RELEASE_DATE" + | 'RELEASE_DATE' /** The sales number on a period of time. */ - | "SALES" + | 'SALES' /** The quantity in stock of the product variant. */ - | "STOCK"; + | 'STOCK'; export type ProductSubscription = { /** The amount of discount if this product is sold as a subscription. */ - discount: Scalars["Decimal"]["output"]; + discount: Scalars['Decimal']['output']; /** The price of the product when sold as a subscription. */ - price?: Maybe; + price?: Maybe; /** Wether this product is sold only as a subscrition. */ - subscriptionOnly: Scalars["Boolean"]["output"]; + subscriptionOnly: Scalars['Boolean']['output']; }; /** Product variants that have the attribute. */ export type ProductVariant = Node & { /** The available stock at the default distribution center. */ - aggregatedStock?: Maybe; + aggregatedStock?: Maybe; /** The product alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the selected variant attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product's EAN. */ - ean?: Maybe; + ean?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The product's images. */ images?: Maybe>>; /** The seller's product offers. */ @@ -2736,23 +2783,24 @@ export type ProductVariant = Node & { /** The product prices. */ prices?: Maybe; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Product variant name. */ - productVariantName?: Maybe; + productVariantName?: Maybe; /** List of promotions this product variant belongs to. */ promotions?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; }; + /** Product variants that have the attribute. */ export type ProductVariantImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** A connection to a list of items. */ @@ -2763,13 +2811,13 @@ export type ProductsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars["Int"]["output"]; + totalCount: Scalars['Int']['output']; }; /** An edge in a connection. */ export type ProductsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars["String"]["output"]; + cursor: Scalars['String']['output']; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2777,23 +2825,24 @@ export type ProductsEdge = { /** Information about promotions of a product. */ export type Promotion = { /** The promotion html content. */ - content?: Maybe; + content?: Maybe; /** Where the promotion is shown (spot, product page, etc..). */ - disclosureType?: Maybe; + disclosureType?: Maybe; /** The stamp URL of the promotion. */ - fullStampUrl?: Maybe; + fullStampUrl?: Maybe; /** The promotion id. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The stamp of the promotion. */ - stamp?: Maybe; + stamp?: Maybe; /** The promotion title. */ - title?: Maybe; + title?: Maybe; }; + /** Information about promotions of a product. */ export type PromotionFullStampUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type QueryRoot = { @@ -2824,9 +2873,7 @@ export type QueryRoot = { /** List of menu groups. */ menuGroups?: Maybe>>; /** Get newsletter information group fields. */ - newsletterInformationGroupFields?: Maybe< - Array> - >; + newsletterInformationGroupFields?: Maybe>>; node?: Maybe; nodes?: Maybe>>; /** Get single partner. */ @@ -2862,287 +2909,315 @@ export type QueryRoot = { uri?: Maybe; }; + export type QueryRootAddressArgs = { - cep?: InputMaybe; + cep?: InputMaybe; }; + export type QueryRootAutocompleteArgs = { - limit?: InputMaybe; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + limit?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; + export type QueryRootBannersArgs = { - after?: InputMaybe; - bannerIds?: InputMaybe>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + bannerIds?: InputMaybe>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: BannerSortKeys; }; + export type QueryRootBrandsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; brandInput?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: BrandSortKeys; }; + export type QueryRootBuyListArgs = { - id: Scalars["Long"]["input"]; - partnerAccessToken?: InputMaybe; + id: Scalars['Long']['input']; + partnerAccessToken?: InputMaybe; }; + export type QueryRootCalculatePricesArgs = { - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; products: Array>; }; + export type QueryRootCategoriesArgs = { - after?: InputMaybe; - before?: InputMaybe; - categoryIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + categoryIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: CategorySortKeys; }; + export type QueryRootCheckoutArgs = { - checkoutId: Scalars["String"]["input"]; - customerAccessToken?: InputMaybe; + checkoutId: Scalars['String']['input']; + customerAccessToken?: InputMaybe; }; + export type QueryRootContentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - contentIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + contentIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: ContentSortKeys; }; + export type QueryRootCustomerArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; }; + export type QueryRootHotsiteArgs = { - hotsiteId?: InputMaybe; - partnerAccessToken?: InputMaybe; - url?: InputMaybe; + hotsiteId?: InputMaybe; + partnerAccessToken?: InputMaybe; + url?: InputMaybe; }; + export type QueryRootHotsitesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - hotsiteIds?: InputMaybe>; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + hotsiteIds?: InputMaybe>; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: HotsiteSortKeys; }; + export type QueryRootMenuGroupsArgs = { - partnerAccessToken?: InputMaybe; - position?: InputMaybe; - url: Scalars["String"]["input"]; + partnerAccessToken?: InputMaybe; + position?: InputMaybe; + url: Scalars['String']['input']; }; + export type QueryRootNodeArgs = { - id: Scalars["ID"]["input"]; + id: Scalars['ID']['input']; }; + export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; + export type QueryRootPartnerArgs = { - partnerAccessToken: Scalars["String"]["input"]; + partnerAccessToken: Scalars['String']['input']; }; + export type QueryRootPartnerByRegionArgs = { input: PartnerByRegionInput; }; + export type QueryRootPartnersArgs = { - after?: InputMaybe; - alias?: InputMaybe>>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - names?: InputMaybe>>; - priceTableIds?: InputMaybe>; + after?: InputMaybe; + alias?: InputMaybe>>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + names?: InputMaybe>>; + priceTableIds?: InputMaybe>; sortDirection?: SortDirection; sortKey?: PartnerSortKeys; }; + export type QueryRootPaymentMethodsArgs = { - checkoutId: Scalars["Uuid"]["input"]; + checkoutId: Scalars['Uuid']['input']; }; + export type QueryRootProductArgs = { - partnerAccessToken?: InputMaybe; - productId: Scalars["Long"]["input"]; + partnerAccessToken?: InputMaybe; + productId: Scalars['Long']['input']; }; + export type QueryRootProductOptionsArgs = { - productId: Scalars["Long"]["input"]; + productId: Scalars['Long']['input']; }; + export type QueryRootProductRecommendationsArgs = { algorithm?: ProductRecommendationAlgorithm; - partnerAccessToken?: InputMaybe; - productId: Scalars["Long"]["input"]; - quantity?: Scalars["Int"]["input"]; + partnerAccessToken?: InputMaybe; + productId: Scalars['Long']['input']; + quantity?: Scalars['Int']['input']; }; + export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters: ProductExplicitFiltersInput; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; + export type QueryRootScriptsArgs = { - name?: InputMaybe; + name?: InputMaybe; pageType?: InputMaybe>; position?: InputMaybe; - url?: InputMaybe; + url?: InputMaybe; }; + export type QueryRootSearchArgs = { operation?: Operation; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; + export type QueryRootShippingQuotesArgs = { - cep?: InputMaybe; - checkoutId?: InputMaybe; - productVariantId?: InputMaybe; - quantity?: InputMaybe; - useSelectedAddress?: InputMaybe; + cep?: InputMaybe; + checkoutId?: InputMaybe; + productVariantId?: InputMaybe; + quantity?: InputMaybe; + useSelectedAddress?: InputMaybe; }; + export type QueryRootShopSettingsArgs = { - settingNames?: InputMaybe>>; + settingNames?: InputMaybe>>; }; + export type QueryRootUriArgs = { - url: Scalars["String"]["input"]; + url: Scalars['String']['input']; }; export type Question = { answers?: Maybe>>; - question?: Maybe; - questionId?: Maybe; + question?: Maybe; + questionId?: Maybe; }; /** Back in stock registration input parameters. */ export type RestockAlertInput = { /** Email to be notified. */ - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; /** Name of the person to be notified. */ - name?: InputMaybe; + name?: InputMaybe; /** The product variant id of the product to be notified. */ - productVariantId: Scalars["Long"]["input"]; + productVariantId: Scalars['Long']['input']; }; export type RestockAlertNode = { /** Email to be notified. */ - email?: Maybe; + email?: Maybe; /** Name of the person to be notified. */ - name?: Maybe; + name?: Maybe; /** The product variant id. */ - productVariantId: Scalars["Long"]["output"]; + productVariantId: Scalars['Long']['output']; /** Date the alert was requested. */ - requestDate: Scalars["DateTime"]["output"]; + requestDate: Scalars['DateTime']['output']; }; /** A product review written by a customer. */ export type Review = { /** The reviewer name. */ - customer?: Maybe; + customer?: Maybe; /** The reviewer e-mail. */ - email?: Maybe; + email?: Maybe; /** The review rating. */ - rating: Scalars["Int"]["output"]; + rating: Scalars['Int']['output']; /** The review content. */ - review?: Maybe; + review?: Maybe; /** The review date. */ - reviewDate: Scalars["DateTime"]["output"]; + reviewDate: Scalars['DateTime']['output']; }; /** Review input parameters. */ export type ReviewCreateInput = { /** The reviewer's email. */ - email: Scalars["String"]["input"]; + email: Scalars['String']['input']; /** The reviewer's name. */ - name: Scalars["String"]["input"]; + name: Scalars['String']['input']; /** The product variant id to add the review to. */ - productVariantId: Scalars["Long"]["input"]; + productVariantId: Scalars['Long']['input']; /** The review rating. */ - rating: Scalars["Int"]["input"]; + rating: Scalars['Int']['input']; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The review content. */ - review: Scalars["String"]["input"]; + review: Scalars['String']['input']; }; /** Entity SEO information. */ export type Seo = { /** Content of SEO. */ - content?: Maybe; + content?: Maybe; /** Equivalent SEO type for HTTP. */ - httpEquiv?: Maybe; + httpEquiv?: Maybe; /** Name of SEO. */ - name?: Maybe; + name?: Maybe; /** Scheme for SEO. */ - scheme?: Maybe; + scheme?: Maybe; /** Type of SEO. */ - type?: Maybe; + type?: Maybe; }; /** Returns the scripts registered in the script manager. */ export type Script = { /** The script content. */ - content?: Maybe; + content?: Maybe; /** The script name. */ - name?: Maybe; + name?: Maybe; /** The script page type. */ pageType: ScriptPageType; /** The script position. */ position: ScriptPosition; /** The script priority. */ - priority: Scalars["Int"]["output"]; + priority: Scalars['Int']['output']; }; export type ScriptPageType = - | "ALL" - | "BRAND" - | "CATEGORY" - | "HOME" - | "PRODUCT" - | "SEARCH"; + | 'ALL' + | 'BRAND' + | 'CATEGORY' + | 'HOME' + | 'PRODUCT' + | 'SEARCH'; export type ScriptPosition = - | "BODY_END" - | "BODY_START" - | "FOOTER_END" - | "FOOTER_START" - | "HEADER_END" - | "HEADER_START"; + | 'BODY_END' + | 'BODY_START' + | 'FOOTER_END' + | 'FOOTER_START' + | 'HEADER_END' + | 'HEADER_START'; /** Search for relevant products to the searched term. */ export type Search = { @@ -3157,39 +3232,41 @@ export type Search = { /** Information about forbidden term. */ forbiddenTerm?: Maybe; /** The quantity of products displayed per page. */ - pageSize: Scalars["Int"]["output"]; + pageSize: Scalars['Int']['output']; /** A cursor based paginated list of products from the search. */ products?: Maybe; /** An offset based paginated list of products from the search. */ productsByOffset?: Maybe; /** Redirection url in case a term in the search triggers a redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; /** Time taken to perform the search. */ - searchTime?: Maybe; + searchTime?: Maybe; }; + /** Search for relevant products to the searched term. */ export type SearchProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; + /** Search for relevant products to the searched term. */ export type SearchProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3197,9 +3274,9 @@ export type SearchProductsByOffsetArgs = { /** Aggregated filters of a list of products. */ export type SearchFilter = { /** The name of the field. */ - field?: Maybe; + field?: Maybe; /** The origin of the field. */ - origin?: Maybe; + origin?: Maybe; /** List of the values of the field. */ values?: Maybe>>; }; @@ -3207,41 +3284,41 @@ export type SearchFilter = { /** Details of a filter value. */ export type SearchFilterItem = { /** The name of the value. */ - name?: Maybe; + name?: Maybe; /** The quantity of product with this value. */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; }; /** The response data */ export type SearchRecord = { /** The date time of the processed request */ - date: Scalars["DateTime"]["output"]; + date: Scalars['DateTime']['output']; /** If the record was successful */ - isSuccess: Scalars["Boolean"]["output"]; + isSuccess: Scalars['Boolean']['output']; /** The searched query */ - query?: Maybe; + query?: Maybe; }; /** The information to be saved for reports. */ export type SearchRecordInput = { /** The search operation (And, Or) */ - operation?: InputMaybe; + operation?: InputMaybe; /** The current page */ - page: Scalars["Int"]["input"]; + page: Scalars['Int']['input']; /** How many products show in page */ - pageSize: Scalars["Int"]["input"]; + pageSize: Scalars['Int']['input']; /** The client search page url */ - pageUrl?: InputMaybe; + pageUrl?: InputMaybe; /** The user search query */ - query?: InputMaybe; + query?: InputMaybe; /** How many products the search returned */ - totalResults: Scalars["Int"]["input"]; + totalResults: Scalars['Int']['input']; }; /** The selected payment method details. */ export type SelectedPaymentMethod = { /** The unique identifier for the selected payment method. */ - id: Scalars["Uuid"]["output"]; + id: Scalars['Uuid']['output']; /** The list of installments associated with the selected payment method. */ installments?: Maybe>>; /** The selected installment. */ @@ -3251,46 +3328,46 @@ export type SelectedPaymentMethod = { /** Details of an installment of the selected payment method. */ export type SelectedPaymentMethodInstallment = { /** The adjustment value applied to the installment. */ - adjustment: Scalars["Float"]["output"]; + adjustment: Scalars['Float']['output']; /** The installment number. */ - number: Scalars["Int"]["output"]; + number: Scalars['Int']['output']; /** The total value of the installment. */ - total: Scalars["Float"]["output"]; + total: Scalars['Float']['output']; /** The individual value of each installment. */ - value: Scalars["Float"]["output"]; + value: Scalars['Float']['output']; }; /** Seller informations. */ export type Seller = { /** Seller name */ - name?: Maybe; + name?: Maybe; }; export type SellerInstallment = { /** Wether the installment has discount. */ - discount: Scalars["Boolean"]["output"]; + discount: Scalars['Boolean']['output']; /** Wether the installment has fees. */ - fees: Scalars["Boolean"]["output"]; + fees: Scalars['Boolean']['output']; /** The number of installments. */ - number: Scalars["Int"]["output"]; + number: Scalars['Int']['output']; /** The value of the installment. */ - value: Scalars["Decimal"]["output"]; + value: Scalars['Decimal']['output']; }; export type SellerInstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; }; /** The seller's product offer */ export type SellerOffer = { - name?: Maybe; + name?: Maybe; /** The product prices. */ prices?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; }; /** The prices of the product. */ @@ -3298,68 +3375,68 @@ export type SellerPrices = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price. */ - price?: Maybe; + price?: Maybe; }; export type ShippingNode = { /** The shipping deadline. */ - deadline: Scalars["Int"]["output"]; + deadline: Scalars['Int']['output']; /** The delivery schedule detail. */ deliverySchedule?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars["Uuid"]["output"]; + shippingQuoteId: Scalars['Uuid']['output']; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars["Float"]["output"]; + value: Scalars['Float']['output']; }; /** The product informations related to the shipping. */ export type ShippingProduct = { /** The product unique identifier. */ - productVariantId: Scalars["Int"]["output"]; + productVariantId: Scalars['Int']['output']; /** The shipping value related to the product. */ - value: Scalars["Float"]["output"]; + value: Scalars['Float']['output']; }; /** A shipping quote. */ export type ShippingQuote = Node & { /** The shipping deadline. */ - deadline: Scalars["Int"]["output"]; + deadline: Scalars['Int']['output']; /** The available time slots for scheduling the delivery of the shipping quote. */ deliverySchedules?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The products related to the shipping. */ products?: Maybe>>; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars["Uuid"]["output"]; + shippingQuoteId: Scalars['Uuid']['output']; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars["Float"]["output"]; + value: Scalars['Float']['output']; }; /** Informations about the store. */ export type Shop = { /** Checkout URL */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** Store main URL */ - mainUrl?: Maybe; + mainUrl?: Maybe; /** Mobile checkout URL */ - mobileCheckoutUrl?: Maybe; + mobileCheckoutUrl?: Maybe; /** Mobile URL */ - mobileUrl?: Maybe; + mobileUrl?: Maybe; /** Store modified name */ - modifiedName?: Maybe; + modifiedName?: Maybe; /** Store name */ - name?: Maybe; + name?: Maybe; /** Physical stores */ physicalStores?: Maybe>>; }; @@ -3367,27 +3444,28 @@ export type Shop = { /** Store setting. */ export type ShopSetting = { /** Setting name */ - name?: Maybe; + name?: Maybe; /** Setting value */ - value?: Maybe; + value?: Maybe; }; /** Information about a similar product. */ export type SimilarProduct = { /** The url alias of this similar product. */ - alias?: Maybe; + alias?: Maybe; /** The file name of the similar product image. */ - image?: Maybe; + image?: Maybe; /** The URL of the similar product image. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the similar product. */ - name?: Maybe; + name?: Maybe; }; + /** Information about a similar product. */ export type SimilarProductImageUrlArgs = { - h?: InputMaybe; - w?: InputMaybe; + h?: InputMaybe; + w?: InputMaybe; }; export type SimpleLogin = { @@ -3401,8 +3479,8 @@ export type SimpleLogin = { /** The simple login type. */ export type SimpleLoginType = - | "NEW" - | "SIMPLE"; + | 'NEW' + | 'SIMPLE'; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsite = Node & { @@ -3415,17 +3493,17 @@ export type SingleHotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars["Long"]["output"]; + hotsiteId: Scalars['Long']['output']; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars["Int"]["output"]; + pageSize: Scalars['Int']['output']; /** A list of products associated with the hotsite. Cursor pagination. */ products?: Maybe; /** A list of products associated with the hotsite. Offset pagination. */ @@ -3435,39 +3513,41 @@ export type SingleHotsite = Node & { /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; + /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; + /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3475,17 +3555,17 @@ export type SingleHotsiteProductsByOffsetArgs = { /** A product represents an item for sale in the store. */ export type SingleProduct = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ @@ -3493,41 +3573,41 @@ export type SingleProduct = Node & { /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -3535,13 +3615,13 @@ export type SingleProduct = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -3553,104 +3633,106 @@ export type SingleProduct = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; + /** A product represents an item for sale in the store. */ export type SingleProductAttributeSelectionsArgs = { selected?: InputMaybe>>; }; + /** A product represents an item for sale in the store. */ export type SingleProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Define the sort orientation of the result set. */ export type SortDirection = /** The results will be sorted in an ascending order. */ - | "ASC" + | 'ASC' /** The results will be sorted in an descending order. */ - | "DESC"; + | 'DESC'; /** Information about a product stock in a particular distribution center. */ export type Stock = { /** The id of the distribution center. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The number of physical items in stock at this DC. */ - items: Scalars["Long"]["output"]; + items: Scalars['Long']['output']; /** The name of the distribution center. */ - name?: Maybe; + name?: Maybe; }; /** Input to specify the range of stocks, distribution center ID, and distribution center name to return. */ export type StocksInput = { /** The distribution center Ids to match. */ - dcId?: InputMaybe>; + dcId?: InputMaybe>; /** The distribution center names to match. */ - dcName?: InputMaybe>>; + dcName?: InputMaybe>>; /** The product stock must be greater than or equal to. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** The product stock must be lesser than or equal to. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; }; export type SubscriptionGroup = { /** The recurring types for this subscription group. */ recurringTypes?: Maybe>>; /** The status name of the group. */ - status?: Maybe; + status?: Maybe; /** The status id of the group. */ - statusId: Scalars["Int"]["output"]; + statusId: Scalars['Int']['output']; /** The subscription group id. */ - subscriptionGroupId: Scalars["Long"]["output"]; + subscriptionGroupId: Scalars['Long']['output']; /** Wether the product is only avaible for subscription. */ - subscriptionOnly: Scalars["Boolean"]["output"]; + subscriptionOnly: Scalars['Boolean']['output']; }; export type SubscriptionRecurringType = { /** The number of days of the recurring type. */ - days: Scalars["Int"]["output"]; + days: Scalars['Int']['output']; /** The recurring type display name. */ - name?: Maybe; + name?: Maybe; /** The recurring type id. */ - recurringTypeId: Scalars["Long"]["output"]; + recurringTypeId: Scalars['Long']['output']; }; export type UpdateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber?: InputMaybe; - cep?: InputMaybe; - city?: InputMaybe; - country?: InputMaybe; - email?: InputMaybe; - name?: InputMaybe; - neighborhood?: InputMaybe; - phone?: InputMaybe; - referencePoint?: InputMaybe; - state?: InputMaybe; - street?: InputMaybe; + addressDetails?: InputMaybe; + addressNumber?: InputMaybe; + cep?: InputMaybe; + city?: InputMaybe; + country?: InputMaybe; + email?: InputMaybe; + name?: InputMaybe; + neighborhood?: InputMaybe; + phone?: InputMaybe; + referencePoint?: InputMaybe; + state?: InputMaybe; + street?: InputMaybe; }; /** Node of URI Kind. */ @@ -3662,34 +3744,34 @@ export type Uri = { /** The partner subtype. */ partnerSubtype?: Maybe; /** Product alias. */ - productAlias?: Maybe; + productAlias?: Maybe; /** Product categories IDs. */ - productCategoriesIds?: Maybe>; + productCategoriesIds?: Maybe>; /** Redirect status code. */ - redirectCode?: Maybe; + redirectCode?: Maybe; /** Url to redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; export type UriKind = - | "BUY_LIST" - | "HOTSITE" - | "NOT_FOUND" - | "PARTNER" - | "PRODUCT" - | "REDIRECT"; + | 'BUY_LIST' + | 'HOTSITE' + | 'NOT_FOUND' + | 'PARTNER' + | 'PRODUCT' + | 'REDIRECT'; export type WholesalePrices = { /** The wholesale price. */ - price: Scalars["Decimal"]["output"]; + price: Scalars['Decimal']['output']; /** The minimum quantity required for the wholesale price to be applied */ - quantity: Scalars["Int"]["output"]; + quantity: Scalars['Int']['output']; }; /** A representation of available time slots for scheduling a delivery. */ export type DeliverySchedule = { /** The date of the delivery schedule. */ - date: Scalars["DateTime"]["output"]; + date: Scalars['DateTime']['output']; /** The list of time periods available for scheduling a delivery. */ periods?: Maybe>>; }; @@ -3697,40 +3779,40 @@ export type DeliverySchedule = { /** Informations about a forbidden search term. */ export type ForbiddenTerm = { /** The suggested search term instead. */ - suggested?: Maybe; + suggested?: Maybe; /** The text to display about the term. */ - text?: Maybe; + text?: Maybe; }; export type Order = { /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** Current account value used for the order. */ - currentAccount: Scalars["Decimal"]["output"]; + currentAccount: Scalars['Decimal']['output']; /** The date when te order was placed. */ - date: Scalars["DateTime"]["output"]; + date: Scalars['DateTime']['output']; /** The address where the order will be delivered. */ deliveryAddress?: Maybe; /** Order discount amount, if any. */ - discount: Scalars["Decimal"]["output"]; + discount: Scalars['Decimal']['output']; /** Order interest fee, if any. */ - interestFee: Scalars["Decimal"]["output"]; + interestFee: Scalars['Decimal']['output']; /** Information about order invoices. */ invoices?: Maybe>>; /** Information about order notes. */ notes?: Maybe>>; /** Order unique identifier. */ - orderId: Scalars["Long"]["output"]; + orderId: Scalars['Long']['output']; /** The date when the order was payed. */ - paymentDate?: Maybe; + paymentDate?: Maybe; /** Information about payments. */ payments?: Maybe>>; /** Products belonging to the order. */ products?: Maybe>>; /** List of promotions applied to the order. */ - promotions?: Maybe>; + promotions?: Maybe>; /** The shipping fee. */ - shippingFee: Scalars["Decimal"]["output"]; + shippingFee: Scalars['Decimal']['output']; /** Information about order shippings. */ shippings?: Maybe>>; /** The order current status. */ @@ -3738,30 +3820,30 @@ export type Order = { /** List of the order status history. */ statusHistory?: Maybe>>; /** Order subtotal value. */ - subtotal: Scalars["Decimal"]["output"]; + subtotal: Scalars['Decimal']['output']; /** Order total value. */ - total: Scalars["Decimal"]["output"]; + total: Scalars['Decimal']['output']; /** Information about order trackings. */ trackings?: Maybe>>; }; export type PaymentMethod = Node & { /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url link that displays for the payment. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; }; /** Represents a time period available for scheduling a delivery. */ export type Period = { /** The end time of the time period. */ - end?: Maybe; + end?: Maybe; /** The unique identifier of the time period. */ - id: Scalars["Long"]["output"]; + id: Scalars['Long']['output']; /** The start time of the time period. */ - start?: Maybe; + start?: Maybe; }; export type Wishlist = { @@ -3770,816 +3852,77 @@ export type Wishlist = { }; export type AddCouponMutationVariables = Exact<{ - checkoutId: Scalars["Uuid"]["input"]; - coupon: Scalars["String"]["input"]; + checkoutId: Scalars['Uuid']['input']; + coupon: Scalars['String']['input']; }>; -export type AddCouponMutation = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; + +export type AddCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; export type AddItemToCartMutationVariables = Exact<{ input: CheckoutProductInput; }>; -export type AddItemToCartMutation = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; + +export type AddItemToCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; export type RemoveCouponMutationVariables = Exact<{ - checkoutId: Scalars["Uuid"]["input"]; + checkoutId: Scalars['Uuid']['input']; }>; -export type RemoveCouponMutation = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; + +export type RemoveCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; export type RemoveItemFromCartMutationVariables = Exact<{ input: CheckoutProductInput; }>; -export type RemoveItemFromCartMutation = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; + +export type RemoveItemFromCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; export type GetCartQueryVariables = Exact<{ - checkoutId: Scalars["String"]["input"]; + checkoutId: Scalars['String']['input']; }>; -export type GetCartQuery = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; - -export type CreateCartMutation = { - checkout?: { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; - } | null; -}; + +export type GetCartQuery = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; + + +export type CreateCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; export type GetProductQueryVariables = Exact<{ - productId: Scalars["Long"]["input"]; + productId: Scalars['Long']['input']; }>; -export type GetProductQuery = { - product?: { - mainVariant?: boolean | null; - productName?: string | null; - productId?: any | null; - alias?: string | null; - available?: boolean | null; - averageRating?: number | null; - condition?: string | null; - createdAt?: any | null; - ean?: string | null; - id?: string | null; - minimumOrderQuantity?: number | null; - productVariantId?: any | null; - sku?: string | null; - stock?: any | null; - variantName?: string | null; - attributes?: - | Array<{ value?: string | null; name?: string | null } | null> - | null; - productCategories?: - | Array< - { - name?: string | null; - url?: string | null; - hierarchy?: string | null; - main: boolean; - googleCategories?: string | null; - } | null - > - | null; - informations?: - | Array< - | { title?: string | null; value?: string | null; type?: string | null } - | null - > - | null; - breadcrumbs?: - | Array<{ text?: string | null; link?: string | null } | null> - | null; - images?: - | Array< - { url?: string | null; fileName?: string | null; print: boolean } | null - > - | null; - prices?: { - discountPercentage: any; - discounted: boolean; - listPrice?: any | null; - multiplicationFactor: number; - price: any; - bestInstallment?: { - discount: boolean; - displayName?: string | null; - fees: boolean; - name?: string | null; - number: number; - value: any; - } | null; - installmentPlans?: - | Array< - { - displayName?: string | null; - name?: string | null; - installments?: - | Array< - | { - discount: boolean; - fees: boolean; - number: number; - value: any; - } - | null - > - | null; - } | null - > - | null; - priceTables?: - | Array< - { - discountPercentage: any; - id: any; - listPrice?: any | null; - price: any; - } | null - > - | null; - wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; - } | null; - productBrand?: { - fullUrlLogo?: string | null; - logoUrl?: string | null; - name?: string | null; - alias?: string | null; - } | null; - reviews?: - | Array< - { - rating: number; - review?: string | null; - reviewDate: any; - email?: string | null; - customer?: string | null; - } | null - > - | null; - seller?: { name?: string | null } | null; - seo?: - | Array< - { - name?: string | null; - scheme?: string | null; - type?: string | null; - httpEquiv?: string | null; - content?: string | null; - } | null - > - | null; - } | null; -}; + +export type GetProductQuery = { product?: { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null } | null }; export type GetProductsQueryVariables = Exact<{ filters: ProductExplicitFiltersInput; - first: Scalars["Int"]["input"]; + first: Scalars['Int']['input']; sortDirection: SortDirection; sortKey?: InputMaybe; }>; -export type GetProductsQuery = { - products?: { - nodes?: - | Array< - { - mainVariant?: boolean | null; - productName?: string | null; - productId?: any | null; - alias?: string | null; - available?: boolean | null; - averageRating?: number | null; - condition?: string | null; - createdAt?: any | null; - ean?: string | null; - id?: string | null; - minimumOrderQuantity?: number | null; - productVariantId?: any | null; - sku?: string | null; - stock?: any | null; - variantName?: string | null; - attributes?: - | Array<{ value?: string | null; name?: string | null } | null> - | null; - productCategories?: - | Array< - { - name?: string | null; - url?: string | null; - hierarchy?: string | null; - main: boolean; - googleCategories?: string | null; - } | null - > - | null; - informations?: - | Array< - { - title?: string | null; - value?: string | null; - type?: string | null; - } | null - > - | null; - images?: - | Array< - | { - url?: string | null; - fileName?: string | null; - print: boolean; - } - | null - > - | null; - prices?: { - discountPercentage: any; - discounted: boolean; - listPrice?: any | null; - multiplicationFactor: number; - price: any; - bestInstallment?: { - discount: boolean; - displayName?: string | null; - fees: boolean; - name?: string | null; - number: number; - value: any; - } | null; - installmentPlans?: - | Array< - { - displayName?: string | null; - name?: string | null; - installments?: - | Array< - { - discount: boolean; - fees: boolean; - number: number; - value: any; - } | null - > - | null; - } | null - > - | null; - priceTables?: - | Array< - { - discountPercentage: any; - id: any; - listPrice?: any | null; - price: any; - } | null - > - | null; - wholesalePrices?: - | Array<{ price: any; quantity: number } | null> - | null; - } | null; - productBrand?: { - fullUrlLogo?: string | null; - logoUrl?: string | null; - name?: string | null; - alias?: string | null; - } | null; - seller?: { name?: string | null } | null; - } | null - > - | null; - } | null; -}; + +export type GetProductsQuery = { products?: { nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null } | null }; export type SearchQueryVariables = Exact<{ operation: Operation; - query?: InputMaybe; - first: Scalars["Int"]["input"]; + query?: InputMaybe; + first: Scalars['Int']['input']; sortDirection?: InputMaybe; sortKey?: InputMaybe; - filters?: InputMaybe< - Array> | InputMaybe - >; + filters?: InputMaybe> | InputMaybe>; }>; -export type SearchQuery = { - search?: { - pageSize: number; - redirectUrl?: string | null; - searchTime?: string | null; - aggregations?: { - filters?: - | Array< - { - field?: string | null; - origin?: string | null; - values?: - | Array<{ quantity: number; name?: string | null } | null> - | null; - } | null - > - | null; - } | null; - breadcrumbs?: - | Array<{ link?: string | null; text?: string | null } | null> - | null; - forbiddenTerm?: { text?: string | null; suggested?: string | null } | null; - products?: { - totalCount: number; - nodes?: - | Array< - { - mainVariant?: boolean | null; - productName?: string | null; - productId?: any | null; - alias?: string | null; - available?: boolean | null; - averageRating?: number | null; - condition?: string | null; - createdAt?: any | null; - ean?: string | null; - id?: string | null; - minimumOrderQuantity?: number | null; - productVariantId?: any | null; - sku?: string | null; - stock?: any | null; - variantName?: string | null; - attributes?: - | Array<{ value?: string | null; name?: string | null } | null> - | null; - productCategories?: - | Array< - { - name?: string | null; - url?: string | null; - hierarchy?: string | null; - main: boolean; - googleCategories?: string | null; - } | null - > - | null; - informations?: - | Array< - { - title?: string | null; - value?: string | null; - type?: string | null; - } | null - > - | null; - images?: - | Array< - { - url?: string | null; - fileName?: string | null; - print: boolean; - } | null - > - | null; - prices?: { - discountPercentage: any; - discounted: boolean; - listPrice?: any | null; - multiplicationFactor: number; - price: any; - bestInstallment?: { - discount: boolean; - displayName?: string | null; - fees: boolean; - name?: string | null; - number: number; - value: any; - } | null; - installmentPlans?: - | Array< - { - displayName?: string | null; - name?: string | null; - installments?: - | Array< - { - discount: boolean; - fees: boolean; - number: number; - value: any; - } | null - > - | null; - } | null - > - | null; - priceTables?: - | Array< - { - discountPercentage: any; - id: any; - listPrice?: any | null; - price: any; - } | null - > - | null; - wholesalePrices?: - | Array<{ price: any; quantity: number } | null> - | null; - } | null; - productBrand?: { - fullUrlLogo?: string | null; - logoUrl?: string | null; - name?: string | null; - alias?: string | null; - } | null; - seller?: { name?: string | null } | null; - } | null - > - | null; - pageInfo: { hasNextPage: boolean; hasPreviousPage: boolean }; - } | null; - } | null; -}; - -export type CheckoutFragment = { - checkoutId: any; - shippingFee: any; - subtotal: any; - total: any; - completed: boolean; - coupon?: string | null; - products?: - | Array< - { - imageUrl?: string | null; - brand?: string | null; - ajustedPrice: any; - listPrice: any; - price: any; - name?: string | null; - productId: any; - productVariantId: any; - quantity: number; - sku?: string | null; - url?: string | null; - } | null - > - | null; -}; - -export type ProductFragment = { - mainVariant?: boolean | null; - productName?: string | null; - productId?: any | null; - alias?: string | null; - available?: boolean | null; - averageRating?: number | null; - condition?: string | null; - createdAt?: any | null; - ean?: string | null; - id?: string | null; - minimumOrderQuantity?: number | null; - productVariantId?: any | null; - sku?: string | null; - stock?: any | null; - variantName?: string | null; - attributes?: - | Array<{ value?: string | null; name?: string | null } | null> - | null; - productCategories?: - | Array< - { - name?: string | null; - url?: string | null; - hierarchy?: string | null; - main: boolean; - googleCategories?: string | null; - } | null - > - | null; - informations?: - | Array< - | { title?: string | null; value?: string | null; type?: string | null } - | null - > - | null; - images?: - | Array< - { url?: string | null; fileName?: string | null; print: boolean } | null - > - | null; - prices?: { - discountPercentage: any; - discounted: boolean; - listPrice?: any | null; - multiplicationFactor: number; - price: any; - bestInstallment?: { - discount: boolean; - displayName?: string | null; - fees: boolean; - name?: string | null; - number: number; - value: any; - } | null; - installmentPlans?: - | Array< - { - displayName?: string | null; - name?: string | null; - installments?: - | Array< - | { discount: boolean; fees: boolean; number: number; value: any } - | null - > - | null; - } | null - > - | null; - priceTables?: - | Array< - | { - discountPercentage: any; - id: any; - listPrice?: any | null; - price: any; - } - | null - > - | null; - wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; - } | null; - productBrand?: { - fullUrlLogo?: string | null; - logoUrl?: string | null; - name?: string | null; - alias?: string | null; - } | null; - seller?: { name?: string | null } | null; -}; - -export type SingleProductFragment = { - mainVariant?: boolean | null; - productName?: string | null; - productId?: any | null; - alias?: string | null; - available?: boolean | null; - averageRating?: number | null; - condition?: string | null; - createdAt?: any | null; - ean?: string | null; - id?: string | null; - minimumOrderQuantity?: number | null; - productVariantId?: any | null; - sku?: string | null; - stock?: any | null; - variantName?: string | null; - attributes?: - | Array<{ value?: string | null; name?: string | null } | null> - | null; - productCategories?: - | Array< - { - name?: string | null; - url?: string | null; - hierarchy?: string | null; - main: boolean; - googleCategories?: string | null; - } | null - > - | null; - informations?: - | Array< - | { title?: string | null; value?: string | null; type?: string | null } - | null - > - | null; - breadcrumbs?: - | Array<{ text?: string | null; link?: string | null } | null> - | null; - images?: - | Array< - { url?: string | null; fileName?: string | null; print: boolean } | null - > - | null; - prices?: { - discountPercentage: any; - discounted: boolean; - listPrice?: any | null; - multiplicationFactor: number; - price: any; - bestInstallment?: { - discount: boolean; - displayName?: string | null; - fees: boolean; - name?: string | null; - number: number; - value: any; - } | null; - installmentPlans?: - | Array< - { - displayName?: string | null; - name?: string | null; - installments?: - | Array< - | { discount: boolean; fees: boolean; number: number; value: any } - | null - > - | null; - } | null - > - | null; - priceTables?: - | Array< - | { - discountPercentage: any; - id: any; - listPrice?: any | null; - price: any; - } - | null - > - | null; - wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; - } | null; - productBrand?: { - fullUrlLogo?: string | null; - logoUrl?: string | null; - name?: string | null; - alias?: string | null; - } | null; - reviews?: - | Array< - { - rating: number; - review?: string | null; - reviewDate: any; - email?: string | null; - customer?: string | null; - } | null - > - | null; - seller?: { name?: string | null } | null; - seo?: - | Array< - { - name?: string | null; - scheme?: string | null; - type?: string | null; - httpEquiv?: string | null; - content?: string | null; - } | null - > - | null; -}; + +export type SearchQuery = { search?: { pageSize: number, redirectUrl?: string | null, searchTime?: string | null, aggregations?: { filters?: Array<{ field?: string | null, origin?: string | null, values?: Array<{ quantity: number, name?: string | null } | null> | null } | null> | null } | null, breadcrumbs?: Array<{ link?: string | null, text?: string | null } | null> | null, forbiddenTerm?: { text?: string | null, suggested?: string | null } | null, products?: { totalCount: number, nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null, pageInfo: { hasNextPage: boolean, hasPreviousPage: boolean } } | null } | null }; + +export type CheckoutFragment = { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null }; + +export type ProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null }; + +export type SingleProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null }; From 07c51ba011fa7200f8d604ad098c5f015f9d2d13 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 10:58:33 -0300 Subject: [PATCH 08/21] remove illegal whitespaces --- .github/workflows/ci.yaml | 63 + deno.json | 2 +- scripts/start.ts | 18 +- shopify/actions/cart/addItems.ts | 12 +- shopify/actions/cart/updateCoupons.ts | 16 +- shopify/actions/cart/updateItems.ts | 13 +- shopify/hooks/context.ts | 2 +- shopify/hooks/useCart.ts | 2 +- shopify/loaders/ProductDetailsPage.ts | 11 +- shopify/loaders/ProductList.ts | 15 +- shopify/loaders/ProductListingPage.ts | 19 +- shopify/loaders/cart.ts | 18 +- shopify/utils/admin/admin.graphql.gen.ts | 42435 ++++ shopify/utils/admin/admin.graphql.json | 194416 +++++++++++++++ shopify/utils/admin/queries.ts | 8 + shopify/utils/fragments/cart.ts | 73 - shopify/utils/fragments/product.ts | 65 - shopify/utils/fragments/productVariant.ts | 42 - shopify/utils/storefront/queries.ts | 255 + .../storefront.graphql.gen.ts | 4968 +- .../{ => storefront}/storefront.graphql.json | 0 shopify/utils/transform.ts | 2 +- wake/actions/cart/addCoupon.ts | 11 +- wake/actions/cart/addItem.ts | 7 +- wake/actions/cart/removeCoupon.ts | 10 +- wake/actions/cart/updateItemQuantity.ts | 14 +- wake/loaders/cart.ts | 11 +- wake/loaders/productDetailsPage.ts | 7 +- wake/loaders/productList.ts | 7 +- wake/loaders/productListingPage.ts | 41 +- wake/utils/graphql/fragments/checkout.ts | 25 - wake/utils/graphql/fragments/product.ts | 86 - wake/utils/graphql/fragments/singleProduct.ts | 104 - wake/utils/graphql/queries.ts | 311 + wake/utils/graphql/storefront.graphql.gen.ts | 3376 +- 35 files changed, 242214 insertions(+), 4251 deletions(-) create mode 100644 .github/workflows/ci.yaml create mode 100644 shopify/utils/admin/admin.graphql.gen.ts create mode 100644 shopify/utils/admin/admin.graphql.json create mode 100644 shopify/utils/admin/queries.ts delete mode 100644 shopify/utils/fragments/cart.ts delete mode 100644 shopify/utils/fragments/product.ts delete mode 100644 shopify/utils/fragments/productVariant.ts create mode 100644 shopify/utils/storefront/queries.ts rename shopify/utils/{ => storefront}/storefront.graphql.gen.ts (71%) rename shopify/utils/{ => storefront}/storefront.graphql.json (100%) delete mode 100644 wake/utils/graphql/fragments/checkout.ts delete mode 100644 wake/utils/graphql/fragments/product.ts delete mode 100644 wake/utils/graphql/fragments/singleProduct.ts create mode 100644 wake/utils/graphql/queries.ts diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 000000000..5f8a4f215 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,63 @@ +name: ci + +on: + push: + branches: + - main + tags: + - v* + pull_request: + branches: + - main +jobs: + test: + strategy: + matrix: + os: [ubuntu-latest, windows-latest] + runs-on: ${{ matrix.os }} + name: "Setup deno" + steps: + - uses: actions/checkout@v3 + - name: cache deno installation and deno.land dependencies + uses: actions/cache@v2 + with: + key: ${{ runner.os }}-deno-${{ hashFiles('**/*') }} + restore-keys: ${{ runner.os }}-deno- + path: | + /home/runner/.deno + /home/runner/.cache/deno/deps/https/deno.land + - uses: denoland/setup-deno@v1 + with: + deno-version: v1.x + - name: Build Deno Module + run: deno run -A --lock=deno.lock --lock-write --reload mod.ts + - name: fetch any uncached dependencies + run: | + deno cache --lock=deno.lock --lock-write --reload=file: ./mod.ts + + ## Generate updated live.gen.ts + - run: | + deno run --unstable --lock=deno.lock --lock-write -A dev.ts + + - name: Check if there are changes on ${{ matrix.os }} + id: changes + shell: bash + run: | + git status --porcelain + if [[ $(git status --porcelain | wc -c) -eq 0 ]]; then + echo "uncommitted changes detected" + exit 1 + fi + + - run: | + deno test --lock=deno.lock --lock-write -A . + - run: | + deno bench --lock=deno.lock --lock-write -A . + - name: check lint + continue-on-error: true + run: | + deno --unstable lint + - name: check formatting + continue-on-error: true + run: | + deno fmt --check \ No newline at end of file diff --git a/deno.json b/deno.json index 587304aeb..9b17fcb65 100644 --- a/deno.json +++ b/deno.json @@ -23,4 +23,4 @@ "jsx": "react-jsx", "jsxImportSource": "preact" } -} \ No newline at end of file +} diff --git a/scripts/start.ts b/scripts/start.ts index 7aeb6383c..d1e2b14e1 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -1,6 +1,7 @@ // deno-lint-ignore-file no-explicit-any import "npm:@graphql-codegen/typescript"; import "npm:@graphql-codegen/typescript-operations"; +import "npm:@graphql-codegen/add"; import { CodegenConfig, generate } from "npm:@graphql-codegen/cli"; import { compile } from "npm:json-schema-to-typescript"; @@ -192,8 +193,7 @@ const generateOpenAPI = async () => { const generateGraphQL = async () => { for (const path of allGraphqlPaths) { const [folder, base] = [dirname(path), basename(path)]; - const [appEntrypoint, ...tail] = folder.split("/"); - const outfile = toOutfile(join(...tail, base)); + const outfile = toOutfile(base); console.info(`Generating GraphQL types for specs at ${folder}`); const config: CodegenConfig = { @@ -202,7 +202,13 @@ const generateGraphQL = async () => { documents: [`./**/*.ts`], generates: { [outfile]: { + // This order matters plugins: [ + { + add: { + content: BANNER, + }, + }, "typescript", "typescript-operations", ], @@ -214,13 +220,7 @@ const generateGraphQL = async () => { }, }; - await generate({ ...config, cwd: appEntrypoint }, true); - - const o = join(appEntrypoint, outfile); - await Deno.writeTextFile( - o, - `${BANNER.trim()}\n${await Deno.readTextFile(o)}`, - ); + await generate({ ...config, cwd: folder }, true); } }; diff --git a/shopify/actions/cart/addItems.ts b/shopify/actions/cart/addItems.ts index 24cc641b0..8e3bca7d4 100644 --- a/shopify/actions/cart/addItems.ts +++ b/shopify/actions/cart/addItems.ts @@ -1,12 +1,11 @@ -import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/fragments/cart.ts"; +import { AddItemToCart } from "../../utils/storefront/queries.ts"; import { AddItemToCartMutation, AddItemToCartMutationVariables, CartFragment, -} from "../../utils/storefront.graphql.gen.ts"; +} from "../../utils/storefront/storefront.graphql.gen.ts"; type UpdateLineProps = { lines: { @@ -34,12 +33,7 @@ const action = async ( AddItemToCartMutationVariables >({ variables: { cartId, lines }, - fragments: [fragment], - query: gql`mutation AddItemToCart($cartId: ID!, $lines: [CartLineInput!]!) { - payload: cartLinesAdd(cartId: $cartId, lines: $lines) { - cart { ...Cart } - } - }`, + ...AddItemToCart, }); setCartCookie(ctx.response.headers, cartId); diff --git a/shopify/actions/cart/updateCoupons.ts b/shopify/actions/cart/updateCoupons.ts index 7cf6655eb..abd678a14 100644 --- a/shopify/actions/cart/updateCoupons.ts +++ b/shopify/actions/cart/updateCoupons.ts @@ -1,12 +1,11 @@ -import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/fragments/cart.ts"; import { AddCouponMutation, AddCouponMutationVariables, CartFragment, -} from "../../utils/storefront.graphql.gen.ts"; +} from "../../utils/storefront/storefront.graphql.gen.ts"; +import { AddCoupon } from "../../utils/storefront/queries.ts"; type AddCouponProps = { discountCodes: string[]; @@ -29,16 +28,7 @@ const action = async ( AddCouponMutationVariables >({ variables: { cartId, discountCodes: props.discountCodes }, - fragments: [fragment], - query: gql`mutation AddCoupon($cartId: ID!, $discountCodes: [String!]!) { - payload: cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) { - cart { ...Cart } - userErrors { - field - message - } - } - }`, + ...AddCoupon, }); setCartCookie(ctx.response.headers, cartId); diff --git a/shopify/actions/cart/updateItems.ts b/shopify/actions/cart/updateItems.ts index 3cf947814..dff50595c 100644 --- a/shopify/actions/cart/updateItems.ts +++ b/shopify/actions/cart/updateItems.ts @@ -1,12 +1,11 @@ -import { gql } from "../../../utils/graphql.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/fragments/cart.ts"; +import { UpdateItems } from "../../utils/storefront/queries.ts"; import { CartFragment, UpdateItemsMutation, UpdateItemsMutationVariables, -} from "../../utils/storefront.graphql.gen.ts"; +} from "../../utils/storefront/storefront.graphql.gen.ts"; type UpdateLineProps = { lines: Array<{ @@ -32,13 +31,7 @@ const action = async ( UpdateItemsMutationVariables >({ variables: { cartId, lines }, - fragments: [fragment], - query: - gql`mutation UpdateItems($cartId: ID!, $lines: [CartLineUpdateInput!]!) { - payload: cartLinesUpdate(cartId: $cartId, lines: $lines) { - cart { ...Cart } - } - }`, + ...UpdateItems, }); setCartCookie(ctx.response.headers, cartId); diff --git a/shopify/hooks/context.ts b/shopify/hooks/context.ts index 72ddb9aa8..997247969 100644 --- a/shopify/hooks/context.ts +++ b/shopify/hooks/context.ts @@ -1,7 +1,7 @@ import { IS_BROWSER } from "$fresh/runtime.ts"; import { signal } from "@preact/signals"; import { invoke } from "../runtime.ts"; -import type { CartFragment } from "../utils/storefront.graphql.gen.ts"; +import type { CartFragment } from "../utils/storefront/storefront.graphql.gen.ts"; export interface Context { cart: CartFragment | null; diff --git a/shopify/hooks/useCart.ts b/shopify/hooks/useCart.ts index 6103e7848..d7e8b7a43 100644 --- a/shopify/hooks/useCart.ts +++ b/shopify/hooks/useCart.ts @@ -2,7 +2,7 @@ import type { AnalyticsItem } from "../../commerce/types.ts"; import type { Manifest } from "../manifest.gen.ts"; import { invoke } from "../runtime.ts"; -import type { CartFragment } from "../utils/storefront.graphql.gen.ts"; +import type { CartFragment } from "../utils/storefront/storefront.graphql.gen.ts"; import { Context, state as storeState } from "./context.ts"; export const itemToAnalyticsItem = ( diff --git a/shopify/loaders/ProductDetailsPage.ts b/shopify/loaders/ProductDetailsPage.ts index 693777209..af7032e53 100644 --- a/shopify/loaders/ProductDetailsPage.ts +++ b/shopify/loaders/ProductDetailsPage.ts @@ -1,14 +1,12 @@ import { ProductDetailsPage } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; import { toProductPage } from "../../shopify/utils/transform.ts"; -import { gql } from "../../utils/graphql.ts"; import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; -import { fragment as productFragment } from "../utils/fragments/product.ts"; -import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; import { GetProductQuery, GetProductQueryVariables, -} from "../utils/storefront.graphql.gen.ts"; +} from "../utils/storefront/storefront.graphql.gen.ts"; +import { GetProduct } from "../utils/storefront/queries.ts"; export interface Props { slug: RequestURLParam; @@ -36,10 +34,7 @@ const loader = async ( GetProductQueryVariables >({ variables: { handle }, - fragments: [productFragment, variantFragment], - query: gql`query GetProduct($handle: String) { - product(handle: $handle) { ...Product } - }`, + ...GetProduct, }); if (!data?.product) { diff --git a/shopify/loaders/ProductList.ts b/shopify/loaders/ProductList.ts index 88a92206e..4ba0b01e3 100644 --- a/shopify/loaders/ProductList.ts +++ b/shopify/loaders/ProductList.ts @@ -1,12 +1,10 @@ import type { Product } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; -import { gql } from "../../utils/graphql.ts"; -import { fragment as productFragment } from "../utils/fragments/product.ts"; -import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; +import { ListProducts } from "../utils/storefront/queries.ts"; import { ListProductsQuery, ListProductsQueryVariables, -} from "../utils/storefront.graphql.gen.ts"; +} from "../utils/storefront/storefront.graphql.gen.ts"; import { toProduct } from "../utils/transform.ts"; export interface Props { @@ -35,14 +33,7 @@ const loader = async ( ListProductsQueryVariables >({ variables: { first: count, query }, - fragments: [productFragment, variantFragment], - query: gql`query ListProducts($first: Int, $after: String, $query: String) { - products(first: $first, after: $after, query: $query) { - nodes { - ...Product - } - } - }`, + ...ListProducts, }); // Transform Shopify product format into schema.org's compatible format diff --git a/shopify/loaders/ProductListingPage.ts b/shopify/loaders/ProductListingPage.ts index 509ee19ca..d44f39f55 100644 --- a/shopify/loaders/ProductListingPage.ts +++ b/shopify/loaders/ProductListingPage.ts @@ -1,12 +1,10 @@ import type { ProductListingPage } from "../../commerce/types.ts"; import { AppContext } from "../../shopify/mod.ts"; -import { gql } from "../../utils/graphql.ts"; -import { fragment as productFragment } from "../utils/fragments/product.ts"; -import { fragment as variantFragment } from "../utils/fragments/productVariant.ts"; +import { SearchProducts } from "../utils/storefront/queries.ts"; import { SearchProductsQuery, SearchProductsQueryVariables, -} from "../utils/storefront.graphql.gen.ts"; +} from "../utils/storefront/storefront.graphql.gen.ts"; import { toProduct } from "../utils/transform.ts"; export interface Props { @@ -42,18 +40,7 @@ const loader = async ( SearchProductsQueryVariables >({ variables: { first: count, query: query }, - fragments: [productFragment, variantFragment], - query: - gql`query SearchProducts($first: Int, $after: String, $query: String) { - products(first: $first, after: $after, query: $query) { - pageInfo { - hasNextPage - } - nodes { - ...Product - } - } - }`, + ...SearchProducts, }); // Transform Shopify product format into schema.org's compatible format diff --git a/shopify/loaders/cart.ts b/shopify/loaders/cart.ts index bede9fd3a..e5eef8d99 100644 --- a/shopify/loaders/cart.ts +++ b/shopify/loaders/cart.ts @@ -1,13 +1,12 @@ -import { gql } from "../../utils/graphql.ts"; import { AppContext } from "../mod.ts"; import { getCartCookie, setCartCookie } from "../utils/cart.ts"; -import { fragment } from "../utils/fragments/cart.ts"; +import { CreateCart, GetCart } from "../utils/storefront/queries.ts"; import { CreateCartMutation, CreateCartMutationVariables, GetCartQuery, GetCartQueryVariables, -} from "../utils/storefront.graphql.gen.ts"; +} from "../utils/storefront/storefront.graphql.gen.ts"; const loader = async ( _props: unknown, @@ -18,13 +17,9 @@ const loader = async ( const maybeCartId = getCartCookie(req.headers); const cartId = maybeCartId || - await storefront.query({ - query: gql`mutation CreateCart { - payload: cartCreate { - cart { id } - } - }`, - }).then((data) => data.payload?.cart?.id); + await storefront.query( + CreateCart, + ).then((data) => data.payload?.cart?.id); if (!cartId) { throw new Error("Missing cart id"); @@ -32,8 +27,7 @@ const loader = async ( const cart = await storefront.query({ variables: { id: cartId }, - fragments: [fragment], - query: gql`query GetCart($id: ID!) { cart(id: $id) { ...Cart } }`, + ...GetCart, }).then((data) => data.cart); setCartCookie(ctx.response.headers, cartId); diff --git a/shopify/utils/admin/admin.graphql.gen.ts b/shopify/utils/admin/admin.graphql.gen.ts new file mode 100644 index 000000000..3b3eedbf6 --- /dev/null +++ b/shopify/utils/admin/admin.graphql.gen.ts @@ -0,0 +1,42435 @@ +// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore +// +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno task start +// + +export type Maybe = T | null; +export type InputMaybe = Maybe; +export type Exact = { + [K in keyof T]: T[K]; +}; +export type MakeOptional = + & Omit + & { [SubKey in K]?: Maybe }; +export type MakeMaybe = + & Omit + & { [SubKey in K]: Maybe }; +export type MakeEmpty = + { [_ in K]?: never }; +export type Incremental = + | T + | { + [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; + }; +/** All built-in and custom scalars, mapped to their actual values */ +export type Scalars = { + ID: { input: string; output: string }; + String: { input: string; output: string }; + Boolean: { input: boolean; output: boolean }; + Int: { input: number; output: number }; + Float: { input: number; output: number }; + ARN: { input: any; output: any }; + Date: { input: any; output: any }; + DateTime: { input: any; output: any }; + Decimal: { input: any; output: any }; + FormattedString: { input: any; output: any }; + HTML: { input: any; output: any }; + JSON: { input: any; output: any }; + Money: { input: any; output: any }; + StorefrontID: { input: any; output: any }; + URL: { input: any; output: any }; + UnsignedInt64: { input: any; output: any }; + UtcOffset: { input: any; output: any }; +}; + +/** A checkout that was abandoned by the customer. */ +export type AbandonedCheckout = Navigable & Node & { + /** The URL for the buyer to recover their checkout. */ + abandonedCheckoutUrl: Scalars["URL"]["output"]; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The number of products in the checkout. */ + lineItemsQuantity: Scalars["Int"]["output"]; + /** + * The sum of all items in the checkout, including discounts, shipping, taxes, and tips. + */ + totalPriceSet: MoneyBag; +}; + +/** A browse, cart, or checkout that was abandoned by a customer. */ +export type Abandonment = Node & { + /** The abandonment payload for the abandoned checkout. */ + abandonedCheckoutPayload?: Maybe; + /** The abandonment type. */ + abandonmentType: AbandonmentAbandonmentType; + /** The app associated with an abandoned checkout. */ + app: App; + /** Permalink to the cart page. */ + cartUrl?: Maybe; + /** The date and time when the abandonment was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customer who abandoned this event. */ + customer: Customer; + /** Whether the customer has completed an order since this checkout has been abandoned. */ + customerHasNoOrderSinceAbandonment: Scalars["Boolean"]["output"]; + /** The number of days since the last abandonment email was sent to the customer. */ + daysSinceLastAbandonmentEmail: Scalars["Int"]["output"]; + /** When the email was sent, if that's the case. */ + emailSentAt?: Maybe; + /** The email state (e.g., sent or not sent). */ + emailState?: Maybe; + /** The number of hours since the customer has last abandoned a checkout. */ + hoursSinceLastAbandonedCheckout?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether the products in abandonment are available. */ + inventoryAvailable: Scalars["Boolean"]["output"]; + /** Whether the abandonment event comes from the Online Store sales channel. */ + isFromOnlineStore: Scalars["Boolean"]["output"]; + /** Whether the abandonment event comes from the Shop app sales channel. */ + isFromShopApp: Scalars["Boolean"]["output"]; + /** Whether the abandonment event comes from Shop Pay. */ + isFromShopPay: Scalars["Boolean"]["output"]; + /** Whether the customer didn't complete another most significant step since this abandonment. */ + isMostSignificantAbandonment: Scalars["Boolean"]["output"]; + /** The date for the latest browse abandonment. */ + lastBrowseAbandonmentDate: Scalars["DateTime"]["output"]; + /** The date for the latest cart abandonment. */ + lastCartAbandonmentDate: Scalars["DateTime"]["output"]; + /** The date for the latest checkout abandonment. */ + lastCheckoutAbandonmentDate: Scalars["DateTime"]["output"]; + /** The most recent step type. */ + mostRecentStep: AbandonmentAbandonmentType; + /** The products added to the cart during the customer abandoned visit. */ + productsAddedToCart: CustomerVisitProductInfoConnection; + /** The products viewed during the customer abandoned visit. */ + productsViewed: CustomerVisitProductInfoConnection; + /** The date and time when the visit started. */ + visitStartedAt?: Maybe; +}; + +/** A browse, cart, or checkout that was abandoned by a customer. */ +export type AbandonmentProductsAddedToCartArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A browse, cart, or checkout that was abandoned by a customer. */ +export type AbandonmentProductsViewedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Specifies the abandonment type. */ +export type AbandonmentAbandonmentType = + /** The abandonment event is an abandoned browse. */ + | "BROWSE" + /** The abandonment event is an abandoned cart. */ + | "CART" + /** The abandonment event is an abandoned checkout. */ + | "CHECKOUT"; + +/** Specifies the delivery state of a marketing activity. */ +export type AbandonmentDeliveryState = + /** The marketing activity action has not yet been sent. */ + | "NOT_SENT" + /** The marketing activity action has been scheduled for later delivery. */ + | "SCHEDULED" + /** The marketing activity action has been sent. */ + | "SENT"; + +/** Specifies the email state. */ +export type AbandonmentEmailState = + /** The email has not yet been sent. */ + | "NOT_SENT" + /** The email has been scheduled for later delivery. */ + | "SCHEDULED" + /** The email has been sent. */ + | "SENT"; + +/** Return type for `abandonmentEmailStateUpdate` mutation. */ +export type AbandonmentEmailStateUpdatePayload = { + /** The updated abandonment. */ + abandonment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `AbandonmentEmailStateUpdate`. */ +export type AbandonmentEmailStateUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `AbandonmentEmailStateUpdateUserError`. */ +export type AbandonmentEmailStateUpdateUserErrorCode = + /** Unable to find an Abandonment for the provided ID. */ + "ABANDONMENT_NOT_FOUND"; + +/** Return type for `abandonmentUpdateActivitiesDeliveryStatuses` mutation. */ +export type AbandonmentUpdateActivitiesDeliveryStatusesPayload = { + /** The updated abandonment. */ + abandonment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `AbandonmentUpdateActivitiesDeliveryStatuses`. */ +export type AbandonmentUpdateActivitiesDeliveryStatusesUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `AbandonmentUpdateActivitiesDeliveryStatusesUserError`. */ +export type AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode = + /** Unable to find an Abandonment for the provided ID. */ + | "ABANDONMENT_NOT_FOUND" + /** Unable to find delivery status info for the provided ID. */ + | "DELIVERY_STATUS_INFO_NOT_FOUND" + /** Unable to find a marketing activity for the provided ID. */ + | "MARKETING_ACTIVITY_NOT_FOUND"; + +/** + * The permission required to access a Shopify Admin API or Storefront API resource for a shop. Merchants grant access scopes that are requested by applications. + */ +export type AccessScope = { + /** A description of the actions that the access scope allows an app to perform. */ + description: Scalars["String"]["output"]; + /** + * A readable string that represents the access scope. The string usually follows the format `{action}_{resource}`. `{action}` is `read` or `write`, and `{resource}` is the resource that the action can be performed on. `{action}` and `{resource}` are separated by an underscore. For example, `read_orders` or `write_products`. + */ + handle: Scalars["String"]["output"]; +}; + +/** Represents an operation publishing all products to a publication. */ +export type AddAllProductsOperation = Node & ResourceOperation & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The count of processed rows, summing imported, failed, and skipped rows. */ + processedRowCount?: Maybe; + /** Represents a rows objects within this background operation. */ + rowCount?: Maybe; + /** The status of this operation. */ + status: ResourceOperationStatus; +}; + +/** The additional fees that have been applied to the order. */ +export type AdditionalFee = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the additional fee. */ + name: Scalars["String"]["output"]; + /** The price of the additional fee. */ + price: MoneyBag; + /** A list of taxes charged on the additional fee. */ + taxLines: Array; +}; + +/** A sale associated with an additional fee charge. */ +export type AdditionalFeeSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The additional fees for the associated sale. */ + additionalFee: SaleAdditionalFee; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** A sale associated with an order price adjustment. */ +export type AdjustmentSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** Targets all items the cart for a specified discount. */ +export type AllDiscountItems = { + /** Whether all items are eligible for the discount. This value always returns `true`. */ + allItems: Scalars["Boolean"]["output"]; +}; + +/** + * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). + * Versions are commonly referred to by their handle (for example, `2021-10`). + */ +export type ApiVersion = { + /** The human-readable name of the version. */ + displayName: Scalars["String"]["output"]; + /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ + handle: Scalars["String"]["output"]; + /** Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning). */ + supported: Scalars["Boolean"]["output"]; +}; + +/** A Shopify application. */ +export type App = Node & { + /** A unique application API identifier. */ + apiKey: Scalars["String"]["output"]; + /** App store page URL of the app. */ + appStoreAppUrl?: Maybe; + /** App store page URL of the developer who created the app. */ + appStoreDeveloperUrl?: Maybe; + /** The access scopes available to the app. */ + availableAccessScopes: Array; + /** Banner image for the app. */ + banner: Image; + /** Description of the app. */ + description?: Maybe; + /** The name of the app developer. */ + developerName?: Maybe; + /** The type of app developer. */ + developerType: AppDeveloperType; + /** + * Website of the developer who created the app. + * @deprecated Use `appStoreDeveloperUrl` instead. + */ + developerUrl: Scalars["URL"]["output"]; + /** Whether the app uses the Embedded App SDK. */ + embedded: Scalars["Boolean"]["output"]; + /** Requirements that must be met before the app can be installed. */ + failedRequirements: Array; + /** A list of app features that are shown in the Shopify App Store listing. */ + features: Array; + /** Feedback from this app about the store. */ + feedback?: Maybe; + /** Handle of the app. */ + handle?: Maybe; + /** Icon that represents the app. */ + icon: Image; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Webpage where you can install the app. */ + installUrl?: Maybe; + /** + * Corresponding AppInstallation for this shop and App. + * Returns null if the App is not installed. + */ + installation?: Maybe; + /** + * Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use. + */ + isPostPurchaseAppInUse: Scalars["Boolean"]["output"]; + /** + * Webpage that the app starts in. + * @deprecated Use AppInstallation.launchUrl instead + */ + launchUrl: Scalars["URL"]["output"]; + /** + * Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin. + * + * @deprecated Use AppInstallation.navigationItems instead + */ + navigationItems: Array; + /** Whether the app was previously installed on the current shop. */ + previouslyInstalled: Scalars["Boolean"]["output"]; + /** Detailed information about the app pricing. */ + pricingDetails?: Maybe; + /** Summary of the app pricing details. */ + pricingDetailsSummary: Scalars["String"]["output"]; + /** Link to app privacy policy. */ + privacyPolicyUrl?: Maybe; + /** The public category for the app. */ + publicCategory: AppPublicCategory; + /** Whether the app is published to the Shopify App Store. */ + published: Scalars["Boolean"]["output"]; + /** The access scopes requested by the app. */ + requestedAccessScopes: Array; + /** Screenshots of the app. */ + screenshots: Array; + /** Whether the app was developed by Shopify. */ + shopifyDeveloped: Scalars["Boolean"]["output"]; + /** Name of the app. */ + title: Scalars["String"]["output"]; + /** + * Message that appears when the app is uninstalled. For example: + * By removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time. + */ + uninstallMessage: Scalars["String"]["output"]; + /** + * Webpage where you can uninstall the app. + * @deprecated Use AppInstallation.uninstallUrl instead + */ + uninstallUrl?: Maybe; + /** The webhook API version for the app. */ + webhookApiVersion: Scalars["String"]["output"]; +}; + +/** + * A catalog that defines the publication associated with an app. + */ +export type AppCatalog = Catalog & Node & { + /** The apps associated with the catalog. */ + apps: AppConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Most recent catalog operations. */ + operations: Array; + /** The price list associated with the catalog. */ + priceList?: Maybe; + /** A group of products and collections that's published to a catalog. */ + publication?: Maybe; + /** The status of the catalog. */ + status: CatalogStatus; + /** The name of the catalog. */ + title: Scalars["String"]["output"]; +}; + +/** + * A catalog that defines the publication associated with an app. + */ +export type AppCatalogAppsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Apps. + */ +export type AppConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify. */ +export type AppCredit = Node & { + /** The amount that can be used towards future app purchases in Shopify. */ + amount: MoneyV2; + /** The date and time when the app credit was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The description of the app credit. */ + description: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether the app credit is a test transaction. */ + test: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple AppCredits. + */ +export type AppCreditConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppCreditEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one AppCredit and a cursor during pagination. + */ +export type AppCreditEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppCreditEdge. */ + node: AppCredit; +}; + +/** Possible types of app developer. */ +export type AppDeveloperType = + /** Indicates the app developer works directly for a Merchant. */ + | "MERCHANT" + /** Indicates the app developer is a Partner. */ + | "PARTNER" + /** Indicates the app developer is Shopify. */ + | "SHOPIFY" + /** Indicates the app developer is unknown. It is not categorized as any of the other developer types. */ + | "UNKNOWN"; + +/** A script that defines a discount type. */ +export type AppDiscountType = { + /** The app providing the app discount type. */ + app: App; + /** The App Bridge details for discount type configuration. */ + appBridge: FunctionsAppBridge; + /** The client ID of the app providing the app discount type. */ + appKey: Scalars["String"]["output"]; + /** A description of the app discount type. */ + description?: Maybe; + /** The class of the app discount type. */ + discountClass: DiscountClass; + /** The ID of the function providing the app discount type. */ + functionId: Scalars["String"]["output"]; + /** The target type of the app discount type. Possible values: `SHIPPING_LINE` and `LINE_ITEM`. */ + targetType: DiscountApplicationTargetType; + /** The title of the app discount type. */ + title: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type which holds one App and a cursor during pagination. + */ +export type AppEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppEdge. */ + node: App; +}; + +/** + * Reports the status of shops and their resources and displays this information + * within Shopify admin. AppFeedback is used to notify merchants about steps they need to take + * to set up an app on their store. + */ +export type AppFeedback = { + /** The application associated to the feedback. */ + app: App; + /** A link to where merchants can resolve errors. */ + link?: Maybe; + /** The feedback message presented to the merchant. */ + messages: Array; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallation = HasMetafields & Node & { + /** The access scopes granted to the application by a merchant during installation. */ + accessScopes: Array; + /** The active application subscriptions billed to the shop on a recurring basis. */ + activeSubscriptions: Array; + /** All subscriptions created for a shop. */ + allSubscriptions: AppSubscriptionConnection; + /** Application which is installed. */ + app: App; + /** + * Channel associated with the installed application. + * @deprecated Use `publication` instead. + */ + channel?: Maybe; + /** Credits that can be used towards future app purchases. */ + credits: AppCreditConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The URL to launch the application. */ + launchUrl: Scalars["URL"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** One-time purchases to a shop. */ + oneTimePurchases: AppPurchaseOneTimeConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The publication associated with the installed application. */ + publication?: Maybe; + /** The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes. */ + revenueAttributionRecords: AppRevenueAttributionRecordConnection; + /** + * Subscriptions charge to a shop on a recurring basis. + * @deprecated Use `activeSubscriptions` instead. + */ + subscriptions: Array; + /** The URL to uninstall the application. */ + uninstallUrl?: Maybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationAllSubscriptionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationCreditsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationOneTimePurchasesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents an installed application on a shop. */ +export type AppInstallationRevenueAttributionRecordsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * The possible categories of an app installation, based on their purpose + * or the environment they can run in. + */ +export type AppInstallationCategory = + /** Apps that serve as channels through which sales are made, such as the online store. */ + | "CHANNEL" + /** Apps that can be used in the POS mobile client. */ + | "POS_EMBEDDED"; + +/** + * An auto-generated type for paginating through multiple AppInstallations. + */ +export type AppInstallationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppInstallationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one AppInstallation and a cursor during pagination. + */ +export type AppInstallationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppInstallationEdge. */ + node: AppInstallation; +}; + +/** The levels of privacy of an app installation. */ +export type AppInstallationPrivacy = + | "PRIVATE" + | "PUBLIC"; + +/** The set of valid sort keys for the AppInstallation query. */ +export type AppInstallationSortKeys = + /** Sort by the `app_title` value. */ + | "APP_TITLE" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `installed_at` value. */ + | "INSTALLED_AT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * The pricing model for the app subscription. + * The pricing model input can be either `appRecurringPricingDetails` or `appUsagePricingDetails`. + */ +export type AppPlanInput = { + /** The pricing details for recurring billing. */ + appRecurringPricingDetails?: InputMaybe; + /** The pricing details for usage-based billing. */ + appUsagePricingDetails?: InputMaybe; +}; + +/** The app plan that the merchant is subscribed to. */ +export type AppPlanV2 = { + /** The plan billed to a shop on a recurring basis. */ + pricingDetails: AppPricingDetails; +}; + +/** + * The information about the price that's charged to a shop every plan period. + * The concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing. + */ +export type AppPricingDetails = AppRecurringPricing | AppUsagePricing; + +/** The frequency at which the shop is billed for an app subscription. */ +export type AppPricingInterval = + /** The app subscription bills the shop annually. */ + | "ANNUAL" + /** The app subscription bills the shop every 30 days. */ + | "EVERY_30_DAYS"; + +/** The public-facing category for an app. */ +export type AppPublicCategory = + /** The app's public category is [custom](https://shopify.dev/apps/distribution#capabilities-and-requirements). */ + | "CUSTOM" + /** The app's public category is other. An app is in this category if it's not classified under any of the other app types (private, public, or custom). */ + | "OTHER" + /** The app's public category is [private](https://shopify.dev/apps/distribution#deprecated-app-types). */ + | "PRIVATE" + /** The app's public category is [public](https://shopify.dev/apps/distribution#capabilities-and-requirements). */ + | "PUBLIC"; + +/** Services and features purchased once by the store. */ +export type AppPurchase = { + /** The date and time when the app purchase occurred. */ + createdAt: Scalars["DateTime"]["output"]; + /** The name of the app purchase. */ + name: Scalars["String"]["output"]; + /** The amount to be charged to the store for the app purchase. */ + price: MoneyV2; + /** The status of the app purchase. */ + status: AppPurchaseStatus; + /** Whether the app purchase is a test transaction. */ + test: Scalars["Boolean"]["output"]; +}; + +/** Services and features purchased once by a store. */ +export type AppPurchaseOneTime = AppPurchase & Node & { + /** The date and time when the app purchase occurred. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the app purchase. */ + name: Scalars["String"]["output"]; + /** The amount to be charged to the store for the app purchase. */ + price: MoneyV2; + /** The status of the app purchase. */ + status: AppPurchaseStatus; + /** Whether the app purchase is a test transaction. */ + test: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple AppPurchaseOneTimes. + */ +export type AppPurchaseOneTimeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppPurchaseOneTimeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `appPurchaseOneTimeCreate` mutation. */ +export type AppPurchaseOneTimeCreatePayload = { + /** The newly created app one-time purchase. */ + appPurchaseOneTime?: Maybe; + /** + * The URL that the merchant can access to approve or decline the newly created app one-time purchase. + * + * If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined. + * If the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`. + * + * You get paid after the charge is activated. + */ + confirmationUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination. + */ +export type AppPurchaseOneTimeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppPurchaseOneTimeEdge. */ + node: AppPurchaseOneTime; +}; + +/** + * The approval status of the app purchase. + * + * The merchant is charged for the purchase immediately after approval, and the status changes to `active`. + * If the payment fails, then the app purchase remains `pending`. + * + * Purchases start as `pending` and can change to: `active`, `declined`, `expired`. After a purchase changes, it + * remains in that final state. + */ +export type AppPurchaseStatus = + /** The app purchase has been approved by the merchant and is ready to be activated by the app. App purchases created through the GraphQL Admin API are activated upon approval. */ + | "ACCEPTED" + /** The app purchase was approved by the merchant and has been activated by the app. Active app purchases are charged to the merchant and are paid out to the partner. */ + | "ACTIVE" + /** The app purchase was declined by the merchant. */ + | "DECLINED" + /** The app purchase was not accepted within two days of being created. */ + | "EXPIRED" + /** The app purchase is pending approval by the merchant. */ + | "PENDING"; + +/** + * The pricing information about a subscription app. + * The object contains an interval (the frequency at which the shop is billed for an app subscription) and + * a price (the amount to be charged to the subscribing shop at each interval). + */ +export type AppRecurringPricing = { + /** The discount applied to the subscription for a given number of billing intervals. */ + discount?: Maybe; + /** The frequency at which the subscribing shop is billed for an app subscription. */ + interval: AppPricingInterval; + /** The amount and currency to be charged to the subscribing shop every billing interval. */ + price: MoneyV2; +}; + +/** Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval. */ +export type AppRecurringPricingInput = { + /** The discount applied to the subscription for a given number of billing intervals. */ + discount?: InputMaybe; + /** How often the app subscription generates a charge. */ + interval?: InputMaybe; + /** The amount to be charged to the store every billing interval. */ + price: MoneyInput; +}; + +/** Represents app revenue that was captured externally by the partner. */ +export type AppRevenueAttributionRecord = Node & { + /** The financial amount captured in this attribution. */ + amount: MoneyV2; + /** The timestamp when the financial amount was captured. */ + capturedAt: Scalars["DateTime"]["output"]; + /** The timestamp at which this revenue attribution was issued. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The unique value submitted during the creation of the app revenue attribution record. + * For more information, refer to + * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). + */ + idempotencyKey: Scalars["String"]["output"]; + /** Indicates whether this is a test submission. */ + test: Scalars["Boolean"]["output"]; + /** The type of revenue attribution. */ + type: AppRevenueAttributionType; +}; + +/** + * An auto-generated type for paginating through multiple AppRevenueAttributionRecords. + */ +export type AppRevenueAttributionRecordConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppRevenueAttributionRecordEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `appRevenueAttributionRecordCreate` mutation. */ +export type AppRevenueAttributionRecordCreatePayload = { + /** The created app revenue attribution record. */ + appRevenueAttributionRecord?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `AppRevenueAttributionRecordCreate`. */ +export type AppRevenueAttributionRecordCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `AppRevenueAttributionRecordCreateUserError`. */ +export type AppRevenueAttributionRecordCreateUserErrorCode = + /** The input value is invalid. */ + | "INVALID" + /** The input value is already taken. */ + | "TAKEN"; + +/** Return type for `appRevenueAttributionRecordDelete` mutation. */ +export type AppRevenueAttributionRecordDeletePayload = { + /** The ID of the revenue attribution that was deleted, if one was. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `AppRevenueAttributionRecordDelete`. */ +export type AppRevenueAttributionRecordDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `AppRevenueAttributionRecordDeleteUserError`. */ +export type AppRevenueAttributionRecordDeleteUserErrorCode = + /** The input value is invalid. */ + "INVALID"; + +/** + * An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination. + */ +export type AppRevenueAttributionRecordEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppRevenueAttributionRecordEdge. */ + node: AppRevenueAttributionRecord; +}; + +/** The input fields to supply an app revenue attribution record. */ +export type AppRevenueAttributionRecordInput = { + /** The financial amount captured in this attribution. */ + amount: MoneyInput; + /** The timestamp when the financial amount was captured. */ + capturedAt: Scalars["DateTime"]["input"]; + /** + * The unique value submitted during creation. + * For more information, refer to + * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). + */ + idempotencyKey: Scalars["String"]["input"]; + /** Indicates whether this is a test submission. */ + test: Scalars["Boolean"]["input"]; + /** The type of revenue attribution. */ + type: AppRevenueAttributionType; +}; + +/** The set of valid sort keys for the AppRevenueAttributionRecord query. */ +export type AppRevenueAttributionRecordSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** Represents the billing types of revenue attribution. */ +export type AppRevenueAttributionType = + /** App purchase related revenue collection. */ + | "APPLICATION_PURCHASE" + /** App subscription revenue collection. */ + | "APPLICATION_SUBSCRIPTION" + /** App usage-based revenue collection. */ + | "APPLICATION_USAGE" + /** Other app revenue collection type. */ + | "OTHER"; + +/** Provides users access to services and/or features for a duration of time. */ +export type AppSubscription = Node & { + /** The date and time when the app subscription was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The date and time when the current app subscription period ends. Returns `null` if the subscription isn't active. */ + currentPeriodEnd?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The plans attached to the app subscription. */ + lineItems: Array; + /** The name of the app subscription. */ + name: Scalars["String"]["output"]; + /** The URL that the merchant is redirected to after approving the app subscription. */ + returnUrl: Scalars["URL"]["output"]; + /** The status of the app subscription. */ + status: AppSubscriptionStatus; + /** Specifies whether the app subscription is a test transaction. */ + test: Scalars["Boolean"]["output"]; + /** The number of free trial days, starting at the subscription's creation date, by which billing is delayed. */ + trialDays: Scalars["Int"]["output"]; +}; + +/** Return type for `appSubscriptionCancel` mutation. */ +export type AppSubscriptionCancelPayload = { + /** The cancelled app subscription. */ + appSubscription?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple AppSubscriptions. + */ +export type AppSubscriptionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppSubscriptionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `appSubscriptionCreate` mutation. */ +export type AppSubscriptionCreatePayload = { + /** The newly-created app subscription. */ + appSubscription?: Maybe; + /** The URL pointing to the page where the merchant approves or declines the charges for an app subscription. */ + confirmationUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Discount applied to the recurring pricing portion of a subscription. */ +export type AppSubscriptionDiscount = { + /** + * The total number of billing intervals to which the discount will be applied. + * The discount will be applied to an indefinite number of billing intervals if this value is blank. + */ + durationLimitInIntervals?: Maybe; + /** The price of the subscription after the discount is applied. */ + priceAfterDiscount: MoneyV2; + /** The remaining number of billing intervals to which the discount will be applied. */ + remainingDurationInIntervals?: Maybe; + /** The value of the discount applied every billing interval. */ + value: AppSubscriptionDiscountValue; +}; + +/** The fixed amount value of a discount. */ +export type AppSubscriptionDiscountAmount = { + /** The fixed amount value of a discount. */ + amount: MoneyV2; +}; + +/** + * The input fields to specify a discount to the recurring pricing portion of a subscription over a number of billing intervals. + */ +export type AppSubscriptionDiscountInput = { + /** + * The total number of billing intervals to which the discount will be applied. + * The discount will be applied to an indefinite number of billing intervals if this value is left blank. + */ + durationLimitInIntervals?: InputMaybe; + /** The value to be discounted every billing interval. */ + value?: InputMaybe; +}; + +/** The percentage value of a discount. */ +export type AppSubscriptionDiscountPercentage = { + /** The percentage value of a discount. */ + percentage: Scalars["Float"]["output"]; +}; + +/** The value of the discount. */ +export type AppSubscriptionDiscountValue = + | AppSubscriptionDiscountAmount + | AppSubscriptionDiscountPercentage; + +/** The input fields to specify the value discounted every billing interval. */ +export type AppSubscriptionDiscountValueInput = { + /** The monetary value of a discount. */ + amount?: InputMaybe; + /** The percentage value of a discount. */ + percentage?: InputMaybe; +}; + +/** + * An auto-generated type which holds one AppSubscription and a cursor during pagination. + */ +export type AppSubscriptionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppSubscriptionEdge. */ + node: AppSubscription; +}; + +/** The plan attached to an app subscription. */ +export type AppSubscriptionLineItem = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The pricing model for the app subscription. */ + plan: AppPlanV2; + /** A list of the store's usage records for a usage pricing plan. */ + usageRecords: AppUsageRecordConnection; +}; + +/** The plan attached to an app subscription. */ +export type AppSubscriptionLineItemUsageRecordsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The input fields to add more than one pricing plan to an app subscription. */ +export type AppSubscriptionLineItemInput = { + /** The pricing model for the app subscription. */ + plan: AppPlanInput; +}; + +/** Return type for `appSubscriptionLineItemUpdate` mutation. */ +export type AppSubscriptionLineItemUpdatePayload = { + /** The updated app subscription. */ + appSubscription?: Maybe; + /** The URL where the merchant approves or declines the updated app subscription line item. */ + confirmationUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The replacement behavior when creating an app subscription for a merchant with an already existing app subscription. */ +export type AppSubscriptionReplacementBehavior = + /** Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription. */ + | "APPLY_IMMEDIATELY" + /** Defers canceling the merchant's current app subscription and applying the newly created app subscription until the start of the next billing cycle. This value is ignored if the new app subscription is using a different currency than the current app subscription, in which case the new app subscription is applied immediately. */ + | "APPLY_ON_NEXT_BILLING_CYCLE" + /** + * Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription, with the exception of + * the following scenarios where replacing the current app subscription will be deferred until the start of the next billing cycle. + * 1) The current app subscription is annual and the newly created app subscription is annual, using the same currency, but is of a lesser value. + * 2) The current app subscription is annual and the newly created app subscription is monthly and using the same currency. + * 3) The current app subscription and the newly created app subscription are identical except for the `discount` value. + */ + | "STANDARD"; + +/** The set of valid sort keys for the AppSubscription query. */ +export type AppSubscriptionSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The status of the app subscription. */ +export type AppSubscriptionStatus = + /** The app subscription has been approved by the merchant and is ready to be activated by the app. */ + | "ACCEPTED" + /** The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop. After payment, partners receive payouts. */ + | "ACTIVE" + /** The app subscription was cancelled by the app. This could be caused by the app being uninstalled, a new app subscription being activated, or a direct cancellation by the app. This is a terminal state. */ + | "CANCELLED" + /** The app subscription was declined by the merchant. This is a terminal state. */ + | "DECLINED" + /** The app subscription wasn't approved by the merchant within two days of being created. This is a terminal state. */ + | "EXPIRED" + /** The app subscription is on hold due to non-payment. The subscription re-activates after payments resume. */ + | "FROZEN" + /** The app subscription is pending approval by the merchant. */ + | "PENDING"; + +/** Return type for `appSubscriptionTrialExtend` mutation. */ +export type AppSubscriptionTrialExtendPayload = { + /** The app subscription that had its trial extended. */ + appSubscription?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `AppSubscriptionTrialExtend`. */ +export type AppSubscriptionTrialExtendUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `AppSubscriptionTrialExtendUserError`. */ +export type AppSubscriptionTrialExtendUserErrorCode = + /** The app subscription isn't active. */ + | "SUBSCRIPTION_NOT_ACTIVE" + /** The app subscription wasn't found. */ + | "SUBSCRIPTION_NOT_FOUND" + /** The trial isn't active. */ + | "TRIAL_NOT_ACTIVE"; + +/** The set of valid sort keys for the AppTransaction query. */ +export type AppTransactionSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * Defines a usage pricing model for the app subscription. + * These charges are variable based on how much the merchant uses the app. + */ +export type AppUsagePricing = { + /** The total usage records for interval. */ + balanceUsed: MoneyV2; + /** + * The capped amount prevents the merchant from being charged for any usage over that amount during a billing period. + * This prevents billing from exceeding a maximum threshold over the duration of the billing period. + * For the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge. + */ + cappedAmount: MoneyV2; + /** The frequency with which the app usage records are billed. */ + interval: AppPricingInterval; + /** + * The terms and conditions for app usage pricing. + * Must be present in order to create usage charges. + * The terms are presented to the merchant when they approve an app's usage charges. + */ + terms: Scalars["String"]["output"]; +}; + +/** The input fields to issue arbitrary charges for app usage associated with a subscription. */ +export type AppUsagePricingInput = { + /** The maximum amount of usage charges that can be incurred within a subscription billing interval. */ + cappedAmount: MoneyInput; + /** The terms and conditions for app usage. These terms stipulate the pricing model for the charges that an app creates. */ + terms: Scalars["String"]["input"]; +}; + +/** Store usage for app subscriptions with usage pricing. */ +export type AppUsageRecord = Node & { + /** The date and time when the usage record was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The description of the app usage record. */ + description: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * A unique key generated by the client to avoid duplicate charges. + */ + idempotencyKey?: Maybe; + /** The price of the usage record. */ + price: MoneyV2; + /** Defines the usage pricing plan the merchant is subscribed to. */ + subscriptionLineItem: AppSubscriptionLineItem; +}; + +/** + * An auto-generated type for paginating through multiple AppUsageRecords. + */ +export type AppUsageRecordConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in AppUsageRecordEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `appUsageRecordCreate` mutation. */ +export type AppUsageRecordCreatePayload = { + /** The newly created app usage record. */ + appUsageRecord?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one AppUsageRecord and a cursor during pagination. + */ +export type AppUsageRecordEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of AppUsageRecordEdge. */ + node: AppUsageRecord; +}; + +/** The set of valid sort keys for the AppUsageRecord query. */ +export type AppUsageRecordSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** Represents a generic custom attribute. */ +export type Attribute = { + /** Key or name of the attribute. */ + key: Scalars["String"]["output"]; + /** Value of the attribute. */ + value?: Maybe; +}; + +/** The input fields for an attribute. */ +export type AttributeInput = { + /** Key or name of the attribute. */ + key: Scalars["String"]["input"]; + /** Value of the attribute. */ + value: Scalars["String"]["input"]; +}; + +/** + * Automatic discount applications capture the intentions of a discount that was automatically applied. + */ +export type AutomaticDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is applied to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** + * An ordered index that can be used to identify the discount application and indicate the precedence + * of the discount application for calculations. + */ + index: Scalars["Int"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The title of the discount application. */ + title: Scalars["String"]["output"]; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** The set of valid sort keys for the AutomaticDiscount query. */ +export type AutomaticDiscountSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * Represents an object containing all information for channels available to a shop. + */ +export type AvailableChannelDefinitionsByChannel = { + /** The channel definitions for channels installed on a shop. */ + channelDefinitions: Array; + /** The name of the channel. */ + channelName: Scalars["String"]["output"]; +}; + +/** The possible types for a badge. */ +export type BadgeType = + /** This badge has type `attention`. */ + | "ATTENTION" + /** This badge has type `default`. */ + | "DEFAULT" + /** This badge has type `info`. */ + | "INFO" + /** This badge has type `success`. */ + | "SUCCESS" + /** This badge has type `warning`. */ + | "WARNING"; + +/** + * Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or + * the addition of a product. + */ +export type BasicEvent = Event & Node & { + /** The name of the app that created the event. */ + appTitle?: Maybe; + /** Whether the event was created by an app. */ + attributeToApp: Scalars["Boolean"]["output"]; + /** Whether the event was caused by an admin user. */ + attributeToUser: Scalars["Boolean"]["output"]; + /** The date and time when the event was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Whether the event is critical. */ + criticalAlert: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Human readable text that describes the event. */ + message: Scalars["FormattedString"]["output"]; +}; + +/** Represents an error that happens during the execution of a billing attempt mutation. */ +export type BillingAttemptUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `BillingAttemptUserError`. */ +export type BillingAttemptUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Subscription contract does not exist. */ + | "CONTRACT_NOT_FOUND" + /** Billing cycle selector cannot select billing cycle outside of index range. */ + | "CYCLE_INDEX_OUT_OF_RANGE" + /** Billing cycle selector cannot select billing cycle outside of start date range. */ + | "CYCLE_START_DATE_OUT_OF_RANGE" + /** The input value is invalid. */ + | "INVALID" + /** Origin time cannot be before the contract creation time. */ + | "ORIGIN_TIME_BEFORE_CONTRACT_CREATION" + /** Origin time needs to be within the selected billing cycle's start and end at date. */ + | "ORIGIN_TIME_OUT_OF_RANGE" + /** Billing cycle selector cannot select upcoming billing cycle past limit. */ + | "UPCOMING_CYCLE_LIMIT_EXCEEDED"; + +/** Possible error codes that can be returned by `BulkMutationUserError`. */ +export type BulkMutationErrorCode = + /** There was a problem reading the JSONL file. This error might be intermittent, so you can try performing the same query again. */ + | "INTERNAL_FILE_SERVER_ERROR" + /** The operation did not run because the mutation is invalid. Check your mutation syntax and try again. */ + | "INVALID_MUTATION" + /** The JSONL file submitted via the `stagedUploadsCreate` mutation is invalid. Update the file and try again. */ + | "INVALID_STAGED_UPLOAD_FILE" + /** The JSONL file could not be found. Try [uploading the file](https://shopify.dev/api/usage/bulk-operations/imports#generate-the-uploaded-url-and-parameters) again, and check that you've entered the URL correctly for the `stagedUploadPath` mutation argument. */ + | "NO_SUCH_FILE" + /** The operation did not run because another bulk mutation is already running. [Wait for the operation to finish](https://shopify.dev/api/usage/bulk-operations/imports#wait-for-the-operation-to-finish) before retrying this operation. */ + | "OPERATION_IN_PROGRESS"; + +/** Represents an error that happens during execution of a bulk mutation. */ +export type BulkMutationUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** + * An asynchronous long-running operation to fetch data in bulk or to bulk import data. + * + * Bulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After + * they are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains + * a link to the data in [JSONL](http://jsonlines.org/) format. + * + * Refer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details. + */ +export type BulkOperation = Node & { + /** When the bulk operation was successfully completed. */ + completedAt?: Maybe; + /** When the bulk operation was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Error code for failed operations. */ + errorCode?: Maybe; + /** File size in bytes of the file in the `url` field. */ + fileSize?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * A running count of all the objects processed. + * For example, when fetching all the products and their variants, this field counts both products and variants. + * This field can be used to track operation progress. + */ + objectCount: Scalars["UnsignedInt64"]["output"]; + /** + * The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation. + * The URL expires 7 days after the operation fails. Returns `null` when there's no data available. + */ + partialDataUrl?: Maybe; + /** GraphQL query document specified in `bulkOperationRunQuery`. */ + query: Scalars["String"]["output"]; + /** + * A running count of all the objects that are processed at the root of the query. + * For example, when fetching all the products and their variants, this field only counts products. + * This field can be used to track operation progress. + */ + rootObjectCount: Scalars["UnsignedInt64"]["output"]; + /** Status of the bulk operation. */ + status: BulkOperationStatus; + /** The bulk operation's type. */ + type: BulkOperationType; + /** + * The URL that points to the response data in [JSONL](http://jsonlines.org/) format. + * The URL expires 7 days after the operation completes. + */ + url?: Maybe; +}; + +/** Return type for `bulkOperationCancel` mutation. */ +export type BulkOperationCancelPayload = { + /** The bulk operation to be canceled. */ + bulkOperation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed bulk operations. */ +export type BulkOperationErrorCode = + /** + * The provided operation `query` returned access denied due to missing + * [access scopes](https://shopify.dev/api/usage/access-scopes). + * Review the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details. + */ + | "ACCESS_DENIED" + /** + * The operation resulted in partial or incomplete data due to internal server errors during execution. + * These errors might be intermittent, so you can try performing the same query again. + */ + | "INTERNAL_SERVER_ERROR" + /** + * The operation resulted in partial or incomplete data due to query timeouts during execution. + * In some cases, timeouts can be avoided by modifying your `query` to select fewer fields. + */ + | "TIMEOUT"; + +/** Return type for `bulkOperationRunMutation` mutation. */ +export type BulkOperationRunMutationPayload = { + /** The newly created bulk operation. */ + bulkOperation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `bulkOperationRunQuery` mutation. */ +export type BulkOperationRunQueryPayload = { + /** The newly created bulk operation. */ + bulkOperation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The valid values for the status of a bulk operation. */ +export type BulkOperationStatus = + /** The bulk operation has been canceled. */ + | "CANCELED" + /** + * Cancelation has been initiated on the bulk operation. There may be a short delay from when a cancelation + * starts until the operation is actually canceled. + */ + | "CANCELING" + /** The bulk operation has successfully completed. */ + | "COMPLETED" + /** The bulk operation has been created. */ + | "CREATED" + /** The bulk operation URL has expired. */ + | "EXPIRED" + /** + * The bulk operation has failed. For information on why the operation failed, use + * [BulkOperation.errorCode](https://shopify.dev/api/admin-graphql/latest/enums/bulkoperationerrorcode). + */ + | "FAILED" + /** The bulk operation is runnning. */ + | "RUNNING"; + +/** The valid values for the bulk operation's type. */ +export type BulkOperationType = + /** The bulk operation is a mutation. */ + | "MUTATION" + /** The bulk operation is a query. */ + | "QUERY"; + +/** Return type for `bulkProductResourceFeedbackCreate` mutation. */ +export type BulkProductResourceFeedbackCreatePayload = { + /** The feedback that's created. */ + feedback?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `BulkProductResourceFeedbackCreate`. */ +export type BulkProductResourceFeedbackCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `BulkProductResourceFeedbackCreateUserError`. */ +export type BulkProductResourceFeedbackCreateUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The input value is invalid. */ + | "INVALID" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** The operation was attempted on too many feedback objects. The maximum number of feedback objects that you can operate on is 50. */ + | "MAXIMUM_FEEDBACK_LIMIT_EXCEEDED" + /** The feedback for a later version of this resource was already accepted. */ + | "OUTDATED_FEEDBACK" + /** The input value needs to be blank. */ + | "PRESENT" + /** The product wasn't found or isn't available to the channel. */ + | "PRODUCT_NOT_FOUND"; + +/** + * Represents the Bundles feature configuration for the shop. + */ +export type BundlesFeature = { + /** Whether a shop is configured properly to sell bundles. */ + eligibleForBundles: Scalars["Boolean"]["output"]; + /** The reason why a shop is not eligible for bundles. */ + ineligibilityReason?: Maybe; + /** Whether a shop has any fixed bundle products or has a cartTransform function installed. */ + sellsBundles: Scalars["Boolean"]["output"]; +}; + +/** Possible error codes that can be returned by `BusinessCustomerUserError`. */ +export type BusinessCustomerErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Deleting the resource failed. */ + | "FAILED_TO_DELETE" + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** The input is invalid. */ + | "INVALID_INPUT" + /** The number of resources exceeded the limit. */ + | "LIMIT_REACHED" + /** The input is empty. */ + | "NO_INPUT" + /** Missing a required field. */ + | "REQUIRED" + /** The resource wasn't found. */ + | "RESOURCE_NOT_FOUND" + /** The input value is already taken. */ + | "TAKEN" + /** The field value is too long. */ + | "TOO_LONG" + /** Unexpected type. */ + | "UNEXPECTED_TYPE"; + +/** An error that happens during the execution of a business customer mutation. */ +export type BusinessCustomerUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Settings describing the behavior of checkout for a B2B buyer. */ +export type BuyerExperienceConfiguration = { + /** Whether to checkout to draft order for merchant review. */ + checkoutToDraft: Scalars["Boolean"]["output"]; + /** Whether to allow customers to use editable shipping addresses. */ + editableShippingAddress: Scalars["Boolean"]["output"]; + /** + * Whether a buyer must pay at checkout or they can also choose to pay + * later using net terms. + */ + payNowOnly: Scalars["Boolean"]["output"]; + /** Represents the merchant configured payment terms. */ + paymentTermsTemplate?: Maybe; +}; + +/** The input fields specifying the behavior of checkout for a B2B buyer. */ +export type BuyerExperienceConfigurationInput = { + /** Whether to checkout to draft order for merchant review. */ + checkoutToDraft?: InputMaybe; + /** Whether to allow customers to edit their shipping address at checkout. */ + editableShippingAddress?: InputMaybe; + /** Represents the merchant configured payment terms. */ + paymentTermsTemplateId?: InputMaybe; +}; + +/** + * A discount that is automatically applied to an order that is being edited. + */ +export type CalculatedAutomaticDiscountApplication = + & CalculatedDiscountApplication + & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The level at which the discount was applied. */ + appliedTo: DiscountApplicationLevel; + /** The description of discount application. Indicates the reason why the discount was applied. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; + }; + +/** + * An amount discounting the line that has been allocated by an associated discount application. + */ +export type CalculatedDiscountAllocation = { + /** The money amount that's allocated by the discount application in shop and presentment currencies. */ + allocatedAmountSet: MoneyBag; + /** The discount that the allocated amount originated from. */ + discountApplication: CalculatedDiscountApplication; +}; + +/** + * A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied. + */ +export type CalculatedDiscountApplication = { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The level at which the discount was applied. */ + appliedTo: DiscountApplicationLevel; + /** The description of discount application. Indicates the reason why the discount was applied. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** + * An auto-generated type for paginating through multiple CalculatedDiscountApplications. + */ +export type CalculatedDiscountApplicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CalculatedDiscountApplicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination. + */ +export type CalculatedDiscountApplicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CalculatedDiscountApplicationEdge. */ + node: CalculatedDiscountApplication; +}; + +/** + * A discount code that is applied to an order that is being edited. + */ +export type CalculatedDiscountCodeApplication = + & CalculatedDiscountApplication + & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The level at which the discount was applied. */ + appliedTo: DiscountApplicationLevel; + /** The string identifying the discount code that was used at the time of application. */ + code: Scalars["String"]["output"]; + /** The description of discount application. Indicates the reason why the discount was applied. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; + }; + +/** The computed properties for a draft order. */ +export type CalculatedDraftOrder = { + /** Order-level discount applied to the draft order. */ + appliedDiscount?: Maybe; + /** The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item. */ + availableShippingRates: Array; + /** Whether the billing address matches the shipping address. */ + billingAddressMatchesShippingAddress: Scalars["Boolean"]["output"]; + /** The currency of the store for this draft order. */ + currencyCode: CurrencyCode; + /** Customer who will be sent an invoice for the draft order, if there's one. */ + customer?: Maybe; + /** Line items in the draft order with their computed properties. */ + lineItems: Array; + /** A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts. */ + lineItemsSubtotalPrice: MoneyBag; + /** The name of the selected market. */ + marketName: Scalars["String"]["output"]; + /** The selected market region country code for the draft order. */ + marketRegionCountryCode: CountryCode; + /** Phone number assigned to draft order. */ + phone?: Maybe; + /** The payment currency of the customer for this draft order. */ + presentmentCurrencyCode: CurrencyCode; + /** The purchasing entity for the draft order. */ + purchasingEntity?: Maybe; + /** Line item that contains the shipping costs. */ + shippingLine?: Maybe; + /** + * Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes). + */ + subtotalPrice: Scalars["Money"]["output"]; + /** Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes). */ + subtotalPriceSet: MoneyBag; + /** Total amount of taxes charged for each line item and shipping line. */ + taxLines: Array; + /** Total discounts for this draft order. */ + totalDiscountsSet: MoneyBag; + /** Total price of line items for this draft order. */ + totalLineItemsPriceSet: MoneyBag; + /** Total amount of the draft order (includes taxes, shipping charges, and discounts). */ + totalPrice: Scalars["Money"]["output"]; + /** Total amount of the draft order(includes taxes, shipping charges, and discounts). */ + totalPriceSet: MoneyBag; + /** Total shipping charge for the draft order. */ + totalShippingPrice: Scalars["Money"]["output"]; + /** Total shipping charge for the draft order. */ + totalShippingPriceSet: MoneyBag; + /** Total amount of taxes for the draft order. */ + totalTax: Scalars["Money"]["output"]; + /** Total amount of taxes for the draft order. */ + totalTaxSet: MoneyBag; +}; + +/** The computed line items for a draft order. */ +export type CalculatedDraftOrderLineItem = { + /** The discount applied to the line item. */ + appliedDiscount?: Maybe; + /** Whether the line item is a custom line item (`true`) or a product variant line item (`false`). */ + custom: Scalars["Boolean"]["output"]; + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** Additional information (metafields) about the line item with the associated types. */ + customAttributesV2: Array; + /** Total price with discounts applied. */ + discountedTotal: MoneyV2; + /** The total price with discounts applied. */ + discountedTotalSet: MoneyBag; + /** The unit price with discounts applied. */ + discountedUnitPrice: MoneyV2; + /** Unit price with discounts applied. */ + discountedUnitPriceSet: MoneyBag; + /** + * Name of the service provider who fulfilled the order. + * + * Valid values are either **manual** or the name of the provider. + * For example, **amazon**, **shipwire**. + * + * Deleted fulfillment services will return null. + */ + fulfillmentService?: Maybe; + /** The image associated with the draft order line item. */ + image?: Maybe; + /** Whether the line item represents the purchase of a gift card. */ + isGiftCard: Scalars["Boolean"]["output"]; + /** The name of the product. */ + name: Scalars["String"]["output"]; + /** + * The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. + */ + originalTotal: MoneyV2; + /** The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. */ + originalTotalSet: MoneyBag; + /** The variant price without any discounts applied. */ + originalUnitPrice: MoneyV2; + /** The variant price without any discounts applied. */ + originalUnitPriceSet: MoneyBag; + /** The product associated with the draft order line item. */ + product?: Maybe; + /** The number of variant items requested in the draft order. */ + quantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** The SKU number of the product variant. */ + sku?: Maybe; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product or variant. This field only applies to custom line items. */ + title: Scalars["String"]["output"]; + /** The total value of the discount. */ + totalDiscount: MoneyV2; + /** The total value of the discount. */ + totalDiscountSet: MoneyBag; + /** The variant associated with the draft order line item. */ + variant?: Maybe; + /** The name of the variant. */ + variantTitle?: Maybe; + /** The name of the vendor who created the product variant. */ + vendor?: Maybe; + /** The weight unit and value for a draft order line item. */ + weight?: Maybe; +}; + +/** + * A line item involved in order editing that may be newly added or have new changes applied. + */ +export type CalculatedLineItem = { + /** The discounts that have been allocated onto the line item by discount applications. */ + calculatedDiscountAllocations: Array; + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** + * The discounts that have been allocated onto the line item by discount applications. + * @deprecated Use `calculatedDiscountAllocations` instead. + */ + discountAllocations: Array; + /** The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price. */ + discountedUnitPriceSet: MoneyBag; + /** The total number of items that can be edited. */ + editableQuantity: Scalars["Int"]["output"]; + /** The editable quantity prior to any changes made in the current edit. */ + editableQuantityBeforeChanges: Scalars["Int"]["output"]; + /** The total price of editable lines in shop and presentment currencies. */ + editableSubtotalSet: MoneyBag; + /** Whether the calculated line item has a staged discount. */ + hasStagedLineItemDiscount: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image object associated to the line item's variant. */ + image?: Maybe; + /** The variant unit price in shop and presentment currencies, without any discounts applied. */ + originalUnitPriceSet: MoneyBag; + /** The total number of items. */ + quantity: Scalars["Int"]["output"]; + /** Whether the line item can be restocked or not. */ + restockable: Scalars["Boolean"]["output"]; + /** Whether the changes on the line item will result in a restock. */ + restocking: Scalars["Boolean"]["output"]; + /** The variant SKU number. */ + sku?: Maybe; + /** A list of changes that affect this line item. */ + stagedChanges: Array; + /** The title of the product. */ + title: Scalars["String"]["output"]; + /** The total price of uneditable lines in shop and presentment currencies. */ + uneditableSubtotalSet: MoneyBag; + /** + * The product variant associated with this line item. The value is null for custom line items and items where + * the variant has been deleted. + */ + variant?: Maybe; + /** The title of the variant. */ + variantTitle?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple CalculatedLineItems. + */ +export type CalculatedLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CalculatedLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CalculatedLineItem and a cursor during pagination. + */ +export type CalculatedLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CalculatedLineItemEdge. */ + node: CalculatedLineItem; +}; + +/** + * Represents a discount that was manually created for an order that is being edited. + */ +export type CalculatedManualDiscountApplication = + & CalculatedDiscountApplication + & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The level at which the discount was applied. */ + appliedTo: DiscountApplicationLevel; + /** The description of discount application. Indicates the reason why the discount was applied. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; + }; + +/** + * An order with edits applied but not saved. + */ +export type CalculatedOrder = Node & { + /** + * Returns only the new discount applications being added to the order in the current edit. + */ + addedDiscountApplications: CalculatedDiscountApplicationConnection; + /** + * Returns only the new line items being added to the order during the current edit. + */ + addedLineItems: CalculatedLineItemConnection; + /** Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies. */ + cartDiscountAmountSet?: Maybe; + /** Whether the changes have been applied and saved to the order. */ + committed: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * Returns all items on the order that existed before starting the edit. + * Will include any changes that have been made. + * Will not include line items added during the current edit. + */ + lineItems: CalculatedLineItemConnection; + /** The HTML of the customer notification for the order edit. */ + notificationPreviewHtml?: Maybe; + /** The customer notification title. */ + notificationPreviewTitle: Scalars["String"]["output"]; + /** + * The order without any changes applied. + * @deprecated Use `originalOrder` instead. + */ + order: Order; + /** + * The order without any changes applied. + */ + originalOrder: Order; + /** + * List of changes made to the order during the current edit. + */ + stagedChanges: OrderStagedChangeConnection; + /** The sum of the quantities for the line items that contribute to the order's subtotal. */ + subtotalLineItemsQuantity: Scalars["Int"]["output"]; + /** The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal doesn't include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders. */ + subtotalPriceSet?: Maybe; + /** Taxes charged for the line item. */ + taxLines: Array; + /** Total price of the order less the total amount received from the customer in shop and presentment currencies. */ + totalOutstandingSet: MoneyBag; + /** Total amount of the order (includes taxes and discounts) in shop and presentment currencies. */ + totalPriceSet: MoneyBag; +}; + +/** + * An order with edits applied but not saved. + */ +export type CalculatedOrderAddedDiscountApplicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order with edits applied but not saved. + */ +export type CalculatedOrderAddedLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order with edits applied but not saved. + */ +export type CalculatedOrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order with edits applied but not saved. + */ +export type CalculatedOrderStagedChangesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A discount created by a Shopify script for an order that is being edited. + */ +export type CalculatedScriptDiscountApplication = + & CalculatedDiscountApplication + & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The level at which the discount was applied. */ + appliedTo: DiscountApplicationLevel; + /** The description of discount application. Indicates the reason why the discount was applied. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; + }; + +/** Card payment details related to a transaction. */ +export type CardPaymentDetails = { + /** The response code from the address verification system (AVS). The code is always a single letter. */ + avsResultCode?: Maybe; + /** The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number. */ + bin?: Maybe; + /** The name of the company that issued the customer's credit card. */ + company?: Maybe; + /** The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string. */ + cvvResultCode?: Maybe; + /** The month in which the used credit card expires. */ + expirationMonth?: Maybe; + /** The year in which the used credit card expires. */ + expirationYear?: Maybe; + /** The holder of the credit card. */ + name?: Maybe; + /** The customer's credit card number, with most of the leading digits redacted. */ + number?: Maybe; + /** Digital wallet used for the payment. */ + wallet?: Maybe; +}; + +/** + * A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). + */ +export type CartTransform = HasMetafields & Node & { + /** The ID for the Cart Transform function. */ + functionId: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; +}; + +/** + * A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). + */ +export type CartTransformMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). + */ +export type CartTransformMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). + */ +export type CartTransformPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle). + */ +export type CartTransformPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple CartTransforms. + */ +export type CartTransformConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CartTransformEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `cartTransformCreate` mutation. */ +export type CartTransformCreatePayload = { + /** The newly created cart transform function. */ + cartTransform?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CartTransformCreate`. */ +export type CartTransformCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CartTransformCreateUserError`. */ +export type CartTransformCreateUserErrorCode = + /** A cart transform function already exists for the provided function_id. */ + | "FUNCTION_ALREADY_REGISTERED" + /** Function does not implement the required interface for this cart_transform function. */ + | "FUNCTION_DOES_NOT_IMPLEMENT" + /** No Shopify Function found for provided function_id. */ + | "FUNCTION_NOT_FOUND" + /** Failed to create cart transform due to invalid input. */ + | "INPUT_INVALID"; + +/** Return type for `cartTransformDelete` mutation. */ +export type CartTransformDeletePayload = { + /** The globally-unique ID for the deleted cart transform. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CartTransformDelete`. */ +export type CartTransformDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CartTransformDeleteUserError`. */ +export type CartTransformDeleteUserErrorCode = + /** Could not find cart transform for provided id. */ + | "NOT_FOUND" + /** Unauthorized app scope. */ + | "UNAUTHORIZED_APP_SCOPE"; + +/** + * An auto-generated type which holds one CartTransform and a cursor during pagination. + */ +export type CartTransformEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CartTransformEdge. */ + node: CartTransform; +}; + +/** + * A list of products with publishing and pricing information. + * A catalog can be associated with a specific context, such as a [`Market`](https://shopify.dev/api/admin-graphql/current/objects/market), [`CompanyLocation`](https://shopify.dev/api/admin-graphql/current/objects/companylocation), or [`App`](https://shopify.dev/api/admin-graphql/current/objects/app). + */ +export type Catalog = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Most recent catalog operations. */ + operations: Array; + /** The price list associated with the catalog. */ + priceList?: Maybe; + /** A group of products and collections that's published to a catalog. */ + publication?: Maybe; + /** The status of the catalog. */ + status: CatalogStatus; + /** The name of the catalog. */ + title: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple Catalogs. + */ +export type CatalogConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CatalogEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** The total count of Catalogs. */ + totalCount: Scalars["UnsignedInt64"]["output"]; +}; + +/** The input fields for the context in which the catalog's publishing and pricing rules apply. */ +export type CatalogContextInput = { + /** The IDs of the company locations to associate to the catalog. */ + companyLocationIds?: InputMaybe>; +}; + +/** Return type for `catalogContextUpdate` mutation. */ +export type CatalogContextUpdatePayload = { + /** The updated catalog. */ + catalog?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to create a catalog. */ +export type CatalogCreateInput = { + /** The context associated with the catalog. */ + context: CatalogContextInput; + /** The ID of the price list to associate to the catalog. */ + priceListId?: InputMaybe; + /** The ID of the publication to associate to the catalog. */ + publicationId?: InputMaybe; + /** The status of the catalog. */ + status: CatalogStatus; + /** The name of the catalog. */ + title: Scalars["String"]["input"]; +}; + +/** Return type for `catalogCreate` mutation. */ +export type CatalogCreatePayload = { + /** The newly created catalog. */ + catalog?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A catalog csv operation represents a CSV file import. */ +export type CatalogCsvOperation = Node & ResourceOperation & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The count of processed rows, summing imported, failed, and skipped rows. */ + processedRowCount?: Maybe; + /** Represents a rows objects within this background operation. */ + rowCount?: Maybe; + /** The status of this operation. */ + status: ResourceOperationStatus; +}; + +/** Return type for `catalogDelete` mutation. */ +export type CatalogDeletePayload = { + /** The ID of the deleted catalog. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Catalog and a cursor during pagination. + */ +export type CatalogEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CatalogEdge. */ + node: Catalog; +}; + +/** The set of valid sort keys for the Catalog query. */ +export type CatalogSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE"; + +/** + * The state of a catalog. + */ +export type CatalogStatus = + /** The catalog is active. */ + | "ACTIVE" + /** The catalog is archived. */ + | "ARCHIVED" + /** The catalog is in draft. */ + | "DRAFT"; + +/** + * The associated catalog's type. + */ +export type CatalogType = + /** Catalogs belonging to apps. */ + | "APP" + /** Catalogs belonging to company locations. */ + | "COMPANY_LOCATION" + /** Catalogs belonging to markets. */ + | "MARKET" + /** Not associated to a catalog. */ + | "NONE"; + +/** The input fields used to update a catalog. */ +export type CatalogUpdateInput = { + /** The context associated with the catalog. */ + context?: InputMaybe; + /** The ID of the price list to associate to the catalog. */ + priceListId?: InputMaybe; + /** The ID of the publication to associate to the catalog. */ + publicationId?: InputMaybe; + /** The status of the catalog. */ + status?: InputMaybe; + /** The name of the catalog. */ + title?: InputMaybe; +}; + +/** Return type for `catalogUpdate` mutation. */ +export type CatalogUpdatePayload = { + /** The updated catalog. */ + catalog?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Defines errors encountered while managing a catalog. + */ +export type CatalogUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CatalogUserError`. */ +export type CatalogUserErrorCode = + /** An app catalog cannot be assigned to a price list. */ + | "APP_CATALOG_PRICE_LIST_ASSIGNMENT" + /** The input value is blank. */ + | "BLANK" + /** The catalog can't be associated with more than one market. */ + | "CANNOT_ADD_MORE_THAN_ONE_MARKET" + /** Cannot create a catalog for an app. */ + | "CANNOT_CREATE_APP_CATALOG" + /** Cannot create a catalog for a market. */ + | "CANNOT_CREATE_MARKET_CATALOG" + /** Cannot delete a catalog for an app. */ + | "CANNOT_DELETE_APP_CATALOG" + /** Cannot delete a catalog for a market. */ + | "CANNOT_DELETE_MARKET_CATALOG" + /** Cannot modify a catalog for an app. */ + | "CANNOT_MODIFY_APP_CATALOG" + /** Cannot modify a catalog for a market. */ + | "CANNOT_MODIFY_MARKET_CATALOG" + /** Quantity rules can be associated only with company location catalogs. */ + | "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES" + /** Catalog failed to save. */ + | "CATALOG_FAILED_TO_SAVE" + /** The catalog wasn't found. */ + | "CATALOG_NOT_FOUND" + /** A company location catalog outside of a supported plan can only have an archived status. */ + | "COMPANY_LOCATION_CATALOG_STATUS_PLAN" + /** The company location could not be found. */ + | "COMPANY_LOCATION_NOT_FOUND" + /** Context driver already assigned to this catalog. */ + | "CONTEXT_ALREADY_ASSIGNED_TO_CATALOG" + /** Cannot save the catalog because the catalog limit for the context was reached. */ + | "CONTEXT_CATALOG_LIMIT_REACHED" + /** The arguments `contextsToAdd` and `contextsToRemove` must match existing catalog context type. */ + | "CONTEXT_DRIVER_MISMATCH" + /** A country price list cannot be assigned to a catalog. */ + | "COUNTRY_PRICE_LIST_ASSIGNMENT" + /** The input value is invalid. */ + | "INVALID" + /** The catalog context type is invalid. */ + | "INVALID_CATALOG_CONTEXT_TYPE" + /** The catalog's market and price list currencies do not match. */ + | "MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH" + /** A market catalog must have an active status. */ + | "MARKET_CATALOG_STATUS" + /** Market not found. */ + | "MARKET_NOT_FOUND" + /** Market already belongs to another catalog. */ + | "MARKET_TAKEN" + /** Must provide exactly one context type. */ + | "MUST_PROVIDE_EXACTLY_ONE_CONTEXT_TYPE" + /** Price list failed to save. */ + | "PRICE_LIST_FAILED_TO_SAVE" + /** The price list is currently being modified. Please try again later. */ + | "PRICE_LIST_LOCKED" + /** A price list cannot be assigned to the primary market. */ + | "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET" + /** Price list not found. */ + | "PRICE_LIST_NOT_FOUND" + /** Publication not found. */ + | "PUBLICATION_NOT_FOUND" + /** Must have `contexts_to_add` or `contexts_to_remove` argument. */ + | "REQUIRES_CONTEXTS_TO_ADD_OR_REMOVE" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** Can't perform this action on a catalog of this type. */ + | "UNSUPPORTED_CATALOG_ACTION"; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type Channel = Node & { + /** The underlying app used by the channel. */ + app: App; + /** The collection publications for the list of collections published to the channel. */ + collectionPublicationsV3: ResourcePublicationConnection; + /** The list of collections published to the channel. */ + collections: CollectionConnection; + /** + * The unique identifier for the channel. + * @deprecated Use `id` instead. + */ + handle: Scalars["String"]["output"]; + /** Whether the collection is available to the channel. */ + hasCollection: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the channel. */ + name: Scalars["String"]["output"]; + /** + * The menu items for the channel, which also appear as submenu items in the left navigation sidebar in the Shopify admin. + * + * @deprecated Use [AppInstallation.navigationItems]( + * https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-navigationitems) instead. + */ + navigationItems: Array; + /** + * Home page for the channel. + * @deprecated Use [AppInstallation.launchUrl]( + * https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-launchurl) instead. + */ + overviewPath?: Maybe; + /** + * The product publications for the products published to the channel. + * @deprecated Use `productPublicationsV3` instead. + */ + productPublications: ProductPublicationConnection; + /** The product publications for the list of products published to the channel. */ + productPublicationsV3: ResourcePublicationConnection; + /** The list of products published to the channel. */ + products: ProductConnection; + /** Whether the channel supports future publishing. */ + supportsFuturePublishing: Scalars["Boolean"]["output"]; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelCollectionPublicationsV3Args = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelHasCollectionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelProductPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelProductPublicationsV3Args = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A channel represents an app where you sell a group of products and collections. + * A channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS. + */ +export type ChannelProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Channels. + */ +export type ChannelConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ChannelEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * A channel definition represents channels surfaces on the platform. + * A channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat. + */ +export type ChannelDefinition = Node & { + /** Name of the channel that this sub channel belongs to. */ + channelName: Scalars["String"]["output"]; + /** Unique string used as a public identifier for the channel definition. */ + handle: Scalars["String"]["output"]; + /** The unique ID for the channel definition. */ + id: Scalars["ID"]["output"]; + /** Whether this channel definition represents a marketplace. */ + isMarketplace: Scalars["Boolean"]["output"]; + /** Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live). */ + subChannelName: Scalars["String"]["output"]; + /** Icon displayed when showing the channel in admin. */ + svgIcon?: Maybe; +}; + +/** + * An auto-generated type which holds one Channel and a cursor during pagination. + */ +export type ChannelEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ChannelEdge. */ + node: Channel; +}; + +/** + * Contains the information for a given sales channel. + */ +export type ChannelInformation = Node & { + /** The app associated with the channel. */ + app: App; + /** The channel definition associated with the channel. */ + channelDefinition?: Maybe; + /** The unique ID for the channel. */ + channelId: Scalars["ID"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; +}; + +/** A checkout profile defines the branding settings and the UI extensions for a store's checkout. A checkout profile could be published or draft. A store might have at most one published checkout profile, which is used to render their live checkout. The store could also have multiple draft profiles that were created, previewed, and published using the admin checkout editor. */ +export type CheckoutProfile = Node & { + /** The date and time when the checkout profile was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The date and time when the checkout profile was last edited. */ + editedAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether the checkout profile is published or not. */ + isPublished: Scalars["Boolean"]["output"]; + /** The profile name. */ + name: Scalars["String"]["output"]; + /** The date and time when the checkout profile was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple CheckoutProfiles. + */ +export type CheckoutProfileConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CheckoutProfileEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CheckoutProfile and a cursor during pagination. + */ +export type CheckoutProfileEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CheckoutProfileEdge. */ + node: CheckoutProfile; +}; + +/** The set of valid sort keys for the CheckoutProfile query. */ +export type CheckoutProfileSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `edited_at` value. */ + | "EDITED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `is_published` value. */ + | "IS_PUBLISHED" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The set of valid sort keys for the CodeDiscount query. */ +export type CodeDiscountSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `ends_at` value. */ + | "ENDS_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `starts_at` value. */ + | "STARTS_AT" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type Collection = + & HasMetafieldDefinitions + & HasMetafields + & HasPublishedTranslations + & Node + & Publishable + & { + /** The number of publications a resource is published to without feedback errors. */ + availablePublicationCount: Scalars["Int"]["output"]; + /** + * A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description. + */ + description: Scalars["String"]["output"]; + /** + * The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme. + */ + descriptionHtml: Scalars["HTML"]["output"]; + /** Information about the collection that's provided through resource feedback. */ + feedback?: Maybe; + /** + * A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`. + * + * If the title is changed, the handle doesn't automatically change. + * + * The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes. + */ + handle: Scalars["String"]["output"]; + /** Whether the collection includes the specified product. */ + hasProduct: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated with the collection. */ + image?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The products that are included in the collection. */ + products: ProductConnection; + /** The number of products in the collection. */ + productsCount: Scalars["Int"]["output"]; + /** The number of publications a resource is published on. */ + publicationCount: Scalars["Int"]["output"]; + /** + * The channels where the collection is published. + * @deprecated Use `resourcePublications` instead. + */ + publications: CollectionPublicationConnection; + /** + * Check to see whether the resource is published to a given channel. + * @deprecated Use `publishedOnPublication` instead. + */ + publishedOnChannel: Scalars["Boolean"]["output"]; + /** + * Check to see whether the resource is published to the calling app's channel. + * @deprecated Use `publishedOnCurrentPublication` instead. + */ + publishedOnCurrentChannel: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to the calling app's publication. */ + publishedOnCurrentPublication: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to a given publication. */ + publishedOnPublication: Scalars["Boolean"]["output"]; + /** The list of resources that are published to a publication. */ + resourcePublications: ResourcePublicationConnection; + /** The list of resources that are either published or staged to be published to a publication. */ + resourcePublicationsV2: ResourcePublicationV2Connection; + /** + * For a smart (automated) collection, specifies the rules that determine whether a product is included. + */ + ruleSet?: Maybe; + /** + * If the default SEO fields for page title and description have been modified, contains the modified information. + */ + seo: Seo; + /** + * The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store. + */ + sortOrder: CollectionSortOrder; + /** + * The Storefront GraphQL API ID of the `Collection`. + * + * As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. + * + * @deprecated Use `id` instead. + */ + storefrontId: Scalars["StorefrontID"]["output"]; + /** + * The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template. + */ + templateSuffix?: Maybe; + /** + * The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store. + */ + title: Scalars["String"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** + * The list of channels that the resource is not published to. + * @deprecated Use `unpublishedPublications` instead. + */ + unpublishedChannels: ChannelConnection; + /** The list of publications that the resource is not published to. */ + unpublishedPublications: PublicationConnection; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified. + */ + updatedAt: Scalars["DateTime"]["output"]; + }; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionDescriptionArgs = { + truncateAt?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionHasProductArgs = { + id: Scalars["ID"]["input"]; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPublicationCountArgs = { + onlyPublished?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPublishedOnChannelArgs = { + channelId: Scalars["ID"]["input"]; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionPublishedOnPublicationArgs = { + publicationId: Scalars["ID"]["input"]; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionResourcePublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionResourcePublicationsV2Args = { + after?: InputMaybe; + before?: InputMaybe; + catalogType?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionUnpublishedChannelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories. + * + * Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections. + * + * Collections can also be created for a custom group of products. These are called custom or manual collections. + */ +export type CollectionUnpublishedPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `collectionAddProducts` mutation. */ +export type CollectionAddProductsPayload = { + /** The updated collection. Returns `null` if an error is raised. */ + collection?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `collectionAddProductsV2` mutation. */ +export type CollectionAddProductsV2Payload = { + /** The asynchronous job adding the products. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CollectionAddProductsV2`. */ +export type CollectionAddProductsV2UserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CollectionAddProductsV2UserError`. */ +export type CollectionAddProductsV2UserErrorCode = + /** Can't manually add products to a smart collection. */ + | "CANT_ADD_TO_SMART_COLLECTION" + /** Collection doesn't exist. */ + | "COLLECTION_DOES_NOT_EXIST"; + +/** + * An auto-generated type for paginating through multiple Collections. + */ +export type CollectionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CollectionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `collectionCreate` mutation. */ +export type CollectionCreatePayload = { + /** The collection that has been created. */ + collection?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for specifying the collection to delete. */ +export type CollectionDeleteInput = { + /** The ID of the collection to be deleted. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `collectionDelete` mutation. */ +export type CollectionDeletePayload = { + /** The ID of the collection that was deleted. Returns `null` if the collection doesn't exist. */ + deletedCollectionId?: Maybe; + /** The shop associated with the collection. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Collection and a cursor during pagination. + */ +export type CollectionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CollectionEdge. */ + node: Collection; +}; + +/** The input fields required to create a collection. */ +export type CollectionInput = { + /** The description of the collection, in HTML format. */ + descriptionHtml?: InputMaybe; + /** + * A unique human-friendly string for the collection. Automatically generated from the collection's title. + */ + handle?: InputMaybe; + /** + * Specifies the collection to update or create a new collection if absent. Required for updating a collection. + */ + id?: InputMaybe; + /** The image associated with the collection. */ + image?: InputMaybe; + /** The metafields to associate with the collection. */ + metafields?: InputMaybe>; + /** Initial list of collection products. Only valid with `collectionCreate` and without rules. */ + products?: InputMaybe>; + /** + * Indicates whether a redirect is required after a new handle has been provided. + * If true, then the old handle is redirected to the new one automatically. + */ + redirectNewHandle?: InputMaybe; + /** + * The rules used to assign products to the collection. + */ + ruleSet?: InputMaybe; + /** SEO information for the collection. */ + seo?: InputMaybe; + /** The order in which the collection's products are sorted. */ + sortOrder?: InputMaybe; + /** The theme template used when viewing the collection in a store. */ + templateSuffix?: InputMaybe; + /** The title of the collection. Required for creating a new collection. */ + title?: InputMaybe; +}; + +/** Represents the publications where a collection is published. */ +export type CollectionPublication = { + /** + * The channel where the collection will be published. + * @deprecated Use `publication` instead. + */ + channel: Channel; + /** The collection to be published on the publication. */ + collection: Collection; + /** Whether the publication is published or not. */ + isPublished: Scalars["Boolean"]["output"]; + /** The publication where the collection will be published. */ + publication: Publication; + /** The date that the publication was or is going to be published. */ + publishDate: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple CollectionPublications. + */ +export type CollectionPublicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CollectionPublicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CollectionPublication and a cursor during pagination. + */ +export type CollectionPublicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CollectionPublicationEdge. */ + node: CollectionPublication; +}; + +/** The input fields for publications to which a collection will be published. */ +export type CollectionPublicationInput = { + /** The ID of the publication. */ + publicationId?: InputMaybe; +}; + +/** The input fields for specifying a collection to publish and the sales channels to publish it to. */ +export type CollectionPublishInput = { + /** The channels where the collection will be published. */ + collectionPublications: Array; + /** The collection to create or update publications for. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `collectionPublish` mutation. */ +export type CollectionPublishPayload = { + /** The published collection. */ + collection?: Maybe; + /** The channels where the collection has been published. */ + collectionPublications?: Maybe>; + /** The shop associated with the collection. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `collectionRemoveProducts` mutation. */ +export type CollectionRemoveProductsPayload = { + /** The asynchronous job removing the products. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `collectionReorderProducts` mutation. */ +export type CollectionReorderProductsPayload = { + /** The asynchronous job reordering the products. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents at rule that's used to assign products to a collection. */ +export type CollectionRule = { + /** The attribute that the rule focuses on. For example, `title` or `product_type`. */ + column: CollectionRuleColumn; + /** The value that the operator is applied to. For example, `Hats`. */ + condition: Scalars["String"]["output"]; + /** The value that the operator is applied to. */ + conditionObject?: Maybe; + /** + * The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`. + */ + relation: CollectionRuleRelation; +}; + +/** Specifies the attribute of a product being used to populate the smart collection. */ +export type CollectionRuleColumn = + /** + * An attribute evaluated based on the `compare_at_price` attribute of the product's variants. + * With `is_set` relation, the rule matches products with at least one variant with `compare_at_price` set. + * With `is_not_set` relation, the rule matches matches products with at least one variant with `compare_at_price` not set. + */ + | "IS_PRICE_REDUCED" + /** + * This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true. + */ + | "PRODUCT_METAFIELD_DEFINITION" + /** The [`product_taxonomy_node_id`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-productcategory) attribute. */ + | "PRODUCT_TAXONOMY_NODE_ID" + /** The [`tag`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute. */ + | "TAG" + /** The [`title`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-title) attribute. */ + | "TITLE" + /** The [`type`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute. */ + | "TYPE" + /** The [`variant_compare_at_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-compareatprice) attribute. */ + | "VARIANT_COMPARE_AT_PRICE" + /** The [`variant_inventory`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryquantity) attribute. */ + | "VARIANT_INVENTORY" + /** + * This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true. + */ + | "VARIANT_METAFIELD_DEFINITION" + /** The [`variant_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-price) attribute. */ + | "VARIANT_PRICE" + /** The [`variant_title`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-title) attribute. */ + | "VARIANT_TITLE" + /** The [`variant_weight`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-weight) attribute. */ + | "VARIANT_WEIGHT" + /** The [`vendor`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-vendor) attribute. */ + | "VENDOR"; + +/** Specifies object for the condition of the rule. */ +export type CollectionRuleConditionObject = + | CollectionRuleMetafieldCondition + | CollectionRuleProductCategoryCondition + | CollectionRuleTextCondition; + +/** This object defines all columns and allowed relations that can be used in rules for smart collections to automatically include the matching products. */ +export type CollectionRuleConditions = { + /** Allowed relations of the rule. */ + allowedRelations: Array; + /** Most commonly used relation for this rule. */ + defaultRelation: CollectionRuleRelation; + /** Additional attributes defining the rule. */ + ruleObject?: Maybe; + /** Type of the rule. */ + ruleType: CollectionRuleColumn; +}; + +/** Specifies object with additional rule attributes. */ +export type CollectionRuleConditionsRuleObject = + CollectionRuleMetafieldCondition; + +/** The input fields for a rule to associate with a collection. */ +export type CollectionRuleInput = { + /** The attribute that the rule focuses on. For example, `title` or `product_type`. */ + column: CollectionRuleColumn; + /** The value that the operator is applied to. For example, `Hats`. */ + condition: Scalars["String"]["input"]; + /** + * The object ID that points to additional attributes for the collection rule. + * This is only required when using metafield definition rules. + */ + conditionObjectId?: InputMaybe; + /** + * The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`. + */ + relation: CollectionRuleRelation; +}; + +/** Identifies a metafield definition used as a rule for the smart collection. */ +export type CollectionRuleMetafieldCondition = { + /** The metafield definition associated with the condition. */ + metafieldDefinition: MetafieldDefinition; +}; + +/** Specifies the condition for a Product Category field. */ +export type CollectionRuleProductCategoryCondition = { + /** The value of the condition. */ + value: ProductTaxonomyNode; +}; + +/** Specifies the relationship between the `column` and the `condition`. */ +export type CollectionRuleRelation = + /** The attribute contains the condition. */ + | "CONTAINS" + /** The attribute ends with the condition. */ + | "ENDS_WITH" + /** The attribute is equal to the condition. */ + | "EQUALS" + /** The attribute is greater than the condition. */ + | "GREATER_THAN" + /** The attribute is not set (equal to `null`). */ + | "IS_NOT_SET" + /** The attribute is set (not equal to `null`). */ + | "IS_SET" + /** The attribute is less than the condition. */ + | "LESS_THAN" + /** The attribute does not contain the condition. */ + | "NOT_CONTAINS" + /** The attribute does not equal the condition. */ + | "NOT_EQUALS" + /** The attribute starts with the condition. */ + | "STARTS_WITH"; + +/** The set of rules that are used to determine which products are included in the collection. */ +export type CollectionRuleSet = { + /** + * Whether products must match any or all of the rules to be included in the collection. + * If true, then products must match at least one of the rules to be included in the collection. + * If false, then products must match all of the rules to be included in the collection. + */ + appliedDisjunctively: Scalars["Boolean"]["output"]; + /** The rules used to assign products to the collection. */ + rules: Array; +}; + +/** The input fields for a rule set of the collection. */ +export type CollectionRuleSetInput = { + /** + * Whether products must match any or all of the rules to be included in the collection. + * If true, then products must match at least one of the rules to be included in the collection. + * If false, then products must match all of the rules to be included in the collection. + */ + appliedDisjunctively: Scalars["Boolean"]["input"]; + /** The rules used to assign products to the collection. */ + rules?: InputMaybe>; +}; + +/** Specifies the condition for a text field. */ +export type CollectionRuleTextCondition = { + /** The value of the condition. */ + value: Scalars["String"]["output"]; +}; + +/** The set of valid sort keys for the Collection query. */ +export type CollectionSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** Specifies the sort order for the products in the collection. */ +export type CollectionSortOrder = + /** Alphabetically, in ascending order (A - Z). */ + | "ALPHA_ASC" + /** Alphabetically, in descending order (Z - A). */ + | "ALPHA_DESC" + /** By best-selling products. */ + | "BEST_SELLING" + /** By date created, in ascending order (oldest - newest). */ + | "CREATED" + /** By date created, in descending order (newest - oldest). */ + | "CREATED_DESC" + /** In the order set manually by the merchant. */ + | "MANUAL" + /** By price, in ascending order (lowest - highest). */ + | "PRICE_ASC" + /** By price, in descending order (highest - lowest). */ + | "PRICE_DESC"; + +/** + * The input fields for specifying the collection to unpublish and the sales channels to remove it from. + */ +export type CollectionUnpublishInput = { + /** The channels where the collection is published. */ + collectionPublications: Array; + /** The collection to create or update publications for. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `collectionUnpublish` mutation. */ +export type CollectionUnpublishPayload = { + /** The collection that has been unpublished. */ + collection?: Maybe; + /** The shop associated with the collection. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `collectionUpdate` mutation. */ +export type CollectionUpdatePayload = { + /** The updated collection. */ + collection?: Maybe; + /** The asynchronous job updating the products based on the new rule set. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Comment events are generated by staff members of a shop. + * They are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer. + */ +export type CommentEvent = Event & Node & { + /** The name of the app that created the event. */ + appTitle?: Maybe; + /** The attachments associated with the comment event. */ + attachments: Array; + /** Whether the event was created by an app. */ + attributeToApp: Scalars["Boolean"]["output"]; + /** Whether the event was caused by an admin user. */ + attributeToUser: Scalars["Boolean"]["output"]; + /** The name of the user that authored the comment event. */ + author: StaffMember; + /** Whether the comment event can be deleted. If true, then the comment event can be deleted. */ + canDelete: Scalars["Boolean"]["output"]; + /** Whether the comment event can be edited. If true, then the comment event can be edited. */ + canEdit: Scalars["Boolean"]["output"]; + /** The date and time when the event was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Whether the event is critical. */ + criticalAlert: Scalars["Boolean"]["output"]; + /** Whether the comment event has been edited. If true, then the comment event has been edited. */ + edited: Scalars["Boolean"]["output"]; + /** The object reference associated with the comment event. For example, a product or discount). */ + embed?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Human readable text that describes the event. */ + message: Scalars["FormattedString"]["output"]; + /** The raw body of the comment event. */ + rawMessage: Scalars["String"]["output"]; + /** The parent subject to which the comment event belongs. */ + subject: CommentEventSubject; +}; + +/** A file attachment associated to a comment event. */ +export type CommentEventAttachment = { + /** The file extension of the comment event attachment, indicating the file format. */ + fileExtension?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image attached to the comment event. */ + image?: Maybe; + /** The filename of the comment event attachment. */ + name: Scalars["String"]["output"]; + /** The size of the attachment. */ + size: Scalars["Int"]["output"]; + /** The URL of the attachment. */ + url: Scalars["URL"]["output"]; +}; + +/** The main embed of a comment event. */ +export type CommentEventEmbed = + | Customer + | DraftOrder + | Order + | Product + | ProductVariant; + +/** The subject line of a comment event. */ +export type CommentEventSubject = { + /** Whether the timeline subject has a timeline comment. If true, then a timeline comment exists. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; +}; + +/** Return type for `companiesDelete` mutation. */ +export type CompaniesDeletePayload = { + /** A list of IDs of the deleted companies. */ + deletedCompanyIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type Company = + & CommentEventSubject + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & Navigable + & Node + & { + /** The number of contacts that belong to the company. */ + contactCount: Scalars["Int"]["output"]; + /** The list of roles for the company contacts. */ + contactRoles: CompanyContactRoleConnection; + /** The list of contacts in the company. */ + contacts: CompanyContactConnection; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify. */ + createdAt: Scalars["DateTime"]["output"]; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company became the customer. */ + customerSince: Scalars["DateTime"]["output"]; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** The role proposed by default for a contact at the company. */ + defaultRole?: Maybe; + /** The list of the company's draft orders. */ + draftOrders: DraftOrderConnection; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** A unique externally-supplied ID for the company. */ + externalId?: Maybe; + /** Whether the merchant added a timeline comment to the company. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The lifetime duration of the company, since it became a customer of the shop. Examples: `2 days`, `3 months`, `1 year`. */ + lifetimeDuration: Scalars["String"]["output"]; + /** The number of locations that belong to the company. */ + locationCount: Scalars["Int"]["output"]; + /** The list of locations in the company. */ + locations: CompanyLocationConnection; + /** The main contact for the company. */ + mainContact?: Maybe; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The name of the company. */ + name: Scalars["String"]["output"]; + /** A note about the company. */ + note?: Maybe; + /** The total number of orders placed for this company, across all its locations. */ + orderCount: Scalars["Int"]["output"]; + /** The list of the company's orders. */ + orders: OrderConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The total amount spent by this company, across all its locations. */ + totalSpent: MoneyV2; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified. */ + updatedAt: Scalars["DateTime"]["output"]; + }; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyContactRolesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyContactsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** Represents information about a company which is also a customer of the shop. */ +export type CompanyPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a billing or shipping address for a company location. */ +export type CompanyAddress = Node & { + /** The first line of the address. Typically the street address or PO Box number. */ + address1: Scalars["String"]["output"]; + /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + address2?: Maybe; + /** The name of the city, district, village, or town. */ + city?: Maybe; + /** The name of the company. */ + companyName: Scalars["String"]["output"]; + /** The name of the country. */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * For example, US. + */ + countryCode: CountryCode; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** The formatted version of the address. */ + formattedAddress: Array; + /** A comma-separated list of the values for city, province, and country. */ + formattedArea?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * A unique phone number for the customer. + * Formatted using E.164 standard. For example, _+16135551111_. + */ + phone?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** The identity of the recipient e.g. 'Receiving Department'. */ + recipient?: Maybe; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was last updated. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** The zip or postal code of the address. */ + zip?: Maybe; + /** + * The two-letter code for the region. + * For example, ON. + */ + zoneCode?: Maybe; +}; + +/** Represents a billing or shipping address for a company location. */ +export type CompanyAddressFormattedAddressArgs = { + withCompanyName?: InputMaybe; + withName?: InputMaybe; +}; + +/** Return type for `companyAddressDelete` mutation. */ +export type CompanyAddressDeletePayload = { + /** The ID of the deleted address. */ + deletedAddressId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update the address of a company location. */ +export type CompanyAddressInput = { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: InputMaybe; + /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + address2?: InputMaybe; + /** The name of the city, district, village, or town. */ + city?: InputMaybe; + /** The two-letter code ([ISO 3166-1 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format) for the country of the address. For example, `US`` for the United States. */ + countryCode?: InputMaybe; + /** A phone number for the recipient. Formatted using E.164 standard. For example, _+16135551111_. */ + phone?: InputMaybe; + /** The identity of the recipient e.g. 'Receiving Department'. */ + recipient?: InputMaybe; + /** The zip or postal code of the address. */ + zip?: InputMaybe; + /** The two-letter code ([ISO 3166-2 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-2) format) for the region of the address, such as the province, state, or district. For example, `ON` for Ontario, Canada. */ + zoneCode?: InputMaybe; +}; + +/** The valid values for the address type of a company. */ +export type CompanyAddressType = + /** The address is a billing address. */ + | "BILLING" + /** The address is a shipping address. */ + | "SHIPPING"; + +/** Return type for `companyAssignCustomerAsContact` mutation. */ +export type CompanyAssignCustomerAsContactPayload = { + /** The created company contact. */ + companyContact?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyAssignMainContact` mutation. */ +export type CompanyAssignMainContactPayload = { + /** The company for which the main contact is assigned. */ + company?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Companies. + */ +export type CompanyConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CompanyEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). */ +export type CompanyContact = Node & { + /** The company to which the contact belongs. */ + company: Company; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was created at Shopify. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customer associated to this contact. */ + customer: Customer; + /** The list of draft orders for the company contact. */ + draftOrders: DraftOrderConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether the contact is the main contact of the company. */ + isMainContact: Scalars["Boolean"]["output"]; + /** The lifetime duration of the company contact, since its creation date on Shopify. Examples: `1 year`, `2 months`, `3 days`. */ + lifetimeDuration: Scalars["String"]["output"]; + /** The company contact's locale (language). */ + locale?: Maybe; + /** The list of orders for the company contact. */ + orders: OrderConnection; + /** The list of roles assigned to this company contact. */ + roleAssignments: CompanyContactRoleAssignmentConnection; + /** The company contact's job title. */ + title?: Maybe; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). */ +export type CompanyContactDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). */ +export type CompanyContactOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer). */ +export type CompanyContactRoleAssignmentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `companyContactAssignRole` mutation. */ +export type CompanyContactAssignRolePayload = { + /** The company contact role assignment. */ + companyContactRoleAssignment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyContactAssignRoles` mutation. */ +export type CompanyContactAssignRolesPayload = { + /** A list of newly created assignments of company contacts to a company location. */ + roleAssignments?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple CompanyContacts. + */ +export type CompanyContactConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CompanyContactEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `companyContactCreate` mutation. */ +export type CompanyContactCreatePayload = { + /** The created company contact. */ + companyContact?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyContactDelete` mutation. */ +export type CompanyContactDeletePayload = { + /** The ID of the deleted company contact. */ + deletedCompanyContactId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one CompanyContact and a cursor during pagination. + */ +export type CompanyContactEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CompanyContactEdge. */ + node: CompanyContact; +}; + +/** The input fields for company contact attributes when creating or updating a company contact. */ +export type CompanyContactInput = { + /** The unique email address of the company contact. */ + email?: InputMaybe; + /** The company contact's first name. */ + firstName?: InputMaybe; + /** The company contact's last name. */ + lastName?: InputMaybe; + /** The contact's locale. */ + locale?: InputMaybe; + /** The phone number of the company contact. */ + phone?: InputMaybe; + /** The title of the company contact. */ + title?: InputMaybe; +}; + +/** Return type for `companyContactRemoveFromCompany` mutation. */ +export type CompanyContactRemoveFromCompanyPayload = { + /** The ID of the removed company contact. */ + removedCompanyContactId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyContactRevokeRole` mutation. */ +export type CompanyContactRevokeRolePayload = { + /** The role assignment that was revoked. */ + revokedCompanyContactRoleAssignmentId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyContactRevokeRoles` mutation. */ +export type CompanyContactRevokeRolesPayload = { + /** A list of role assignment IDs that were removed from the company contact. */ + revokedRoleAssignmentIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The role for a [company contact](https://shopify.dev/api/admin-graphql/latest/objects/companycontact). */ +export type CompanyContactRole = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The name of a role. + * For example, `admin` or `buyer`. + */ + name: Scalars["String"]["output"]; + /** A note for the role. */ + note?: Maybe; +}; + +/** + * The input fields for the role and location to assign to a company contact. + */ +export type CompanyContactRoleAssign = { + /** The role ID. */ + companyContactRoleId: Scalars["ID"]["input"]; + /** The location. */ + companyLocationId: Scalars["ID"]["input"]; +}; + +/** The CompanyContactRoleAssignment describes the company and location associated to a company contact's role. */ +export type CompanyContactRoleAssignment = Node & { + /** The company this role assignment belongs to. */ + company: Company; + /** The company contact for whom this role is assigned. */ + companyContact: CompanyContact; + /** The company location to which the role is assigned. */ + companyLocation: CompanyLocation; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The role that's assigned to the company contact. */ + role: CompanyContactRole; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple CompanyContactRoleAssignments. + */ +export type CompanyContactRoleAssignmentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CompanyContactRoleAssignmentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination. + */ +export type CompanyContactRoleAssignmentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CompanyContactRoleAssignmentEdge. */ + node: CompanyContactRoleAssignment; +}; + +/** The set of valid sort keys for the CompanyContactRoleAssignment query. */ +export type CompanyContactRoleAssignmentSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `location_name` value. */ + | "LOCATION_NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** + * An auto-generated type for paginating through multiple CompanyContactRoles. + */ +export type CompanyContactRoleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CompanyContactRoleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CompanyContactRole and a cursor during pagination. + */ +export type CompanyContactRoleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CompanyContactRoleEdge. */ + node: CompanyContactRole; +}; + +/** The set of valid sort keys for the CompanyContactRole query. */ +export type CompanyContactRoleSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** Return type for `companyContactSendWelcomeEmail` mutation. */ +export type CompanyContactSendWelcomeEmailPayload = { + /** The company contact to whom a welcome email was sent. */ + companyContact?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the CompanyContact query. */ +export type CompanyContactSortKeys = + /** Sort by the `company_id` value. */ + | "COMPANY_ID" + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `email` value. */ + | "EMAIL" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** Sort by the `name_email` value. */ + | "NAME_EMAIL" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** Return type for `companyContactUpdate` mutation. */ +export type CompanyContactUpdatePayload = { + /** The updated company contact. */ + companyContact?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyContactsDelete` mutation. */ +export type CompanyContactsDeletePayload = { + /** The list of IDs of the deleted company contacts. */ + deletedCompanyContactIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields and values for creating a company and its associated resources. + */ +export type CompanyCreateInput = { + /** The attributes for the company. */ + company: CompanyInput; + /** The attributes for the company contact. */ + companyContact?: InputMaybe; + /** The attributes for the company location. */ + companyLocation?: InputMaybe; +}; + +/** Return type for `companyCreate` mutation. */ +export type CompanyCreatePayload = { + /** The created company. */ + company?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyDelete` mutation. */ +export type CompanyDeletePayload = { + /** The ID of the deleted company. */ + deletedCompanyId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Company and a cursor during pagination. + */ +export type CompanyEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CompanyEdge. */ + node: Company; +}; + +/** The input fields for company attributes when creating or updating a company. */ +export type CompanyInput = { + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at + * which the company became the customer. + */ + customerSince?: InputMaybe; + /** A unique externally-supplied ID for the company. */ + externalId?: InputMaybe; + /** The name of the company. */ + name?: InputMaybe; + /** A note about the company. */ + note?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocation = + & CommentEventSubject + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & Navigable + & Node + & { + /** The address used as billing address for the location. */ + billingAddress?: Maybe; + /** The configuration for the buyer's B2B checkout. */ + buyerExperienceConfiguration?: Maybe; + /** The list of catalogs associated with the company location. */ + catalogs: CatalogConnection; + /** The company that the company location belongs to. */ + company: Company; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify. */ + createdAt: Scalars["DateTime"]["output"]; + /** The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market. */ + currency: CurrencyCode; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** The list of draft orders for the company location. */ + draftOrders: DraftOrderConnection; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** A unique externally-supplied ID for the company location. */ + externalId?: Maybe; + /** Whether the merchant added a timeline comment to the company location. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether the company location is assigned a specific catalog. */ + inCatalog: Scalars["Boolean"]["output"]; + /** The preferred locale of the company location. */ + locale?: Maybe; + /** The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market. */ + market: Market; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The name of the company location. */ + name: Scalars["String"]["output"]; + /** A note about the company location. */ + note?: Maybe; + /** The total number of orders placed for the location. */ + orderCount: Scalars["Int"]["output"]; + /** The list of orders for the company location. */ + orders: OrderConnection; + /** The phone number of the company location. */ + phone?: Maybe; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The list of roles assigned to the company location. */ + roleAssignments: CompanyContactRoleAssignmentConnection; + /** The address used as shipping address for the location. */ + shippingAddress?: Maybe; + /** The list of tax exemptions applied to the location. */ + taxExemptions: Array; + /** The tax registration ID for the company location. */ + taxRegistrationId?: Maybe; + /** The total amount spent by the location. */ + totalSpent: MoneyV2; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified. */ + updatedAt: Scalars["DateTime"]["output"]; + }; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationCatalogsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationInCatalogArgs = { + catalogId: Scalars["ID"]["input"]; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location. */ +export type CompanyLocationRoleAssignmentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `companyLocationAssignAddress` mutation. */ +export type CompanyLocationAssignAddressPayload = { + /** The list of updated addresses on the company location. */ + addresses?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationAssignRoles` mutation. */ +export type CompanyLocationAssignRolesPayload = { + /** A list of newly created assignments of company contacts to a company location. */ + roleAssignments?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationAssignTaxExemptions` mutation. */ +export type CompanyLocationAssignTaxExemptionsPayload = { + /** The updated company location. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * A list of products with publishing and pricing information associated with company locations. + */ +export type CompanyLocationCatalog = Catalog & Node & { + /** The company locations associated with the catalog. */ + companyLocations: CompanyLocationConnection; + /** The number of company locations associated with the catalog. */ + companyLocationsCount: Scalars["Int"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Most recent catalog operations. */ + operations: Array; + /** The price list associated with the catalog. */ + priceList?: Maybe; + /** A group of products and collections that's published to a catalog. */ + publication?: Maybe; + /** The status of the catalog. */ + status: CatalogStatus; + /** The name of the catalog. */ + title: Scalars["String"]["output"]; +}; + +/** + * A list of products with publishing and pricing information associated with company locations. + */ +export type CompanyLocationCatalogCompanyLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple CompanyLocations. + */ +export type CompanyLocationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CompanyLocationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `companyLocationCreate` mutation. */ +export type CompanyLocationCreatePayload = { + /** The created company location. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationCreateTaxRegistration` mutation. */ +export type CompanyLocationCreateTaxRegistrationPayload = { + /** The company location with the created tax registration. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationDelete` mutation. */ +export type CompanyLocationDeletePayload = { + /** The ID of the deleted company location. */ + deletedCompanyLocationId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one CompanyLocation and a cursor during pagination. + */ +export type CompanyLocationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CompanyLocationEdge. */ + node: CompanyLocation; +}; + +/** The input fields for company location when creating or updating a company location. */ +export type CompanyLocationInput = { + /** The input fields to create or update the billing address for a company location. */ + billingAddress?: InputMaybe; + /** Whether the billing address is the same as the shipping address. If the value is true, then the input for `billingAddress` is ignored. */ + billingSameAsShipping?: InputMaybe; + /** The configuration for the buyer's checkout at the company location. */ + buyerExperienceConfiguration?: InputMaybe; + /** A unique externally-supplied ID for the company location. */ + externalId?: InputMaybe; + /** The preferred locale of the company location. */ + locale?: InputMaybe; + /** The name of the company location. */ + name?: InputMaybe; + /** A note about the company location. */ + note?: InputMaybe; + /** The phone number of the company location. */ + phone?: InputMaybe; + /** The input fields to create or update the shipping address for a company location. */ + shippingAddress?: InputMaybe; + /** The list of tax exemptions to apply to the company location. */ + taxExemptions?: InputMaybe>; + /** The tax registration ID of the company location. */ + taxRegistrationId?: InputMaybe; +}; + +/** Return type for `companyLocationRevokeRoles` mutation. */ +export type CompanyLocationRevokeRolesPayload = { + /** A list of role assignment IDs that were removed from the company location. */ + revokedRoleAssignmentIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationRevokeTaxExemptions` mutation. */ +export type CompanyLocationRevokeTaxExemptionsPayload = { + /** The updated company location. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationRevokeTaxRegistration` mutation. */ +export type CompanyLocationRevokeTaxRegistrationPayload = { + /** The updated company location. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for the role and contact to assign on a location. + */ +export type CompanyLocationRoleAssign = { + /** The company contact ID.. */ + companyContactId: Scalars["ID"]["input"]; + /** The role ID. */ + companyContactRoleId: Scalars["ID"]["input"]; +}; + +/** The set of valid sort keys for the CompanyLocation query. */ +export type CompanyLocationSortKeys = + /** Sort by the `company_and_location_name` value. */ + | "COMPANY_AND_LOCATION_NAME" + /** Sort by the `company_id` value. */ + | "COMPANY_ID" + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The input fields for company location when creating or updating a company location. */ +export type CompanyLocationUpdateInput = { + /** The configuration for the buyer's checkout at the company location. */ + buyerExperienceConfiguration?: InputMaybe; + /** A unique externally-supplied ID for the company location. */ + externalId?: InputMaybe; + /** The preferred locale of the company location. */ + locale?: InputMaybe; + /** The name of the company location. */ + name?: InputMaybe; + /** A note about the company location. */ + note?: InputMaybe; + /** The phone number of the company location. */ + phone?: InputMaybe; +}; + +/** Return type for `companyLocationUpdate` mutation. */ +export type CompanyLocationUpdatePayload = { + /** The updated company location. */ + companyLocation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyLocationsDelete` mutation. */ +export type CompanyLocationsDeletePayload = { + /** A list of IDs of the deleted company locations. */ + deletedCompanyLocationIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `companyRevokeMainContact` mutation. */ +export type CompanyRevokeMainContactPayload = { + /** The company from which the main contact is revoked. */ + company?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the Company query. */ +export type CompanySortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** Sort by the `order_count` value. */ + | "ORDER_COUNT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `since_date` value. */ + | "SINCE_DATE" + /** Sort by the `total_spent` value. */ + | "TOTAL_SPENT" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** Return type for `companyUpdate` mutation. */ +export type CompanyUpdatePayload = { + /** The updated company. */ + company?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for the context data that determines the pricing of a variant. */ +export type ContextualPricingContext = { + /** + * The CompanyLocation ID used to fetch company location specific prices. + */ + companyLocationId?: InputMaybe; + /** The country code used to fetch country-specific prices. */ + country?: InputMaybe; +}; + +/** The context data that determines the publication status of a product. */ +export type ContextualPublicationContext = { + /** The company location ID used to fetch company-specific publication. */ + companyLocationId?: InputMaybe; + /** The country code used to fetch country-specific publication. */ + country?: InputMaybe; +}; + +/** The list of all the countries from the combined shipping zones for the shop. */ +export type CountriesInShippingZones = { + /** The list of all the countries from all the combined shipping zones. */ + countryCodes: Array; + /** Whether 'Rest of World' has been defined in any of the shipping zones. */ + includeRestOfWorld: Scalars["Boolean"]["output"]; +}; + +/** + * The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines. + * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision + * of another country. For example, the territories associated with Spain are represented by the country code `ES`, + * and the territories associated with the United States of America are represented by the country code `US`. + */ +export type CountryCode = + /** Ascension Island. */ + | "AC" + /** Andorra. */ + | "AD" + /** United Arab Emirates. */ + | "AE" + /** Afghanistan. */ + | "AF" + /** Antigua & Barbuda. */ + | "AG" + /** Anguilla. */ + | "AI" + /** Albania. */ + | "AL" + /** Armenia. */ + | "AM" + /** Netherlands Antilles. */ + | "AN" + /** Angola. */ + | "AO" + /** Argentina. */ + | "AR" + /** Austria. */ + | "AT" + /** Australia. */ + | "AU" + /** Aruba. */ + | "AW" + /** Åland Islands. */ + | "AX" + /** Azerbaijan. */ + | "AZ" + /** Bosnia & Herzegovina. */ + | "BA" + /** Barbados. */ + | "BB" + /** Bangladesh. */ + | "BD" + /** Belgium. */ + | "BE" + /** Burkina Faso. */ + | "BF" + /** Bulgaria. */ + | "BG" + /** Bahrain. */ + | "BH" + /** Burundi. */ + | "BI" + /** Benin. */ + | "BJ" + /** St. Barthélemy. */ + | "BL" + /** Bermuda. */ + | "BM" + /** Brunei. */ + | "BN" + /** Bolivia. */ + | "BO" + /** Caribbean Netherlands. */ + | "BQ" + /** Brazil. */ + | "BR" + /** Bahamas. */ + | "BS" + /** Bhutan. */ + | "BT" + /** Bouvet Island. */ + | "BV" + /** Botswana. */ + | "BW" + /** Belarus. */ + | "BY" + /** Belize. */ + | "BZ" + /** Canada. */ + | "CA" + /** Cocos (Keeling) Islands. */ + | "CC" + /** Congo - Kinshasa. */ + | "CD" + /** Central African Republic. */ + | "CF" + /** Congo - Brazzaville. */ + | "CG" + /** Switzerland. */ + | "CH" + /** Côte d’Ivoire. */ + | "CI" + /** Cook Islands. */ + | "CK" + /** Chile. */ + | "CL" + /** Cameroon. */ + | "CM" + /** China. */ + | "CN" + /** Colombia. */ + | "CO" + /** Costa Rica. */ + | "CR" + /** Cuba. */ + | "CU" + /** Cape Verde. */ + | "CV" + /** Curaçao. */ + | "CW" + /** Christmas Island. */ + | "CX" + /** Cyprus. */ + | "CY" + /** Czechia. */ + | "CZ" + /** Germany. */ + | "DE" + /** Djibouti. */ + | "DJ" + /** Denmark. */ + | "DK" + /** Dominica. */ + | "DM" + /** Dominican Republic. */ + | "DO" + /** Algeria. */ + | "DZ" + /** Ecuador. */ + | "EC" + /** Estonia. */ + | "EE" + /** Egypt. */ + | "EG" + /** Western Sahara. */ + | "EH" + /** Eritrea. */ + | "ER" + /** Spain. */ + | "ES" + /** Ethiopia. */ + | "ET" + /** Finland. */ + | "FI" + /** Fiji. */ + | "FJ" + /** Falkland Islands. */ + | "FK" + /** Faroe Islands. */ + | "FO" + /** France. */ + | "FR" + /** Gabon. */ + | "GA" + /** United Kingdom. */ + | "GB" + /** Grenada. */ + | "GD" + /** Georgia. */ + | "GE" + /** French Guiana. */ + | "GF" + /** Guernsey. */ + | "GG" + /** Ghana. */ + | "GH" + /** Gibraltar. */ + | "GI" + /** Greenland. */ + | "GL" + /** Gambia. */ + | "GM" + /** Guinea. */ + | "GN" + /** Guadeloupe. */ + | "GP" + /** Equatorial Guinea. */ + | "GQ" + /** Greece. */ + | "GR" + /** South Georgia & South Sandwich Islands. */ + | "GS" + /** Guatemala. */ + | "GT" + /** Guinea-Bissau. */ + | "GW" + /** Guyana. */ + | "GY" + /** Hong Kong SAR. */ + | "HK" + /** Heard & McDonald Islands. */ + | "HM" + /** Honduras. */ + | "HN" + /** Croatia. */ + | "HR" + /** Haiti. */ + | "HT" + /** Hungary. */ + | "HU" + /** Indonesia. */ + | "ID" + /** Ireland. */ + | "IE" + /** Israel. */ + | "IL" + /** Isle of Man. */ + | "IM" + /** India. */ + | "IN" + /** British Indian Ocean Territory. */ + | "IO" + /** Iraq. */ + | "IQ" + /** Iran. */ + | "IR" + /** Iceland. */ + | "IS" + /** Italy. */ + | "IT" + /** Jersey. */ + | "JE" + /** Jamaica. */ + | "JM" + /** Jordan. */ + | "JO" + /** Japan. */ + | "JP" + /** Kenya. */ + | "KE" + /** Kyrgyzstan. */ + | "KG" + /** Cambodia. */ + | "KH" + /** Kiribati. */ + | "KI" + /** Comoros. */ + | "KM" + /** St. Kitts & Nevis. */ + | "KN" + /** North Korea. */ + | "KP" + /** South Korea. */ + | "KR" + /** Kuwait. */ + | "KW" + /** Cayman Islands. */ + | "KY" + /** Kazakhstan. */ + | "KZ" + /** Laos. */ + | "LA" + /** Lebanon. */ + | "LB" + /** St. Lucia. */ + | "LC" + /** Liechtenstein. */ + | "LI" + /** Sri Lanka. */ + | "LK" + /** Liberia. */ + | "LR" + /** Lesotho. */ + | "LS" + /** Lithuania. */ + | "LT" + /** Luxembourg. */ + | "LU" + /** Latvia. */ + | "LV" + /** Libya. */ + | "LY" + /** Morocco. */ + | "MA" + /** Monaco. */ + | "MC" + /** Moldova. */ + | "MD" + /** Montenegro. */ + | "ME" + /** St. Martin. */ + | "MF" + /** Madagascar. */ + | "MG" + /** North Macedonia. */ + | "MK" + /** Mali. */ + | "ML" + /** Myanmar (Burma). */ + | "MM" + /** Mongolia. */ + | "MN" + /** Macao SAR. */ + | "MO" + /** Martinique. */ + | "MQ" + /** Mauritania. */ + | "MR" + /** Montserrat. */ + | "MS" + /** Malta. */ + | "MT" + /** Mauritius. */ + | "MU" + /** Maldives. */ + | "MV" + /** Malawi. */ + | "MW" + /** Mexico. */ + | "MX" + /** Malaysia. */ + | "MY" + /** Mozambique. */ + | "MZ" + /** Namibia. */ + | "NA" + /** New Caledonia. */ + | "NC" + /** Niger. */ + | "NE" + /** Norfolk Island. */ + | "NF" + /** Nigeria. */ + | "NG" + /** Nicaragua. */ + | "NI" + /** Netherlands. */ + | "NL" + /** Norway. */ + | "NO" + /** Nepal. */ + | "NP" + /** Nauru. */ + | "NR" + /** Niue. */ + | "NU" + /** New Zealand. */ + | "NZ" + /** Oman. */ + | "OM" + /** Panama. */ + | "PA" + /** Peru. */ + | "PE" + /** French Polynesia. */ + | "PF" + /** Papua New Guinea. */ + | "PG" + /** Philippines. */ + | "PH" + /** Pakistan. */ + | "PK" + /** Poland. */ + | "PL" + /** St. Pierre & Miquelon. */ + | "PM" + /** Pitcairn Islands. */ + | "PN" + /** Palestinian Territories. */ + | "PS" + /** Portugal. */ + | "PT" + /** Paraguay. */ + | "PY" + /** Qatar. */ + | "QA" + /** Réunion. */ + | "RE" + /** Romania. */ + | "RO" + /** Serbia. */ + | "RS" + /** Russia. */ + | "RU" + /** Rwanda. */ + | "RW" + /** Saudi Arabia. */ + | "SA" + /** Solomon Islands. */ + | "SB" + /** Seychelles. */ + | "SC" + /** Sudan. */ + | "SD" + /** Sweden. */ + | "SE" + /** Singapore. */ + | "SG" + /** St. Helena. */ + | "SH" + /** Slovenia. */ + | "SI" + /** Svalbard & Jan Mayen. */ + | "SJ" + /** Slovakia. */ + | "SK" + /** Sierra Leone. */ + | "SL" + /** San Marino. */ + | "SM" + /** Senegal. */ + | "SN" + /** Somalia. */ + | "SO" + /** Suriname. */ + | "SR" + /** South Sudan. */ + | "SS" + /** São Tomé & Príncipe. */ + | "ST" + /** El Salvador. */ + | "SV" + /** Sint Maarten. */ + | "SX" + /** Syria. */ + | "SY" + /** Eswatini. */ + | "SZ" + /** Tristan da Cunha. */ + | "TA" + /** Turks & Caicos Islands. */ + | "TC" + /** Chad. */ + | "TD" + /** French Southern Territories. */ + | "TF" + /** Togo. */ + | "TG" + /** Thailand. */ + | "TH" + /** Tajikistan. */ + | "TJ" + /** Tokelau. */ + | "TK" + /** Timor-Leste. */ + | "TL" + /** Turkmenistan. */ + | "TM" + /** Tunisia. */ + | "TN" + /** Tonga. */ + | "TO" + /** Turkey. */ + | "TR" + /** Trinidad & Tobago. */ + | "TT" + /** Tuvalu. */ + | "TV" + /** Taiwan. */ + | "TW" + /** Tanzania. */ + | "TZ" + /** Ukraine. */ + | "UA" + /** Uganda. */ + | "UG" + /** U.S. Outlying Islands. */ + | "UM" + /** United States. */ + | "US" + /** Uruguay. */ + | "UY" + /** Uzbekistan. */ + | "UZ" + /** Vatican City. */ + | "VA" + /** St. Vincent & Grenadines. */ + | "VC" + /** Venezuela. */ + | "VE" + /** British Virgin Islands. */ + | "VG" + /** Vietnam. */ + | "VN" + /** Vanuatu. */ + | "VU" + /** Wallis & Futuna. */ + | "WF" + /** Samoa. */ + | "WS" + /** Kosovo. */ + | "XK" + /** Yemen. */ + | "YE" + /** Mayotte. */ + | "YT" + /** South Africa. */ + | "ZA" + /** Zambia. */ + | "ZM" + /** Zimbabwe. */ + | "ZW" + /** Unknown Region. */ + | "ZZ"; + +/** + * The country-specific harmonized system code and ISO country code for an inventory item. + */ +export type CountryHarmonizedSystemCode = { + /** The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. */ + countryCode: CountryCode; + /** The country-specific harmonized system code. These are usually longer than 6 digits. */ + harmonizedSystemCode: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes. + */ +export type CountryHarmonizedSystemCodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CountryHarmonizedSystemCodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination. + */ +export type CountryHarmonizedSystemCodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CountryHarmonizedSystemCodeEdge. */ + node: CountryHarmonizedSystemCode; +}; + +/** + * The input fields required to specify a harmonized system code. + */ +export type CountryHarmonizedSystemCodeInput = { + /** The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code. */ + countryCode: CountryCode; + /** Country specific harmonized system code. */ + harmonizedSystemCode: Scalars["String"]["input"]; +}; + +/** The input fields required to create a media object. */ +export type CreateMediaInput = { + /** The alt text associated with the media. */ + alt?: InputMaybe; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The original source of the media object. This might be an external URL or a staged upload URL. */ + originalSource: Scalars["String"]["input"]; +}; + +/** The part of the image that should remain after cropping. */ +export type CropRegion = + /** Keep the bottom of the image. */ + | "BOTTOM" + /** Keep the center of the image. */ + | "CENTER" + /** Keep the left of the image. */ + | "LEFT" + /** Keep the right of the image. */ + | "RIGHT" + /** Keep the top of the image. */ + | "TOP"; + +/** + * The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes, + * and non-standard codes. + */ +export type CurrencyCode = + /** United Arab Emirates Dirham (AED). */ + | "AED" + /** Afghan Afghani (AFN). */ + | "AFN" + /** Albanian Lek (ALL). */ + | "ALL" + /** Armenian Dram (AMD). */ + | "AMD" + /** Netherlands Antillean Guilder. */ + | "ANG" + /** Angolan Kwanza (AOA). */ + | "AOA" + /** Argentine Pesos (ARS). */ + | "ARS" + /** Australian Dollars (AUD). */ + | "AUD" + /** Aruban Florin (AWG). */ + | "AWG" + /** Azerbaijani Manat (AZN). */ + | "AZN" + /** Bosnia and Herzegovina Convertible Mark (BAM). */ + | "BAM" + /** Barbadian Dollar (BBD). */ + | "BBD" + /** Bangladesh Taka (BDT). */ + | "BDT" + /** Bulgarian Lev (BGN). */ + | "BGN" + /** Bahraini Dinar (BHD). */ + | "BHD" + /** Burundian Franc (BIF). */ + | "BIF" + /** Bermudian Dollar (BMD). */ + | "BMD" + /** Brunei Dollar (BND). */ + | "BND" + /** Bolivian Boliviano (BOB). */ + | "BOB" + /** Brazilian Real (BRL). */ + | "BRL" + /** Bahamian Dollar (BSD). */ + | "BSD" + /** Bhutanese Ngultrum (BTN). */ + | "BTN" + /** Botswana Pula (BWP). */ + | "BWP" + /** Belarusian Ruble (BYN). */ + | "BYN" + /** Belarusian Ruble (BYR). */ + | "BYR" + /** Belize Dollar (BZD). */ + | "BZD" + /** Canadian Dollars (CAD). */ + | "CAD" + /** Congolese franc (CDF). */ + | "CDF" + /** Swiss Francs (CHF). */ + | "CHF" + /** Chilean Peso (CLP). */ + | "CLP" + /** Chinese Yuan Renminbi (CNY). */ + | "CNY" + /** Colombian Peso (COP). */ + | "COP" + /** Costa Rican Colones (CRC). */ + | "CRC" + /** Cape Verdean escudo (CVE). */ + | "CVE" + /** Czech Koruny (CZK). */ + | "CZK" + /** Djiboutian Franc (DJF). */ + | "DJF" + /** Danish Kroner (DKK). */ + | "DKK" + /** Dominican Peso (DOP). */ + | "DOP" + /** Algerian Dinar (DZD). */ + | "DZD" + /** Egyptian Pound (EGP). */ + | "EGP" + /** Eritrean Nakfa (ERN). */ + | "ERN" + /** Ethiopian Birr (ETB). */ + | "ETB" + /** Euro (EUR). */ + | "EUR" + /** Fijian Dollars (FJD). */ + | "FJD" + /** Falkland Islands Pounds (FKP). */ + | "FKP" + /** United Kingdom Pounds (GBP). */ + | "GBP" + /** Georgian Lari (GEL). */ + | "GEL" + /** Ghanaian Cedi (GHS). */ + | "GHS" + /** Gibraltar Pounds (GIP). */ + | "GIP" + /** Gambian Dalasi (GMD). */ + | "GMD" + /** Guinean Franc (GNF). */ + | "GNF" + /** Guatemalan Quetzal (GTQ). */ + | "GTQ" + /** Guyanese Dollar (GYD). */ + | "GYD" + /** Hong Kong Dollars (HKD). */ + | "HKD" + /** Honduran Lempira (HNL). */ + | "HNL" + /** Croatian Kuna (HRK). */ + | "HRK" + /** Haitian Gourde (HTG). */ + | "HTG" + /** Hungarian Forint (HUF). */ + | "HUF" + /** Indonesian Rupiah (IDR). */ + | "IDR" + /** Israeli New Shekel (NIS). */ + | "ILS" + /** Indian Rupees (INR). */ + | "INR" + /** Iraqi Dinar (IQD). */ + | "IQD" + /** Iranian Rial (IRR). */ + | "IRR" + /** Icelandic Kronur (ISK). */ + | "ISK" + /** Jersey Pound. */ + | "JEP" + /** Jamaican Dollars (JMD). */ + | "JMD" + /** Jordanian Dinar (JOD). */ + | "JOD" + /** Japanese Yen (JPY). */ + | "JPY" + /** Kenyan Shilling (KES). */ + | "KES" + /** Kyrgyzstani Som (KGS). */ + | "KGS" + /** Cambodian Riel. */ + | "KHR" + /** Kiribati Dollar (KID). */ + | "KID" + /** Comorian Franc (KMF). */ + | "KMF" + /** South Korean Won (KRW). */ + | "KRW" + /** Kuwaiti Dinar (KWD). */ + | "KWD" + /** Cayman Dollars (KYD). */ + | "KYD" + /** Kazakhstani Tenge (KZT). */ + | "KZT" + /** Laotian Kip (LAK). */ + | "LAK" + /** Lebanese Pounds (LBP). */ + | "LBP" + /** Sri Lankan Rupees (LKR). */ + | "LKR" + /** Liberian Dollar (LRD). */ + | "LRD" + /** Lesotho Loti (LSL). */ + | "LSL" + /** Lithuanian Litai (LTL). */ + | "LTL" + /** Latvian Lati (LVL). */ + | "LVL" + /** Libyan Dinar (LYD). */ + | "LYD" + /** Moroccan Dirham. */ + | "MAD" + /** Moldovan Leu (MDL). */ + | "MDL" + /** Malagasy Ariary (MGA). */ + | "MGA" + /** Macedonia Denar (MKD). */ + | "MKD" + /** Burmese Kyat (MMK). */ + | "MMK" + /** Mongolian Tugrik. */ + | "MNT" + /** Macanese Pataca (MOP). */ + | "MOP" + /** Mauritanian Ouguiya (MRU). */ + | "MRU" + /** Mauritian Rupee (MUR). */ + | "MUR" + /** Maldivian Rufiyaa (MVR). */ + | "MVR" + /** Malawian Kwacha (MWK). */ + | "MWK" + /** Mexican Pesos (MXN). */ + | "MXN" + /** Malaysian Ringgits (MYR). */ + | "MYR" + /** Mozambican Metical. */ + | "MZN" + /** Namibian Dollar. */ + | "NAD" + /** Nigerian Naira (NGN). */ + | "NGN" + /** Nicaraguan Córdoba (NIO). */ + | "NIO" + /** Norwegian Kroner (NOK). */ + | "NOK" + /** Nepalese Rupee (NPR). */ + | "NPR" + /** New Zealand Dollars (NZD). */ + | "NZD" + /** Omani Rial (OMR). */ + | "OMR" + /** Panamian Balboa (PAB). */ + | "PAB" + /** Peruvian Nuevo Sol (PEN). */ + | "PEN" + /** Papua New Guinean Kina (PGK). */ + | "PGK" + /** Philippine Peso (PHP). */ + | "PHP" + /** Pakistani Rupee (PKR). */ + | "PKR" + /** Polish Zlotych (PLN). */ + | "PLN" + /** Paraguayan Guarani (PYG). */ + | "PYG" + /** Qatari Rial (QAR). */ + | "QAR" + /** Romanian Lei (RON). */ + | "RON" + /** Serbian dinar (RSD). */ + | "RSD" + /** Russian Rubles (RUB). */ + | "RUB" + /** Rwandan Franc (RWF). */ + | "RWF" + /** Saudi Riyal (SAR). */ + | "SAR" + /** Solomon Islands Dollar (SBD). */ + | "SBD" + /** Seychellois Rupee (SCR). */ + | "SCR" + /** Sudanese Pound (SDG). */ + | "SDG" + /** Swedish Kronor (SEK). */ + | "SEK" + /** Singapore Dollars (SGD). */ + | "SGD" + /** Saint Helena Pounds (SHP). */ + | "SHP" + /** Sierra Leonean Leone (SLL). */ + | "SLL" + /** Somali Shilling (SOS). */ + | "SOS" + /** Surinamese Dollar (SRD). */ + | "SRD" + /** South Sudanese Pound (SSP). */ + | "SSP" + /** Sao Tome And Principe Dobra (STD). */ + | "STD" + /** Sao Tome And Principe Dobra (STN). */ + | "STN" + /** Syrian Pound (SYP). */ + | "SYP" + /** Swazi Lilangeni (SZL). */ + | "SZL" + /** Thai baht (THB). */ + | "THB" + /** Tajikistani Somoni (TJS). */ + | "TJS" + /** Turkmenistani Manat (TMT). */ + | "TMT" + /** Tunisian Dinar (TND). */ + | "TND" + /** Tongan Pa'anga (TOP). */ + | "TOP" + /** Turkish Lira (TRY). */ + | "TRY" + /** Trinidad and Tobago Dollars (TTD). */ + | "TTD" + /** Taiwan Dollars (TWD). */ + | "TWD" + /** Tanzanian Shilling (TZS). */ + | "TZS" + /** Ukrainian Hryvnia (UAH). */ + | "UAH" + /** Ugandan Shilling (UGX). */ + | "UGX" + /** United States Dollars (USD). */ + | "USD" + /** Uruguayan Pesos (UYU). */ + | "UYU" + /** Uzbekistan som (UZS). */ + | "UZS" + /** Venezuelan Bolivares (VED). */ + | "VED" + /** Venezuelan Bolivares (VEF). */ + | "VEF" + /** Venezuelan Bolivares (VES). */ + | "VES" + /** Vietnamese đồng (VND). */ + | "VND" + /** Vanuatu Vatu (VUV). */ + | "VUV" + /** Samoan Tala (WST). */ + | "WST" + /** Central African CFA Franc (XAF). */ + | "XAF" + /** East Caribbean Dollar (XCD). */ + | "XCD" + /** West African CFA franc (XOF). */ + | "XOF" + /** CFP Franc (XPF). */ + | "XPF" + /** Unrecognized currency. */ + | "XXX" + /** Yemeni Rial (YER). */ + | "YER" + /** South African Rand (ZAR). */ + | "ZAR" + /** Zambian Kwacha (ZMW). */ + | "ZMW"; + +/** Currency formats configured for the merchant. These formats are available to use within Liquid. */ +export type CurrencyFormats = { + /** Money without currency in HTML. */ + moneyFormat: Scalars["FormattedString"]["output"]; + /** Money without currency in emails. */ + moneyInEmailsFormat: Scalars["String"]["output"]; + /** Money with currency in HTML. */ + moneyWithCurrencyFormat: Scalars["FormattedString"]["output"]; + /** Money with currency in emails. */ + moneyWithCurrencyInEmailsFormat: Scalars["String"]["output"]; +}; + +/** A setting for a presentment currency. */ +export type CurrencySetting = { + /** The currency's ISO code. */ + currencyCode: CurrencyCode; + /** The full name of the currency. */ + currencyName: Scalars["String"]["output"]; + /** Whether the currency is enabled or not. An enabled currency setting is visible to buyers and allows orders to be generated with that currency as presentment. */ + enabled: Scalars["Boolean"]["output"]; + /** The date and time when the active exchange rate for the currency was last modified. It can be the automatic rate's creation date, or the manual rate's last updated at date if active. */ + rateUpdatedAt?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple CurrencySettings. + */ +export type CurrencySettingConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CurrencySettingEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CurrencySetting and a cursor during pagination. + */ +export type CurrencySettingEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CurrencySettingEdge. */ + node: CurrencySetting; +}; + +/** The input fields for a custom shipping package used to pack shipment. */ +export type CustomShippingPackageInput = { + /** The default package is the one used to calculate shipping costs on checkout. */ + default?: InputMaybe; + /** Outside dimensions of the empty shipping package. */ + dimensions?: InputMaybe; + /** Descriptive name for the package. */ + name?: InputMaybe; + /** Type of package. */ + type?: InputMaybe; + /** Weight of the empty shipping package. */ + weight?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type Customer = + & CommentEventSubject + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & LegacyInteroperability + & Node + & { + /** + * Whether the customer has agreed to receive marketing material. + * @deprecated Use `emailMarketingConsent` instead. + */ + acceptsMarketing: Scalars["Boolean"]["output"]; + /** + * The date and time when the customer consented or objected to receiving marketing material by email. + * + * @deprecated Use `emailMarketingConsent` instead. + */ + acceptsMarketingUpdatedAt: Scalars["DateTime"]["output"]; + /** A list of addresses associated with the customer. */ + addresses: Array; + /** The total amount that the customer has spent on orders in their lifetime. */ + amountSpent: MoneyV2; + /** + * The average amount that the customer spent per order. + * @deprecated This field is no longer supported. + */ + averageOrderAmount?: Maybe; + /** + * The average amount that the customer spent per order. + * @deprecated This field is no longer supported. + */ + averageOrderAmountV2?: Maybe; + /** + * Whether the merchant can delete the customer from their store. + * + * A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an + * order, they can't be deleted from a store. + */ + canDelete: Scalars["Boolean"]["output"]; + /** A list of the customer's company contact profiles. */ + companyContactProfiles: Array; + /** The date and time when the customer was added to the store. */ + createdAt: Scalars["DateTime"]["output"]; + /** The default address associated with the customer. */ + defaultAddress?: Maybe; + /** + * The full name of the customer, based on the values for first_name and last_name. If the first_name and + * last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. + */ + displayName: Scalars["String"]["output"]; + /** The customer's email address. */ + email?: Maybe; + /** + * The current email marketing state for the customer. + * If the customer doesn't have an email address, then this property is `null`. + */ + emailMarketingConsent?: Maybe; + /** A list of events associated with the customer. */ + events: EventConnection; + /** The customer's first name. */ + firstName?: Maybe; + /** + * Whether the merchant has added timeline comments about the customer on the customer's page. + * @deprecated To query for comments on the timeline, use the events connection and a `query` argument containing `verb:comment`, or look for a `CommentEvent` in the `__typename` of events. + */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated with the customer. */ + image: Image; + /** The customer's last name. */ + lastName?: Maybe; + /** The customer's last order. */ + lastOrder?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** + * The amount of time since the customer was first added to the store. + * + * Example: 'about 12 years'. + */ + lifetimeDuration: Scalars["String"]["output"]; + /** The customer's locale. */ + locale: Scalars["String"]["output"]; + /** The market that includes the customer’s default address. */ + market?: Maybe; + /** + * The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the + * customer gave when they consented to receive marketing material by email. + * + * If the customer doesn't accept email marketing, then this property is `null`. + * + * @deprecated Use `emailMarketingConsent` instead. + */ + marketingOptInLevel?: Maybe; + /** Whether the customer can be merged with another customer. */ + mergeable: CustomerMergeable; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** A unique identifier for the customer that's used with Multipass login. */ + multipassIdentifier?: Maybe; + /** A note about the customer. */ + note?: Maybe; + /** The number of orders that the customer has made at the store in their lifetime. */ + numberOfOrders: Scalars["UnsignedInt64"]["output"]; + /** A list of the customer's orders. */ + orders: OrderConnection; + /** A list of the customer's payment methods. */ + paymentMethods: CustomerPaymentMethodConnection; + /** The customer's phone number. */ + phone?: Maybe; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** Possible subscriber states of a customer defined by their subscription contracts. */ + productSubscriberStatus: CustomerProductSubscriberStatus; + /** + * The current SMS marketing state for the customer's phone number. + * + * If the customer does not have a phone number, then this property is `null`. + */ + smsMarketingConsent?: Maybe; + /** The state of the customer's account with the shop. */ + state: CustomerState; + /** The statistics for a given customer. */ + statistics: CustomerStatistics; + /** A list of the customer's subscription contracts. */ + subscriptionContracts: SubscriptionContractConnection; + /** A comma separated list of tags that have been added to the customer. */ + tags: Array; + /** Whether the customer is exempt from being charged taxes on their orders. */ + taxExempt: Scalars["Boolean"]["output"]; + /** The list of tax exemptions applied to the customer. */ + taxExemptions: Array; + /** The URL to unsubscribe the customer from the mailing list. */ + unsubscribeUrl: Scalars["URL"]["output"]; + /** The date and time when the customer was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * Whether the email address is formatted correctly. + * + * Returns `true` when the email is formatted correctly and + * belongs to an existing domain. This doesn't guarantee that + * the email address actually exists. + */ + validEmailAddress: Scalars["Boolean"]["output"]; + /** Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API. */ + verifiedEmail: Scalars["Boolean"]["output"]; + }; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerAddressesArgs = { + first?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerPaymentMethodsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + showRevoked?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents information about a customer of the shop, such as the customer's contact details, their order + * history, and whether they've agreed to receive marketing material by email. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type CustomerSubscriptionContractsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `customerAddTaxExemptions` mutation. */ +export type CustomerAddTaxExemptionsPayload = { + /** The updated customer. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Customers. + */ +export type CustomerConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CustomerEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * The source that collected the customer's consent to receive marketing materials. + */ +export type CustomerConsentCollectedFrom = + /** + * The customer consent was collected outside of Shopify. + */ + | "OTHER" + /** + * The customer consent was collected by Shopify. + */ + | "SHOPIFY"; + +/** Return type for `customerCreate` mutation. */ +export type CustomerCreatePayload = { + /** The created customer. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a card instrument for customer payment method. */ +export type CustomerCreditCard = { + /** The billing address of the card. */ + billingAddress?: Maybe; + /** The brand of the card. */ + brand: Scalars["String"]["output"]; + /** Whether the card is about to expire. */ + expiresSoon: Scalars["Boolean"]["output"]; + /** The expiry month of the card. */ + expiryMonth: Scalars["Int"]["output"]; + /** The expiry year of the card. */ + expiryYear: Scalars["Int"]["output"]; + /** The card's BIN number. */ + firstDigits?: Maybe; + /** The payment method can be revoked if there are no active subscription contracts. */ + isRevocable: Scalars["Boolean"]["output"]; + /** The last 4 digits of the card. */ + lastDigits: Scalars["String"]["output"]; + /** The masked card number with only the last 4 digits displayed. */ + maskedNumber: Scalars["String"]["output"]; + /** The name of the card holder. */ + name: Scalars["String"]["output"]; + /** The source of the card if coming from a wallet such as Apple Pay. */ + source?: Maybe; + /** The last 4 digits of the Device Account Number. */ + virtualLastDigits?: Maybe; +}; + +/** The billing address of a credit card payment instrument. */ +export type CustomerCreditCardBillingAddress = { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** The name of the city, district, village, or town. */ + city?: Maybe; + /** The name of the country. */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * For example, US. + */ + countryCode?: Maybe; + /** The first name in the billing address. */ + firstName?: Maybe; + /** The last name in the billing address. */ + lastName?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * For example, ON. + */ + provinceCode?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + +/** The input fields to delete a customer. */ +export type CustomerDeleteInput = { + /** The ID of the customer to delete. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `customerDelete` mutation. */ +export type CustomerDeletePayload = { + /** The ID of the deleted customer. */ + deletedCustomerId?: Maybe; + /** The shop of the deleted customer. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Customer and a cursor during pagination. + */ +export type CustomerEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CustomerEdge. */ + node: Customer; +}; + +/** + * Represents an email address. + */ +export type CustomerEmailAddress = { + /** The customer's default email address. */ + emailAddress: Scalars["String"]["output"]; + /** Whether the customer has subscribed to email marketing. */ + marketingState: CustomerEmailAddressMarketingState; + /** The URL to unsubscribe a member from all mailing lists. */ + marketingUnsubscribeUrl: Scalars["URL"]["output"]; + /** + * Whether the customer has opted in to having their opened emails tracked. + */ + openTrackingLevel: CustomerEmailAddressOpenTrackingLevel; + /** + * The URL that can be used to opt a customer in or out of email open tracking. + */ + openTrackingUrl: Scalars["URL"]["output"]; +}; + +/** + * Possible marketing states for the customer’s email address. + */ +export type CustomerEmailAddressMarketingState = + /** + * The customer’s email address marketing state is invalid. + */ + | "INVALID" + /** + * The customer is not subscribed to email marketing. + */ + | "NOT_SUBSCRIBED" + /** + * The customer is in the process of subscribing to email marketing. + */ + | "PENDING" + /** + * The customer is subscribed to email marketing. + */ + | "SUBSCRIBED" + /** + * The customer is not subscribed to email marketing but was previously subscribed. + */ + | "UNSUBSCRIBED"; + +/** + * The different levels related to whether a customer has opted in to having their opened emails tracked. + */ +export type CustomerEmailAddressOpenTrackingLevel = + /** + * The customer has opted in to having their open emails tracked. + */ + | "OPTED_IN" + /** + * The customer has opted out of having their open emails tracked. + */ + | "OPTED_OUT" + /** + * The customer has not specified whether they want to opt in or out of having their open emails tracked. + */ + | "UNKNOWN"; + +/** + * Information that describes when a customer consented to + * receiving marketing material by email. + */ +export type CustomerEmailMarketingConsentInput = { + /** + * The latest date and time when the customer consented or objected to + * receiving marketing material by email. + */ + consentUpdatedAt?: InputMaybe; + /** The customer opt-in level at the time of subscribing to marketing material. */ + marketingOptInLevel?: InputMaybe; + /** + * The current marketing state associated with the customer's email. + * If the customer doesn't have an email, then this field is `null`. + */ + marketingState: CustomerEmailMarketingState; +}; + +/** + * The record of when a customer consented to receive marketing material by email. + */ +export type CustomerEmailMarketingConsentState = { + /** + * The date and time at which the customer consented to receive marketing material by email. + * The customer's consent state reflects the consent record with the most recent `consent_updated_at` date. + * If no date is provided, then the date and time at which the consent information was sent is used. + */ + consentUpdatedAt?: Maybe; + /** + * The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, + * that the customer gave when they consented to receive marketing material by email. + */ + marketingOptInLevel?: Maybe; + /** The current email marketing state for the customer. */ + marketingState: CustomerEmailMarketingState; +}; + +/** + * The input fields for the email consent information to update for a given customer ID. + */ +export type CustomerEmailMarketingConsentUpdateInput = { + /** The ID of the customer for which to update the email marketing consent information. The customer must have a unique email address associated to the record. If not, add the email address using the `customerUpdate` mutation first. */ + customerId: Scalars["ID"]["input"]; + /** The marketing consent information when the customer consented to receiving marketing material by email. */ + emailMarketingConsent: CustomerEmailMarketingConsentInput; +}; + +/** Return type for `customerEmailMarketingConsentUpdate` mutation. */ +export type CustomerEmailMarketingConsentUpdatePayload = { + /** + * The updated customer. + */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CustomerEmailMarketingConsentUpdate`. */ +export type CustomerEmailMarketingConsentUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerEmailMarketingConsentUpdateUserError`. */ +export type CustomerEmailMarketingConsentUpdateUserErrorCode = + /** The input value isn't included in the list. */ + | "INCLUSION" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** Missing a required argument. */ + | "MISSING_ARGUMENT"; + +/** + * The possible email marketing states for a customer. + */ +export type CustomerEmailMarketingState = + /** + * The customer’s email address marketing state is invalid. + */ + | "INVALID" + /** + * The customer isn't subscribed to email marketing. + */ + | "NOT_SUBSCRIBED" + /** + * The customer is in the process of subscribing to email marketing. + */ + | "PENDING" + /** + * The customer's personal data is erased. This value is internally-set and read-only. + */ + | "REDACTED" + /** + * The customer is subscribed to email marketing. + */ + | "SUBSCRIBED" + /** + * The customer isn't currently subscribed to email marketing but was previously subscribed. + */ + | "UNSUBSCRIBED"; + +/** Return type for `customerGenerateAccountActivationUrl` mutation. */ +export type CustomerGenerateAccountActivationUrlPayload = { + /** The generated account activation URL. */ + accountActivationUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields and values to use when creating or updating a customer. */ +export type CustomerInput = { + /** The addresses for a customer. */ + addresses?: InputMaybe>; + /** The unique email address of the customer. */ + email?: InputMaybe; + /** + * Information that describes when the customer consented to receiving marketing + * material by email. The `email` field is required when creating a customer with email marketing + * consent information. + */ + emailMarketingConsent?: InputMaybe; + /** The customer's first name. */ + firstName?: InputMaybe; + /** The ID of the customer to update. */ + id?: InputMaybe; + /** The customer's last name. */ + lastName?: InputMaybe; + /** The customer's locale. */ + locale?: InputMaybe; + /** Additional metafields to associate to the customer. */ + metafields?: InputMaybe>; + /** A note about the customer. */ + note?: InputMaybe; + /** The unique phone number for the customer. */ + phone?: InputMaybe; + /** + * The marketing consent information when the customer consented to receiving marketing + * material by SMS. The `phone` field is required when creating a customer with SMS + * marketing consent information. + */ + smsMarketingConsent?: InputMaybe; + /** + * A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: `["tag1", "tag2", "tag3"]`, `"tag1, tag2, tag3"` + * + * Updating `tags` overwrites any existing tags that were previously added to the customer. To add new tags without overwriting + * existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) + * mutation. + */ + tags?: InputMaybe>; + /** Whether the customer is exempt from paying taxes on their order. */ + taxExempt?: InputMaybe; + /** The list of tax exemptions to apply to the customer. */ + taxExemptions?: InputMaybe>; +}; + +/** Represents a customer's visiting activities on a shop's online store. */ +export type CustomerJourney = { + /** The position of the current order within the customer's order history. */ + customerOrderIndex: Scalars["Int"]["output"]; + /** The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order. */ + daysToConversion: Scalars["Int"]["output"]; + /** The customer's first session going into the shop. */ + firstVisit: CustomerVisit; + /** The last session before an order is made. */ + lastVisit?: Maybe; + /** Events preceding a customer order, such as shop sessions. */ + moments: Array; +}; + +/** Represents a customer's visiting activities on a shop's online store. */ +export type CustomerJourneySummary = { + /** The position of the current order within the customer's order history. Test orders aren't included. */ + customerOrderIndex?: Maybe; + /** The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order. */ + daysToConversion?: Maybe; + /** The customer's first session going into the shop. */ + firstVisit?: Maybe; + /** The last session before an order is made. */ + lastVisit?: Maybe; + /** The events preceding a customer's order, such as shop sessions. */ + moments?: Maybe; + /** The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed. */ + momentsCount?: Maybe; + /** Whether the attributed sessions for the order have been created yet. */ + ready: Scalars["Boolean"]["output"]; +}; + +/** Represents a customer's visiting activities on a shop's online store. */ +export type CustomerJourneySummaryMomentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The possible values for the marketing subscription opt-in level enabled at the time the customer consented to receive marketing information. + * + * The levels are defined by [the M3AAWG best practices guideline + * document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf). + */ +export type CustomerMarketingOptInLevel = + /** + * After providing their information, the customer receives a confirmation and is required to + * perform a intermediate step before receiving marketing information. + */ + | "CONFIRMED_OPT_IN" + /** + * After providing their information, the customer receives marketing information without any + * intermediate steps. + */ + | "SINGLE_OPT_IN" + /** + * The customer receives marketing information but how they were opted in is unknown. + */ + | "UNKNOWN"; + +/** The error blocking a customer merge. */ +export type CustomerMergeError = { + /** The list of fields preventing the customer from being merged. */ + errorFields: Array; + /** The customer merge error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerMergeUserError`. */ +export type CustomerMergeErrorCode = + /** The customer cannot be merged because it has associated gift cards. */ + | "CUSTOMER_HAS_GIFT_CARDS" + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** The customer cannot be merged. */ + | "INVALID_CUSTOMER" + /** The customer ID is invalid. */ + | "INVALID_CUSTOMER_ID" + /** The customer is missing the attribute requested for override. */ + | "MISSING_OVERRIDE_ATTRIBUTE" + /** The override attribute is invalid. */ + | "OVERRIDE_ATTRIBUTE_INVALID"; + +/** + * The types of the hard blockers preventing a customer from being merged to another customer. + */ +export type CustomerMergeErrorFieldType = + /** The customer is a company contact. */ + | "COMPANY_CONTACT" + /** The customer has payment methods. */ + | "CUSTOMER_PAYMENT_METHODS" + /** The customer does not exist. */ + | "DELETED_AT" + /** The customer has gift cards. */ + | "GIFT_CARDS" + /** The customer has a merge in progress. */ + | "MERGE_IN_PROGRESS" + /** The customer has a multipass identifier. */ + | "MULTIPASS_IDENTIFIER" + /** The customer has a pending data request. */ + | "PENDING_DATA_REQUEST" + /** The customer has a pending or completed redaction. */ + | "REDACTED_AT" + /** The customer has a subscription history. */ + | "SUBSCRIPTIONS"; + +/** + * The input fields to override default customer merge rules. + */ +export type CustomerMergeOverrideFields = { + /** + * The ID of the customer whose default address will be kept. + */ + customerIdOfDefaultAddressToKeep?: InputMaybe; + /** + * The ID of the customer whose email will be kept. + */ + customerIdOfEmailToKeep?: InputMaybe; + /** + * The ID of the customer whose first name will be kept. + */ + customerIdOfFirstNameToKeep?: InputMaybe; + /** + * The ID of the customer whose last name will be kept. + */ + customerIdOfLastNameToKeep?: InputMaybe; + /** + * The ID of the customer whose phone number will be kept. + */ + customerIdOfPhoneNumberToKeep?: InputMaybe; + /** The note to keep. */ + note?: InputMaybe; + /** The tags to keep. */ + tags?: InputMaybe>; +}; + +/** Return type for `customerMerge` mutation. */ +export type CustomerMergePayload = { + /** The asynchronous job for merging the customers. */ + job?: Maybe; + /** The ID of the customer resulting from the merge. */ + resultingCustomerId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A preview of the results of a customer merge request. */ +export type CustomerMergePreview = { + /** The fields that can be used to override the default fields. */ + alternateFields?: Maybe; + /** The fields that will block the merge if the two customers are merged. */ + blockingFields?: Maybe; + /** The errors blocking the customer merge. */ + customerMergeErrors?: Maybe>; + /** The fields that will be kept if the two customers are merged. */ + defaultFields?: Maybe; + /** The resulting customer ID if the two customers are merged. */ + resultingCustomerId?: Maybe; +}; + +/** The fields that can be used to override the default fields. */ +export type CustomerMergePreviewAlternateFields = { + /** The default address of a customer. */ + defaultAddress?: Maybe; + /** The email state of a customer. */ + email?: Maybe; + /** The first name of a customer. */ + firstName?: Maybe; + /** The last name of a customer. */ + lastName?: Maybe; + /** The phone number state of a customer. */ + phoneNumber?: Maybe; +}; + +/** + * The blocking fields of a customer merge preview. These fields will block customer merge unless edited. + */ +export type CustomerMergePreviewBlockingFields = { + /** + * The merged note resulting from a customer merge. The merged note is over the 5000 character limit and will block customer merge. + */ + note?: Maybe; + /** + * The merged tags resulting from a customer merge. The merged tags are over the 250 limit and will block customer merge. + */ + tags: Array; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFields = { + /** The merged addresses resulting from a customer merge. */ + addresses: MailingAddressConnection; + /** The default address resulting from a customer merge. */ + defaultAddress?: Maybe; + /** The total number of customer-specific discounts resulting from a customer merge. */ + discountNodeCount: Scalars["UnsignedInt64"]["output"]; + /** The merged customer-specific discounts resulting from a customer merge. */ + discountNodes: DiscountNodeConnection; + /** The full name of the customer, based on the values for `first_name` and `last_name`. If `first_name` and `last_name` aren't available, then this field falls back to the customer's email address. If the customer's email isn't available, then this field falls back to the customer's phone number. */ + displayName: Scalars["String"]["output"]; + /** The total number of merged draft orders. */ + draftOrderCount: Scalars["UnsignedInt64"]["output"]; + /** The merged draft orders resulting from a customer merge. */ + draftOrders: DraftOrderConnection; + /** The email state of a customer. */ + email?: Maybe; + /** The first name resulting from a customer merge. */ + firstName?: Maybe; + /** The total number of merged gift cards. */ + giftCardCount: Scalars["UnsignedInt64"]["output"]; + /** The merged gift cards resulting from a customer merge. */ + giftCards: GiftCardConnection; + /** The last name resulting from a customer merge. */ + lastName?: Maybe; + /** The total number of merged metafields. */ + metafieldCount: Scalars["UnsignedInt64"]["output"]; + /** The merged note resulting from a customer merge. */ + note?: Maybe; + /** The total number of merged orders. */ + orderCount: Scalars["UnsignedInt64"]["output"]; + /** The merged orders resulting from a customer merge. */ + orders: OrderConnection; + /** The phone number state of a customer. */ + phoneNumber?: Maybe; + /** The merged tags resulting from a customer merge. */ + tags: Array; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFieldsAddressesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFieldsDiscountNodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFieldsDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFieldsGiftCardsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The fields that will be kept as part of a customer merge preview. */ +export type CustomerMergePreviewDefaultFieldsOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * A merge request for merging two customers. + */ +export type CustomerMergeRequest = { + /** The merge errors that occurred during the customer merge request. */ + customerMergeErrors: Array; + /** The UUID of the merge job. */ + jobId?: Maybe; + /** The ID of the customer resulting from the merge. */ + resultingCustomerId: Scalars["ID"]["output"]; + /** The status of the customer merge request. */ + status: CustomerMergeRequestStatus; +}; + +/** + * The status of the customer merge request. + */ +export type CustomerMergeRequestStatus = + /** + * The customer merge request has been completed. + */ + | "COMPLETED" + /** + * The customer merge request has failed. + */ + | "FAILED" + /** + * The customer merge request is currently in progress. + */ + | "IN_PROGRESS" + /** + * The customer merge request has been requested. + */ + | "REQUESTED"; + +/** An error that occurs while merging two customers. */ +export type CustomerMergeUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** + * An object that represents whether a customer can be merged with another customer. + */ +export type CustomerMergeable = { + /** + * The list of fields preventing the customer from being merged. + */ + errorFields: Array; + /** + * Whether the customer can be merged with another customer. + */ + isMergeable: Scalars["Boolean"]["output"]; + /** + * The merge request if one is currently in progress. + */ + mergeInProgress?: Maybe; + /** + * The reason why the customer can't be merged with another customer. + */ + reason?: Maybe; +}; + +/** Represents a session preceding an order, often used for building a timeline of events leading to an order. */ +export type CustomerMoment = { + /** The date and time when the customer's session occurred. */ + occurredAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple CustomerMoments. + */ +export type CustomerMomentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CustomerMomentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CustomerMoment and a cursor during pagination. + */ +export type CustomerMomentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CustomerMomentEdge. */ + node: CustomerMoment; +}; + +/** All possible instruments for CustomerPaymentMethods. */ +export type CustomerPaymentInstrument = + | CustomerCreditCard + | CustomerPaypalBillingAgreement + | CustomerShopPayAgreement; + +/** The billing address of a payment instrument. */ +export type CustomerPaymentInstrumentBillingAddress = { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** The name of the city, district, village, or town. */ + city?: Maybe; + /** The name of the country. */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * For example, US. + */ + countryCode?: Maybe; + /** The name of the buyer of the address. */ + name?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * For example, ON. + */ + provinceCode?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + +/** A customer's payment method. */ +export type CustomerPaymentMethod = Node & { + /** The customer to whom the payment method belongs. */ + customer?: Maybe; + /** The ID of this payment method. */ + id: Scalars["ID"]["output"]; + /** The instrument for this payment method. */ + instrument?: Maybe; + /** The time that the payment method was revoked. */ + revokedAt?: Maybe; + /** The revocation reason for this payment method. */ + revokedReason?: Maybe; + /** List Subscription Contracts. */ + subscriptionContracts: SubscriptionContractConnection; +}; + +/** A customer's payment method. */ +export type CustomerPaymentMethodSubscriptionContractsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple CustomerPaymentMethods. + */ +export type CustomerPaymentMethodConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CustomerPaymentMethodEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `customerPaymentMethodCreateFromDuplicationData` mutation. */ +export type CustomerPaymentMethodCreateFromDuplicationDataPayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CustomerPaymentMethodCreateFromDuplicationData`. */ +export type CustomerPaymentMethodCreateFromDuplicationDataUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `CustomerPaymentMethodCreateFromDuplicationDataUserError`. */ +export type CustomerPaymentMethodCreateFromDuplicationDataUserErrorCode = + /** Customer doesn't exist. */ + | "CUSTOMER_DOES_NOT_EXIST" + /** Invalid encrypted duplication data. */ + | "INVALID_ENCRYPTED_DUPLICATION_DATA" + /** Too many requests. */ + | "TOO_MANY_REQUESTS"; + +/** Return type for `customerPaymentMethodCreditCardCreate` mutation. */ +export type CustomerPaymentMethodCreditCardCreatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerPaymentMethodCreditCardUpdate` mutation. */ +export type CustomerPaymentMethodCreditCardUpdatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination. + */ +export type CustomerPaymentMethodEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CustomerPaymentMethodEdge. */ + node: CustomerPaymentMethod; +}; + +/** Return type for `customerPaymentMethodGetDuplicationData` mutation. */ +export type CustomerPaymentMethodGetDuplicationDataPayload = { + /** The encrypted data from the payment method to be duplicated. */ + encryptedDuplicationData?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CustomerPaymentMethodGetDuplicationData`. */ +export type CustomerPaymentMethodGetDuplicationDataUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `CustomerPaymentMethodGetDuplicationDataUserError`. */ +export type CustomerPaymentMethodGetDuplicationDataUserErrorCode = + /** Customer doesn't exist. */ + | "CUSTOMER_DOES_NOT_EXIST" + /** Invalid payment instrument. */ + | "INVALID_INSTRUMENT" + /** Must be targeted to another shop in the same organization. */ + | "INVALID_ORGANIZATION_SHOP" + /** Payment method doesn't exist. */ + | "PAYMENT_METHOD_DOES_NOT_EXIST" + /** Target shop cannot be the same as the source. */ + | "SAME_SHOP" + /** Too many requests. */ + | "TOO_MANY_REQUESTS"; + +/** Return type for `customerPaymentMethodGetUpdateUrl` mutation. */ +export type CustomerPaymentMethodGetUpdateUrlPayload = { + /** The URL to redirect the customer to update the payment method. */ + updatePaymentMethodUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `CustomerPaymentMethodGetUpdateUrl`. */ +export type CustomerPaymentMethodGetUpdateUrlUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerPaymentMethodGetUpdateUrlUserError`. */ +export type CustomerPaymentMethodGetUpdateUrlUserErrorCode = + /** Customer doesn't exist. */ + | "CUSTOMER_DOES_NOT_EXIST" + /** Invalid payment instrument. */ + | "INVALID_INSTRUMENT" + /** Payment method doesn't exist. */ + | "PAYMENT_METHOD_DOES_NOT_EXIST" + /** Too many requests. */ + | "TOO_MANY_REQUESTS"; + +/** Return type for `customerPaymentMethodPaypalBillingAgreementCreate` mutation. */ +export type CustomerPaymentMethodPaypalBillingAgreementCreatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerPaymentMethodPaypalBillingAgreementUpdate` mutation. */ +export type CustomerPaymentMethodPaypalBillingAgreementUpdatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerPaymentMethodRemoteCreate` mutation. */ +export type CustomerPaymentMethodRemoteCreatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation. */ +export type CustomerPaymentMethodRemoteCreditCardCreatePayload = { + /** The customer payment method. */ + customerPaymentMethod?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for a remote gateway payment method, only one remote reference permitted. + */ +export type CustomerPaymentMethodRemoteInput = { + /** + * The input fields for a remote authorize net customer profile. + */ + authorizeNetCustomerPaymentProfile?: InputMaybe< + RemoteAuthorizeNetCustomerPaymentProfileInput + >; + /** The input fields for a remote Braintree customer profile. */ + braintreePaymentMethod?: InputMaybe; + /** + * Input containing the fields for a remote stripe payment method. + */ + stripePaymentMethod?: InputMaybe; +}; + +/** Represents an error in the input of a mutation. */ +export type CustomerPaymentMethodRemoteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerPaymentMethodRemoteUserError`. */ +export type CustomerPaymentMethodRemoteUserErrorCode = + /** Authorize.net is not enabled for subscriptions. */ + | "AUTHORIZE_NET_NOT_ENABLED_FOR_SUBSCRIPTIONS" + /** Braintree is not enabled for subscriptions. */ + | "BRAINTREE_NOT_ENABLED_FOR_SUBSCRIPTIONS" + /** Exactly one remote reference is required. */ + | "EXACTLY_ONE_REMOTE_REFERENCE_REQUIRED" + /** The input value is invalid. */ + | "INVALID" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN"; + +/** The revocation reason types for a customer payment method. */ +export type CustomerPaymentMethodRevocationReason = + /** The Authorize.net payment gateway is not enabled. */ + | "AUTHORIZE_NET_GATEWAY_NOT_ENABLED" + /** Authorize.net did not return any payment methods. Make sure that the correct Authorize.net account is linked. */ + | "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD" + /** Failed to contact Braintree API. */ + | "BRAINTREE_API_AUTHENTICATION_ERROR" + /** The Braintree payment gateway is not enabled. */ + | "BRAINTREE_GATEWAY_NOT_ENABLED" + /** The Braintree payment method type should be a credit card or Apple Pay card. */ + | "BRAINTREE_PAYMENT_METHOD_NOT_CARD" + /** Braintree returned no payment methods. Make sure the correct Braintree account is linked. */ + | "BRAINTREE_RETURNED_NO_PAYMENT_METHOD" + /** The credit card failed to update. */ + | "FAILED_TO_UPDATE_CREDIT_CARD" + /** The payment method was manually revoked. */ + | "MANUALLY_REVOKED" + /** The payment method was replaced with an existing payment method. The associated contracts have been migrated to the other payment method. */ + | "MERGED" + /** Failed to contact the Stripe API. */ + | "STRIPE_API_AUTHENTICATION_ERROR" + /** Invalid request. Failed to retrieve payment method from Stripe. */ + | "STRIPE_API_INVALID_REQUEST_ERROR" + /** The Stripe payment gateway is not enabled. */ + | "STRIPE_GATEWAY_NOT_ENABLED" + /** The Stripe payment method type should be card. */ + | "STRIPE_PAYMENT_METHOD_NOT_CARD" + /** Stripe did not return any payment methods. Make sure that the correct Stripe account is linked. */ + | "STRIPE_RETURNED_NO_PAYMENT_METHOD"; + +/** Return type for `customerPaymentMethodRevoke` mutation. */ +export type CustomerPaymentMethodRevokePayload = { + /** The ID of the revoked customer payment method. */ + revokedCustomerPaymentMethodId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerPaymentMethodSendUpdateEmail` mutation. */ +export type CustomerPaymentMethodSendUpdateEmailPayload = { + /** The customer to whom an update payment method email was sent. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents an error in the input of a mutation. */ +export type CustomerPaymentMethodUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerPaymentMethodUserError`. */ +export type CustomerPaymentMethodUserErrorCode = + /** The input value is invalid. */ + | "INVALID" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN"; + +/** Represents a PayPal instrument for customer payment method. */ +export type CustomerPaypalBillingAgreement = { + /** The billing address of this payment method. */ + billingAddress?: Maybe; + /** Whether the PayPal billing agreement is inactive. */ + inactive: Scalars["Boolean"]["output"]; + /** Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts. */ + isRevocable: Scalars["Boolean"]["output"]; + /** The customers's PayPal account email address. */ + paypalAccountEmail?: Maybe; +}; + +/** + * A phone number. + */ +export type CustomerPhoneNumber = { + /** Whether the customer has subscribed to SMS marketing material. */ + marketingState: CustomerSmsMarketingState; + /** A customer's phone number. */ + phoneNumber: Scalars["String"]["output"]; +}; + +/** The valid tiers for the predicted spend of a customer with a shop. */ +export type CustomerPredictedSpendTier = + /** + * The customer's spending is predicted to be in the top spending range for the shop in the following year. + */ + | "HIGH" + /** + * The customer's spending is predicted to be zero, or in the lowest spending range for the shop in the following year. + */ + | "LOW" + /** + * The customer's spending is predicted to be in the normal spending range for the shop in the following year. + */ + | "MEDIUM"; + +/** + * The possible product subscription states for a customer, as defined by the customer's subscription contracts. + */ +export type CustomerProductSubscriberStatus = + /** + * The customer has at least one active subscription contract. + */ + | "ACTIVE" + /** + * The customer's last subscription contract was cancelled and there are no other active or paused + * subscription contracts. + */ + | "CANCELLED" + /** + * The customer's last subscription contract expired and there are no other active or paused + * subscription contracts. + */ + | "EXPIRED" + /** + * The customer's last subscription contract failed and there are no other active or paused + * subscription contracts. + */ + | "FAILED" + /** + * The customer has never had a subscription contract. + */ + | "NEVER_SUBSCRIBED" + /** + * The customer has at least one paused subscription contract and there are no other active + * subscription contracts. + */ + | "PAUSED"; + +/** Return type for `customerRemoveTaxExemptions` mutation. */ +export type CustomerRemoveTaxExemptionsPayload = { + /** The updated customer. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerReplaceTaxExemptions` mutation. */ +export type CustomerReplaceTaxExemptionsPayload = { + /** The updated customer. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the CustomerSavedSearch query. */ +export type CustomerSavedSearchSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * The member of a segment. + */ +export type CustomerSegmentMember = HasMetafields & { + /** The total amount of money that the member has spent on orders. */ + amountSpent?: Maybe; + /** The member's default address. */ + defaultAddress?: Maybe; + /** The member's default email address. */ + defaultEmailAddress?: Maybe; + /** The member's default phone number. */ + defaultPhoneNumber?: Maybe; + /** The full name of the member, which is based on the values of the `first_name` and `last_name` fields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used. */ + displayName: Scalars["String"]["output"]; + /** The member's first name. */ + firstName?: Maybe; + /** The member’s ID. */ + id: Scalars["ID"]["output"]; + /** The member's last name. */ + lastName?: Maybe; + /** The ID of the member's most recent order. */ + lastOrderId?: Maybe; + /** Whether the customer can be merged with another customer. */ + mergeable: CustomerMergeable; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** A note about the member. */ + note?: Maybe; + /** The total number of orders that the member has made. */ + numberOfOrders?: Maybe; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; +}; + +/** + * The member of a segment. + */ +export type CustomerSegmentMemberMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * The member of a segment. + */ +export type CustomerSegmentMemberMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The member of a segment. + */ +export type CustomerSegmentMemberPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * The member of a segment. + */ +export type CustomerSegmentMemberPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The connection type for the `CustomerSegmentMembers` object. */ +export type CustomerSegmentMemberConnection = { + /** A list of edges. */ + edges: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** The statistics for a given segment. */ + statistics: SegmentStatistics; + /** The total number of members in a given segment. */ + totalCount: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type which holds one CustomerSegmentMember and a cursor during pagination. + */ +export type CustomerSegmentMemberEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CustomerSegmentMemberEdge. */ + node: CustomerSegmentMember; +}; + +/** A job to determine a list of members, such as customers, that are associated with an individual segment. */ +export type CustomerSegmentMembersQuery = JobResult & Node & { + /** The current total number of members in a given segment. */ + currentCount: Scalars["Int"]["output"]; + /** This indicates if the job is still queued or has been run. */ + done: Scalars["Boolean"]["output"]; + /** A globally-unique ID that's returned when running an asynchronous mutation. */ + id: Scalars["ID"]["output"]; +}; + +/** Return type for `customerSegmentMembersQueryCreate` mutation. */ +export type CustomerSegmentMembersQueryCreatePayload = { + /** The newly created customer segment members query. */ + customerSegmentMembersQuery?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields and values for creating a customer segment members query. */ +export type CustomerSegmentMembersQueryInput = { + /** The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference). */ + query?: InputMaybe; + /** Reverse the order of the list. The sorting behaviour defaults to ascending order. */ + reverse?: InputMaybe; + /** The ID of the segment. */ + segmentId?: InputMaybe; + /** Sort the list by a given key. */ + sortKey?: InputMaybe; +}; + +/** + * Represents a customer segment members query custom error. + */ +export type CustomerSegmentMembersQueryUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerSegmentMembersQueryUserError`. */ +export type CustomerSegmentMembersQueryUserErrorCode = + /** The input value is invalid. */ + "INVALID"; + +/** Represents a Shop Pay card instrument for customer payment method. */ +export type CustomerShopPayAgreement = { + /** The billing address of the card. */ + billingAddress?: Maybe; + /** Whether the card is about to expire. */ + expiresSoon: Scalars["Boolean"]["output"]; + /** The expiry month of the card. */ + expiryMonth: Scalars["Int"]["output"]; + /** The expiry year of the card. */ + expiryYear: Scalars["Int"]["output"]; + /** Whether the Shop Pay billing agreement is inactive. */ + inactive: Scalars["Boolean"]["output"]; + /** The payment method can be revoked if there are no active subscription contracts. */ + isRevocable: Scalars["Boolean"]["output"]; + /** The last 4 digits of the card. */ + lastDigits: Scalars["String"]["output"]; + /** The masked card number with only the last 4 digits displayed. */ + maskedNumber: Scalars["String"]["output"]; + /** The name of the card holder. */ + name: Scalars["String"]["output"]; +}; + +/** An error that occurs during execution of an SMS marketing consent mutation. */ +export type CustomerSmsMarketingConsentError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `CustomerSmsMarketingConsentError`. */ +export type CustomerSmsMarketingConsentErrorCode = + /** The input value isn't included in the list. */ + | "INCLUSION" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** Missing a required argument. */ + | "MISSING_ARGUMENT"; + +/** + * The marketing consent information when the customer consented to + * receiving marketing material by SMS. + */ +export type CustomerSmsMarketingConsentInput = { + /** + * The date and time when the customer consented to receive marketing material by SMS. + * If no date is provided, then the date and time when the consent information was sent is used. + */ + consentUpdatedAt?: InputMaybe; + /** + * The marketing subscription opt-in level that was set when the customer consented to receive marketing information. + */ + marketingOptInLevel?: InputMaybe; + /** The current SMS marketing state for the customer. */ + marketingState: CustomerSmsMarketingState; +}; + +/** + * The record of when a customer consented to receive marketing material by SMS. + * + * The customer's consent state reflects the record with the most recent date when consent was updated. + */ +export type CustomerSmsMarketingConsentState = { + /** The source from which the SMS marketing information for the customer was collected. */ + consentCollectedFrom?: Maybe; + /** + * The date and time when the customer consented to receive marketing material by SMS. + * If no date is provided, then the date and time when the consent information was sent is used. + */ + consentUpdatedAt?: Maybe; + /** + * The marketing subscription opt-in level that was set when the customer consented to receive marketing information. + */ + marketingOptInLevel: CustomerMarketingOptInLevel; + /** The current SMS marketing state for the customer. */ + marketingState: CustomerSmsMarketingState; +}; + +/** + * The input fields for updating SMS marketing consent information for a given customer ID. + */ +export type CustomerSmsMarketingConsentUpdateInput = { + /** The ID of the customer to update the SMS marketing consent information for. The customer must have a unique phone number associated to the record. If not, add the phone number using the `customerUpdate` mutation first. */ + customerId: Scalars["ID"]["input"]; + /** The marketing consent information when the customer consented to receiving marketing material by SMS. */ + smsMarketingConsent: CustomerSmsMarketingConsentInput; +}; + +/** Return type for `customerSmsMarketingConsentUpdate` mutation. */ +export type CustomerSmsMarketingConsentUpdatePayload = { + /** + * The updated customer. + */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The valid SMS marketing states for a customer’s phone number. + */ +export type CustomerSmsMarketingState = + /** + * The customer hasn't subscribed to SMS marketing. + */ + | "NOT_SUBSCRIBED" + /** + * The customer is in the process of subscribing to SMS marketing. + */ + | "PENDING" + /** + * The customer's personal data is erased. This value is internally-set and read-only. + */ + | "REDACTED" + /** + * The customer is subscribed to SMS marketing. + */ + | "SUBSCRIBED" + /** + * The customer isn't currently subscribed to SMS marketing but was previously subscribed. + */ + | "UNSUBSCRIBED"; + +/** The set of valid sort keys for the Customer query. */ +export type CustomerSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `last_order_date` value. */ + | "LAST_ORDER_DATE" + /** Sort by the `location` value. */ + | "LOCATION" + /** Sort by the `name` value. */ + | "NAME" + /** Sort by the `orders_count` value. */ + | "ORDERS_COUNT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `total_spent` value. */ + | "TOTAL_SPENT" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The valid values for the state of a customer's account with a shop. */ +export type CustomerState = + /** + * The customer declined the email invite to create an account. + */ + | "DECLINED" + /** + * The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time. + */ + | "DISABLED" + /** + * The customer has created an account. + */ + | "ENABLED" + /** + * The customer has received an email invite to create an account. + */ + | "INVITED"; + +/** A customer's computed statistics. */ +export type CustomerStatistics = { + /** The predicted spend tier of a customer with a shop. */ + predictedSpendTier?: Maybe; +}; + +/** Return type for `customerUpdateDefaultAddress` mutation. */ +export type CustomerUpdateDefaultAddressPayload = { + /** The customer whose address was updated. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerUpdate` mutation. */ +export type CustomerUpdatePayload = { + /** The updated customer. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session. */ +export type CustomerVisit = CustomerMoment & Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** URL of the first page the customer landed on for the session. */ + landingPage?: Maybe; + /** Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1. */ + landingPageHtml?: Maybe; + /** + * Represent actions taken by an app, on behalf of a merchant, + * to market Shopify resources such as products, collections, and discounts. + */ + marketingEvent?: Maybe; + /** The date and time when the customer's session occurred. */ + occurredAt: Scalars["DateTime"]["output"]; + /** + * Marketing referral code from the link that the customer clicked to visit the store. + * Supports the following URL attributes: _ref_, _source_, or _r_. + * For example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2. + */ + referralCode?: Maybe; + /** Referral information with URLs linked in HTML. */ + referralInfoHtml: Scalars["FormattedString"]["output"]; + /** + * Webpage where the customer clicked a link that sent them to the online store. + * For example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_. + */ + referrerUrl?: Maybe; + /** + * Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, + * a website domain, QR code, or unknown. + */ + source: Scalars["String"]["output"]; + /** Describes the source explicitly for first or last session. */ + sourceDescription?: Maybe; + /** Type of marketing tactic. */ + sourceType?: Maybe; + /** A set of UTM parameters gathered from the URL parameters of the referrer. */ + utmParameters?: Maybe; +}; + +/** + * This type returns the information about the product and product variant from a customer visit. + */ +export type CustomerVisitProductInfo = { + /** The product information. If `null`, then the product was deleted from the store. */ + product?: Maybe; + /** The quantity of the product that the customer requested. */ + quantity: Scalars["Int"]["output"]; + /** The product variant information, if the product variant exists. */ + variant?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple CustomerVisitProductInfos. + */ +export type CustomerVisitProductInfoConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CustomerVisitProductInfoEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CustomerVisitProductInfo and a cursor during pagination. + */ +export type CustomerVisitProductInfoEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of CustomerVisitProductInfoEdge. */ + node: CustomerVisitProductInfo; +}; + +/** Days of the week from Monday to Sunday. */ +export type DayOfTheWeek = + /** Friday. */ + | "FRIDAY" + /** Monday. */ + | "MONDAY" + /** Saturday. */ + | "SATURDAY" + /** Sunday. */ + | "SUNDAY" + /** Thursday. */ + | "THURSDAY" + /** Tuesday. */ + | "TUESDAY" + /** Wednesday. */ + | "WEDNESDAY"; + +/** + * A token that delegates a set of scopes from the original permission. + * + * To learn more about creating delegate access tokens, refer to + * [Delegate OAuth access tokens to subsystems] + * (https://shopify.dev/apps/auth/oauth/delegate-access-tokens). + */ +export type DelegateAccessToken = { + /** The list of permissions associated with the token. */ + accessScopes: Array; + /** The issued delegate access token. */ + accessToken: Scalars["String"]["output"]; + /** The date and time when the delegate access token was created. */ + createdAt: Scalars["DateTime"]["output"]; +}; + +/** Return type for `delegateAccessTokenCreate` mutation. */ +export type DelegateAccessTokenCreatePayload = { + /** The delegate access token. */ + delegateAccessToken?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `DelegateAccessTokenCreate`. */ +export type DelegateAccessTokenCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `DelegateAccessTokenCreateUserError`. */ +export type DelegateAccessTokenCreateUserErrorCode = + /** The parent access token can't be a delegate token. */ + | "DELEGATE_ACCESS_TOKEN" + /** The access scope can't be empty. */ + | "EMPTY_ACCESS_SCOPE" + /** The delegate token can't expire after the parent token. */ + | "EXPIRES_AFTER_PARENT" + /** The expires_in value must be greater than 0. */ + | "NEGATIVE_EXPIRES_IN" + /** Persistence failed. */ + | "PERSISTENCE_FAILED" + /** The parent access token can't have a refresh token. */ + | "REFRESH_TOKEN" + /** Unknown scopes. */ + | "UNKNOWN_SCOPES"; + +/** Return type for `delegateAccessTokenDestroy` mutation. */ +export type DelegateAccessTokenDestroyPayload = { + /** The user's shop. */ + shop: Shop; + /** The status of the delegate access token destroy operation. Returns true if successful. */ + status?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `DelegateAccessTokenDestroy`. */ +export type DelegateAccessTokenDestroyUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `DelegateAccessTokenDestroyUserError`. */ +export type DelegateAccessTokenDestroyUserErrorCode = + /** Access denied. */ + | "ACCESS_DENIED" + /** Access token not found. */ + | "ACCESS_TOKEN_NOT_FOUND" + /** Cannot delete parent access token. */ + | "CAN_ONLY_DELETE_DELEGATE_TOKENS" + /** Persistence failed. */ + | "PERSISTENCE_FAILED"; + +/** The input fields for a delegate access token. */ +export type DelegateAccessTokenInput = { + /** The list of scopes that will be delegated to the new access token. */ + delegateAccessScope: Array; + /** The amount of time, in seconds, after which the delegate access token is no longer valid. */ + expiresIn?: InputMaybe; +}; + +/** + * Deletion events chronicle the destruction of resources (e.g. products and collections). + * Once deleted, the deletion event is the only trace of the original's existence, + * as the resource itself has been removed and can no longer be accessed. + */ +export type DeletionEvent = { + /** The date and time when the deletion event for the related resource was generated. */ + occurredAt: Scalars["DateTime"]["output"]; + /** The ID of the resource that was deleted. */ + subjectId: Scalars["ID"]["output"]; + /** The type of resource that was deleted. */ + subjectType: DeletionEventSubjectType; +}; + +/** + * An auto-generated type for paginating through multiple DeletionEvents. + */ +export type DeletionEventConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeletionEventEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DeletionEvent and a cursor during pagination. + */ +export type DeletionEventEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeletionEventEdge. */ + node: DeletionEvent; +}; + +/** The set of valid sort keys for the DeletionEvent query. */ +export type DeletionEventSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The supported subject types of deletion events. */ +export type DeletionEventSubjectType = + | "COLLECTION" + | "PRODUCT"; + +/** A shipping service and a list of countries that the service is available for. */ +export type DeliveryAvailableService = { + /** The countries the service provider ships to. */ + countries: DeliveryCountryCodesOrRestOfWorld; + /** The name of the service. */ + name: Scalars["String"]["output"]; +}; + +/** + * Represents a branded promise presented to buyers. + */ +export type DeliveryBrandedPromise = { + /** The handle of the branded promise. For example: `shop_promise`. */ + handle: Scalars["String"]["output"]; + /** The name of the branded promise. For example: `Shop Promise`. */ + name: Scalars["String"]["output"]; +}; + +/** A shipping service provider or a carrier account. */ +export type DeliveryCarrierService = Node & { + /** The list of services offered for given destinations. */ + availableServicesForCountries: Array; + /** The properly formatted name of the shipping service provider, ready to display. */ + formattedName?: Maybe; + /** The logo of the service provider. */ + icon: Image; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the shipping service provider. */ + name?: Maybe; +}; + +/** A shipping service provider or a carrier account. */ +export type DeliveryCarrierServiceAvailableServicesForCountriesArgs = { + countryCodes?: InputMaybe>; + origins?: InputMaybe>; + restOfWorld: Scalars["Boolean"]["input"]; +}; + +/** A carrier service and the associated list of shop locations. */ +export type DeliveryCarrierServiceAndLocations = { + /** The carrier service. */ + carrierService: DeliveryCarrierService; + /** The list of locations that support this carrier service. */ + locations: Array; +}; + +/** A condition that must pass for a delivery method definition to be applied to an order. */ +export type DeliveryCondition = Node & { + /** The value (weight or price) that the condition field is compared to. */ + conditionCriteria: DeliveryConditionCriteria; + /** The field to compare the criterion value against, using the operator. */ + field: DeliveryConditionField; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The operator to compare the field and criterion value. */ + operator: DeliveryConditionOperator; +}; + +/** The value (weight or price) that the condition field is compared to. */ +export type DeliveryConditionCriteria = MoneyV2 | Weight; + +/** The field type that the condition will be applied to. */ +export type DeliveryConditionField = + /** The condition will check against the total price of the order. */ + | "TOTAL_PRICE" + /** The condition will check against the total weight of the order. */ + | "TOTAL_WEIGHT"; + +/** The operator to use to determine if the condition passes. */ +export type DeliveryConditionOperator = + /** The condition will check whether the field is greater than or equal to the criterion. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** The condition will check if the field is less than or equal to the criterion. */ + | "LESS_THAN_OR_EQUAL_TO"; + +/** A country that is used to define a shipping zone. */ +export type DeliveryCountry = Node & { + /** + * A two-letter country code in ISO 3166-1 alpha-2 standard. + * It also includes a flag indicating whether the country should be + * a part of the 'Rest Of World' shipping zone. + */ + code: DeliveryCountryCodeOrRestOfWorld; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The full name of the country. */ + name: Scalars["String"]["output"]; + /** The list of regions associated with this country. */ + provinces: Array; + /** The translated name of the country. The translation returned is based on the system's locale. */ + translatedName: Scalars["String"]["output"]; +}; + +/** The country details and the associated shipping zone. */ +export type DeliveryCountryAndZone = { + /** The country details. */ + country: DeliveryCountry; + /** The name of the shipping zone. */ + zone: Scalars["String"]["output"]; +}; + +/** + * The country code and whether the country is a part of the 'Rest Of World' shipping zone. + */ +export type DeliveryCountryCodeOrRestOfWorld = { + /** The country code in the ISO 3166-1 alpha-2 format. */ + countryCode?: Maybe; + /** Whether the country is a part of the 'Rest of World' shipping zone. */ + restOfWorld: Scalars["Boolean"]["output"]; +}; + +/** + * The list of country codes and information whether the countries + * are a part of the 'Rest Of World' shipping zone. + */ +export type DeliveryCountryCodesOrRestOfWorld = { + /** List of applicable country codes in the ISO 3166-1 alpha-2 format. */ + countryCodes: Array; + /** Whether the countries are a part of the 'Rest of World' shipping zone. */ + restOfWorld: Scalars["Boolean"]["output"]; +}; + +/** The input fields to specify a country. */ +export type DeliveryCountryInput = { + /** The country code of the country in the ISO 3166-1 alpha-2 format. */ + code?: InputMaybe; + /** Associate all available provinces with this country. */ + includeAllProvinces?: InputMaybe; + /** The regions associated with this country. */ + provinces?: InputMaybe>; + /** Whether the country is a part of the 'Rest of World' shipping zone. */ + restOfWorld?: InputMaybe; +}; + +/** A delivery customization. */ +export type DeliveryCustomization = + & HasMetafieldDefinitions + & HasMetafields + & Node + & { + /** The enabled status of the delivery customization. */ + enabled: Scalars["Boolean"]["output"]; + /** The error history on the most recent version of the delivery customization. */ + errorHistory?: Maybe; + /** The ID of the Shopify Function implementing the delivery customization. */ + functionId: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The Shopify Function implementing the delivery customization. */ + shopifyFunction: ShopifyFunction; + /** The title of the delivery customization. */ + title: Scalars["String"]["output"]; + }; + +/** A delivery customization. */ +export type DeliveryCustomizationMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A delivery customization. */ +export type DeliveryCustomizationMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A delivery customization. */ +export type DeliveryCustomizationMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A delivery customization. */ +export type DeliveryCustomizationPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A delivery customization. */ +export type DeliveryCustomizationPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `deliveryCustomizationActivation` mutation. */ +export type DeliveryCustomizationActivationPayload = { + /** The IDs of the updated delivery customizations. */ + ids?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple DeliveryCustomizations. + */ +export type DeliveryCustomizationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeliveryCustomizationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `deliveryCustomizationCreate` mutation. */ +export type DeliveryCustomizationCreatePayload = { + /** Returns the created delivery customization. */ + deliveryCustomization?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `deliveryCustomizationDelete` mutation. */ +export type DeliveryCustomizationDeletePayload = { + /** Returns the deleted delivery customization ID. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one DeliveryCustomization and a cursor during pagination. + */ +export type DeliveryCustomizationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeliveryCustomizationEdge. */ + node: DeliveryCustomization; +}; + +/** An error that occurs during the execution of a delivery customization mutation. */ +export type DeliveryCustomizationError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `DeliveryCustomizationError`. */ +export type DeliveryCustomizationErrorCode = + /** Shop must be on a Shopify Plus plan to activate functions from a custom app. */ + | "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE" + /** Shop must be on a Shopify Plus plan to activate delivery customizations from a custom app. */ + | "DELIVERY_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE" + /** Delivery customization not found. */ + | "DELIVERY_CUSTOMIZATION_NOT_FOUND" + /** Function does not implement the required interface for this delivery customization. */ + | "FUNCTION_DOES_NOT_IMPLEMENT" + /** Function ID cannot be changed. */ + | "FUNCTION_ID_CANNOT_BE_CHANGED" + /** Function not found. */ + | "FUNCTION_NOT_FOUND" + /** Function is pending deletion. */ + | "FUNCTION_PENDING_DELETION" + /** The input value is invalid. */ + | "INVALID" + /** Could not create or update metafields. */ + | "INVALID_METAFIELDS" + /** Maximum delivery customizations are already enabled. */ + | "MAXIMUM_ACTIVE_DELIVERY_CUSTOMIZATIONS" + /** Required input field must be present. */ + | "REQUIRED_INPUT_FIELD" + /** Unauthorized app scope. */ + | "UNAUTHORIZED_APP_SCOPE"; + +/** The input fields to create and update a delivery customization. */ +export type DeliveryCustomizationInput = { + /** The enabled status of the delivery customization. */ + enabled?: InputMaybe; + /** The ID of the function providing the delivery customization. */ + functionId?: InputMaybe; + /** Additional metafields to associate to the delivery customization. */ + metafields?: InputMaybe>; + /** The title of the delivery customization. */ + title?: InputMaybe; +}; + +/** Return type for `deliveryCustomizationUpdate` mutation. */ +export type DeliveryCustomizationUpdatePayload = { + /** Returns the updated delivery customization. */ + deliveryCustomization?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */ +export type DeliveryLegacyModeBlocked = { + /** Whether the shop can convert to full multi-location delivery profiles mode. */ + blocked: Scalars["Boolean"]["output"]; + /** The reasons why the shop is blocked from converting to full multi-location delivery profiles mode. */ + reasons?: Maybe>; +}; + +/** Reasons the shop is blocked from converting to full multi-location delivery profiles mode. */ +export type DeliveryLegacyModeBlockedReason = + /** Multi-Location mode is disabled. The shop can't convert to full multi-location delivery profiles mode. */ + | "MULTI_LOCATION_DISABLED" + /** There are no locations for this store that can fulfill online orders. */ + | "NO_LOCATIONS_FULFILLING_ONLINE_ORDERS"; + +/** Local pickup settings associated with a location. */ +export type DeliveryLocalPickupSettings = { + /** Additional instructions or information related to the local pickup. */ + instructions: Scalars["String"]["output"]; + /** The estimated pickup time to show customers at checkout. */ + pickupTime: DeliveryLocalPickupTime; +}; + +/** Possible pickup time values that a location enabled for local pickup can have. */ +export type DeliveryLocalPickupTime = + /** Usually ready in 5+ days. */ + | "FIVE_OR_MORE_DAYS" + /** Usually ready in 4 hours. */ + | "FOUR_HOURS" + /** Usually ready in 1 hour. */ + | "ONE_HOUR" + /** Usually ready in 24 hours. */ + | "TWENTY_FOUR_HOURS" + /** Usually ready in 2 hours. */ + | "TWO_HOURS" + /** Usually ready in 2-4 days. */ + | "TWO_TO_FOUR_DAYS"; + +/** + * A location group is a collection of locations. They share zones and delivery methods across delivery + * profiles. + */ +export type DeliveryLocationGroup = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** A list of all locations that are part of this location group. */ + locations: LocationConnection; + /** A count of all locations that are part of this location group. */ + locationsCount: Scalars["Int"]["output"]; +}; + +/** + * A location group is a collection of locations. They share zones and delivery methods across delivery + * profiles. + */ +export type DeliveryLocationGroupLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + includeInactive?: InputMaybe; + includeLegacy?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Links a location group with a zone and the associated method definitions. */ +export type DeliveryLocationGroupZone = { + /** The number of method definitions for the zone. */ + methodDefinitionCounts: DeliveryMethodDefinitionCounts; + /** The method definitions associated to a zone and location group. */ + methodDefinitions: DeliveryMethodDefinitionConnection; + /** The zone associated to a location group. */ + zone: DeliveryZone; +}; + +/** Links a location group with a zone and the associated method definitions. */ +export type DeliveryLocationGroupZoneMethodDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + eligible?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DeliveryLocationGroupZones. + */ +export type DeliveryLocationGroupZoneConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeliveryLocationGroupZoneEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination. + */ +export type DeliveryLocationGroupZoneEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeliveryLocationGroupZoneEdge. */ + node: DeliveryLocationGroupZone; +}; + +/** The input fields for a delivery zone associated to a location group and profile. */ +export type DeliveryLocationGroupZoneInput = { + /** A list of countries to associate with the zone. */ + countries?: InputMaybe>; + /** A globally-unique ID of the zone. */ + id?: InputMaybe; + /** A list of method definitions to create. */ + methodDefinitionsToCreate?: InputMaybe>; + /** A list of method definitions to update. */ + methodDefinitionsToUpdate?: InputMaybe>; + /** The name of the zone. */ + name?: InputMaybe; +}; + +/** The input fields for a local pickup setting associated with a location. */ +export type DeliveryLocationLocalPickupEnableInput = { + /** The instructions for the local pickup. */ + instructions?: InputMaybe; + /** The ID of the location associated with the location setting. */ + locationId: Scalars["ID"]["input"]; + /** The time of the local pickup. */ + pickupTime: DeliveryLocalPickupTime; +}; + +/** Represents an error that happened when changing local pickup settings for a location. */ +export type DeliveryLocationLocalPickupSettingsError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `DeliveryLocationLocalPickupSettingsError`. */ +export type DeliveryLocationLocalPickupSettingsErrorCode = + /** Provided locationId is not for an active location belonging to this store. */ + | "ACTIVE_LOCATION_NOT_FOUND" + /** An error occurred while changing the local pickup settings. */ + | "GENERIC_ERROR"; + +/** The delivery method used by a fulfillment order. */ +export type DeliveryMethod = Node & { + /** The branded promise that was presented to the buyer during checkout. For example: Shop Promise. */ + brandedPromise?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location. */ + maxDeliveryDateTime?: Maybe; + /** The type of the delivery method. */ + methodType: DeliveryMethodType; + /** The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location. */ + minDeliveryDateTime?: Maybe; +}; + +/** + * A method definition contains the delivery rate and the conditions that must be met for the method to be + * applied. + */ +export type DeliveryMethodDefinition = Node & { + /** Whether this method definition is active. */ + active: Scalars["Boolean"]["output"]; + /** The description of the method definition. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The method conditions that must pass for this method definition to be applied to an order. */ + methodConditions: Array; + /** The name of the method definition. */ + name: Scalars["String"]["output"]; + /** The provided rate for this method definition, from a rate definition or participant. */ + rateProvider: DeliveryRateProvider; +}; + +/** + * An auto-generated type for paginating through multiple DeliveryMethodDefinitions. + */ +export type DeliveryMethodDefinitionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeliveryMethodDefinitionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * The number of method definitions for a zone, separated into merchant-owned and participant definitions. + */ +export type DeliveryMethodDefinitionCounts = { + /** The number of participant method definitions for the specified zone. */ + participantDefinitionsCount: Scalars["Int"]["output"]; + /** The number of merchant-defined method definitions for the specified zone. */ + rateDefinitionsCount: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination. + */ +export type DeliveryMethodDefinitionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeliveryMethodDefinitionEdge. */ + node: DeliveryMethodDefinition; +}; + +/** The input fields for a method definition. */ +export type DeliveryMethodDefinitionInput = { + /** Whether to use this method definition during rate calculation. */ + active?: InputMaybe; + /** A list of conditions to update on the method definition. */ + conditionsToUpdate?: InputMaybe>; + /** The description of the method definition. */ + description?: InputMaybe; + /** A globally-unique ID of the method definition. Use only when updating a method definiton. */ + id?: InputMaybe; + /** The name of the method definition. */ + name?: InputMaybe; + /** A participant to apply to the method definition. */ + participant?: InputMaybe; + /** A list of price conditions on the method definition. */ + priceConditionsToCreate?: InputMaybe>; + /** A rate definition to apply to the method definition. */ + rateDefinition?: InputMaybe; + /** A list of weight conditions on the method definition. */ + weightConditionsToCreate?: InputMaybe>; +}; + +/** The different types of method definitions to filter by. */ +export type DeliveryMethodDefinitionType = + /** A static merchant-defined rate. */ + | "MERCHANT" + /** A dynamic participant rate. */ + | "PARTICIPANT"; + +/** Possible method types that a delivery method can have. */ +export type DeliveryMethodType = + /** The order is delivered using a local delivery service. */ + | "LOCAL" + /** No delivery is needed. */ + | "NONE" + /** The order is picked up by the customer. */ + | "PICK_UP" + /** The order is delivered to a retail store. */ + | "RETAIL" + /** The order is shipped. */ + | "SHIPPING"; + +/** + * A participant defines carrier-calculated rates for shipping services + * with a possible merchant-defined fixed fee or a percentage-of-rate fee. + */ +export type DeliveryParticipant = Node & { + /** + * Whether to display new shipping services automatically to the customer when the service becomes available. + */ + adaptToNewServicesFlag: Scalars["Boolean"]["output"]; + /** The carrier used for this participant. */ + carrierService: DeliveryCarrierService; + /** The merchant-defined fixed fee for this participant. */ + fixedFee?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The carrier-specific services offered by the participant, and whether each service is active. */ + participantServices: Array; + /** The merchant-defined percentage-of-rate fee for this participant. */ + percentageOfRateFee: Scalars["Float"]["output"]; +}; + +/** The input fields for a participant. */ +export type DeliveryParticipantInput = { + /** + * Whether to automatically display new shipping services to the customer when a service becomes available. + */ + adaptToNewServices?: InputMaybe; + /** The ID of the carrier service for this participant. */ + carrierServiceId?: InputMaybe; + /** The fixed feed that's defined by the merchant for this participant. */ + fixedFee?: InputMaybe; + /** The ID of the participant. */ + id?: InputMaybe; + /** The list of shipping services offered by the participant. */ + participantServices?: InputMaybe>; + /** The merchant-defined percentage-of-rate fee for this participant. */ + percentageOfRateFee?: InputMaybe; +}; + +/** A mail service provided by the participant. */ +export type DeliveryParticipantService = { + /** Whether the service is active. */ + active: Scalars["Boolean"]["output"]; + /** The name of the service. */ + name: Scalars["String"]["output"]; +}; + +/** The input fields for a shipping service provided by a participant. */ +export type DeliveryParticipantServiceInput = { + /** Whether the service is active. */ + active: Scalars["Boolean"]["input"]; + /** The name of the service. */ + name: Scalars["String"]["input"]; +}; + +/** The input fields for a price-based condition of a delivery method definition. */ +export type DeliveryPriceConditionInput = { + /** The monetary value to compare the price of an order to. */ + criteria?: InputMaybe; + /** The operator to use for comparison. */ + operator?: InputMaybe; +}; + +/** How many product variants are in a profile. This count is capped at 500. */ +export type DeliveryProductVariantsCount = { + /** Whether the count has reached the cap of 500. */ + capped: Scalars["Boolean"]["output"]; + /** The product variant count. */ + count: Scalars["Int"]["output"]; +}; + +/** + * A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. + */ +export type DeliveryProfile = Node & { + /** The number of active shipping rates for the profile. */ + activeMethodDefinitionsCount: Scalars["Int"]["output"]; + /** Whether this is the default profile. */ + default: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Whether this shop has enabled legacy compatibility mode for delivery profiles. */ + legacyMode: Scalars["Boolean"]["output"]; + /** The number of locations without rates defined. */ + locationsWithoutRatesCount: Scalars["Int"]["output"]; + /** The name of the delivery profile. */ + name: Scalars["String"]["output"]; + /** The number of active origin locations for the profile. */ + originLocationCount: Scalars["Int"]["output"]; + /** + * The number of product variants for this profile. The count for the default profile isn't supported and will return -1. + * @deprecated Use `productVariantsCountV2` instead. + */ + productVariantsCount: Scalars["Int"]["output"]; + /** How many product variants are in this profile. */ + productVariantsCountV2: DeliveryProductVariantsCount; + /** The products and variants associated with this profile. */ + profileItems: DeliveryProfileItemConnection; + /** The location groups and associated zones using this profile. */ + profileLocationGroups: Array; + /** Selling plan groups associated with the specified delivery profile. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** List of locations that haven't been assigned to a location group for this profile. */ + unassignedLocations: Array; + /** List of locations that have not been assigned to a location group for this profile. */ + unassignedLocationsPaginated: LocationConnection; + /** The number of countries with active rates to deliver to. */ + zoneCountryCount: Scalars["Int"]["output"]; +}; + +/** + * A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. + */ +export type DeliveryProfileProfileItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. + */ +export type DeliveryProfileProfileLocationGroupsArgs = { + locationGroupId?: InputMaybe; +}; + +/** + * A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. + */ +export type DeliveryProfileSellingPlanGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones. + */ +export type DeliveryProfileUnassignedLocationsPaginatedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DeliveryProfiles. + */ +export type DeliveryProfileConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeliveryProfileEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DeliveryProfile and a cursor during pagination. + */ +export type DeliveryProfileEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeliveryProfileEdge. */ + node: DeliveryProfile; +}; + +/** The input fields for a delivery profile. */ +export type DeliveryProfileInput = { + /** The list of condition IDs to delete. */ + conditionsToDelete?: InputMaybe>; + /** + * The list of location groups to be created in the delivery profile. + * + * **Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request. + */ + locationGroupsToCreate?: InputMaybe>; + /** The list of location groups to be deleted from the delivery profile. */ + locationGroupsToDelete?: InputMaybe>; + /** + * The list of location groups to be updated in the delivery profile. + * + * **Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request. + */ + locationGroupsToUpdate?: InputMaybe>; + /** The list of method definition IDs to delete. */ + methodDefinitionsToDelete?: InputMaybe>; + /** The name of the delivery profile. */ + name?: InputMaybe; + /** The list of location groups associated with the delivery profile. */ + profileLocationGroups?: InputMaybe>; + /** The list of selling plan groups to be associated with the delivery profile. */ + sellingPlanGroupsToAssociate?: InputMaybe>; + /** The list of selling plan groups to be dissociated with the delivery profile. */ + sellingPlanGroupsToDissociate?: InputMaybe>; + /** The list of product variant IDs to be associated with the delivery profile. */ + variantsToAssociate?: InputMaybe>; + /** + * The list of product variant IDs to be dissociated from the delivery profile. + * The dissociated product variants are moved back to the default delivery profile. + */ + variantsToDissociate?: InputMaybe>; + /** The list of zone IDs to delete. */ + zonesToDelete?: InputMaybe>; +}; + +/** A product and the subset of associated variants that are part of this delivery profile. */ +export type DeliveryProfileItem = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** A product associated with this profile. */ + product: Product; + /** The product variants associated with this delivery profile. */ + variants: ProductVariantConnection; +}; + +/** A product and the subset of associated variants that are part of this delivery profile. */ +export type DeliveryProfileItemVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DeliveryProfileItems. + */ +export type DeliveryProfileItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DeliveryProfileItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination. + */ +export type DeliveryProfileItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DeliveryProfileItemEdge. */ + node: DeliveryProfileItem; +}; + +/** Links a location group with zones. Both are associated to a delivery profile. */ +export type DeliveryProfileLocationGroup = { + /** The countries already selected in any zone for the specified location group. */ + countriesInAnyZone: Array; + /** The collection of locations that make up the specified location group. */ + locationGroup: DeliveryLocationGroup; + /** The applicable zones associated to the specified location group. */ + locationGroupZones: DeliveryLocationGroupZoneConnection; +}; + +/** Links a location group with zones. Both are associated to a delivery profile. */ +export type DeliveryProfileLocationGroupLocationGroupZonesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields for a location group associated to a delivery profile. */ +export type DeliveryProfileLocationGroupInput = { + /** The globally-unique ID of the delivery profile location group. */ + id?: InputMaybe; + /** The list of location IDs to be moved to this location group. */ + locations?: InputMaybe>; + /** + * The list of location IDs to be added to this location group. + * + * **Note:** due to API input array limits, a maximum of 250 items can be sent per each request. + */ + locationsToAdd?: InputMaybe>; + /** + * The list of location IDs to be removed from this location group. + * + * **Note:** due to API input array limits, a maximum of 250 items can be sent per each request. + */ + locationsToRemove?: InputMaybe>; + /** + * The list of location group zones to create. + * + * **Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request. + */ + zonesToCreate?: InputMaybe>; + /** + * The list of location group zones to update. + * + * **Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request. + */ + zonesToUpdate?: InputMaybe>; +}; + +/** A region that is used to define a shipping zone. */ +export type DeliveryProvince = Node & { + /** The code of the region. */ + code: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The full name of the region. */ + name: Scalars["String"]["output"]; + /** The translated name of the region. The translation returned is based on the system's locale. */ + translatedName: Scalars["String"]["output"]; +}; + +/** The input fields to specify a region. */ +export type DeliveryProvinceInput = { + /** The code of the region. */ + code: Scalars["String"]["input"]; +}; + +/** The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition). */ +export type DeliveryRateDefinition = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The price of this rate. */ + price: MoneyV2; +}; + +/** The input fields for a rate definition. */ +export type DeliveryRateDefinitionInput = { + /** A globally-unique ID of the rate definition. */ + id?: InputMaybe; + /** The price of the rate definition. */ + price: MoneyInput; +}; + +/** A rate provided by a merchant-defined rate or a participant. */ +export type DeliveryRateProvider = DeliveryParticipant | DeliveryRateDefinition; + +/** + * The `DeliverySetting` object enables you to manage shop-wide shipping settings. + * You can enable legacy compatibility mode for the multi-location delivery profiles feature + * if the legacy mode isn't blocked. + */ +export type DeliverySetting = { + /** Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned. */ + legacyModeBlocked: DeliveryLegacyModeBlocked; + /** Enables legacy compatability mode for the multi-location delivery profiles feature. */ + legacyModeProfiles: Scalars["Boolean"]["output"]; +}; + +/** The input fields for shop-level delivery settings. */ +export type DeliverySettingInput = { + /** Whether legacy compatability mode is enabled for the multi-location delivery profiles feature. */ + legacyModeProfiles?: InputMaybe; +}; + +/** Return type for `deliverySettingUpdate` mutation. */ +export type DeliverySettingUpdatePayload = { + /** The updated delivery shop level settings. */ + setting?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `deliveryShippingOriginAssign` mutation. */ +export type DeliveryShippingOriginAssignPayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for updating the condition of a delivery method definition. */ +export type DeliveryUpdateConditionInput = { + /** The value that will be used in comparison. */ + criteria?: InputMaybe; + /** The unit associated with the value that will be used in comparison. */ + criteriaUnit?: InputMaybe; + /** The property of an order that will be used in comparison. */ + field?: InputMaybe; + /** A globally-unique ID of the condition. */ + id: Scalars["ID"]["input"]; + /** The operator to use for comparison. */ + operator?: InputMaybe; +}; + +/** The input fields for a weight-based condition of a delivery method definition. */ +export type DeliveryWeightConditionInput = { + /** The weight value to compare the weight of an order to. */ + criteria?: InputMaybe; + /** The operator to use for comparison. */ + operator?: InputMaybe; +}; + +/** + * A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones. + */ +export type DeliveryZone = Node & { + /** The list of countries within the zone. */ + countries: Array; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the zone. */ + name: Scalars["String"]["output"]; +}; + +/** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ +export type DigitalWallet = + /** Android Pay. */ + | "ANDROID_PAY" + /** Apple Pay. */ + | "APPLE_PAY" + /** Google Pay. */ + | "GOOGLE_PAY" + /** Shopify Pay. */ + | "SHOPIFY_PAY"; + +/** A discount. */ +export type Discount = + | DiscountAutomaticApp + | DiscountAutomaticBasic + | DiscountAutomaticBxgy + | DiscountCodeApp + | DiscountCodeBasic + | DiscountCodeBxgy + | DiscountCodeFreeShipping; + +/** An amount that's allocated to a line based on an associated discount application. */ +export type DiscountAllocation = { + /** + * The money amount that's allocated to a line based on the associated discount application. + * @deprecated Use `allocatedAmountSet` instead. + */ + allocatedAmount: MoneyV2; + /** The money amount that's allocated to a line based on the associated discount application in shop and presentment currencies. */ + allocatedAmountSet: MoneyBag; + /** The discount application that the allocated amount originated from. */ + discountApplication: DiscountApplication; +}; + +/** The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items. */ +export type DiscountAmount = { + /** The value of the discount. */ + amount: MoneyV2; + /** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */ + appliesOnEachItem: Scalars["Boolean"]["output"]; +}; + +/** The input fields for the value of the discount and how it is applied. */ +export type DiscountAmountInput = { + /** The value of the discount. */ + amount?: InputMaybe; + /** If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items. */ + appliesOnEachItem?: InputMaybe; +}; + +/** + * Discount applications capture the intentions of a discount source at + * the time of application on an order's line items or shipping lines. + * + * Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object. + */ +export type DiscountApplication = { + /** The method by which the discount's value is applied to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** + * An ordered index that can be used to identify the discount application and indicate the precedence + * of the discount application for calculations. + */ + index: Scalars["Int"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** The method by which the discount's value is allocated onto its entitled lines. */ +export type DiscountApplicationAllocationMethod = + /** The value is spread across all entitled lines. */ + | "ACROSS" + /** The value is applied onto every entitled line. */ + | "EACH" + /** The value is specifically applied onto a particular line. */ + | "ONE"; + +/** + * An auto-generated type for paginating through multiple DiscountApplications. + */ +export type DiscountApplicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountApplicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountApplication and a cursor during pagination. + */ +export type DiscountApplicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountApplicationEdge. */ + node: DiscountApplication; +}; + +/** The level at which the discount's value is applied. */ +export type DiscountApplicationLevel = + /** + * The discount is applied at the line level. + * Line level discounts are factored into the discountedUnitPriceSet on line items. + */ + | "LINE" + /** + * The discount is applied at the order level. + * Order level discounts are not factored into the discountedUnitPriceSet on line items. + */ + | "ORDER"; + +/** + * The lines on the order to which the discount is applied, of the type defined by + * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of + * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. + * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. + */ +export type DiscountApplicationTargetSelection = + /** The discount is allocated onto all the lines. */ + | "ALL" + /** The discount is allocated onto only the lines that it's entitled for. */ + | "ENTITLED" + /** The discount is allocated onto explicitly chosen lines. */ + | "EXPLICIT"; + +/** + * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. + */ +export type DiscountApplicationTargetType = + /** The discount applies onto line items. */ + | "LINE_ITEM" + /** The discount applies onto shipping lines. */ + | "SHIPPING_LINE"; + +/** The type of discount associated to the automatic discount. For example, the automatic discount might offer a basic discount using a fixed percentage, or a fixed amount, on specific products from the order. The automatic discount may also be a BXGY discount, which offers customer discounts on select products if they add a specific product to their order. */ +export type DiscountAutomatic = + | DiscountAutomaticApp + | DiscountAutomaticBasic + | DiscountAutomaticBxgy; + +/** Return type for `discountAutomaticActivate` mutation. */ +export type DiscountAutomaticActivatePayload = { + /** The activated automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An automatic app discount. */ +export type DiscountAutomaticApp = { + /** The app discount type providing the discount type. */ + appDiscountType: AppDiscountType; + /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The class of the discount for combining purposes. */ + discountClass: DiscountClass; + /** The ID for the discount. */ + discountId: Scalars["ID"]["output"]; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** The error history on the most recent version of the app discount. */ + errorHistory?: Maybe; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** Return type for `discountAutomaticAppCreate` mutation. */ +export type DiscountAutomaticAppCreatePayload = { + /** The created app discount. */ + automaticAppDiscount?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create an app discount. */ +export type DiscountAutomaticAppInput = { + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The ID of the function providing the app discount type. */ + functionId?: InputMaybe; + /** Additional metafields to associate to the discount. */ + metafields?: InputMaybe>; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; +}; + +/** Return type for `discountAutomaticAppUpdate` mutation. */ +export type DiscountAutomaticAppUpdatePayload = { + /** The updated automatic app discount. */ + automaticAppDiscount?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An automatic discount that offers customers a percentage discount, or fixed amount discount, on specific products, collections, or the entire order. */ +export type DiscountAutomaticBasic = { + /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets: DiscountCustomerGets; + /** The class of the discount for combining purposes. */ + discountClass: MerchandiseDiscountClass; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement: DiscountMinimumRequirement; + /** A short summary of the discount. */ + shortSummary: Scalars["String"]["output"]; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** A detailed summary of the discount. */ + summary: Scalars["String"]["output"]; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * The number of times that the discount has been used. + * @deprecated Use `asyncUsageCount` instead. + */ + usageCount: Scalars["Int"]["output"]; +}; + +/** Return type for `discountAutomaticBasicCreate` mutation. */ +export type DiscountAutomaticBasicCreatePayload = { + /** The created automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update an automatic basic discount. */ +export type DiscountAutomaticBasicInput = { + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** Information about the qualifying items and their discount. */ + customerGets?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement?: InputMaybe; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; +}; + +/** Return type for `discountAutomaticBasicUpdate` mutation. */ +export type DiscountAutomaticBasicUpdatePayload = { + /** The updated automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountAutomaticBulkDelete` mutation. */ +export type DiscountAutomaticBulkDeletePayload = { + /** The asynchronous job removing the automatic discounts. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An automatic discount that offers customers a Buy X, Get Y (BXGY) discount. */ +export type DiscountAutomaticBxgy = HasEvents & Node & { + /** The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ + customerBuys: DiscountCustomerBuys; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets: DiscountCustomerGets; + /** The class of the discount for combining purposes. */ + discountClass: MerchandiseDiscountClass; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** + * A legacy unique ID for the discount. + * @deprecated Use DiscountAutomaticNode.id instead. + */ + id: Scalars["ID"]["output"]; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** A detailed summary of the discount. */ + summary: Scalars["String"]["output"]; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * The number of times that the discount has been used. + * @deprecated Use `asyncUsageCount` instead. + */ + usageCount: Scalars["Int"]["output"]; + /** The maximum number of times that the discount can be applied to an order. */ + usesPerOrderLimit?: Maybe; +}; + +/** An automatic discount that offers customers a Buy X, Get Y (BXGY) discount. */ +export type DiscountAutomaticBxgyEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `discountAutomaticBxgyCreate` mutation. */ +export type DiscountAutomaticBxgyCreatePayload = { + /** The created automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update an automatic Buy X, Get Y (BXGY) discount. */ +export type DiscountAutomaticBxgyInput = { + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ + customerBuys?: InputMaybe; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; + /** The maximum number of times that the discount can be applied to an order. */ + usesPerOrderLimit?: InputMaybe; +}; + +/** Return type for `discountAutomaticBxgyUpdate` mutation. */ +export type DiscountAutomaticBxgyUpdatePayload = { + /** The updated automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple DiscountAutomatics. + */ +export type DiscountAutomaticConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountAutomaticEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `discountAutomaticDeactivate` mutation. */ +export type DiscountAutomaticDeactivatePayload = { + /** The deactivated automatic discount. */ + automaticDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountAutomaticDelete` mutation. */ +export type DiscountAutomaticDeletePayload = { + /** The deleted automatic discount ID. */ + deletedAutomaticDiscountId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one DiscountAutomatic and a cursor during pagination. + */ +export type DiscountAutomaticEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountAutomaticEdge. */ + node: DiscountAutomatic; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNode = + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & Node + & { + /** The automatic discount object. */ + automaticDiscount: DiscountAutomatic; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + }; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodeEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodeMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodeMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodeMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodePrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A node containing an automatic discount and its related events. */ +export type DiscountAutomaticNodePrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DiscountAutomaticNodes. + */ +export type DiscountAutomaticNodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountAutomaticNodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination. + */ +export type DiscountAutomaticNodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountAutomaticNodeEdge. */ + node: DiscountAutomaticNode; +}; + +/** The class of the discount for combining purposes. */ +export type DiscountClass = + /** Combined as an order discount. */ + | "ORDER" + /** Combined as a product discount. */ + | "PRODUCT" + /** Combined as a shipping discount. */ + | "SHIPPING"; + +/** The type of discount associated with the discount code. For example, the discount code might offer a basic discount of a fixed percentage, or a fixed amount, on specific products or the order. Alternatively, the discount might offer the customer free shipping on their order. A third option is a Buy X, Get Y (BXGY) discount, which offers a customer discounts on select products if they add a specific product to their order. */ +export type DiscountCode = + | DiscountCodeApp + | DiscountCodeBasic + | DiscountCodeBxgy + | DiscountCodeFreeShipping; + +/** Return type for `discountCodeActivate` mutation. */ +export type DiscountCodeActivatePayload = { + /** The activated code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A code app discount. */ +export type DiscountCodeApp = { + /** The app discount type providing the discount type. */ + appDiscountType: AppDiscountType; + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer: Scalars["Boolean"]["output"]; + /** The number of times that the discount has been used. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** The number of redeem codes for the discount. */ + codeCount: Scalars["Int"]["output"]; + /** A list of redeem codes for the discount. */ + codes: DiscountRedeemCodeConnection; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customers that can use the discount. */ + customerSelection: DiscountCustomerSelection; + /** The class of the discount for combining purposes. */ + discountClass: DiscountClass; + /** The ID for the discount. */ + discountId: Scalars["ID"]["output"]; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** The error history on the most recent version of the discount. */ + errorHistory?: Maybe; + /** Indicates whether there are any timeline comments on the discount. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** The number of times a discount applies on recurring purchases (subscriptions). */ + recurringCycleLimit?: Maybe; + /** URLs that can be used to share the discount. */ + shareableUrls: Array; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The total sales from orders where the discount was used. */ + totalSales?: Maybe; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The maximum number of times that the discount can be used. */ + usageLimit?: Maybe; +}; + +/** A code app discount. */ +export type DiscountCodeAppCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `discountCodeAppCreate` mutation. */ +export type DiscountCodeAppCreatePayload = { + /** The created code app discount. */ + codeAppDiscount?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create a code app discount. */ +export type DiscountCodeAppInput = { + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer?: InputMaybe; + /** The code to use the discount. */ + code?: InputMaybe; + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The customers that can use the discount. */ + customerSelection?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The ID of the function providing the app discount type. */ + functionId?: InputMaybe; + /** Additional metafields to associate to the discount. */ + metafields?: InputMaybe>; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; + /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ + usageLimit?: InputMaybe; +}; + +/** Return type for `discountCodeAppUpdate` mutation. */ +export type DiscountCodeAppUpdatePayload = { + /** The updated code app discount. */ + codeAppDiscount?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Discount code applications capture the intentions of a discount code at + * the time that it is applied onto an order. + * + * Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object. + */ +export type DiscountCodeApplication = DiscountApplication & { + /** The method by which the discount's value is applied to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The string identifying the discount code that was used at the time of application. */ + code: Scalars["String"]["output"]; + /** + * An ordered index that can be used to identify the discount application and indicate the precedence + * of the discount application for calculations. + */ + index: Scalars["Int"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order. */ +export type DiscountCodeBasic = { + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer: Scalars["Boolean"]["output"]; + /** The number of times that the discount has been used. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** The number of redeem codes for the discount. */ + codeCount: Scalars["Int"]["output"]; + /** A list of redeem codes for the discount. */ + codes: DiscountRedeemCodeConnection; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets: DiscountCustomerGets; + /** The customers that can use the discount. */ + customerSelection: DiscountCustomerSelection; + /** The class of the discount for combining purposes. */ + discountClass: MerchandiseDiscountClass; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** Indicates whether there are any timeline comments on the discount. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement?: Maybe; + /** The number of times a discount applies on recurring purchases (subscriptions). */ + recurringCycleLimit?: Maybe; + /** URLs that can be used to share the discount. */ + shareableUrls: Array; + /** A short summary of the discount. */ + shortSummary: Scalars["String"]["output"]; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** A detailed summary of the discount. */ + summary: Scalars["String"]["output"]; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The total sales from orders where the discount was used. */ + totalSales?: Maybe; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The maximum number of times that the discount can be used. */ + usageLimit?: Maybe; +}; + +/** A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order. */ +export type DiscountCodeBasicCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `discountCodeBasicCreate` mutation. */ +export type DiscountCodeBasicCreatePayload = { + /** The created code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update a basic code discount. */ +export type DiscountCodeBasicInput = { + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer?: InputMaybe; + /** The code to use the discount. */ + code?: InputMaybe; + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets?: InputMaybe; + /** The customers that can use the discount. */ + customerSelection?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement?: InputMaybe; + /** The number of times a discount applies on recurring purchases (subscriptions). */ + recurringCycleLimit?: InputMaybe; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; + /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ + usageLimit?: InputMaybe; +}; + +/** Return type for `discountCodeBasicUpdate` mutation. */ +export type DiscountCodeBasicUpdatePayload = { + /** The updated code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountCodeBulkActivate` mutation. */ +export type DiscountCodeBulkActivatePayload = { + /** The asynchronous job that activates the code discounts. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountCodeBulkDeactivate` mutation. */ +export type DiscountCodeBulkDeactivatePayload = { + /** The asynchronous job that deactivates the code discounts. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountCodeBulkDelete` mutation. */ +export type DiscountCodeBulkDeletePayload = { + /** The asynchronous job that deletes the code discounts. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A code discount that offers customers a Buy X, Get Y (BXGY) discount. */ +export type DiscountCodeBxgy = { + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer: Scalars["Boolean"]["output"]; + /** The number of times that the discount has been used. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** The number of redeem codes for the discount. */ + codeCount: Scalars["Int"]["output"]; + /** A list of redeem codes for the discount. */ + codes: DiscountRedeemCodeConnection; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ + customerBuys: DiscountCustomerBuys; + /** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ + customerGets: DiscountCustomerGets; + /** The customers that can use the discount. */ + customerSelection: DiscountCustomerSelection; + /** The class of the discount for combining purposes. */ + discountClass: MerchandiseDiscountClass; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** Indicates whether there are any timeline comments on the discount. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** URLs that can be used to share the discount. */ + shareableUrls: Array; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** A detailed summary of the discount. */ + summary: Scalars["String"]["output"]; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The total sales from orders where the discount was used. */ + totalSales?: Maybe; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The maximum number of times that the discount can be used. */ + usageLimit?: Maybe; + /** The maximum number of times that the discount can be applied to an order. */ + usesPerOrderLimit?: Maybe; +}; + +/** A code discount that offers customers a Buy X, Get Y (BXGY) discount. */ +export type DiscountCodeBxgyCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `discountCodeBxgyCreate` mutation. */ +export type DiscountCodeBxgyCreatePayload = { + /** The created code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update a BXGY code discount. */ +export type DiscountCodeBxgyInput = { + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer?: InputMaybe; + /** The code to use the discount. */ + code?: InputMaybe; + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount. */ + customerBuys?: InputMaybe; + /** The qualifying items that will be discounted, the quantity of each one, and the total value of the discount. */ + customerGets?: InputMaybe; + /** The customers that are eligible to use the discount. */ + customerSelection?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; + /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ + usageLimit?: InputMaybe; + /** The maximum number of times that the discount can be applied to an order. */ + usesPerOrderLimit?: InputMaybe; +}; + +/** Return type for `discountCodeBxgyUpdate` mutation. */ +export type DiscountCodeBxgyUpdatePayload = { + /** The updated code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountCodeDeactivate` mutation. */ +export type DiscountCodeDeactivatePayload = { + /** The deactivated code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `discountCodeDelete` mutation. */ +export type DiscountCodeDeletePayload = { + /** The deleted code discount ID. */ + deletedCodeDiscountId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A code discount that offers customers free shipping on their order. */ +export type DiscountCodeFreeShipping = { + /** Whether the discount applies on regular one-time-purchase shipping lines. */ + appliesOnOneTimePurchase: Scalars["Boolean"]["output"]; + /** Whether the discount applies on subscription shipping lines. */ + appliesOnSubscription: Scalars["Boolean"]["output"]; + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer: Scalars["Boolean"]["output"]; + /** The number of times that the discount has been used. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** The number of redeem codes for the discount. */ + codeCount: Scalars["Int"]["output"]; + /** A list of redeem codes for the discount. */ + codes: DiscountRedeemCodeConnection; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the discount was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customers that can use the discount. */ + customerSelection: DiscountCustomerSelection; + /** A shipping destination that qualifies for the discount. */ + destinationSelection: DiscountShippingDestinationSelection; + /** The class of the discount for combining purposes. */ + discountClass: ShippingDiscountClass; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: Maybe; + /** Indicates whether there are any timeline comments on the discount. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** The maximum shipping price amount accepted to qualify for the discount. */ + maximumShippingPrice?: Maybe; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement?: Maybe; + /** The number of times a discount applies on recurring purchases (subscriptions). */ + recurringCycleLimit?: Maybe; + /** URLs that can be used to share the discount. */ + shareableUrls: Array; + /** A short summary of the discount. */ + shortSummary: Scalars["String"]["output"]; + /** The date and time when the discount starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the discount. */ + status: DiscountStatus; + /** A detailed summary of the discount. */ + summary: Scalars["String"]["output"]; + /** The title of the discount. */ + title: Scalars["String"]["output"]; + /** The total sales from orders where the discount was used. */ + totalSales?: Maybe; + /** The date and time when the discount was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The maximum number of times that the discount can be used. */ + usageLimit?: Maybe; +}; + +/** A code discount that offers customers free shipping on their order. */ +export type DiscountCodeFreeShippingCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `discountCodeFreeShippingCreate` mutation. */ +export type DiscountCodeFreeShippingCreatePayload = { + /** The created code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to create or update a free shipping code discount. */ +export type DiscountCodeFreeShippingInput = { + /** Whether the discount applies on regular one-time-purchase items. */ + appliesOnOneTimePurchase?: InputMaybe; + /** Whether the discount applies on subscription items. */ + appliesOnSubscription?: InputMaybe; + /** Whether the discount can be applied only once per customer. */ + appliesOncePerCustomer?: InputMaybe; + /** The code to use the discount. */ + code?: InputMaybe; + /** Determines which discount classes the shipping discount can combine with. */ + combinesWith?: InputMaybe; + /** The customers that are eligible to use the discount. */ + customerSelection?: InputMaybe; + /** A list of destinations where the discount will apply. */ + destination?: InputMaybe; + /** The date and time when the discount ends. For open-ended discounts, use `null`. */ + endsAt?: InputMaybe; + /** The maximum shipping price that qualifies for the discount. */ + maximumShippingPrice?: InputMaybe; + /** The minimum subtotal or quantity that's required for the discount to be applied. */ + minimumRequirement?: InputMaybe; + /** The number of times a discount applies on recurring purchases (subscriptions). */ + recurringCycleLimit?: InputMaybe; + /** The date and time when the discount starts. */ + startsAt?: InputMaybe; + /** The title of the discount. */ + title?: InputMaybe; + /** The maximum number of times that the discount can be used. For open-ended discounts, use `null`. */ + usageLimit?: InputMaybe; +}; + +/** Return type for `discountCodeFreeShippingUpdate` mutation. */ +export type DiscountCodeFreeShippingUpdatePayload = { + /** The updated code discount. */ + codeDiscountNode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNode = + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & Node + & { + /** The underlying code discount object. */ + codeDiscount: DiscountCode; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + }; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodeEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodeMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodeMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodeMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodePrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A node containing a code discount and its related events. */ +export type DiscountCodeNodePrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DiscountCodeNodes. + */ +export type DiscountCodeNodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountCodeNodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountCodeNode and a cursor during pagination. + */ +export type DiscountCodeNodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountCodeNodeEdge. */ + node: DiscountCodeNode; +}; + +/** Return type for `discountCodeRedeemCodeBulkDelete` mutation. */ +export type DiscountCodeRedeemCodeBulkDeletePayload = { + /** The asynchronous job that deletes the discount redeem codes. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the DiscountCode query. */ +export type DiscountCodeSortKeys = + /** Sort by the `code` value. */ + | "CODE" + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied. */ +export type DiscountCollections = { + /** The list of collections that the discount can have as a prerequisite or the list of collections to which the discount can be applied. */ + collections: CollectionConnection; +}; + +/** A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied. */ +export type DiscountCollectionsCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields for collections attached to a discount. */ +export type DiscountCollectionsInput = { + /** Specifies list of collection ids to add. */ + add?: InputMaybe>; + /** Specifies list of collection ids to remove. */ + remove?: InputMaybe>; +}; + +/** Determines which discount classes the discount can combine with. */ +export type DiscountCombinesWith = { + /** Combines with order discounts. */ + orderDiscounts: Scalars["Boolean"]["output"]; + /** Combines with product discounts. */ + productDiscounts: Scalars["Boolean"]["output"]; + /** Combines with shipping discounts. */ + shippingDiscounts: Scalars["Boolean"]["output"]; +}; + +/** The input fields to determine which discount classes the discount can combine with. */ +export type DiscountCombinesWithInput = { + /** Combines with order discounts. */ + orderDiscounts?: InputMaybe; + /** Combines with product discounts. */ + productDiscounts?: InputMaybe; + /** Combines with shipping discounts. */ + shippingDiscounts?: InputMaybe; +}; + +/** The shipping destinations where the discount can be applied. */ +export type DiscountCountries = { + /** The codes for the countries where the discount can be applied. */ + countries: Array; + /** Whether the discount is applicable to countries that haven't been defined in the shop's shipping zones. */ + includeRestOfWorld: Scalars["Boolean"]["output"]; +}; + +/** The input fields for a list of countries to add or remove from the free shipping discount. */ +export type DiscountCountriesInput = { + /** The country codes to add to the list of countries where the discount applies. */ + add?: InputMaybe>; + /** Whether the discount code is applicable to countries that haven't been defined in the shop's shipping zones. */ + includeRestOfWorld?: InputMaybe; + /** The country codes to remove from the list of countries where the discount applies. */ + remove?: InputMaybe>; +}; + +/** The `DiscountCountryAll` object lets you target all countries as shipping destination for discount eligibility. */ +export type DiscountCountryAll = { + /** Whether the discount can be applied to all countries as shipping destination. This value is always `true`. */ + allCountries: Scalars["Boolean"]["output"]; +}; + +/** The `DiscountCustomerAll` object lets you target all customers for discount eligibility. */ +export type DiscountCustomerAll = { + /** Whether the discount can be applied by all customers. This value is always `true`. */ + allCustomers: Scalars["Boolean"]["output"]; +}; + +/** The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable. */ +export type DiscountCustomerBuys = { + /** The items required for the discount to be applicable. */ + items: DiscountItems; + /** The prerequisite value. */ + value: DiscountCustomerBuysValue; +}; + +/** The input fields for prerequisite items and quantity for the discount. */ +export type DiscountCustomerBuysInput = { + /** The IDs of items that the customer buys. The items can be either collections or products. */ + items?: InputMaybe; + /** The quantity of prerequisite items. */ + value?: InputMaybe; +}; + +/** The prerequisite for the discount to be applicable. For example, the discount might require a customer to buy a minimum quantity of select items. Alternatively, the discount might require a customer to spend a minimum amount on select items. */ +export type DiscountCustomerBuysValue = + | DiscountPurchaseAmount + | DiscountQuantity; + +/** The input fields for prerequisite quantity or minimum purchase amount required for the discount. */ +export type DiscountCustomerBuysValueInput = { + /** The prerequisite minimum purchase amount required for the discount to be applicable. */ + amount?: InputMaybe; + /** The quantity of prerequisite items. */ + quantity?: InputMaybe; +}; + +/** The qualifying items in an order, the quantity of each one, and the total value of the discount. */ +export type DiscountCustomerGets = { + /** Whether the discount applies on regular one-time-purchase items. */ + appliesOnOneTimePurchase: Scalars["Boolean"]["output"]; + /** Whether the discount applies on subscription items. */ + appliesOnSubscription: Scalars["Boolean"]["output"]; + /** The items to which the discount applies. */ + items: DiscountItems; + /** Entitled quantity and the discount value. */ + value: DiscountCustomerGetsValue; +}; + +/** Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount. */ +export type DiscountCustomerGetsInput = { + /** Whether the discount applies on regular one-time-purchase items. */ + appliesOnOneTimePurchase?: InputMaybe; + /** Whether the discount applies on subscription items. */ + appliesOnSubscription?: InputMaybe; + /** The IDs of the items that the customer gets. The items can be either collections or products. */ + items?: InputMaybe; + /** The quantity of items discounted and the discount value. */ + value?: InputMaybe; +}; + +/** The type of the discount value and how it will be applied. For example, it might be a percentage discount on a fixed number of items. Alternatively, it might be a fixed amount evenly distributed across all items or on each individual item. A third example is a percentage discount on all items. */ +export type DiscountCustomerGetsValue = + | DiscountAmount + | DiscountOnQuantity + | DiscountPercentage; + +/** The input fields for the quantity of items discounted and the discount value. */ +export type DiscountCustomerGetsValueInput = { + /** The value of the discount. */ + discountAmount?: InputMaybe; + /** The quantity of the items that are discounted and the discount value. */ + discountOnQuantity?: InputMaybe; + /** The percentage value of the discount. Value must be between 0.00 - 1.00. */ + percentage?: InputMaybe; +}; + +/** A list of customer segments that contain the customers that the discount applies to. */ +export type DiscountCustomerSegments = { + /** A list of customer segments that contain the customers who can use the discount. */ + segments: Array; +}; + +/** The input fields for which customer segments to add to or remove from the discount. */ +export type DiscountCustomerSegmentsInput = { + /** A list of customer segments to add to the current list of customer segments. */ + add?: InputMaybe>; + /** A list of customer segments to remove from the current list of customer segments. */ + remove?: InputMaybe>; +}; + +/** The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers. */ +export type DiscountCustomerSelection = + | DiscountCustomerAll + | DiscountCustomerSegments + | DiscountCustomers; + +/** The input fields for the customers who can use this discount. */ +export type DiscountCustomerSelectionInput = { + /** Whether all customers can use this discount. */ + all?: InputMaybe; + /** The list of customer segment IDs to add or remove from the list of customer segments. */ + customerSegments?: InputMaybe; + /** The list of customer IDs to add or remove from the list of customers. */ + customers?: InputMaybe; +}; + +/** A list of customers eligible for the discount. */ +export type DiscountCustomers = { + /** The list of customers eligible for the discount. */ + customers: Array; +}; + +/** The input fields for which customers to add to or remove from the discount. */ +export type DiscountCustomersInput = { + /** A list of customers to add to the current list of customers who can use the discount. */ + add?: InputMaybe>; + /** A list of customers to remove from the current list of customers who can use the discount. */ + remove?: InputMaybe>; +}; + +/** The type of discount that will be applied. Currently, only a percentage discount is supported. */ +export type DiscountEffect = DiscountPercentage; + +/** The input fields for how the discount will be applied. Currently, only percentage off is supported. */ +export type DiscountEffectInput = { + /** The percentage value of the discount. Value must be between 0.00 - 1.00. */ + percentage?: InputMaybe; +}; + +/** Possible error codes that can be returned by `DiscountUserError`. */ +export type DiscountErrorCode = + /** The active period overlaps with other automatic discounts. At any given time, only one automatic discount can be active. */ + | "ACTIVE_PERIOD_OVERLAP" + /** The input value is blank. */ + | "BLANK" + /** The attribute selection contains conflicting settings. */ + | "CONFLICT" + /** The input value is already present. */ + | "DUPLICATE" + /** The input value should be equal to the value allowed. */ + | "EQUAL_TO" + /** The value exceeded the maximum allowed value. */ + | "EXCEEDED_MAX" + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** The input value should be greater than or equal to the minimum value allowed. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** The value is already present through another selection. */ + | "IMPLICIT_DUPLICATE" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** The `combinesWith` settings are invalid for the discount class. */ + | "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS" + /** The discountClass is invalid for the price rule. */ + | "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE" + /** The input value should be less than the maximum value allowed. */ + | "LESS_THAN" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** The active period overlaps with too many other app-provided discounts. There's a limit on the number of app discounts that can be active at any given time. */ + | "MAX_APP_DISCOUNTS" + /** Specify a minimum subtotal or a quantity, but not both. */ + | "MINIMUM_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT" + /** Missing a required argument. */ + | "MISSING_ARGUMENT" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** Too many arguments provided. */ + | "TOO_MANY_ARGUMENTS" + /** The input value is too short. */ + | "TOO_SHORT" + /** The value is outside of the allowed range. */ + | "VALUE_OUTSIDE_RANGE"; + +/** The type used to target the items required for discount eligibility, or the items to which the application of a discount might apply. For example, for a customer to be eligible for a discount, they're required to add an item from a specified collection to their order. Alternatively, a customer might be required to add a specific product or product variant. When using this type to target which items the discount will apply to, the discount might apply to all items on the order, or to specific products and product variants, or items in a given collection. */ +export type DiscountItems = + | AllDiscountItems + | DiscountCollections + | DiscountProducts; + +/** + * The input fields for the items attached to a discount. You can specify the discount items by product ID or collection ID. + */ +export type DiscountItemsInput = { + /** Whether all items should be selected. */ + all?: InputMaybe; + /** The collections that are attached to a discount. */ + collections?: InputMaybe; + /** The products and product variants that are attached to a discount. */ + products?: InputMaybe; +}; + +/** The minimum quantity of items required for the discount to apply. */ +export type DiscountMinimumQuantity = { + /** The minimum quantity of items that's required for the discount to be applied. */ + greaterThanOrEqualToQuantity: Scalars["UnsignedInt64"]["output"]; +}; + +/** The input fields for the minimum quantity required for the discount. */ +export type DiscountMinimumQuantityInput = { + /** The minimum quantity of items that's required for the discount to be applied. */ + greaterThanOrEqualToQuantity?: InputMaybe; +}; + +/** The type of minimum requirement that must be met for the discount to be applied. For example, a customer must spend a minimum subtotal to be eligible for the discount. Alternatively, a customer must purchase a minimum quantity of items to be eligible for the discount. */ +export type DiscountMinimumRequirement = + | DiscountMinimumQuantity + | DiscountMinimumSubtotal; + +/** The input fields for the minimum quantity or subtotal required for a discount. */ +export type DiscountMinimumRequirementInput = { + /** The minimum required quantity. */ + quantity?: InputMaybe; + /** The minimum required subtotal. */ + subtotal?: InputMaybe; +}; + +/** The minimum subtotal required for the discount to apply. */ +export type DiscountMinimumSubtotal = { + /** The minimum subtotal that's required for the discount to be applied. */ + greaterThanOrEqualToSubtotal: MoneyV2; +}; + +/** The input fields for the minimum subtotal required for a discount. */ +export type DiscountMinimumSubtotalInput = { + /** The minimum subtotal that's required for the discount to be applied. */ + greaterThanOrEqualToSubtotal?: InputMaybe; +}; + +/** A discount wrapper node. */ +export type DiscountNode = + & HasEvents + & HasMetafieldDefinitions + & HasMetafields + & Node + & { + /** A discount. */ + discount: Discount; + /** The paginated list of events associated with the host subject. */ + events: EventConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + }; + +/** A discount wrapper node. */ +export type DiscountNodeEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A discount wrapper node. */ +export type DiscountNodeMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A discount wrapper node. */ +export type DiscountNodeMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A discount wrapper node. */ +export type DiscountNodeMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A discount wrapper node. */ +export type DiscountNodePrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A discount wrapper node. */ +export type DiscountNodePrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple DiscountNodes. + */ +export type DiscountNodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountNodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountNode and a cursor during pagination. + */ +export type DiscountNodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountNodeEdge. */ + node: DiscountNode; +}; + +/** The quantity of items discounted, the discount value, and how the discount will be applied. */ +export type DiscountOnQuantity = { + /** The discount's effect on qualifying items. */ + effect: DiscountEffect; + /** The number of items being discounted. The customer must have at least this many items of specified products or product variants in their order to be eligible for the discount. */ + quantity: DiscountQuantity; +}; + +/** The input fields for the quantity of items discounted and the discount value. */ +export type DiscountOnQuantityInput = { + /** The percentage value of the discount. */ + effect?: InputMaybe; + /** The quantity of items that are discounted. */ + quantity?: InputMaybe; +}; + +/** A discount effect that gives customers a percentage off of specified items on their order. */ +export type DiscountPercentage = { + /** The percentage value of the discount. */ + percentage: Scalars["Float"]["output"]; +}; + +/** A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. */ +export type DiscountProducts = { + /** The list of product variants that the discount can have as a prerequisite or the list of product variants to which the discount can be applied. */ + productVariants: ProductVariantConnection; + /** The list of products that the discount can have as a prerequisite or the list of products to which the discount can be applied. */ + products: ProductConnection; +}; + +/** A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. */ +export type DiscountProductsProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied. */ +export type DiscountProductsProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields for the products and product variants attached to a discount. */ +export type DiscountProductsInput = { + /** Specifies list of product variant ids to add. */ + productVariantsToAdd?: InputMaybe>; + /** Specifies list of product variant ids to remove. */ + productVariantsToRemove?: InputMaybe>; + /** Specifies list of product ids to add. */ + productsToAdd?: InputMaybe>; + /** Specifies list of product ids to remove. */ + productsToRemove?: InputMaybe>; +}; + +/** A purchase amount in the context of a discount. This object can be used to define the minimum purchase amount required for a discount to be applicable. */ +export type DiscountPurchaseAmount = { + /** The purchase amount in decimal format. */ + amount: Scalars["Decimal"]["output"]; +}; + +/** A quantity of items in the context of a discount. This object can be used to define the minimum quantity of items required to apply a discount. Alternatively, it can be used to define the quantity of items that can be discounted. */ +export type DiscountQuantity = { + /** The quantity of items. */ + quantity: Scalars["UnsignedInt64"]["output"]; +}; + +/** A code that a customer can use at checkout to receive a discount. For example, a customer can use the redeem code 'SUMMER20' at checkout to receive a 20% discount on their entire order. */ +export type DiscountRedeemCode = { + /** The number of times that the discount redeem code has been used. This value is updated asynchronously and can be different than the actual usage count. */ + asyncUsageCount: Scalars["Int"]["output"]; + /** The code that a customer can use at checkout to receive a discount. */ + code: Scalars["String"]["output"]; + /** The application that created the discount redeem code. */ + createdBy?: Maybe; + /** A globally-unique ID of the discount redeem code. */ + id: Scalars["ID"]["output"]; +}; + +/** Return type for `discountRedeemCodeBulkAdd` mutation. */ +export type DiscountRedeemCodeBulkAddPayload = { + /** The ID of the discount redeem code bulk creation operation. The properties and status of the operation can be tracked using the [`DiscountRedeemCodeBulkCreation` query](https://shopify.dev/api/admin-graphql/2022-04/queries/discountRedeemCodeBulkCreation). */ + bulkCreation?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The properties and status of a bulk discount redeem code creation operation. */ +export type DiscountRedeemCodeBulkCreation = Node & { + /** The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation. */ + codes: DiscountRedeemCodeBulkCreationCodeConnection; + /** The number of codes to create. */ + codesCount: Scalars["Int"]["output"]; + /** The date and time when the bulk creation was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The code discount associated with the created codes. */ + discountCode?: Maybe; + /** Whether the bulk creation is still queued (`false`) or has been run (`true`). */ + done: Scalars["Boolean"]["output"]; + /** The number of codes that weren't created successfully. */ + failedCount: Scalars["Int"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The number of codes created successfully. */ + importedCount: Scalars["Int"]["output"]; +}; + +/** The properties and status of a bulk discount redeem code creation operation. */ +export type DiscountRedeemCodeBulkCreationCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A result of a discount redeem code creation operation created by a bulk creation. */ +export type DiscountRedeemCodeBulkCreationCode = { + /** The code to use in the discount redeem code creation operation. */ + code: Scalars["String"]["output"]; + /** + * The successfully created discount redeem code. + * + * If the discount redeem code couldn't be created, then this field is `null``. + */ + discountRedeemCode?: Maybe; + /** A list of errors that occurred during the creation operation of the discount redeem code. */ + errors: Array; +}; + +/** + * An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes. + */ +export type DiscountRedeemCodeBulkCreationCodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountRedeemCodeBulkCreationCodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination. + */ +export type DiscountRedeemCodeBulkCreationCodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountRedeemCodeBulkCreationCodeEdge. */ + node: DiscountRedeemCodeBulkCreationCode; +}; + +/** + * An auto-generated type for paginating through multiple DiscountRedeemCodes. + */ +export type DiscountRedeemCodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountRedeemCodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination. + */ +export type DiscountRedeemCodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DiscountRedeemCodeEdge. */ + node: DiscountRedeemCode; +}; + +/** The input fields for the redeem code to attach to a discount. */ +export type DiscountRedeemCodeInput = { + /** The code that a customer can use at checkout to receive the associated discount. */ + code: Scalars["String"]["input"]; +}; + +/** A shareable URL for a discount code. */ +export type DiscountShareableUrl = { + /** The image URL of the item (product or collection) to which the discount applies. */ + targetItemImage?: Maybe; + /** The type of page that's associated with the URL. */ + targetType: DiscountShareableUrlTargetType; + /** The title of the page that's associated with the URL. */ + title: Scalars["String"]["output"]; + /** The URL for the discount code. */ + url: Scalars["URL"]["output"]; +}; + +/** The type of page where a shareable discount URL lands. */ +export type DiscountShareableUrlTargetType = + /** The URL lands on a collection page. */ + | "COLLECTION" + /** The URL lands on a home page. */ + | "HOME" + /** The URL lands on a product page. */ + | "PRODUCT"; + +/** The type used to target the eligible countries of an order's shipping destination for which the discount applies. For example, the discount might be applicable when shipping to all countries, or only to a set of countries. */ +export type DiscountShippingDestinationSelection = + | DiscountCountries + | DiscountCountryAll; + +/** The input fields for the destinations where the free shipping discount will be applied. */ +export type DiscountShippingDestinationSelectionInput = { + /** Whether the discount code applies to all countries. */ + all?: InputMaybe; + /** A list of countries where the discount code will apply. */ + countries?: InputMaybe; +}; + +/** The set of valid sort keys for the Discount query. */ +export type DiscountSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `ends_at` value. */ + | "ENDS_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `starts_at` value. */ + | "STARTS_AT" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The status of the discount. */ +export type DiscountStatus = + /** The discount is active. */ + | "ACTIVE" + /** The discount is expired. */ + | "EXPIRED" + /** The discount is scheduled. */ + | "SCHEDULED"; + +/** The type of line (line item or shipping line) on an order that the subscription discount is applicable towards. */ +export type DiscountTargetType = + /** The discount applies onto line items. */ + | "LINE_ITEM" + /** The discount applies onto shipping lines. */ + | "SHIPPING_LINE"; + +/** The type of the subscription discount. */ +export type DiscountType = + /** Code discount type. */ + | "CODE_DISCOUNT" + /** Manual discount type. */ + | "MANUAL"; + +/** An error that occurs during the execution of a discount mutation. */ +export type DiscountUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** Extra information about this error. */ + extraInfo?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Represents an error in the input of a mutation. */ +export type DisplayableError = { + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Return type for `disputeEvidenceUpdate` mutation. */ +export type DisputeEvidenceUpdatePayload = { + /** The updated dispute evidence. */ + disputeEvidence?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `DisputeEvidenceUpdate`. */ +export type DisputeEvidenceUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `DisputeEvidenceUpdateUserError`. */ +export type DisputeEvidenceUpdateUserErrorCode = + /** Dispute evidence could not be found. */ + | "DISPUTE_EVIDENCE_NOT_FOUND" + /** Evidence already accepted. */ + | "EVIDENCE_ALREADY_ACCEPTED" + /** Evidence past due date. */ + | "EVIDENCE_PAST_DUE_DATE" + /** Combined files size is too large. */ + | "FILES_SIZE_EXCEEDED_LIMIT" + /** The input value is invalid. */ + | "INVALID" + /** Individual file size is too large. */ + | "TOO_LARGE"; + +/** The possible statuses of a dispute. */ +export type DisputeStatus = + | "ACCEPTED" + | "CHARGE_REFUNDED" + | "LOST" + | "NEEDS_RESPONSE" + | "UNDER_REVIEW" + | "WON"; + +/** The possible types for a dispute. */ +export type DisputeType = + /** The dispute has turned into a chargeback. */ + | "CHARGEBACK" + /** The dispute is in the inquiry phase. */ + | "INQUIRY"; + +/** A unique string that represents the address of a Shopify store on the Internet. */ +export type Domain = Node & { + /** The host name of the domain. For example, `example.com`. */ + host: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The localization of the domain, if the domain doesn't redirect. */ + localization?: Maybe; + /** The web presence of the domain. */ + marketWebPresence?: Maybe; + /** Whether SSL is enabled. */ + sslEnabled: Scalars["Boolean"]["output"]; + /** The URL of the domain (for example, `https://example.com`). */ + url: Scalars["URL"]["output"]; +}; + +/** The country and language settings assigned to a domain. */ +export type DomainLocalization = { + /** The ISO codes for the domain’s alternate locales. For example, `["en"]`. */ + alternateLocales: Array; + /** The ISO code for the country assigned to the domain. For example, `"CA"` or "*" for a domain set to "Rest of world". */ + country?: Maybe; + /** The ISO code for the domain’s default locale. For example, `"en"`. */ + defaultLocale: Scalars["String"]["output"]; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrder = + & CommentEventSubject + & HasEvents + & HasLocalizationExtensions + & HasMetafields + & LegacyInteroperability + & Navigable + & Node + & { + /** The order-level discount applied to the draft order. */ + appliedDiscount?: Maybe; + /** + * The billing address of the customer. + */ + billingAddress?: Maybe; + /** Whether the billing address matches the shipping address. */ + billingAddressMatchesShippingAddress: Scalars["Boolean"]["output"]; + /** + * The date and time when the draft order converted to a new order, + * and the draft order's status changed to **Completed**. + */ + completedAt?: Maybe; + /** The date and time when the draft order was created in Shopify. */ + createdAt: Scalars["DateTime"]["output"]; + /** + * The three letter code for the currency of the store at the time of the most recent update to the draft order. + */ + currencyCode: CurrencyCode; + /** + * The custom information added to the draft order on behalf of the customer. + */ + customAttributes: Array; + /** The customer who will be sent an invoice for the draft order, if there is one. */ + customer?: Maybe; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** The email address of the customer, which is used to send notifications. */ + email?: Maybe; + /** The list of events associated with the draft order. */ + events: EventConnection; + /** Whether the merchant has added timeline comments to the draft order. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The subject defined for the draft invoice email template. */ + invoiceEmailTemplateSubject: Scalars["String"]["output"]; + /** The date and time when the invoice was last emailed to the customer. */ + invoiceSentAt?: Maybe; + /** The link to the checkout, which is sent to the customer in the invoice email. */ + invoiceUrl?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The list of the line items in the draft order. */ + lineItems: DraftOrderLineItemConnection; + /** The subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts. */ + lineItemsSubtotalPrice: MoneyBag; + /** List of localization extensions for the resource. */ + localizationExtensions: LocalizationExtensionConnection; + /** The name of the selected market. */ + marketName: Scalars["String"]["output"]; + /** The selected market region country code for the draft order. */ + marketRegionCountryCode: CountryCode; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * The identifier for the draft order, which is unique within the store. For example, _#D1223_. + */ + name: Scalars["String"]["output"]; + /** The text from an optional note attached to the draft order. */ + note2?: Maybe; + /** The order that was created from this draft order. */ + order?: Maybe; + /** The associated payment terms for this draft order. */ + paymentTerms?: Maybe; + /** The phone number assigned to the draft order. */ + phone?: Maybe; + /** The purchase order number. */ + poNumber?: Maybe; + /** The payment currency of the customer for this draft order. */ + presentmentCurrencyCode: CurrencyCode; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The purchasing entity for the draft order. */ + purchasingEntity?: Maybe; + /** + * Whether the Draft Order is ready and can be completed. Draft Orders + * might have asynchronous operations that can take time to finish. + */ + ready: Scalars["Boolean"]["output"]; + /** The time after which inventory will automatically be restocked. */ + reserveInventoryUntil?: Maybe; + /** The shipping address of the customer. */ + shippingAddress?: Maybe; + /** The line item that contains the shipping costs. */ + shippingLine?: Maybe; + /** Status of the draft order. */ + status: DraftOrderStatus; + /** + * The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. + */ + subtotalPrice: Scalars["Money"]["output"]; + /** A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes. */ + subtotalPriceSet: MoneyBag; + /** + * A comma separated list of tags associated with the draft order. Updating `tags` overwrites + * any existing tags that were previously added to the draft order. To add new tags without overwriting + * existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) + * mutation. + */ + tags: Array; + /** Whether the draft order is tax exempt. */ + taxExempt: Scalars["Boolean"]["output"]; + /** Total amount of taxes charged for each line item and shipping line. */ + taxLines: Array; + /** Whether the line item prices include taxes. */ + taxesIncluded: Scalars["Boolean"]["output"]; + /** The total discounts for this draft order. */ + totalDiscountsSet: MoneyBag; + /** The total price of line items for this draft order. */ + totalLineItemsPriceSet: MoneyBag; + /** The total amount of the draft order, including taxes, shipping charges, and discounts. */ + totalPrice: Scalars["Money"]["output"]; + /** The total amount of the draft order including taxes, shipping charges, and discounts. */ + totalPriceSet: MoneyBag; + /** The total shipping charge for the draft order. */ + totalShippingPrice: Scalars["Money"]["output"]; + /** The total shipping charge for the draft order. */ + totalShippingPriceSet: MoneyBag; + /** The total amount of taxes for the draft order. */ + totalTax: Scalars["Money"]["output"]; + /** The total amount of taxes for the draft order. */ + totalTaxSet: MoneyBag; + /** The total weight in grams of the draft order. */ + totalWeight: Scalars["UnsignedInt64"]["output"]; + /** + * The date and time when the draft order was last changed. + * The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** Whether the draft order will be visible to the customer on the self-serve portal. */ + visibleToCustomer: Scalars["Boolean"]["output"]; + }; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderLocalizationExtensionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + countryCodes?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + purposes?: InputMaybe>; + reverse?: InputMaybe; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks: + * + * - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. + * - Send invoices to customers to pay with a secure checkout link. + * - Use custom items to represent additional costs or products that aren't displayed in a shop's inventory. + * - Re-create orders manually from active sales channels. + * - Sell products at discount or wholesale rates. + * - Take pre-orders. + * - Save an order as a draft and resume working on it later. + * + * For Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type DraftOrderPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The order-level discount applied to a draft order. */ +export type DraftOrderAppliedDiscount = { + /** + * Amount of the order-level discount that's applied to the draft order. + * @deprecated Use `amountV2` instead. + */ + amount: Scalars["Money"]["output"]; + /** The amount of money discounted, with values shown in both shop currency and presentment currency. */ + amountSet: MoneyBag; + /** Amount of money discounted. */ + amountV2: MoneyV2; + /** Description of the order-level discount. */ + description: Scalars["String"]["output"]; + /** Name of the order-level discount. */ + title?: Maybe; + /** + * The order level discount amount. If `valueType` is `"percentage"`, + * then `value` is the percentage discount. + */ + value: Scalars["Float"]["output"]; + /** Type of the order-level discount. */ + valueType: DraftOrderAppliedDiscountType; +}; + +/** The input fields for applying an order-level discount to a draft order. */ +export type DraftOrderAppliedDiscountInput = { + /** + * The applied amount of the discount. + * If the type of the discount is fixed amount, then this is the fixed dollar amount. + * If the type is percentage, then this is the subtotal multiplied by the percentage. + */ + amount?: InputMaybe; + /** + * Reason for the discount. + */ + description?: InputMaybe; + /** + * Title of the discount. + */ + title?: InputMaybe; + /** + * The value of the discount. + * If the type of the discount is fixed amount, then this is a fixed dollar amount. + * If the type is percentage, then this is the percentage. + */ + value: Scalars["Float"]["input"]; + /** + * The type of discount. + */ + valueType: DraftOrderAppliedDiscountType; +}; + +/** The valid discount types that can be applied to a draft order. */ +export type DraftOrderAppliedDiscountType = + /** A fixed amount in the store's currency. */ + | "FIXED_AMOUNT" + /** A percentage of the order subtotal. */ + | "PERCENTAGE"; + +/** Return type for `draftOrderBulkAddTags` mutation. */ +export type DraftOrderBulkAddTagsPayload = { + /** The asynchronous job for adding tags to the draft orders. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderBulkDelete` mutation. */ +export type DraftOrderBulkDeletePayload = { + /** The asynchronous job for deleting the draft orders. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderBulkRemoveTags` mutation. */ +export type DraftOrderBulkRemoveTagsPayload = { + /** The asynchronous job for removing tags from the draft orders. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderCalculate` mutation. */ +export type DraftOrderCalculatePayload = { + /** The calculated properties for a draft order. */ + calculatedDraftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderComplete` mutation. */ +export type DraftOrderCompletePayload = { + /** The completed draft order. */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple DraftOrders. + */ +export type DraftOrderConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DraftOrderEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `draftOrderCreateFromOrder` mutation. */ +export type DraftOrderCreateFromOrderPayload = { + /** The created Draft Order. */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderCreateMerchantCheckout` mutation. */ +export type DraftOrderCreateMerchantCheckoutPayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderCreate` mutation. */ +export type DraftOrderCreatePayload = { + /** + * The created draft order. + */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to specify the draft order to delete by its ID. */ +export type DraftOrderDeleteInput = { + /** + * The ID of the draft order to delete. + */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `draftOrderDelete` mutation. */ +export type DraftOrderDeletePayload = { + /** + * The ID of the deleted draft order. + */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderDuplicate` mutation. */ +export type DraftOrderDuplicatePayload = { + /** The newly duplicated draft order. */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one DraftOrder and a cursor during pagination. + */ +export type DraftOrderEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DraftOrderEdge. */ + node: DraftOrder; +}; + +/** The input fields used to create or update a draft order. */ +export type DraftOrderInput = { + /** + * The discount that will be applied to the draft order. + * A draft order line item can have one discount. A draft order can also have one order-level discount. + */ + appliedDiscount?: InputMaybe; + /** + * The mailing address associated with the payment method. + */ + billingAddress?: InputMaybe; + /** + * Extra information added to the customer. + */ + customAttributes?: InputMaybe>; + /** + * The customer's email address. + */ + email?: InputMaybe; + /** + * Product variant line item or custom line item associated to the draft order. + * Each draft order must include at least one line item. + */ + lineItems?: InputMaybe>; + /** The localization extensions attached to the draft order. For example, Tax IDs. */ + localizationExtensions?: InputMaybe>; + /** The selected market region country code for the draft order. */ + marketRegionCountryCode?: InputMaybe; + /** + * Metafields attached to the draft order. + */ + metafields?: InputMaybe>; + /** + * The text of an optional note that a shop owner can attach to the draft order. + */ + note?: InputMaybe; + /** The fields used to create payment terms. */ + paymentTerms?: InputMaybe; + /** The customer's phone number. */ + phone?: InputMaybe; + /** The purchase order number. */ + poNumber?: InputMaybe; + /** The payment currency of the customer for this draft order. */ + presentmentCurrencyCode?: InputMaybe; + /** The purchasing entity for this draft order. */ + purchasingEntity?: InputMaybe; + /** Time after which inventory will automatically be restocked. */ + reserveInventoryUntil?: InputMaybe; + /** + * The mailing address to where the order will be shipped. + */ + shippingAddress?: InputMaybe; + /** + * A shipping line object, which details the shipping method used. + */ + shippingLine?: InputMaybe; + /** + * The source of the checkout. + * To use this field for sales attribution, you must register the channels that your app is managing. + * You can register the channels that your app is managing by completing + * [this Google Form](https://docs.google.com/forms/d/e/1FAIpQLScmVTZRQNjOJ7RD738mL1lGeFjqKVe_FM2tO9xsm21QEo5Ozg/viewform?usp=sf_link). + * After you've submitted your request, you need to wait for your request to be processed by Shopify. + * You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension. + * You need to specify the handle as the `source_name` value in your request. + * The handle is the channel that the order was placed from. + */ + sourceName?: InputMaybe; + /** + * A comma separated list of tags that have been added to the draft order. + */ + tags?: InputMaybe>; + /** + * Whether or not taxes are exempt for the draft order. + * If false, then Shopify will refer to the taxable field for each line item. + * If a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead. + */ + taxExempt?: InputMaybe; + /** + * Sent as part of a draft order object to load customer shipping information. + */ + useCustomerDefaultAddress?: InputMaybe; + /** Whether the draft order will be visible to the customer on the self-serve portal. */ + visibleToCustomer?: InputMaybe; +}; + +/** Return type for `draftOrderInvoicePreview` mutation. */ +export type DraftOrderInvoicePreviewPayload = { + /** The draft order invoice email rendered as HTML to allow previewing. */ + previewHtml?: Maybe; + /** The subject preview for the draft order invoice email. */ + previewSubject?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `draftOrderInvoiceSend` mutation. */ +export type DraftOrderInvoiceSendPayload = { + /** The draft order an invoice email is sent for. */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A line item included in a draft order. */ +export type DraftOrderLineItem = Node & { + /** + * The discount that will be applied to the line item or the overall order. + */ + appliedDiscount?: Maybe; + /** + * Whether the line item is a custom line item (`true`) or a product variant line item (`false`). + */ + custom: Scalars["Boolean"]["output"]; + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** Additional information (metafields) about the line item with the associated types. */ + customAttributesV2: Array; + /** + * The line item price after discounts are applied. + */ + discountedTotal: Scalars["Money"]["output"]; + /** The line item price after discounts are applied. */ + discountedTotalSet: MoneyBag; + /** + * The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit. + */ + discountedUnitPrice: Scalars["Money"]["output"]; + /** The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit. */ + discountedUnitPriceSet: MoneyBag; + /** + * Name of the service provider who fulfilled the order. + * + * Valid values are either **manual** or the name of the provider. + * For example, **amazon**, **shipwire**. + * + * Deleted fulfillment services will return null. + */ + fulfillmentService?: Maybe; + /** + * The weight of the line item in grams. The weight can only be specified if the line item is a custom + * line item. + * + * @deprecated Use `weight` instead. + */ + grams?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated with the draft order line item. */ + image?: Maybe; + /** Whether the line item is a gift card. */ + isGiftCard: Scalars["Boolean"]["output"]; + /** The name of the product. */ + name: Scalars["String"]["output"]; + /** + * The total price (without discounts) of the line item, based on the original unit price of the variant x quantity. + */ + originalTotal: Scalars["Money"]["output"]; + /** The total price (without discounts) of the line item,based on the original unit price of the variant x quantity. */ + originalTotalSet: MoneyBag; + /** The variant price without any discounts applied. */ + originalUnitPrice: Scalars["Money"]["output"]; + /** The variant price without any discounts applied. */ + originalUnitPriceSet: MoneyBag; + /** + * The product corresponding to the line item’s product variant. + */ + product?: Maybe; + /** The number of product variants that are requested in the draft order. */ + quantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** The SKU number of the product variant. */ + sku?: Maybe; + /** + * A list of tax line objects, each of which details the total taxes applicable to the order. + */ + taxLines: Array; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product or variant. This field only applies to custom line items. */ + title: Scalars["String"]["output"]; + /** + * The total value of the discount that's applied to the line item. + */ + totalDiscount: Scalars["Money"]["output"]; + /** The total value of the discount that's applied to the line item. */ + totalDiscountSet: MoneyBag; + /** + * The associated variant for the line item. + */ + variant?: Maybe; + /** The name of the variant. */ + variantTitle?: Maybe; + /** The name of the vendor who created the product variant. */ + vendor?: Maybe; + /** The weight unit and value for a draft order line item. */ + weight?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple DraftOrderLineItems. + */ +export type DraftOrderLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DraftOrderLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination. + */ +export type DraftOrderLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of DraftOrderLineItemEdge. */ + node: DraftOrderLineItem; +}; + +/** The input fields used to create a line item for a draft order. */ +export type DraftOrderLineItemInput = { + /** + * Discount which will be applied to the line item. + */ + appliedDiscount?: InputMaybe; + /** + * Represents a generic custom attribute using a key value pair. + */ + customAttributes?: InputMaybe>; + /** The price without any discounts applied. This value is ignored when `variantId` is provided. */ + originalUnitPrice?: InputMaybe; + /** + * The number of products that were purchased. + */ + quantity: Scalars["Int"]["input"]; + /** + * Whether physical shipping is required. This value is ignored when `variantId` is provided. + */ + requiresShipping?: InputMaybe; + /** The SKU number of the item. This value is ignored when `variantId` is provided. */ + sku?: InputMaybe; + /** Whether the item is taxable. This value is ignored when `variantId` is provided. */ + taxable?: InputMaybe; + /** Title of the item. Ignored when `variantId` is provided. */ + title?: InputMaybe; + /** + * The ID of the product variant corresponding to the line item. + * Null if custom line item. Required if product variant line item. + */ + variantId?: InputMaybe; + /** + * Specifies the weight unit and value inputs. + * This value is ignored when `variantId` is provided. + */ + weight?: InputMaybe; +}; + +/** The set of valid sort keys for the DraftOrder query. */ +export type DraftOrderSortKeys = + /** Sort by the `customer_name` value. */ + | "CUSTOMER_NAME" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `number` value. */ + | "NUMBER" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `status` value. */ + | "STATUS" + /** Sort by the `total_price` value. */ + | "TOTAL_PRICE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The valid statuses for a draft order. */ +export type DraftOrderStatus = + /** The draft order has been paid. */ + | "COMPLETED" + /** An invoice for the draft order has been sent to the customer. */ + | "INVOICE_SENT" + /** The draft order is open. It has not been paid, and an invoice hasn't been sent. */ + | "OPEN"; + +/** Represents a draft order tag. */ +export type DraftOrderTag = Node & { + /** Handle of draft order tag. */ + handle: Scalars["String"]["output"]; + /** ID of draft order tag. */ + id: Scalars["ID"]["output"]; + /** Title of draft order tag. */ + title: Scalars["String"]["output"]; +}; + +/** Return type for `draftOrderUpdate` mutation. */ +export type DraftOrderUpdatePayload = { + /** The updated draft order. */ + draftOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The duty details for a line item. */ +export type Duty = Node & { + /** The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty. */ + countryCodeOfOrigin?: Maybe; + /** The harmonized system code of the item used in calculating the duty. */ + harmonizedSystemCode?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The amount of the duty. */ + price: MoneyBag; + /** A list of taxes charged on the duty. */ + taxLines: Array; +}; + +/** A sale associated with a duty charge. */ +export type DutySale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The duty for the associated sale. */ + duty: Duty; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** The attribute editable information. */ +export type EditableProperty = { + /** Whether the attribute is locked for editing. */ + locked: Scalars["Boolean"]["output"]; + /** The reason the attribute is locked for editing. */ + reason?: Maybe; +}; + +/** The input fields for an email. */ +export type EmailInput = { + /** Specifies any bcc recipients for the email. */ + bcc?: InputMaybe>; + /** Specifies the email body. */ + body?: InputMaybe; + /** Specifies a custom message to include in the email. */ + customMessage?: InputMaybe; + /** Specifies the email sender. */ + from?: InputMaybe; + /** Specifies the email subject. */ + subject?: InputMaybe; + /** Specifies the email recipient. */ + to?: InputMaybe; +}; + +/** Error position information in a ShopifyQL parsing error. */ +export type ErrorPosition = { + /** The character position of the error in the line. */ + character: Scalars["Int"]["output"]; + /** The line number of the error. */ + line: Scalars["Int"]["output"]; +}; + +/** An error that occurs during the execution of a server pixel mutation. */ +export type ErrorsServerPixelUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ErrorsServerPixelUserError`. */ +export type ErrorsServerPixelUserErrorCode = + /** A server pixel already exists for this app and shop. Only one server pixel can exist for any app and shop combination. */ + | "ALREADY_EXISTS" + /** Server Pixel must be configured with a valid AWS Event Bridge or GCP pub/sub endpoint address to be connected. */ + | "NEEDS_CONFIGURATION_TO_CONNECT" + /** A server pixel doesn't exist for this app and shop. */ + | "NOT_FOUND" + /** PubSubProject and PubSubTopic values resulted in an address that is not a valid GCP pub/sub format.Address format should be pubsub://project:topic. */ + | "PUB_SUB_ERROR"; + +/** An error that occurs during the execution of a web pixel mutation. */ +export type ErrorsWebPixelUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ErrorsWebPixelUserError`. */ +export type ErrorsWebPixelUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The provided settings ID does not match the expected settings definition on the app. */ + | "INVALID_SETTINGS" + /** The record with the ID used as the input value couldn't be found. */ + | "NOT_FOUND" + /** The input value is already taken. */ + | "TAKEN" + /** An error occurred and the web pixel couldnt be deleted. */ + | "UNABLE_TO_DELETE"; + +/** + * Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the + * addition of a product. + */ +export type Event = { + /** The name of the app that created the event. */ + appTitle?: Maybe; + /** Whether the event was created by an app. */ + attributeToApp: Scalars["Boolean"]["output"]; + /** Whether the event was caused by an admin user. */ + attributeToUser: Scalars["Boolean"]["output"]; + /** The date and time when the event was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Whether the event is critical. */ + criticalAlert: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Human readable text that describes the event. */ + message: Scalars["FormattedString"]["output"]; +}; + +/** Return type for `eventBridgeServerPixelUpdate` mutation. */ +export type EventBridgeServerPixelUpdatePayload = { + /** The server pixel as configured by the mutation. */ + serverPixel?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `eventBridgeWebhookSubscriptionCreate` mutation. */ +export type EventBridgeWebhookSubscriptionCreatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was created. */ + webhookSubscription?: Maybe; +}; + +/** + * The input fields for an EventBridge webhook subscription. + */ +export type EventBridgeWebhookSubscriptionInput = { + /** The ARN of the EventBridge partner event source. */ + arn?: InputMaybe; + /** The format in which the webhook subscription should send the data. */ + format?: InputMaybe; + /** The list of fields to be included in the webhook subscription. */ + includeFields?: InputMaybe>; + /** The list of namespaces for any metafields that should be included in the webhook subscription. */ + metafieldNamespaces?: InputMaybe>; +}; + +/** Return type for `eventBridgeWebhookSubscriptionUpdate` mutation. */ +export type EventBridgeWebhookSubscriptionUpdatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was updated. */ + webhookSubscription?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple Events. + */ +export type EventConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in EventEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Event and a cursor during pagination. + */ +export type EventEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of EventEdge. */ + node: Event; +}; + +/** The set of valid sort keys for the Event query. */ +export type EventSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** An exchange where existing items on an order are returned and new items are added to the order. */ +export type ExchangeV2 = Node & { + /** The details of the new items in the exchange. */ + additions: ExchangeV2Additions; + /** The date and time when the exchange was completed. */ + completedAt?: Maybe; + /** The date and time when the exchange was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The location where the exchange happened. */ + location?: Maybe; + /** The text of an optional note that a shop owner can attach to the exchange. */ + note?: Maybe; + /** The refunds processed during the exchange. */ + refunds: Array; + /** The details of the returned items in the exchange. */ + returns: ExchangeV2Returns; + /** The staff member associated with the exchange. */ + staffMember?: Maybe; + /** The amount of money that was paid or refunded as part of the exchange. */ + totalAmountProcessedSet: MoneyBag; + /** The difference in values of the items that were exchanged. */ + totalPriceSet: MoneyBag; + /** The order transactions related to the exchange. */ + transactions: Array; +}; + +/** New items associated to the exchange. */ +export type ExchangeV2Additions = { + /** The list of new items for the exchange. */ + lineItems: Array; + /** The subtotal of the items being added, including discounts. */ + subtotalPriceSet: MoneyBag; + /** The summary of all taxes of the items being added. */ + taxLines: Array; + /** The total price of the items being added, including discounts and taxes. */ + totalPriceSet: MoneyBag; +}; + +/** + * An auto-generated type for paginating through multiple ExchangeV2s. + */ +export type ExchangeV2Connection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ExchangeV2Edge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ExchangeV2 and a cursor during pagination. + */ +export type ExchangeV2Edge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ExchangeV2Edge. */ + node: ExchangeV2; +}; + +/** Contains information about an item in the exchange. */ +export type ExchangeV2LineItem = { + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** The total line price, in shop and presentment currencies, after discounts are applied. */ + discountedTotalSet: MoneyBag; + /** + * The price, in shop and presentment currencies, + * of a single variant unit after line item discounts are applied. + */ + discountedUnitPriceSet: MoneyBag; + /** + * Name of the service provider who fulfilled the order. + * + * Valid values are either **manual** or the name of the provider. + * For example, **amazon**, **shipwire**. + * + * Deleted fulfillment services will return null. + */ + fulfillmentService?: Maybe; + /** Indiciates if this line item is a gift card. */ + giftCard: Scalars["Boolean"]["output"]; + /** The gift cards associated with the line item. */ + giftCards: Array; + /** The line item associated with this object. */ + lineItem?: Maybe; + /** The name of the product. */ + name: Scalars["String"]["output"]; + /** The total price, in shop and presentment currencies, before discounts are applied. */ + originalTotalSet: MoneyBag; + /** + * The price, in shop and presentment currencies, + * of a single variant unit before line item discounts are applied. + */ + originalUnitPriceSet: MoneyBag; + /** The number of products that were purchased. */ + quantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** The SKU number of the product variant. */ + sku?: Maybe; + /** The TaxLine object connected to this line item. */ + taxLines: Array; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product or variant. This field only applies to custom line items. */ + title: Scalars["String"]["output"]; + /** The product variant of the line item. */ + variant?: Maybe; + /** The name of the variant. */ + variantTitle?: Maybe; + /** The name of the vendor who created the product variant. */ + vendor?: Maybe; +}; + +/** Return items associated to the exchange. */ +export type ExchangeV2Returns = { + /** The list of return items for the exchange. */ + lineItems: Array; + /** + * The amount of the order-level discount for the items and shipping being returned, which doesn't contain any line item discounts. + */ + orderDiscountAmountSet: MoneyBag; + /** The amount of money to be refunded for shipping. */ + shippingRefundAmountSet: MoneyBag; + /** The subtotal of the items being returned. */ + subtotalPriceSet: MoneyBag; + /** The summary of all taxes of the items being returned. */ + taxLines: Array; + /** The amount of money to be refunded for tip. */ + tipRefundAmountSet: MoneyBag; + /** The total value of the items being returned. */ + totalPriceSet: MoneyBag; +}; + +/** + * Represents a video hosted outside of Shopify. + */ +export type ExternalVideo = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** The embed URL of the video for the respective host. */ + embedUrl: Scalars["URL"]["output"]; + /** + * The URL. + * @deprecated Use `originUrl` instead. + */ + embeddedUrl: Scalars["URL"]["output"]; + /** The host of the external video. */ + host: MediaHost; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The media content type. */ + mediaContentType: MediaContentType; + /** Any errors which have occurred on the media. */ + mediaErrors: Array; + /** The warnings attached to the media. */ + mediaWarnings: Array; + /** The origin URL of the video on the respective host. */ + originUrl: Scalars["URL"]["output"]; + /** The preview image for the media. */ + preview?: Maybe; + /** Current status of the media. */ + status: MediaStatus; +}; + +/** Requirements that must be met before an app can be installed. */ +export type FailedRequirement = { + /** Action to be taken to resolve a failed requirement, including URL link. */ + action?: Maybe; + /** + * A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app + * encounters when trying to make use of their Shop and its resources. + */ + message: Scalars["String"]["output"]; +}; + +/** A file interface. */ +export type File = { + /** A word or phrase to describe the contents or the function of a file. */ + alt?: Maybe; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** Any errors that have occurred on the file. */ + fileErrors: Array; + /** The status of the file. */ + fileStatus: FileStatus; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The preview image for the media. */ + preview?: Maybe; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** Return type for `fileAcknowledgeUpdateFailed` mutation. */ +export type FileAcknowledgeUpdateFailedPayload = { + /** The updated file(s). */ + files?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Files. + */ +export type FileConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FileEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The possible content types for a file object. */ +export type FileContentType = + /** A Shopify-hosted generic file. */ + | "FILE" + /** A Shopify-hosted image. */ + | "IMAGE" + /** A Shopify-hosted video file. It's recommended to use this type for all video files. */ + | "VIDEO"; + +/** The input fields that are required to create a file object. */ +export type FileCreateInput = { + /** The alternative text description of the file. */ + alt?: InputMaybe; + /** The file content type. If omitted, then Shopify will attempt to determine the content type during file processing. */ + contentType?: InputMaybe; + /** How to handle if filename is already in use. */ + duplicateResolutionMode?: InputMaybe; + /** + * When provided, the file will be created with the given filename, + * otherwise the filename in the originalSource will be used. + */ + filename?: InputMaybe; + /** + * An external URL (for images only) or a + * [staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate). + */ + originalSource: Scalars["String"]["input"]; +}; + +/** The input fields for handling if filename is already in use. */ +export type FileCreateInputDuplicateResolutionMode = + /** Append a UUID if filename is already in use. */ + | "APPEND_UUID" + /** Raise an error if filename is already in use. */ + | "RAISE_ERROR" + /** Replace the existing file if filename is already in use. */ + | "REPLACE"; + +/** Return type for `fileCreate` mutation. */ +export type FileCreatePayload = { + /** The newly created files. */ + files?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fileDelete` mutation. */ +export type FileDeletePayload = { + /** The IDs of the deleted files. */ + deletedFileIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one File and a cursor during pagination. + */ +export type FileEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FileEdge. */ + node: File; +}; + +/** + * A file error. This typically occurs when there is an issue with the file itself causing it to fail validation. + * Check the file before attempting to upload again. + */ +export type FileError = { + /** Code representing the type of error. */ + code: FileErrorCode; + /** Additional details regarding the error. */ + details?: Maybe; + /** Translated error message. */ + message: Scalars["String"]["output"]; +}; + +/** The error types for a file. */ +export type FileErrorCode = + /** File could not be created because a file with the same name already exists. */ + | "DUPLICATE_FILENAME_ERROR" + /** File could not be created because embed permissions are disabled for this video. */ + | "EXTERNAL_VIDEO_EMBED_DISABLED" + /** File could not be created because video is either not found or still transcoding. */ + | "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING" + /** File could not be created because the external video has an invalid aspect ratio. */ + | "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO" + /** File could not be created because the external video could not be found. */ + | "EXTERNAL_VIDEO_NOT_FOUND" + /** File could not be created because the external video is not listed or is private. */ + | "EXTERNAL_VIDEO_UNLISTED" + /** File could not be created because the cumulative file storage limit would be exceeded. */ + | "FILE_STORAGE_LIMIT_EXCEEDED" + /** File could not be processed because the source could not be downloaded. */ + | "GENERIC_FILE_DOWNLOAD_FAILURE" + /** File could not be created because the size is too large. */ + | "GENERIC_FILE_INVALID_SIZE" + /** File could not be processed because the image could not be downloaded. */ + | "IMAGE_DOWNLOAD_FAILURE" + /** File could not be processed because the image could not be processed. */ + | "IMAGE_PROCESSING_FAILURE" + /** File could not be created because the image has an invalid aspect ratio. */ + | "INVALID_IMAGE_ASPECT_RATIO" + /** File could not be created because the image size is too large. */ + | "INVALID_IMAGE_FILE_SIZE" + /** File could not be created because the image's resolution exceeds the max limit. */ + | "INVALID_IMAGE_RESOLUTION" + /** File could not be processed because the signed URL was invalid. */ + | "INVALID_SIGNED_URL" + /** File timed out because it is currently being modified by another operation. */ + | "MEDIA_TIMEOUT_ERROR" + /** File could not be created because the model file failed processing. */ + | "MODEL3D_GLB_OUTPUT_CREATION_ERROR" + /** File could not be created because the model can't be converted to USDZ format. */ + | "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR" + /** File could not be created because the model file failed processing. */ + | "MODEL3D_PROCESSING_FAILURE" + /** File could not be created because the model's thumbnail generation failed. */ + | "MODEL3D_THUMBNAIL_GENERATION_ERROR" + /** There was an issue while trying to generate a new thumbnail. */ + | "MODEL3D_THUMBNAIL_REGENERATION_ERROR" + /** Model failed validation. */ + | "MODEL3D_VALIDATION_ERROR" + /** File error has occurred for an unknown reason. */ + | "UNKNOWN" + /** File could not be created because the image is an unsupported file type. */ + | "UNSUPPORTED_IMAGE_FILE_TYPE" + /** File could not be created because it has an invalid file type. */ + | "VIDEO_INVALID_FILETYPE_ERROR" + /** File could not be created because it does not meet the maximum duration requirement. */ + | "VIDEO_MAX_DURATION_ERROR" + /** File could not be created because it does not meet the maximum height requirement. */ + | "VIDEO_MAX_HEIGHT_ERROR" + /** File could not be created because it does not meet the maximum width requirement. */ + | "VIDEO_MAX_WIDTH_ERROR" + /** File could not be created because the metadata could not be read. */ + | "VIDEO_METADATA_READ_ERROR" + /** File could not be created because it does not meet the minimum duration requirement. */ + | "VIDEO_MIN_DURATION_ERROR" + /** File could not be created because it does not meet the minimum height requirement. */ + | "VIDEO_MIN_HEIGHT_ERROR" + /** File could not be created because it does not meet the minimum width requirement. */ + | "VIDEO_MIN_WIDTH_ERROR" + /** Video failed validation. */ + | "VIDEO_VALIDATION_ERROR"; + +/** The set of valid sort keys for the File query. */ +export type FileSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `filename` value. */ + | "FILENAME" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `original_upload_size` value. */ + | "ORIGINAL_UPLOAD_SIZE" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The possible statuses for a file object. */ +export type FileStatus = + /** File processing has failed. */ + | "FAILED" + /** File is being processed. */ + | "PROCESSING" + /** File is ready to be displayed. */ + | "READY" + /** File has been uploaded but hasn't been processed. */ + | "UPLOADED"; + +/** The input fields that are required to update a file object. */ +export type FileUpdateInput = { + /** The alternative text description of the file. */ + alt?: InputMaybe; + /** + * The name of the file including its extension. + */ + filename?: InputMaybe; + /** The ID of the file to be updated. */ + id: Scalars["ID"]["input"]; + /** + * The source from which to update a media image or generic file. + * An external URL (for images only) or a + * [staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate). + */ + originalSource?: InputMaybe; + /** + * The source from which to update the media preview image. + * May be an external URL or a + * [staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate). + */ + previewImageSource?: InputMaybe; +}; + +/** Return type for `fileUpdate` mutation. */ +export type FileUpdatePayload = { + /** The list of updated files. */ + files?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `FilesUserError`. */ +export type FilesErrorCode = + /** The alt value exceeds the maximum limit of 512 characters. */ + | "ALT_VALUE_LIMIT_EXCEEDED" + /** The search term must not be blank. */ + | "BLANK_SEARCH" + /** The provided filename already exists. */ + | "FILENAME_ALREADY_EXISTS" + /** File does not exist. */ + | "FILE_DOES_NOT_EXIST" + /** File has a pending operation. */ + | "FILE_LOCKED" + /** The input value is invalid. */ + | "INVALID" + /** Duplicate resolution mode is not supported for this file type. */ + | "INVALID_DUPLICATE_MODE_FOR_TYPE" + /** The provided filename is invalid. */ + | "INVALID_FILENAME" + /** Invalid filename extension. */ + | "INVALID_FILENAME_EXTENSION" + /** Invalid image source url value provided. */ + | "INVALID_IMAGE_SOURCE_URL" + /** Search query isn't supported. */ + | "INVALID_QUERY" + /** Cannot create file with custom filename which does not match original source extension. */ + | "MISMATCHED_FILENAME_AND_ORIGINAL_SOURCE" + /** At least one argument is required. */ + | "MISSING_ARGUMENTS" + /** Duplicate resolution mode REPLACE cannot be used without specifying filename. */ + | "MISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACE" + /** Exceeded the limit of non-image media per shop. */ + | "NON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDED" + /** The file is not in the READY state. */ + | "NON_READY_STATE" + /** Specify one argument: search, IDs, or deleteAll. */ + | "TOO_MANY_ARGUMENTS" + /** The file type is not supported. */ + | "UNACCEPTABLE_ASSET" + /** The file is not supported on trial accounts. Select a plan to upload this file. */ + | "UNACCEPTABLE_TRIAL_ASSET" + /** The file is not supported on trial accounts that have not validated their email. Either select a plan or verify the shop owner email to upload this file. */ + | "UNACCEPTABLE_UNVERIFIED_TRIAL_ASSET" + /** Filename update is only supported on Image and GenericFile. */ + | "UNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATE"; + +/** An error that happens during the execution of a Files API query or mutation. */ +export type FilesUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** A filter option is one possible value in a search filter. */ +export type FilterOption = { + /** The filter option's label for display purposes. */ + label: Scalars["String"]["output"]; + /** The filter option's value. */ + value: Scalars["String"]["output"]; +}; + +/** Return type for `flowTriggerReceive` mutation. */ +export type FlowTriggerReceivePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents a fulfillment. + * In Shopify, a fulfillment represents a shipment of one or more items in an order. + * When an order has been completely fulfilled, it means that all the items that are included + * in the order have been sent to the customer. + * There can be more than one fulfillment for an order. + */ +export type Fulfillment = LegacyInteroperability & Node & { + /** The date and time when the fulfillment was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The date that this fulfillment was delivered. */ + deliveredAt?: Maybe; + /** Human readable display status for this fulfillment. */ + displayStatus?: Maybe; + /** The estimated date that this fulfillment will arrive. */ + estimatedDeliveryAt?: Maybe; + /** The history of events associated with this fulfillment. */ + events: FulfillmentEventConnection; + /** List of the fulfillment's line items. */ + fulfillmentLineItems: FulfillmentLineItemConnection; + /** A paginated list of fulfillment orders for the fulfillment. */ + fulfillmentOrders: FulfillmentOrderConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The date and time when the fulfillment went into transit. */ + inTransitAt?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The location that the fulfillment was processed at. */ + location?: Maybe; + /** Human readable reference identifier for this fulfillment. */ + name: Scalars["String"]["output"]; + /** The order for which the fulfillment was created. */ + order: Order; + /** The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center. */ + originAddress?: Maybe; + /** Whether any of the line items in the fulfillment require shipping. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** Fulfillment service associated with the fulfillment. */ + service?: Maybe; + /** The status of the fulfillment. */ + status: FulfillmentStatus; + /** Sum of all line item quantities for the fulfillment. */ + totalQuantity: Scalars["Int"]["output"]; + /** + * Tracking information associated with the fulfillment, + * such as the tracking company, tracking number, and tracking URL. + */ + trackingInfo: Array; + /** + * The date and time when the fulfillment was last modified. + */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * Represents a fulfillment. + * In Shopify, a fulfillment represents a shipment of one or more items in an order. + * When an order has been completely fulfilled, it means that all the items that are included + * in the order have been sent to the customer. + * There can be more than one fulfillment for an order. + */ +export type FulfillmentEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a fulfillment. + * In Shopify, a fulfillment represents a shipment of one or more items in an order. + * When an order has been completely fulfilled, it means that all the items that are included + * in the order have been sent to the customer. + * There can be more than one fulfillment for an order. + */ +export type FulfillmentFulfillmentLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a fulfillment. + * In Shopify, a fulfillment represents a shipment of one or more items in an order. + * When an order has been completely fulfilled, it means that all the items that are included + * in the order have been sent to the customer. + * There can be more than one fulfillment for an order. + */ +export type FulfillmentFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a fulfillment. + * In Shopify, a fulfillment represents a shipment of one or more items in an order. + * When an order has been completely fulfilled, it means that all the items that are included + * in the order have been sent to the customer. + * There can be more than one fulfillment for an order. + */ +export type FulfillmentTrackingInfoArgs = { + first?: InputMaybe; +}; + +/** Return type for `fulfillmentCancel` mutation. */ +export type FulfillmentCancelPayload = { + /** The canceled fulfillment. */ + fulfillment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Fulfillments. + */ +export type FulfillmentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `fulfillmentCreateV2` mutation. */ +export type FulfillmentCreateV2Payload = { + /** The created fulfillment. */ + fulfillment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The display status of a fulfillment. */ +export type FulfillmentDisplayStatus = + /** Displayed as **Attempted delivery**. */ + | "ATTEMPTED_DELIVERY" + /** Displayed as **Canceled**. */ + | "CANCELED" + /** Displayed as **Confirmed**. */ + | "CONFIRMED" + /** Displayed as **Delivered**. */ + | "DELIVERED" + /** Displayed as **Failure**. */ + | "FAILURE" + /** Displayed as **Fulfilled**. */ + | "FULFILLED" + /** Displayed as **In transit**. */ + | "IN_TRANSIT" + /** Displayed as **Label printed**. */ + | "LABEL_PRINTED" + /** Displayed as **Label purchased**. */ + | "LABEL_PURCHASED" + /** Displayed as **Label voided**. */ + | "LABEL_VOIDED" + /** Displayed as **Marked as fulfilled**. */ + | "MARKED_AS_FULFILLED" + /** Displayed as **Not delivered**. */ + | "NOT_DELIVERED" + /** Displayed as **Out for delivery**. */ + | "OUT_FOR_DELIVERY" + /** Displayed as **Picked up**. */ + | "PICKED_UP" + /** Displayed as **Ready for pickup**. */ + | "READY_FOR_PICKUP" + /** Displayed as **Submitted**. */ + | "SUBMITTED"; + +/** + * An auto-generated type which holds one Fulfillment and a cursor during pagination. + */ +export type FulfillmentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentEdge. */ + node: Fulfillment; +}; + +/** The fulfillment event that describes the fulfilllment status at a particular time. */ +export type FulfillmentEvent = Node & { + /** The street address where this fulfillment event occurred. */ + address1?: Maybe; + /** The city where this fulfillment event occurred. */ + city?: Maybe; + /** The country where this fulfillment event occurred. */ + country?: Maybe; + /** The estimated delivery date and time of the fulfillment. */ + estimatedDeliveryAt?: Maybe; + /** The time at which this fulfillment event happened. */ + happenedAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The latitude where this fulfillment event occurred. */ + latitude?: Maybe; + /** The longitude where this fulfillment event occurred. */ + longitude?: Maybe; + /** A message associated with this fulfillment event. */ + message?: Maybe; + /** The province where this fulfillment event occurred. */ + province?: Maybe; + /** The status of this fulfillment event. */ + status: FulfillmentEventStatus; + /** The zip code of the location where this fulfillment event occurred. */ + zip?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentEvents. + */ +export type FulfillmentEventConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentEventEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `fulfillmentEventCreate` mutation. */ +export type FulfillmentEventCreatePayload = { + /** The created fulfillment event. */ + fulfillmentEvent?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one FulfillmentEvent and a cursor during pagination. + */ +export type FulfillmentEventEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentEventEdge. */ + node: FulfillmentEvent; +}; + +/** The input fields used to create a fulfillment event. */ +export type FulfillmentEventInput = { + /** The street address where this fulfillment event occurred. */ + address1?: InputMaybe; + /** The city where this fulfillment event occurred. */ + city?: InputMaybe; + /** The country where this fulfillment event occurred. */ + country?: InputMaybe; + /** The estimated delivery date and time of the fulfillment. */ + estimatedDeliveryAt?: InputMaybe; + /** The ID for the fulfillment that's associated with this fulfillment event. */ + fulfillmentId: Scalars["ID"]["input"]; + /** The time at which this fulfillment event happened. */ + happenedAt?: InputMaybe; + /** The latitude where this fulfillment event occurred. */ + latitude?: InputMaybe; + /** The longitude where this fulfillment event occurred. */ + longitude?: InputMaybe; + /** A message associated with this fulfillment event. */ + message?: InputMaybe; + /** The province where this fulfillment event occurred. */ + province?: InputMaybe; + /** The status of this fulfillment event. */ + status: FulfillmentEventStatus; + /** The zip code of the location where this fulfillment event occurred. */ + zip?: InputMaybe; +}; + +/** The set of valid sort keys for the FulfillmentEvent query. */ +export type FulfillmentEventSortKeys = + /** Sort by the `happened_at` value. */ + | "HAPPENED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The status that describes a fulfillment or delivery event. */ +export type FulfillmentEventStatus = + /** A delivery was attempted. */ + | "ATTEMPTED_DELIVERY" + /** The fulfillment is confirmed. This is the default value when no other information is available. */ + | "CONFIRMED" + /** The fulfillment was successfully delivered. */ + | "DELIVERED" + /** The fulfillment request failed. */ + | "FAILURE" + /** The fulfillment is in transit. */ + | "IN_TRANSIT" + /** A purchased shipping label has been printed. */ + | "LABEL_PRINTED" + /** A shipping label has been purchased. */ + | "LABEL_PURCHASED" + /** The fulfillment is out for delivery. */ + | "OUT_FOR_DELIVERY" + /** The fulfillment is ready to be picked up. */ + | "READY_FOR_PICKUP"; + +/** + * A fulfillment hold currently applied on a fulfillment order. + */ +export type FulfillmentHold = { + /** The name of the app or service that applied the fulfillment hold. */ + heldBy?: Maybe; + /** The reason for the fulfillment hold. */ + reason: FulfillmentHoldReason; + /** Additional information about the fulfillment hold reason. */ + reasonNotes?: Maybe; +}; + +/** The reason for a fulfillment hold. */ +export type FulfillmentHoldReason = + /** The fulfillment hold is applied because payment is pending. */ + | "AWAITING_PAYMENT" + /** The fulfillment hold is applied because of a high risk of fraud. */ + | "HIGH_RISK_OF_FRAUD" + /** The fulfillment hold is applied because of an incorrect address. */ + | "INCORRECT_ADDRESS" + /** The fulfillment hold is applied because inventory is out of stock. */ + | "INVENTORY_OUT_OF_STOCK" + /** The fulfillment hold is applied because of a post purchase upsell offer. */ + | "ONLINE_STORE_POST_PURCHASE_CROSS_SELL" + /** The fulfillment hold is applied for another reason. */ + | "OTHER" + /** The fulfillment hold is applied because of an unknown delivery date. */ + | "UNKNOWN_DELIVERY_DATE"; + +/** Represents a line item from an order that's included in a fulfillment. */ +export type FulfillmentLineItem = Node & { + /** + * The total price after discounts are applied. + * @deprecated Use `discountedTotalSet` instead. + */ + discountedTotal: Scalars["Money"]["output"]; + /** The total price after discounts are applied in shop and presentment currencies. */ + discountedTotalSet: MoneyBag; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The associated order's line item. */ + lineItem: LineItem; + /** + * The total price before discounts are applied. + * @deprecated Use `originalTotalSet` instead. + */ + originalTotal: Scalars["Money"]["output"]; + /** The total price before discounts are applied in shop and presentment currencies. */ + originalTotalSet: MoneyBag; + /** Number of line items in the fulfillment. */ + quantity?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentLineItems. + */ +export type FulfillmentLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. + */ +export type FulfillmentLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentLineItemEdge. */ + node: FulfillmentLineItem; +}; + +/** + * The FulfillmentOrder object represents either an item or a group of items in an + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * that are expected to be fulfilled from the same location. + * There can be more than one fulfillment order for an + * [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * at a given location. + * + * {{ '/api/reference/fulfillment_order_relationships.png' | image }} + * + * Fulfillment orders represent the work which is intended to be done in relation to an order. + * When fulfillment has started for one or more line items, a + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) + * is created by a merchant or third party to represent the ongoing or completed work of fulfillment. + * + * [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). + * + * > Note: + * > Shopify creates fulfillment orders automatically when an order is created. + * > It is not possible to manually create fulfillment orders. + * > + * > [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). + * + * ## Retrieving fulfillment orders + * + * ### Fulfillment orders from an order + * + * All fulfillment orders related to a given order can be retrieved with the + * [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) + * connection. + * + * [API access scopes](#api-access-scopes) + * govern which fulfillments orders are returned to clients. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * + * ### Fulfillment orders assigned to the app for fulfillment + * + * Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + * Use the `assignmentStatus` argument to control whether all assigned fulfillment orders + * should be returned or only those where a merchant has sent a + * [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) + * and it has yet to be responded to. + * + * The API client must be granted the `read_assigned_fulfillment_orders` access scope to access + * the assigned fulfillment orders. + * + * ### All fulfillment orders + * + * Apps can retrieve all fulfillment orders with the + * [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) + * query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, + * which are accessible to the app according to the + * [fulfillment order access scopes](#api-access-scopes) it was granted with. + * + * ## The lifecycle of a fulfillment order + * + * ### Fulfillment Order Creation + * + * After an order is created, a background worker performs the order routing process which determines + * which locations will be responsible for fulfilling the purchased items. + * Once the order routing process is complete, one or more fulfillment orders will be created + * and assigned to these locations. It is not possible to manually create fulfillment orders. + * + * Once a fulfillment order has been created, it will have one of two different lifecycles depending on + * the type of location which the fulfillment order is assigned to. + * + * ### The lifecycle of a fulfillment order at a merchant managed location + * + * Fulfillment orders are completed by creating + * [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). + * Fulfillments represents the work done. + * + * For digital products a merchant or an order management app would create a fulfilment once the digital asset + * has been provisioned. + * For example, in the case of a digital gift card, a merchant would to do this once + * the gift card has been activated - before the email has been shipped. + * + * On the other hand, for a traditional shipped order, + * a merchant or an order management app would create a fulfillment after picking and packing the items relating + * to a fulfillment order, but before the courier has collected the goods. + * + * [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). + * + * ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service + * + * For fulfillment orders which are assigned to a location that is managed by a fulfillment service, + * a merchant or an Order Management App can + * [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) + * to the fulfillment service which operates the location to request that they fulfill the associated items. + * A fulfillment service has the option to + * [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) + * or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) + * this fulfillment request. + * + * Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant + * or order management app and instead a + * [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) + * to the fulfillment service. + * + * Once a fulfillment service accepts a fulfillment request, + * then after they are ready to pack items and send them for delivery, they create fulfillments with the + * [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + * mutation. + * They can provide tracking information right away or create fulfillments without it and then + * update the tracking information for fulfillments with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + * mutation. + * + * [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). + * + * ## API access scopes + * + * Fulfillment orders are governed by the following API access scopes: + * + * * The `read_merchant_managed_fulfillment_orders` and + * `write_merchant_managed_fulfillment_orders` access scopes + * grant access to fulfillment orders assigned to merchant-managed locations. + * * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` + * access scopes are intended for fulfillment services. + * These scopes grant access to fulfillment orders assigned to locations that are being managed + * by fulfillment services. + * * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` + * access scopes grant access to fulfillment orders + * assigned to locations managed by other fulfillment services. + * + * ### Fulfillment service app access scopes + * + * Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope + * and don't have the `*_third_party_fulfillment_orders` + * or `*_merchant_managed_fulfillment_orders` access scopes. + * The app will only have access to the fulfillment orders assigned to their location + * (or multiple locations if the app registers multiple fulfillment services on the shop). + * The app will not have access to fulfillment orders assigned to merchant-managed locations + * or locations owned by other fulfillment service apps. + * + * ### Order management app access scopes + * + * **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and + * `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders + * on behalf of a merchant. + * + * If an app combines the functions of an order management app and a fulfillment service, + * then the app should request all + * access scopes to manage all assigned and all unassigned fulfillment orders. + * + * ## Notifications about fulfillment orders + * + * Fulfillment services are required to + * [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified + * whenever a merchant submits a fulfillment or cancellation request. + * + * Both merchants and apps can + * [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * to the + * [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) + * to be notified whenever fulfillment order related domain events occur. + * + * [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). + */ +export type FulfillmentOrder = Node & { + /** + * The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen. + * + * The fulfillment order's assigned location might change in the following cases: + * + * - The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove]( + * https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove + * ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder]( + * https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder + * ) field within the mutation's response. + * - Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the + * [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open), + * [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or + * [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold) + * status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin). + */ + assignedLocation: FulfillmentOrderAssignedLocation; + /** Date and time when the fulfillment order was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Delivery method of this fulfillment order. */ + deliveryMethod?: Maybe; + /** The destination where the items should be sent. */ + destination?: Maybe; + /** The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the `fulfill_at` date for a subscription order might be the 1st of each month, a pre-order `fulfill_at` date would be `nil`, and a standard order `fulfill_at` date would be the order creation date. */ + fulfillAt?: Maybe; + /** The latest date and time by which all items in the fulfillment order need to be fulfilled. */ + fulfillBy?: Maybe; + /** The fulfillment holds applied on the fulfillment order. */ + fulfillmentHolds: Array; + /** A list of fulfillments for the fulfillment order. */ + fulfillments: FulfillmentConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The duties delivery method of this fulfillment order. */ + internationalDuties?: Maybe; + /** A list of the fulfillment order's line items. */ + lineItems: FulfillmentOrderLineItemConnection; + /** A list of locations that the fulfillment order can potentially move to. */ + locationsForMove: FulfillmentOrderLocationForMoveConnection; + /** A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order. */ + merchantRequests: FulfillmentOrderMerchantRequestConnection; + /** The order that's associated with the fulfillment order. */ + order: Order; + /** The request status of the fulfillment order. */ + requestStatus: FulfillmentOrderRequestStatus; + /** The status of the fulfillment order. */ + status: FulfillmentOrderStatus; + /** The actions that can be performed on this fulfillment order. */ + supportedActions: Array; + /** The date and time when the fulfillment order was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * The FulfillmentOrder object represents either an item or a group of items in an + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * that are expected to be fulfilled from the same location. + * There can be more than one fulfillment order for an + * [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * at a given location. + * + * {{ '/api/reference/fulfillment_order_relationships.png' | image }} + * + * Fulfillment orders represent the work which is intended to be done in relation to an order. + * When fulfillment has started for one or more line items, a + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) + * is created by a merchant or third party to represent the ongoing or completed work of fulfillment. + * + * [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). + * + * > Note: + * > Shopify creates fulfillment orders automatically when an order is created. + * > It is not possible to manually create fulfillment orders. + * > + * > [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). + * + * ## Retrieving fulfillment orders + * + * ### Fulfillment orders from an order + * + * All fulfillment orders related to a given order can be retrieved with the + * [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) + * connection. + * + * [API access scopes](#api-access-scopes) + * govern which fulfillments orders are returned to clients. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * + * ### Fulfillment orders assigned to the app for fulfillment + * + * Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + * Use the `assignmentStatus` argument to control whether all assigned fulfillment orders + * should be returned or only those where a merchant has sent a + * [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) + * and it has yet to be responded to. + * + * The API client must be granted the `read_assigned_fulfillment_orders` access scope to access + * the assigned fulfillment orders. + * + * ### All fulfillment orders + * + * Apps can retrieve all fulfillment orders with the + * [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) + * query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, + * which are accessible to the app according to the + * [fulfillment order access scopes](#api-access-scopes) it was granted with. + * + * ## The lifecycle of a fulfillment order + * + * ### Fulfillment Order Creation + * + * After an order is created, a background worker performs the order routing process which determines + * which locations will be responsible for fulfilling the purchased items. + * Once the order routing process is complete, one or more fulfillment orders will be created + * and assigned to these locations. It is not possible to manually create fulfillment orders. + * + * Once a fulfillment order has been created, it will have one of two different lifecycles depending on + * the type of location which the fulfillment order is assigned to. + * + * ### The lifecycle of a fulfillment order at a merchant managed location + * + * Fulfillment orders are completed by creating + * [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). + * Fulfillments represents the work done. + * + * For digital products a merchant or an order management app would create a fulfilment once the digital asset + * has been provisioned. + * For example, in the case of a digital gift card, a merchant would to do this once + * the gift card has been activated - before the email has been shipped. + * + * On the other hand, for a traditional shipped order, + * a merchant or an order management app would create a fulfillment after picking and packing the items relating + * to a fulfillment order, but before the courier has collected the goods. + * + * [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). + * + * ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service + * + * For fulfillment orders which are assigned to a location that is managed by a fulfillment service, + * a merchant or an Order Management App can + * [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) + * to the fulfillment service which operates the location to request that they fulfill the associated items. + * A fulfillment service has the option to + * [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) + * or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) + * this fulfillment request. + * + * Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant + * or order management app and instead a + * [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) + * to the fulfillment service. + * + * Once a fulfillment service accepts a fulfillment request, + * then after they are ready to pack items and send them for delivery, they create fulfillments with the + * [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + * mutation. + * They can provide tracking information right away or create fulfillments without it and then + * update the tracking information for fulfillments with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + * mutation. + * + * [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). + * + * ## API access scopes + * + * Fulfillment orders are governed by the following API access scopes: + * + * * The `read_merchant_managed_fulfillment_orders` and + * `write_merchant_managed_fulfillment_orders` access scopes + * grant access to fulfillment orders assigned to merchant-managed locations. + * * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` + * access scopes are intended for fulfillment services. + * These scopes grant access to fulfillment orders assigned to locations that are being managed + * by fulfillment services. + * * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` + * access scopes grant access to fulfillment orders + * assigned to locations managed by other fulfillment services. + * + * ### Fulfillment service app access scopes + * + * Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope + * and don't have the `*_third_party_fulfillment_orders` + * or `*_merchant_managed_fulfillment_orders` access scopes. + * The app will only have access to the fulfillment orders assigned to their location + * (or multiple locations if the app registers multiple fulfillment services on the shop). + * The app will not have access to fulfillment orders assigned to merchant-managed locations + * or locations owned by other fulfillment service apps. + * + * ### Order management app access scopes + * + * **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and + * `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders + * on behalf of a merchant. + * + * If an app combines the functions of an order management app and a fulfillment service, + * then the app should request all + * access scopes to manage all assigned and all unassigned fulfillment orders. + * + * ## Notifications about fulfillment orders + * + * Fulfillment services are required to + * [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified + * whenever a merchant submits a fulfillment or cancellation request. + * + * Both merchants and apps can + * [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * to the + * [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) + * to be notified whenever fulfillment order related domain events occur. + * + * [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). + */ +export type FulfillmentOrderFulfillmentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The FulfillmentOrder object represents either an item or a group of items in an + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * that are expected to be fulfilled from the same location. + * There can be more than one fulfillment order for an + * [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * at a given location. + * + * {{ '/api/reference/fulfillment_order_relationships.png' | image }} + * + * Fulfillment orders represent the work which is intended to be done in relation to an order. + * When fulfillment has started for one or more line items, a + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) + * is created by a merchant or third party to represent the ongoing or completed work of fulfillment. + * + * [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). + * + * > Note: + * > Shopify creates fulfillment orders automatically when an order is created. + * > It is not possible to manually create fulfillment orders. + * > + * > [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). + * + * ## Retrieving fulfillment orders + * + * ### Fulfillment orders from an order + * + * All fulfillment orders related to a given order can be retrieved with the + * [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) + * connection. + * + * [API access scopes](#api-access-scopes) + * govern which fulfillments orders are returned to clients. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * + * ### Fulfillment orders assigned to the app for fulfillment + * + * Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + * Use the `assignmentStatus` argument to control whether all assigned fulfillment orders + * should be returned or only those where a merchant has sent a + * [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) + * and it has yet to be responded to. + * + * The API client must be granted the `read_assigned_fulfillment_orders` access scope to access + * the assigned fulfillment orders. + * + * ### All fulfillment orders + * + * Apps can retrieve all fulfillment orders with the + * [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) + * query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, + * which are accessible to the app according to the + * [fulfillment order access scopes](#api-access-scopes) it was granted with. + * + * ## The lifecycle of a fulfillment order + * + * ### Fulfillment Order Creation + * + * After an order is created, a background worker performs the order routing process which determines + * which locations will be responsible for fulfilling the purchased items. + * Once the order routing process is complete, one or more fulfillment orders will be created + * and assigned to these locations. It is not possible to manually create fulfillment orders. + * + * Once a fulfillment order has been created, it will have one of two different lifecycles depending on + * the type of location which the fulfillment order is assigned to. + * + * ### The lifecycle of a fulfillment order at a merchant managed location + * + * Fulfillment orders are completed by creating + * [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). + * Fulfillments represents the work done. + * + * For digital products a merchant or an order management app would create a fulfilment once the digital asset + * has been provisioned. + * For example, in the case of a digital gift card, a merchant would to do this once + * the gift card has been activated - before the email has been shipped. + * + * On the other hand, for a traditional shipped order, + * a merchant or an order management app would create a fulfillment after picking and packing the items relating + * to a fulfillment order, but before the courier has collected the goods. + * + * [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). + * + * ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service + * + * For fulfillment orders which are assigned to a location that is managed by a fulfillment service, + * a merchant or an Order Management App can + * [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) + * to the fulfillment service which operates the location to request that they fulfill the associated items. + * A fulfillment service has the option to + * [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) + * or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) + * this fulfillment request. + * + * Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant + * or order management app and instead a + * [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) + * to the fulfillment service. + * + * Once a fulfillment service accepts a fulfillment request, + * then after they are ready to pack items and send them for delivery, they create fulfillments with the + * [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + * mutation. + * They can provide tracking information right away or create fulfillments without it and then + * update the tracking information for fulfillments with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + * mutation. + * + * [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). + * + * ## API access scopes + * + * Fulfillment orders are governed by the following API access scopes: + * + * * The `read_merchant_managed_fulfillment_orders` and + * `write_merchant_managed_fulfillment_orders` access scopes + * grant access to fulfillment orders assigned to merchant-managed locations. + * * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` + * access scopes are intended for fulfillment services. + * These scopes grant access to fulfillment orders assigned to locations that are being managed + * by fulfillment services. + * * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` + * access scopes grant access to fulfillment orders + * assigned to locations managed by other fulfillment services. + * + * ### Fulfillment service app access scopes + * + * Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope + * and don't have the `*_third_party_fulfillment_orders` + * or `*_merchant_managed_fulfillment_orders` access scopes. + * The app will only have access to the fulfillment orders assigned to their location + * (or multiple locations if the app registers multiple fulfillment services on the shop). + * The app will not have access to fulfillment orders assigned to merchant-managed locations + * or locations owned by other fulfillment service apps. + * + * ### Order management app access scopes + * + * **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and + * `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders + * on behalf of a merchant. + * + * If an app combines the functions of an order management app and a fulfillment service, + * then the app should request all + * access scopes to manage all assigned and all unassigned fulfillment orders. + * + * ## Notifications about fulfillment orders + * + * Fulfillment services are required to + * [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified + * whenever a merchant submits a fulfillment or cancellation request. + * + * Both merchants and apps can + * [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * to the + * [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) + * to be notified whenever fulfillment order related domain events occur. + * + * [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). + */ +export type FulfillmentOrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The FulfillmentOrder object represents either an item or a group of items in an + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * that are expected to be fulfilled from the same location. + * There can be more than one fulfillment order for an + * [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * at a given location. + * + * {{ '/api/reference/fulfillment_order_relationships.png' | image }} + * + * Fulfillment orders represent the work which is intended to be done in relation to an order. + * When fulfillment has started for one or more line items, a + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) + * is created by a merchant or third party to represent the ongoing or completed work of fulfillment. + * + * [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). + * + * > Note: + * > Shopify creates fulfillment orders automatically when an order is created. + * > It is not possible to manually create fulfillment orders. + * > + * > [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). + * + * ## Retrieving fulfillment orders + * + * ### Fulfillment orders from an order + * + * All fulfillment orders related to a given order can be retrieved with the + * [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) + * connection. + * + * [API access scopes](#api-access-scopes) + * govern which fulfillments orders are returned to clients. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * + * ### Fulfillment orders assigned to the app for fulfillment + * + * Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + * Use the `assignmentStatus` argument to control whether all assigned fulfillment orders + * should be returned or only those where a merchant has sent a + * [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) + * and it has yet to be responded to. + * + * The API client must be granted the `read_assigned_fulfillment_orders` access scope to access + * the assigned fulfillment orders. + * + * ### All fulfillment orders + * + * Apps can retrieve all fulfillment orders with the + * [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) + * query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, + * which are accessible to the app according to the + * [fulfillment order access scopes](#api-access-scopes) it was granted with. + * + * ## The lifecycle of a fulfillment order + * + * ### Fulfillment Order Creation + * + * After an order is created, a background worker performs the order routing process which determines + * which locations will be responsible for fulfilling the purchased items. + * Once the order routing process is complete, one or more fulfillment orders will be created + * and assigned to these locations. It is not possible to manually create fulfillment orders. + * + * Once a fulfillment order has been created, it will have one of two different lifecycles depending on + * the type of location which the fulfillment order is assigned to. + * + * ### The lifecycle of a fulfillment order at a merchant managed location + * + * Fulfillment orders are completed by creating + * [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). + * Fulfillments represents the work done. + * + * For digital products a merchant or an order management app would create a fulfilment once the digital asset + * has been provisioned. + * For example, in the case of a digital gift card, a merchant would to do this once + * the gift card has been activated - before the email has been shipped. + * + * On the other hand, for a traditional shipped order, + * a merchant or an order management app would create a fulfillment after picking and packing the items relating + * to a fulfillment order, but before the courier has collected the goods. + * + * [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). + * + * ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service + * + * For fulfillment orders which are assigned to a location that is managed by a fulfillment service, + * a merchant or an Order Management App can + * [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) + * to the fulfillment service which operates the location to request that they fulfill the associated items. + * A fulfillment service has the option to + * [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) + * or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) + * this fulfillment request. + * + * Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant + * or order management app and instead a + * [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) + * to the fulfillment service. + * + * Once a fulfillment service accepts a fulfillment request, + * then after they are ready to pack items and send them for delivery, they create fulfillments with the + * [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + * mutation. + * They can provide tracking information right away or create fulfillments without it and then + * update the tracking information for fulfillments with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + * mutation. + * + * [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). + * + * ## API access scopes + * + * Fulfillment orders are governed by the following API access scopes: + * + * * The `read_merchant_managed_fulfillment_orders` and + * `write_merchant_managed_fulfillment_orders` access scopes + * grant access to fulfillment orders assigned to merchant-managed locations. + * * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` + * access scopes are intended for fulfillment services. + * These scopes grant access to fulfillment orders assigned to locations that are being managed + * by fulfillment services. + * * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` + * access scopes grant access to fulfillment orders + * assigned to locations managed by other fulfillment services. + * + * ### Fulfillment service app access scopes + * + * Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope + * and don't have the `*_third_party_fulfillment_orders` + * or `*_merchant_managed_fulfillment_orders` access scopes. + * The app will only have access to the fulfillment orders assigned to their location + * (or multiple locations if the app registers multiple fulfillment services on the shop). + * The app will not have access to fulfillment orders assigned to merchant-managed locations + * or locations owned by other fulfillment service apps. + * + * ### Order management app access scopes + * + * **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and + * `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders + * on behalf of a merchant. + * + * If an app combines the functions of an order management app and a fulfillment service, + * then the app should request all + * access scopes to manage all assigned and all unassigned fulfillment orders. + * + * ## Notifications about fulfillment orders + * + * Fulfillment services are required to + * [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified + * whenever a merchant submits a fulfillment or cancellation request. + * + * Both merchants and apps can + * [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * to the + * [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) + * to be notified whenever fulfillment order related domain events occur. + * + * [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). + */ +export type FulfillmentOrderLocationsForMoveArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The FulfillmentOrder object represents either an item or a group of items in an + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * that are expected to be fulfilled from the same location. + * There can be more than one fulfillment order for an + * [order](https://shopify.dev/api/admin-graphql/latest/objects/Order) + * at a given location. + * + * {{ '/api/reference/fulfillment_order_relationships.png' | image }} + * + * Fulfillment orders represent the work which is intended to be done in relation to an order. + * When fulfillment has started for one or more line items, a + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) + * is created by a merchant or third party to represent the ongoing or completed work of fulfillment. + * + * [See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service). + * + * > Note: + * > Shopify creates fulfillment orders automatically when an order is created. + * > It is not possible to manually create fulfillment orders. + * > + * > [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order). + * + * ## Retrieving fulfillment orders + * + * ### Fulfillment orders from an order + * + * All fulfillment orders related to a given order can be retrieved with the + * [Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders) + * connection. + * + * [API access scopes](#api-access-scopes) + * govern which fulfillments orders are returned to clients. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * + * ### Fulfillment orders assigned to the app for fulfillment + * + * Fulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + * Use the `assignmentStatus` argument to control whether all assigned fulfillment orders + * should be returned or only those where a merchant has sent a + * [fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest) + * and it has yet to be responded to. + * + * The API client must be granted the `read_assigned_fulfillment_orders` access scope to access + * the assigned fulfillment orders. + * + * ### All fulfillment orders + * + * Apps can retrieve all fulfillment orders with the + * [fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders) + * query. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop, + * which are accessible to the app according to the + * [fulfillment order access scopes](#api-access-scopes) it was granted with. + * + * ## The lifecycle of a fulfillment order + * + * ### Fulfillment Order Creation + * + * After an order is created, a background worker performs the order routing process which determines + * which locations will be responsible for fulfilling the purchased items. + * Once the order routing process is complete, one or more fulfillment orders will be created + * and assigned to these locations. It is not possible to manually create fulfillment orders. + * + * Once a fulfillment order has been created, it will have one of two different lifecycles depending on + * the type of location which the fulfillment order is assigned to. + * + * ### The lifecycle of a fulfillment order at a merchant managed location + * + * Fulfillment orders are completed by creating + * [fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment). + * Fulfillments represents the work done. + * + * For digital products a merchant or an order management app would create a fulfilment once the digital asset + * has been provisioned. + * For example, in the case of a digital gift card, a merchant would to do this once + * the gift card has been activated - before the email has been shipped. + * + * On the other hand, for a traditional shipped order, + * a merchant or an order management app would create a fulfillment after picking and packing the items relating + * to a fulfillment order, but before the courier has collected the goods. + * + * [Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments). + * + * ### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service + * + * For fulfillment orders which are assigned to a location that is managed by a fulfillment service, + * a merchant or an Order Management App can + * [send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest) + * to the fulfillment service which operates the location to request that they fulfill the associated items. + * A fulfillment service has the option to + * [accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest) + * or [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest) + * this fulfillment request. + * + * Once the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant + * or order management app and instead a + * [cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest) + * to the fulfillment service. + * + * Once a fulfillment service accepts a fulfillment request, + * then after they are ready to pack items and send them for delivery, they create fulfillments with the + * [fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2) + * mutation. + * They can provide tracking information right away or create fulfillments without it and then + * update the tracking information for fulfillments with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) + * mutation. + * + * [Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments). + * + * ## API access scopes + * + * Fulfillment orders are governed by the following API access scopes: + * + * * The `read_merchant_managed_fulfillment_orders` and + * `write_merchant_managed_fulfillment_orders` access scopes + * grant access to fulfillment orders assigned to merchant-managed locations. + * * The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders` + * access scopes are intended for fulfillment services. + * These scopes grant access to fulfillment orders assigned to locations that are being managed + * by fulfillment services. + * * The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders` + * access scopes grant access to fulfillment orders + * assigned to locations managed by other fulfillment services. + * + * ### Fulfillment service app access scopes + * + * Usually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope + * and don't have the `*_third_party_fulfillment_orders` + * or `*_merchant_managed_fulfillment_orders` access scopes. + * The app will only have access to the fulfillment orders assigned to their location + * (or multiple locations if the app registers multiple fulfillment services on the shop). + * The app will not have access to fulfillment orders assigned to merchant-managed locations + * or locations owned by other fulfillment service apps. + * + * ### Order management app access scopes + * + * **Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and + * `write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders + * on behalf of a merchant. + * + * If an app combines the functions of an order management app and a fulfillment service, + * then the app should request all + * access scopes to manage all assigned and all unassigned fulfillment orders. + * + * ## Notifications about fulfillment orders + * + * Fulfillment services are required to + * [register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * a self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified + * whenever a merchant submits a fulfillment or cancellation request. + * + * Both merchants and apps can + * [subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * to the + * [fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted) + * to be notified whenever fulfillment order related domain events occur. + * + * [Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment). + */ +export type FulfillmentOrderMerchantRequestsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + kind?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `fulfillmentOrderAcceptCancellationRequest` mutation. */ +export type FulfillmentOrderAcceptCancellationRequestPayload = { + /** The fulfillment order whose cancellation request was accepted. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderAcceptFulfillmentRequest` mutation. */ +export type FulfillmentOrderAcceptFulfillmentRequestPayload = { + /** The fulfillment order whose fulfillment request was accepted. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The actions that can be taken on a fulfillment order. */ +export type FulfillmentOrderAction = + /** Cancels a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderCancel`. */ + | "CANCEL_FULFILLMENT_ORDER" + /** Creates a fulfillment for selected line items in the fulfillment order. The corresponding mutation for this action is `fulfillmentCreateV2`. */ + | "CREATE_FULFILLMENT" + /** Opens an external URL to initiate the fulfillment process outside Shopify. This action should be paired with `FulfillmentOrderSupportedAction.externalUrl`. */ + | "EXTERNAL" + /** Applies a fulfillment hold on an open fulfillment order. The corresponding mutation for this action is `fulfillmentOrderHold`. */ + | "HOLD" + /** Marks the fulfillment order as open. The corresponding mutation for this action is `fulfillmentOrderOpen`. */ + | "MARK_AS_OPEN" + /** Merges a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMerge`. */ + | "MERGE" + /** Moves a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMove`. */ + | "MOVE" + /** Releases the fulfillment hold on the fulfillment order. The corresponding mutation for this action is `fulfillmentOrderReleaseHold`. */ + | "RELEASE_HOLD" + /** Sends a cancellation request to the fulfillment service of a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSubmitCancellationRequest`. */ + | "REQUEST_CANCELLATION" + /** Sends a request for fulfilling selected line items in a fulfillment order to a fulfillment service. The corresponding mutation for this action is `fulfillmentOrderSubmitFulfillmentRequest`. */ + | "REQUEST_FULFILLMENT" + /** Splits a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSplit`. */ + | "SPLIT"; + +/** + * The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen. + * + * The fulfillment order's assigned location might change in the following cases: + * + * - The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove]( + * https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove + * ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder]( + * https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder + * ) field within the mutation's response. + * + * - Work on the fulfillment order has not yet begun, which means that the fulfillment order has the + * [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open), + * [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or + * [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold) + * status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin). + * + * If the [fulfillmentOrderMove]( + * https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove + * ) mutation has moved the fulfillment order's line items to a new location, + * but hasn't moved the fulfillment order instance itself, then the original fulfillment order's assigned location + * doesn't change. + * This happens if the fulfillment order is being split during the move, or if all line items can be moved + * to an existing fulfillment order at a new location. + * + * Once the fulfillment order has been taken into work or canceled, + * which means that the fulfillment order has the + * [IN_PROGRESS](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-inprogress), + * [CLOSED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-closed), + * [CANCELLED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-cancelled), or + * [INCOMPLETE](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-incomplete) + * status, `FulfillmentOrderAssignedLocation` acts as a snapshot of the shop's location content. + * Up-to-date shop's location data may be queried through [location]( + * https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderAssignedLocation#field-fulfillmentorderassignedlocation-location + * ) connection. + */ +export type FulfillmentOrderAssignedLocation = { + /** The first line of the address for the location. */ + address1?: Maybe; + /** The second line of the address for the location. */ + address2?: Maybe; + /** The city of the location. */ + city?: Maybe; + /** The two-letter country code of the location. */ + countryCode: CountryCode; + /** + * The location where the fulfillment is expected to happen. This value might be different from + * `FulfillmentOrderAssignedLocation` if the location's attributes were updated + * after the fulfillment order was taken into work of canceled. + */ + location?: Maybe; + /** The name of the location. */ + name: Scalars["String"]["output"]; + /** The phone number of the location. */ + phone?: Maybe; + /** The province of the location. */ + province?: Maybe; + /** The ZIP code of the location. */ + zip?: Maybe; +}; + +/** The assigment status to be used to filter fulfillment orders. */ +export type FulfillmentOrderAssignmentStatus = + /** + * Fulfillment orders for which the merchant has requested cancellation of + * the previously accepted fulfillment request. + */ + | "CANCELLATION_REQUESTED" + /** + * Fulfillment orders for which the merchant's fulfillment request has been accepted. + * Any number of fulfillments can be created on these fulfillment orders + * to completely fulfill the requested items. + */ + | "FULFILLMENT_ACCEPTED" + /** + * Fulfillment orders for which the merchant has requested fulfillment. + */ + | "FULFILLMENT_REQUESTED"; + +/** Return type for `fulfillmentOrderCancel` mutation. */ +export type FulfillmentOrderCancelPayload = { + /** The fulfillment order that was marked as canceled. */ + fulfillmentOrder?: Maybe; + /** The fulfillment order that was created to replace the canceled fulfillment order. */ + replacementFulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderClose` mutation. */ +export type FulfillmentOrderClosePayload = { + /** The fulfillment order that was marked as incomplete. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentOrders. + */ +export type FulfillmentOrderConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentOrderEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * Represents the destination where the items should be sent upon fulfillment. + */ +export type FulfillmentOrderDestination = Node & { + /** The first line of the address of the destination. */ + address1?: Maybe; + /** The second line of the address of the destination. */ + address2?: Maybe; + /** The city of the destination. */ + city?: Maybe; + /** The company of the destination. */ + company?: Maybe; + /** The two-letter country code of the destination. */ + countryCode?: Maybe; + /** The email of the customer at the destination. */ + email?: Maybe; + /** The first name of the customer at the destination. */ + firstName?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The last name of the customer at the destination. */ + lastName?: Maybe; + /** The phone number of the customer at the destination. */ + phone?: Maybe; + /** The province of the destination. */ + province?: Maybe; + /** The ZIP code of the destination. */ + zip?: Maybe; +}; + +/** + * An auto-generated type which holds one FulfillmentOrder and a cursor during pagination. + */ +export type FulfillmentOrderEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentOrderEdge. */ + node: FulfillmentOrder; +}; + +/** The input fields for the fulfillment hold applied on the fulfillment order. */ +export type FulfillmentOrderHoldInput = { + /** A configurable ID used to track the automation system releasing these holds. */ + externalId?: InputMaybe; + /** + * The fulfillment order line items to be placed on hold. + * If left blank, all line items of the fulfillment order are placed on hold. + */ + fulfillmentOrderLineItems?: InputMaybe>; + /** Whether the merchant receives a notification about the fulfillment hold. The default value is `false`. */ + notifyMerchant?: InputMaybe; + /** The reason for the fulfillment hold. */ + reason: FulfillmentHoldReason; + /** Additional information about the fulfillment hold reason. */ + reasonNotes?: InputMaybe; +}; + +/** Return type for `fulfillmentOrderHold` mutation. */ +export type FulfillmentOrderHoldPayload = { + /** The fulfillment order on which a fulfillment hold was applied. */ + fulfillmentOrder?: Maybe; + /** + * The remaining fulfillment order containing the line items to which the hold wasn't applied, + * if specific line items were specified to be placed on hold. + */ + remainingFulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrderHold`. */ +export type FulfillmentOrderHoldUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrderHoldUserError`. */ +export type FulfillmentOrderHoldUserErrorCode = + /** The fulfillment order could not be found. */ + | "FULFILLMENT_ORDER_NOT_FOUND" + /** The fulfillment order line item quantity must be greater than 0. */ + | "GREATER_THAN_ZERO" + /** The fulfillment order line item quantity is invalid. */ + | "INVALID_LINE_ITEM_QUANTITY" + /** The input value is already taken. */ + | "TAKEN"; + +/** + * The international duties relevant to a fulfillment order. + */ +export type FulfillmentOrderInternationalDuties = { + /** The method of duties payment. Example values: `DDP`, `DAP`. */ + incoterm: Scalars["String"]["output"]; +}; + +/** + * Associates an order line item with quantities requiring fulfillment from the respective fulfillment order. + */ +export type FulfillmentOrderLineItem = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated to the line item's variant. */ + image?: Maybe; + /** The ID of the inventory item. */ + inventoryItemId?: Maybe; + /** + * The associated order line item. + * @deprecated As of API version 2023-01, this field has been deprecated. The order line item associated with a `FulfillmentOrderLineItem` + * shouldn't be used to determine what to fulfill. Use the `FulfillmentOrderLineItem` and `FulfillmentOrder` objects + * instead. An order `LineItem` represents a single line item on an order, but it doesn't represent what should be fulfilled. + */ + lineItem: LineItem; + /** The variant unit price without discounts applied, in shop and presentment currencies. */ + originalUnitPriceSet: MoneyBag; + /** The title of the product. */ + productTitle: Scalars["String"]["output"]; + /** The number of units remaining to be fulfilled. */ + remainingQuantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** The variant SKU number. */ + sku?: Maybe; + /** The total number of units to be fulfilled. */ + totalQuantity: Scalars["Int"]["output"]; + /** The name of the variant. */ + variantTitle?: Maybe; + /** The name of the vendor who made the variant. */ + vendor?: Maybe; + /** Warning messages for a fulfillment order line item. */ + warnings: Array; + /** The weight of a line item unit. */ + weight?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentOrderLineItems. + */ +export type FulfillmentOrderLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentOrderLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination. + */ +export type FulfillmentOrderLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentOrderLineItemEdge. */ + node: FulfillmentOrderLineItem; +}; + +/** + * The input fields used to include the quantity of the fulfillment order line item that should be fulfilled. + */ +export type FulfillmentOrderLineItemInput = { + /** The ID of the fulfillment order line item. */ + id: Scalars["ID"]["input"]; + /** The quantity of the fulfillment order line item. */ + quantity: Scalars["Int"]["input"]; +}; + +/** + * A fulfillment order line item warning. For example, a warning about why a fulfillment request was rejected. + */ +export type FulfillmentOrderLineItemWarning = { + /** The description of warning. */ + description?: Maybe; + /** The title of warning. */ + title?: Maybe; +}; + +/** + * The input fields used to include the line items of a specified fulfillment order that should be fulfilled. + */ +export type FulfillmentOrderLineItemsInput = { + /** The ID of the fulfillment order. */ + fulfillmentOrderId: Scalars["ID"]["input"]; + /** + * The fulfillment order line items to be fulfilled. + * If left blank, all line items of the fulfillment order will be fulfilled. + */ + fulfillmentOrderLineItems?: InputMaybe>; +}; + +/** The input fields for marking fulfillment order line items as ready for pickup. */ +export type FulfillmentOrderLineItemsPreparedForPickupInput = { + /** + * The fulfillment orders associated with the line items which are ready to be picked up by a customer. + */ + lineItemsByFulfillmentOrder: Array; +}; + +/** Return type for `fulfillmentOrderLineItemsPreparedForPickup` mutation. */ +export type FulfillmentOrderLineItemsPreparedForPickupPayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrderLineItemsPreparedForPickup`. */ +export type FulfillmentOrderLineItemsPreparedForPickupUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `FulfillmentOrderLineItemsPreparedForPickupUserError`. */ +export type FulfillmentOrderLineItemsPreparedForPickupUserErrorCode = + /** Invalid fulfillment order ID provided. */ + | "FULFILLMENT_ORDER_INVALID" + /** The fulfillment order does not have any line items that can be prepared. */ + | "NO_LINE_ITEMS_TO_PREPARE_FOR_FULFILLMENT_ORDER" + /** Unable to prepare quantity. */ + | "UNABLE_TO_PREPARE_QUANTITY"; + +/** + * A location that a fulfillment order can potentially move to. + */ +export type FulfillmentOrderLocationForMove = { + /** The location being considered as the fulfillment order's new assigned location. */ + location: Location; + /** + * A human-readable string with the reason why the fulfillment order, or some of its line items, can't be + * moved to the location. + */ + message?: Maybe; + /** Whether the fulfillment order can be moved to the location. */ + movable: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves. + */ +export type FulfillmentOrderLocationForMoveConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentOrderLocationForMoveEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination. + */ +export type FulfillmentOrderLocationForMoveEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentOrderLocationForMoveEdge. */ + node: FulfillmentOrderLocationForMove; +}; + +/** + * A request made by the merchant or an order management app to a fulfillment service + * for a fulfillment order. + */ +export type FulfillmentOrderMerchantRequest = Node & { + /** The fulfillment order associated with the merchant request. */ + fulfillmentOrder: FulfillmentOrder; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The kind of request made. */ + kind: FulfillmentOrderMerchantRequestKind; + /** The optional message that the merchant included in the request. */ + message?: Maybe; + /** + * Additional options requested by the merchant. These depend on the `kind` of the request. + * For example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the + * merchant intends to notify the customer upon fulfillment. The fulfillment service can then set + * `notifyCustomer` when making calls to `FulfillmentCreateV2`. + */ + requestOptions?: Maybe; + /** The response from the fulfillment service. */ + responseData?: Maybe; + /** The timestamp when the request was made. */ + sentAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests. + */ +export type FulfillmentOrderMerchantRequestConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentOrderMerchantRequestEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination. + */ +export type FulfillmentOrderMerchantRequestEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of FulfillmentOrderMerchantRequestEdge. */ + node: FulfillmentOrderMerchantRequest; +}; + +/** The kinds of request merchants can make to a fulfillment service. */ +export type FulfillmentOrderMerchantRequestKind = + /** + * The merchant requests cancellation of an `IN_PROGRESS` fulfillment order. + */ + | "CANCELLATION_REQUEST" + /** + * The merchant requests fulfillment for an `OPEN` fulfillment order. + */ + | "FULFILLMENT_REQUEST"; + +/** The input fields for merging fulfillment orders. */ +export type FulfillmentOrderMergeInput = { + /** The details of the fulfillment orders to be merged. */ + mergeIntents: Array; +}; + +/** The input fields for merging fulfillment orders into a single merged fulfillment order. */ +export type FulfillmentOrderMergeInputMergeIntent = { + /** The ID of the fulfillment order to be merged. */ + fulfillmentOrderId: Scalars["ID"]["input"]; + /** + * The fulfillment order line items to be merged. + */ + fulfillmentOrderLineItems?: InputMaybe>; +}; + +/** Return type for `fulfillmentOrderMerge` mutation. */ +export type FulfillmentOrderMergePayload = { + /** The result of the fulfillment order merges. */ + fulfillmentOrderMerges?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The result of merging a set of fulfillment orders. */ +export type FulfillmentOrderMergeResult = { + /** The new fulfillment order as a result of the merge. */ + fulfillmentOrder: FulfillmentOrder; +}; + +/** An error that occurs during the execution of `FulfillmentOrderMerge`. */ +export type FulfillmentOrderMergeUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrderMergeUserError`. */ +export type FulfillmentOrderMergeUserErrorCode = + /** The fulfillment order could not be found. */ + | "FULFILLMENT_ORDER_NOT_FOUND" + /** The fulfillment order line item quantity must be greater than 0. */ + | "GREATER_THAN" + /** The fulfillment order line item quantity is invalid. */ + | "INVALID_LINE_ITEM_QUANTITY"; + +/** Return type for `fulfillmentOrderMove` mutation. */ +export type FulfillmentOrderMovePayload = { + /** + * The fulfillment order which now contains the moved line items and is assigned to the destination location. + * + * **First scenario:** All line items belonging to the original fulfillment order are re-assigned. + * + * In this case, this will be the original fulfillment order. + * + * **Second scenario:** A subset of the line items belonging to the original fulfillment order are re-assigned. + * + * If the new location is already assigned to fulfill line items on the order, then + * this will be an existing active fulfillment order. + * Otherwise, this will be a new fulfillment order with the moved line items assigned. + */ + movedFulfillmentOrder?: Maybe; + /** + * The final state of the original fulfillment order. + * + * As a result of the move operation, the original fulfillment order might be moved to the new location + * or remain in the original location. The original fulfillment order might have the same status or be closed. + */ + originalFulfillmentOrder?: Maybe; + /** + * This field is deprecated. + */ + remainingFulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderOpen` mutation. */ +export type FulfillmentOrderOpenPayload = { + /** The fulfillment order that was transitioned to open and is fulfillable. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderRejectCancellationRequest` mutation. */ +export type FulfillmentOrderRejectCancellationRequestPayload = { + /** The fulfillment order whose cancellation request was rejected. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderRejectFulfillmentRequest` mutation. */ +export type FulfillmentOrderRejectFulfillmentRequestPayload = { + /** The fulfillment order whose fulfillment request was rejected. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The reason for a fulfillment order rejection. */ +export type FulfillmentOrderRejectionReason = + /** The fulfillment order was rejected because of an incorrect address. */ + | "INCORRECT_ADDRESS" + /** The fulfillment order was rejected because of an ineligible product. */ + | "INELIGIBLE_PRODUCT" + /** The fulfillment order was rejected because inventory is out of stock. */ + | "INVENTORY_OUT_OF_STOCK" + /** The fulfillment order was rejected for another reason. */ + | "OTHER" + /** The fulfillment order was rejected because of an undeliverable destination. */ + | "UNDELIVERABLE_DESTINATION"; + +/** Return type for `fulfillmentOrderReleaseHold` mutation. */ +export type FulfillmentOrderReleaseHoldPayload = { + /** The fulfillment order on which the hold was released. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrderReleaseHold`. */ +export type FulfillmentOrderReleaseHoldUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrderReleaseHoldUserError`. */ +export type FulfillmentOrderReleaseHoldUserErrorCode = + /** The fulfillment order wasn't found. */ + | "FULFILLMENT_ORDER_NOT_FOUND" + /** The fulfillment order line item quantity must be greater than 0. */ + | "GREATER_THAN_ZERO" + /** The fulfillment order line item quantity is invalid. */ + | "INVALID_LINE_ITEM_QUANTITY"; + +/** The request status of a fulfillment order. */ +export type FulfillmentOrderRequestStatus = + /** The fulfillment service accepted the merchant's fulfillment request. */ + | "ACCEPTED" + /** + * The fulfillment service accepted the merchant's fulfillment cancellation request. + */ + | "CANCELLATION_ACCEPTED" + /** + * The fulfillment service rejected the merchant's fulfillment cancellation request. + */ + | "CANCELLATION_REJECTED" + /** + * The merchant requested a cancellation of the fulfillment request for this fulfillment order. + */ + | "CANCELLATION_REQUESTED" + /** The fulfillment service closed the fulfillment order without completing it. */ + | "CLOSED" + /** The fulfillment service rejected the merchant's fulfillment request. */ + | "REJECTED" + /** The merchant requested fulfillment for this fulfillment order. */ + | "SUBMITTED" + /** + * The initial request status for the newly-created fulfillment orders. This is the only valid + * request status for fulfillment orders that aren't assigned to a fulfillment service. + */ + | "UNSUBMITTED"; + +/** Return type for `fulfillmentOrderReschedule` mutation. */ +export type FulfillmentOrderReschedulePayload = { + /** The fulfillment order that was rescheduled. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrderReschedule`. */ +export type FulfillmentOrderRescheduleUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrderRescheduleUserError`. */ +export type FulfillmentOrderRescheduleUserErrorCode = + /** Fulfillment order could not be found. */ + "FULFILLMENT_ORDER_NOT_FOUND"; + +/** The set of valid sort keys for the FulfillmentOrder query. */ +export type FulfillmentOrderSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The input fields for the split applied to the fulfillment order. */ +export type FulfillmentOrderSplitInput = { + /** The ID of the fulfillment order to be split. */ + fulfillmentOrderId: Scalars["ID"]["input"]; + /** + * The fulfillment order line items to be split out. + */ + fulfillmentOrderLineItems: Array; +}; + +/** Return type for `fulfillmentOrderSplit` mutation. */ +export type FulfillmentOrderSplitPayload = { + /** The result of the fulfillment order splits. */ + fulfillmentOrderSplits?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The result of splitting a fulfillment order. */ +export type FulfillmentOrderSplitResult = { + /** The original fulfillment order as a result of the split. */ + fulfillmentOrder: FulfillmentOrder; + /** The remaining fulfillment order as a result of the split. */ + remainingFulfillmentOrder: FulfillmentOrder; + /** The replacement fulfillment order if the original fulfillment order wasn't in a state to be split. */ + replacementFulfillmentOrder?: Maybe; +}; + +/** An error that occurs during the execution of `FulfillmentOrderSplit`. */ +export type FulfillmentOrderSplitUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrderSplitUserError`. */ +export type FulfillmentOrderSplitUserErrorCode = + /** The fulfillment order could not be found. */ + | "FULFILLMENT_ORDER_NOT_FOUND" + /** The fulfillment order line item quantity must be greater than 0. */ + | "GREATER_THAN" + /** The fulfillment order line item quantity is invalid. */ + | "INVALID_LINE_ITEM_QUANTITY"; + +/** The status of a fulfillment order. */ +export type FulfillmentOrderStatus = + /** The fulfillment order has been cancelled by the merchant. */ + | "CANCELLED" + /** The fulfillment order has been completed and closed. */ + | "CLOSED" + /** The fulfillment order cannot be completed as requested. */ + | "INCOMPLETE" + /** The fulfillment order is being processed. */ + | "IN_PROGRESS" + /** The fulfillment order is on hold. The fulfillment process can't be initiated until the hold on the fulfillment order is released. */ + | "ON_HOLD" + /** The fulfillment order is ready for fulfillment. */ + | "OPEN" + /** The fulfillment order is deferred and will be ready for fulfillment after the date and time specified in `fulfill_at`. */ + | "SCHEDULED"; + +/** Return type for `fulfillmentOrderSubmitCancellationRequest` mutation. */ +export type FulfillmentOrderSubmitCancellationRequestPayload = { + /** The fulfillment order specified in the cancelation request. */ + fulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentOrderSubmitFulfillmentRequest` mutation. */ +export type FulfillmentOrderSubmitFulfillmentRequestPayload = { + /** + * The original fulfillment order intended to request fulfillment for. + */ + originalFulfillmentOrder?: Maybe; + /** + * The fulfillment order that was submitted to the fulfillment service. This will be the same as + * the original fulfillment order field. The exception to this is partial fulfillment requests or + * fulfillment request for cancelled or incomplete fulfillment orders. + */ + submittedFulfillmentOrder?: Maybe; + /** + * This field will only be present for partial fulfillment requests. This will represent the new + * fulfillment order with the remaining line items not submitted to the fulfillment service. + */ + unsubmittedFulfillmentOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * One of the actions that the fulfillment order supports in its current state. + */ +export type FulfillmentOrderSupportedAction = { + /** The action value. */ + action: FulfillmentOrderAction; + /** + * The external URL to be used to initiate the fulfillment process outside Shopify. + * Applicable only when the `action` value is `EXTERNAL`. + */ + externalUrl?: Maybe; +}; + +/** Return type for `fulfillmentOrdersReleaseHolds` mutation. */ +export type FulfillmentOrdersReleaseHoldsPayload = { + /** The asynchronous job that will release the fulfillment holds. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrdersReleaseHolds`. */ +export type FulfillmentOrdersReleaseHoldsUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `FulfillmentOrdersReleaseHoldsUserError`. */ +export type FulfillmentOrdersReleaseHoldsUserErrorCode = + /** Failed to create release fulfillment order holds job. */ + "FAILED_TO_CREATE_JOB"; + +/** Return type for `fulfillmentOrdersSetFulfillmentDeadline` mutation. */ +export type FulfillmentOrdersSetFulfillmentDeadlinePayload = { + /** Whether the fulfillment deadline was successfully set. */ + success?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `FulfillmentOrdersSetFulfillmentDeadline`. */ +export type FulfillmentOrdersSetFulfillmentDeadlineUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `FulfillmentOrdersSetFulfillmentDeadlineUserError`. */ +export type FulfillmentOrdersSetFulfillmentDeadlineUserErrorCode = + /** The fulfillment orders could not be found. */ + "FULFILLMENT_ORDERS_NOT_FOUND"; + +/** The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center. */ +export type FulfillmentOriginAddress = { + /** The street address of the fulfillment location. */ + address1?: Maybe; + /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + address2?: Maybe; + /** The city in which the fulfillment location is located. */ + city?: Maybe; + /** The country code of the fulfillment location. */ + countryCode: Scalars["String"]["output"]; + /** The province code of the fulfillment location. */ + provinceCode?: Maybe; + /** The zip code of the fulfillment location. */ + zip?: Maybe; +}; + +/** The input fields used to include the address at which the fulfillment occurred. Typically the address of a warehouse or a fulfillment center. */ +export type FulfillmentOriginAddressInput = { + /** The street address of the fulfillment location. */ + address1?: InputMaybe; + /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + address2?: InputMaybe; + /** The city in which the fulfillment location is located. */ + city?: InputMaybe; + /** The country of the fulfillment location. */ + countryCode: Scalars["String"]["input"]; + /** The province of the fulfillment location. */ + provinceCode?: InputMaybe; + /** The zip code of the fulfillment location. */ + zip?: InputMaybe; +}; + +/** + * A **Fulfillment Service** is a third party warehouse that prepares and ships orders + * on behalf of the store owner. Fulfillment services charge a fee to package and ship items + * and update product inventory levels. Some well known fulfillment services with Shopify integrations + * include: Amazon, Shipwire, and Rakuten. When an app registers a new `FulfillmentService` on a store, + * Shopify automatically creates a `Location` that's associated to the fulfillment service. + * To learn more about fulfillment services, refer to + * [Manage fulfillments as a fulfillment service app](https://shopify.dev/apps/fulfillment/fulfillment-service-apps) + * guide. + * + * ## Mutations + * + * You can work with the `FulfillmentService` object with the + * [fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate), + * [fulfillmentServiceUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceUpdate), + * and [fulfillmentServiceDelete](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceDelete) + * mutations. + * + * ## Hosted endpoints + * + * Fulfillment service providers integrate with Shopify by providing Shopify with a set of hosted endpoints that + * Shopify can query on certain conditions. + * These endpoints must have a common prefix, and this prefix should be supplied in the `callbackUrl` parameter + * in the + * [fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate) + * mutation. + * + * - Shopify sends POST requests to the `/fulfillment_order_notification` endpoint + * to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests, + * if `fulfillment_orders_opt_in` is set to `true`. + * + * [As of the 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation), + * it's mandatory for a fulfillment service to follow a fulfillment order based workflow by + * having `fulfillment_orders_opt_in` set to `true`, + * hosting the `/fulfillment_order_notification` endpoint, and acting on fulfillment requests and cancellations. + * + * For more information, refer to + * [Receive fulfillment requests and cancellations](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations). + * - Shopify sends GET requests to the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers for orders, + * if `trackingSupport` is set to `true`. + * + * For more information, refer to + * [Enable tracking support](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-8-enable-tracking-support-optional). + * + * Fulfillment services can also update tracking information with the + * [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation, + * rather than waiting for Shopify to ask for tracking numbers. + * - Shopify sends GET requests to the `/fetch_stock` endpoint to retrieve inventory levels, + * if `inventoryManagement` is set to `true`. + * + * For more information, refer to + * [Sharing inventory levels with Shopify](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-9-share-inventory-levels-with-shopify-optional). + * + * To make sure you have everything set up correctly, you can test the `callbackUrl`-prefixed endpoints + * in your development store. + * + * ## Resources and webhooks + * + * There are a variety of objects and webhooks that enable a fulfillment service to work. + * To exchange fulfillment information with Shopify, fulfillment services use the + * [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder), + * [Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) and + * [Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) objects and related mutations. + * To act on fulfillment process events that happen on the Shopify side, + * besides awaiting calls to `callbackUrl`-prefixed endpoints, + * fulfillment services can subscribe to the + * [fulfillment order](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks) + * and [order](https://shopify.dev/api/admin-rest/latest/resources/webhook) + * webhooks. + */ +export type FulfillmentService = { + /** + * The callback URL that the fulfillment service has registered for requests. The following considerations apply: + * + * - Shopify queries the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers + * for orders, if `trackingSupport` is set to `true`. + * - Shopify queries the `/fetch_stock` endpoint to retrieve inventory levels, + * if `inventoryManagement` is set to `true`. + * - Shopify uses the `/fulfillment_order_notification` endpoint to send + * [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations), + * if the fulfillment service has opted in to the fulfillment order based workflow for managing fulfillments + * (`fulfillmentOrdersOptIn` is set to `true`). + */ + callbackUrl?: Maybe; + /** + * Whether the fulfillment service uses the [fulfillment order based workflow](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments) for managing fulfillments. + */ + fulfillmentOrdersOptIn: Scalars["Boolean"]["output"]; + /** Human-readable unique identifier for this fulfillment service. */ + handle: Scalars["String"]["output"]; + /** The ID of the fulfillment service. */ + id: Scalars["ID"]["output"]; + /** Whether the fulfillment service tracks product inventory and provides updates to Shopify. */ + inventoryManagement: Scalars["Boolean"]["output"]; + /** Location associated with the fulfillment service. */ + location?: Maybe; + /** Whether the fulfillment service can stock inventory alongside other locations. */ + permitsSkuSharing: Scalars["Boolean"]["output"]; + /** Whether the fulfillment service supports local deliveries. */ + productBased: Scalars["Boolean"]["output"]; + /** The name of the fulfillment service as seen by merchants. */ + serviceName: Scalars["String"]["output"]; + /** + * Shipping methods associated with the fulfillment service provider. Applies only to Fulfill By Amazon fulfillment service. + * @deprecated The Fulfillment by Amazon feature will no longer be supported from March 30, 2023. To continue using Amazon fulfillment, merchants need to set up a Multi-Channel Fulfillment solution recommended by Amazon: https://help.shopify.com/manual/shipping/fulfillment-services/amazon#activate-fulfillment-by-amazon + */ + shippingMethods: Array; + /** Type associated with the fulfillment service. */ + type: FulfillmentServiceType; +}; + +/** Return type for `fulfillmentServiceCreate` mutation. */ +export type FulfillmentServiceCreatePayload = { + /** The created fulfillment service. */ + fulfillmentService?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `fulfillmentServiceDelete` mutation. */ +export type FulfillmentServiceDeletePayload = { + /** The ID of the deleted fulfillment service. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The type of a fulfillment service. */ +export type FulfillmentServiceType = + /** Fulfillment by gift card. */ + | "GIFT_CARD" + /** Manual fulfillment by the merchant. */ + | "MANUAL" + /** Fullfillment by a third-party fulfillment service. */ + | "THIRD_PARTY"; + +/** Return type for `fulfillmentServiceUpdate` mutation. */ +export type FulfillmentServiceUpdatePayload = { + /** The updated fulfillment service. */ + fulfillmentService?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The status of a fulfillment. */ +export type FulfillmentStatus = + /** The fulfillment was canceled. */ + | "CANCELLED" + /** There was an error with the fulfillment request. */ + | "ERROR" + /** The fulfillment request failed. */ + | "FAILURE" + /** + * The third-party fulfillment service has acknowledged the fulfillment and is processing it. + */ + | "OPEN" + /** + * Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`. + */ + | "PENDING" + /** The fulfillment was completed successfully. */ + | "SUCCESS"; + +/** Represents the tracking information for a fulfillment. */ +export type FulfillmentTrackingInfo = { + /** + * The name of the tracking company. + * + * For tracking company names from the list below + * Shopify will automatically build tracking URLs for all provided tracking numbers, + * which will make the tracking numbers clickable in the interface. + * + * Additionally, for the tracking companies listed on the + * [Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers) + * Shopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process. + * + * ### Supported tracking companies + * + * The following tracking companies display for shops located in any country: + * + * * 4PX + * * AGS + * * Amazon Logistics UK + * * Amazon Logistics US + * * An Post + * * Anjun Logistics + * * APC + * * Asendia USA + * * Australia Post + * * Bonshaw + * * BPost + * * BPost International + * * Canada Post + * * Canpar + * * CDL Last Mile + * * China Post + * * Chronopost + * * Chukou1 + * * Colissimo + * * Comingle + * * Coordinadora + * * Correios + * * Correos + * * CTT + * * CTT Express + * * Cyprus Post + * * Delnext + * * Deutsche Post + * * DHL eCommerce + * * DHL eCommerce Asia + * * DHL Express + * * DoorDash + * * DPD + * * DPD Local + * * DPD UK + * * DTD Express + * * DX + * * Eagle + * * Estes + * * Evri + * * FedEx + * * First Global Logistics + * * First Line + * * FSC + * * Fulfilla + * * GLS + * * Guangdong Weisuyi Information Technology (WSE) + * * Heppner Internationale Spedition GmbH & Co. + * * Iceland Post + * * IDEX + * * Israel Post + * * Japan Post (EN) + * * Japan Post (JA) + * * La Poste + * * Lasership + * * Latvia Post + * * Lietuvos Paštas + * * Logisters + * * Lone Star Overnight + * * M3 Logistics + * * Meteor Space + * * Mondial Relay + * * New Zealand Post + * * NinjaVan + * * North Russia Supply Chain (Shenzhen) Co. + * * OnTrac + * * Packeta + * * Pago Logistics + * * Ping An Da Tengfei Express + * * Pitney Bowes + * * Portal PostNord + * * Poste Italiane + * * PostNL + * * PostNord DK + * * PostNord NO + * * PostNord SE + * * Purolator + * * Qxpress + * * Qyun Express + * * Royal Mail + * * Royal Shipments + * * Sagawa (EN) + * * Sagawa (JA) + * * Sendle + * * SF Express + * * SFC Fulfillment + * * SHREE NANDAN COURIER + * * Singapore Post + * * Southwest Air Cargo + * * StarTrack + * * Step Forward Freight + * * Swiss Post + * * TForce Final Mile + * * Tinghao + * * TNT + * * Toll IPEC + * * United Delivery Service + * * UPS + * * USPS + * * Venipak + * * We Post + * * Whistl + * * Wizmo + * * WMYC + * * Xpedigo + * * XPO Logistics + * * Yamato (EN) + * * Yamato (JA) + * * YiFan Express + * * YunExpress + * + * The following tracking companies are displayed for shops located in specific countries: + * + * * **Australia**: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics + * * **Austria**: Österreichische Post + * * **Bulgaria**: Speedy + * * **Canada**: Intelcom, BoxKnight, Loomis, GLS + * * **China**: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC + * * **Czechia**: Zásilkovna + * * **Germany**: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS + * * **Spain**: SEUR + * * **France**: Colissimo, Mondial Relay, Colis Privé, GLS + * * **United Kingdom**: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells + * * **Greece**: ACS Courier + * * **Hong Kong SAR**: SF Express + * * **Ireland**: Fastway, DPD Ireland + * * **India**: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart + * * **Italy**: BRT, GLS Italy + * * **Japan**: エコ配, 西濃運輸, 西濃スーパーエキスプレス, 福山通運, 日本通運, 名鉄運輸, 第一貨物 + * * **Netherlands**: DHL Parcel, DPD + * * **Norway**: Bring + * * **Poland**: Inpost + * * **Turkey**: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo + * * **United States**: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo + * * **South Africa**: Fastway, Skynet. + */ + company?: Maybe; + /** + * The tracking number of the fulfillment. + * + * The tracking number is clickable in the interface if one of the following applies + * (the highest in the list has the highest priority): + * + * * Tracking url provided in the `url` field. + * * [Shopify-known tracking company name](#supported-tracking-companies) specified in the `company` field. + * Shopify will build the tracking URL automatically based on the tracking number specified. + * * The tracking number has a Shopify-known format. + * Shopify will guess the tracking provider and build the tracking url based on the tracking number format. + * Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. + * This can result in an invalid tracking URL. + * It is highly recommended that you send the tracking company and the tracking URL. + */ + number?: Maybe; + /** + * The URLs to track the fulfillment. + * + * The tracking URL is displayed in the merchant's admin on the order page. + * The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer. + * When accounts are enabled, it's also displayed in the customer's order history. + */ + url?: Maybe; +}; + +/** Return type for `fulfillmentTrackingInfoUpdateV2` mutation. */ +export type FulfillmentTrackingInfoUpdateV2Payload = { + /** The updated fulfillment with tracking information. */ + fulfillment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields that specify all possible fields for tracking information. + * + * > Note: + * > If you provide the `url` field, you should not provide the `urls` field. + * > + * > If you provide the `number` field, you should not provide the `numbers` field. + * > + * > If you provide the `url` field, you should provide the `number` field. + * > + * > If you provide the `urls` field, you should provide the `numbers` field. + */ +export type FulfillmentTrackingInput = { + /** + * The name of the tracking company. + * + * If you specify a tracking company name from + * [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies), + * Shopify will automatically build tracking URLs for all provided tracking numbers, + * which will make the tracking numbers clickable in the interface. + * The same tracking company will be applied to all tracking numbers specified. + * + * Additionally, for the tracking companies listed on the + * [Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers) + * Shopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process. + * + * > Note: + * > Send the tracking company name exactly as written in + * > [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies) + * > (capitalization matters). + */ + company?: InputMaybe; + /** + * The tracking number of the fulfillment. + * + * The tracking number will be clickable in the interface if one of the following applies + * (the highest in the list has the highest priority): + * + * * Tracking url provided in the `url` field. + * * [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies) + * specified in the `company` field. + * Shopify will build the tracking URL automatically based on the tracking number specified. + * * The tracking number has a Shopify-known format. + * Shopify will guess the tracking provider and build the tracking url based on the tracking number format. + * Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. + * This can result in an invalid tracking URL. + * It is highly recommended that you send the tracking company and the tracking URL. + */ + number?: InputMaybe; + /** + * The tracking numbers of the fulfillment, one or many. + * + * With multiple tracking numbers, you can provide tracking information + * for all shipments associated with the fulfillment, if there are more than one. + * For example, if you're shipping assembly parts of one furniture item in several boxes. + * + * Tracking numbers will be clickable in the interface if one of the following applies + * (the highest in the list has the highest priority): + * + * * Tracking URLs provided in the `urls` field. + * The tracking URLs will be matched to the tracking numbers based on their positions in the arrays. + * * [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies) + * specified in the `company` field. + * Shopify will build tracking URLs automatically for all tracking numbers specified. + * The same tracking company will be applied to all tracking numbers. + * * Tracking numbers have a Shopify-known format. + * Shopify will guess tracking providers and build tracking URLs based on the tracking number formats. + * Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers. + * This can result in an invalid tracking URL. + * It is highly recommended that you send the tracking company and the tracking URLs. + */ + numbers?: InputMaybe>; + /** + * The URL to track the fulfillment. + * + * The tracking URL is displayed in the merchant's admin on the order page. + * The tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer. + * When accounts are enabled, it's also displayed in the customer's order history. + * + * The URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and + * [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. + * For example, `"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER"` is a valid URL. + * It includes a scheme (`https`) and a host (`myshipping.com`). + */ + url?: InputMaybe; + /** + * The URLs to track the fulfillment, one or many. + * + * The tracking URLs are displayed in the merchant's admin on the order page. + * The tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer. + * When accounts are enabled, the tracking URLs are also displayed in the customer's order history. + * + * If you're not specifying a + * [Shopify-known](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies) + * tracking company name in the `company` field, + * then provide tracking URLs for all tracking numbers from the `numbers` field. + * + * Tracking URLs from the `urls` array field are being matched with the tracking numbers from the `numbers` array + * field correspondingly their positions in the arrays. + * + * Each URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and + * [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string. + * For example, `"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER"` is a valid URL. + * It includes a scheme (`https`) and a host (`myshipping.com`). + */ + urls?: InputMaybe>; +}; + +/** The input fields used to create a fulfillment from fulfillment orders. */ +export type FulfillmentV2Input = { + /** + * Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment + * order line items that have to be fulfilled for each fulfillment order. For any given pair, if the + * fulfillment order line items are left blank then all the fulfillment order line items of the + * associated fulfillment order ID will be fulfilled. + */ + lineItemsByFulfillmentOrder: Array; + /** + * Whether the customer is notified. + * If `true`, then a notification is sent when the fulfillment is created. The default value is `false`. + */ + notifyCustomer?: InputMaybe; + /** + * Address information about the location from which the order was fulfilled. + */ + originAddress?: InputMaybe; + /** + * The fulfillment's tracking information, including a tracking URL, a tracking number, + * and the company associated with the fulfillment. + */ + trackingInfo?: InputMaybe; +}; + +/** The App Bridge information for a Shopify Function. */ +export type FunctionsAppBridge = { + /** The relative path for creating a customization. */ + createPath: Scalars["String"]["output"]; + /** The relative path for viewing a customization. */ + detailsPath: Scalars["String"]["output"]; +}; + +/** The error history from running a Shopify Function. */ +export type FunctionsErrorHistory = { + /** The date and time that the first error occurred. */ + errorsFirstOccurredAt: Scalars["DateTime"]["output"]; + /** The date and time that the first error occurred. */ + firstOccurredAt: Scalars["DateTime"]["output"]; + /** Whether the merchant has shared all the recent errors with the developer. */ + hasBeenSharedSinceLastError: Scalars["Boolean"]["output"]; + /** Whether the merchant has shared all the recent errors with the developer. */ + hasSharedRecentErrors: Scalars["Boolean"]["output"]; +}; + +/** + * Represents any file other than HTML. + */ +export type GenericFile = File & Node & { + /** A word or phrase to describe the contents or the function of a file. */ + alt?: Maybe; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** Any errors that have occurred on the file. */ + fileErrors: Array; + /** The status of the file. */ + fileStatus: FileStatus; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The generic file's MIME type. */ + mimeType?: Maybe; + /** The generic file's size in bytes. */ + originalFileSize?: Maybe; + /** The preview image for the media. */ + preview?: Maybe; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The generic file's URL. */ + url?: Maybe; +}; + +/** Represents an issued gift card. */ +export type GiftCard = Node & { + /** The gift card's remaining balance. */ + balance: MoneyV2; + /** The date and time at which the gift card was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customer who will receive the gift card. */ + customer?: Maybe; + /** The date and time at which the gift card was disabled. */ + disabledAt?: Maybe; + /** Whether the gift card is enabled. */ + enabled: Scalars["Boolean"]["output"]; + /** The date at which the gift card will expire. */ + expiresOn?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The initial value of the gift card. */ + initialValue: MoneyV2; + /** The final four characters of the gift card code. */ + lastCharacters: Scalars["String"]["output"]; + /** The gift card code. Everything but the final four characters is masked. */ + maskedCode: Scalars["String"]["output"]; + /** The note associated with the gift card, which isn't visible to the customer. */ + note?: Maybe; + /** + * The order associated with the gift card. This value is `null` if the gift card was issued manually. + */ + order?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple GiftCards. + */ +export type GiftCardConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in GiftCardEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields to issue a gift card. */ +export type GiftCardCreateInput = { + /** + * The gift card's code. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9). + * It isn't case sensitive. If not provided, then a random code will be generated. + */ + code?: InputMaybe; + /** The ID of the customer who will receive the gift card. Requires `write_customers` access_scope. */ + customerId?: InputMaybe; + /** + * The date at which the gift card will expire. If not provided, then the gift card will never expire. + */ + expiresOn?: InputMaybe; + /** The initial value of the gift card. */ + initialValue: Scalars["Decimal"]["input"]; + /** The note associated with the gift card, which isn't visible to the customer. */ + note?: InputMaybe; + /** + * The suffix of the Liquid template that's used to render the gift card online. + * For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`. + * If not provided, then the default `gift_card.liquid` template is used. + */ + templateSuffix?: InputMaybe; +}; + +/** Return type for `giftCardCreate` mutation. */ +export type GiftCardCreatePayload = { + /** The created gift card. */ + giftCard?: Maybe; + /** The created gift card's code. */ + giftCardCode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `giftCardDisable` mutation. */ +export type GiftCardDisablePayload = { + /** The disabled gift card. */ + giftCard?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one GiftCard and a cursor during pagination. + */ +export type GiftCardEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of GiftCardEdge. */ + node: GiftCard; +}; + +/** Possible error codes that can be returned by `GiftCardUserError`. */ +export type GiftCardErrorCode = + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** Missing a required argument. */ + | "MISSING_ARGUMENT" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT"; + +/** A sale associated with a gift card. */ +export type GiftCardSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line item for the associated sale. */ + lineItem: LineItem; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** The set of valid sort keys for the GiftCard query. */ +export type GiftCardSortKeys = + /** Sort by the `amount_spent` value. */ + | "AMOUNT_SPENT" + /** Sort by the `balance` value. */ + | "BALANCE" + /** Sort by the `code` value. */ + | "CODE" + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `customer_name` value. */ + | "CUSTOMER_NAME" + /** Sort by the `disabled_at` value. */ + | "DISABLED_AT" + /** Sort by the `expires_on` value. */ + | "EXPIRES_ON" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `initial_value` value. */ + | "INITIAL_VALUE" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The input fields to update a gift card. */ +export type GiftCardUpdateInput = { + /** + * The ID of the customer who will receive the gift card. The ID can't be changed if the gift card already has an assigned customer ID. + */ + customerId?: InputMaybe; + /** + * The date at which the gift card will expire. If set to `null`, then the gift card will never expire. + */ + expiresOn?: InputMaybe; + /** The note associated with the gift card, which isn't visible to the customer. */ + note?: InputMaybe; + /** + * The suffix of the Liquid template that's used to render the gift card online. + * For example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`. + */ + templateSuffix?: InputMaybe; +}; + +/** Return type for `giftCardUpdate` mutation. */ +export type GiftCardUpdatePayload = { + /** The updated gift card. */ + giftCard?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents an error that happens during the execution of a gift card mutation. */ +export type GiftCardUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Represents an object that has a list of events. */ +export type HasEvents = { + /** The paginated list of events associated with the host subject. */ + events: EventConnection; +}; + +/** Represents an object that has a list of events. */ +export type HasEventsEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Localization extensions associated with the specified resource. For example, the tax id for government invoice. + */ +export type HasLocalizationExtensions = { + /** List of localization extensions for the resource. */ + localizationExtensions: LocalizationExtensionConnection; +}; + +/** + * Localization extensions associated with the specified resource. For example, the tax id for government invoice. + */ +export type HasLocalizationExtensionsLocalizationExtensionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + countryCodes?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + purposes?: InputMaybe>; + reverse?: InputMaybe; +}; + +/** Resources that metafield definitions can be applied to. */ +export type HasMetafieldDefinitions = { + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; +}; + +/** Resources that metafield definitions can be applied to. */ +export type HasMetafieldDefinitionsMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafields = { + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Published translations associated with the resource. */ +export type HasPublishedTranslations = { + /** The translations associated with the resource. */ + translations: Array; +}; + +/** Published translations associated with the resource. */ +export type HasPublishedTranslationsTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** Represents an image resource. */ +export type Image = HasMetafields & { + /** A word or phrase to share the nature or contents of an image. */ + altText?: Maybe; + /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ + height?: Maybe; + /** A unique ID for the image. */ + id?: Maybe; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * The location of the original image as a URL. + * + * If there are any existing transformations in the original source URL, they will remain and not be stripped. + * + * @deprecated Use `url` instead. + */ + originalSrc: Scalars["URL"]["output"]; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** + * The location of the image as a URL. + * @deprecated Use `url` instead. + */ + src: Scalars["URL"]["output"]; + /** + * The location of the transformed image as a URL. + * + * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. + * Otherwise any transformations which an image type doesn't support will be ignored. + * + * @deprecated Use `url(transform:)` instead + */ + transformedSrc: Scalars["URL"]["output"]; + /** + * The location of the image as a URL. + * + * If no transform options are specified, then the original image will be preserved including any pre-applied transforms. + * + * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. + * + * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). + */ + url: Scalars["URL"]["output"]; + /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ + width?: Maybe; +}; + +/** Represents an image resource. */ +export type ImageMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** Represents an image resource. */ +export type ImageMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents an image resource. */ +export type ImagePrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** Represents an image resource. */ +export type ImagePrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents an image resource. */ +export type ImageTransformedSrcArgs = { + crop?: InputMaybe; + maxHeight?: InputMaybe; + maxWidth?: InputMaybe; + preferredContentType?: InputMaybe; + scale?: InputMaybe; +}; + +/** Represents an image resource. */ +export type ImageUrlArgs = { + transform?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Images. + */ +export type ImageConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ImageEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** List of supported image content types. */ +export type ImageContentType = + /** A JPG image. */ + | "JPG" + /** A PNG image. */ + | "PNG" + /** A WEBP image. */ + | "WEBP"; + +/** + * An auto-generated type which holds one Image and a cursor during pagination. + */ +export type ImageEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ImageEdge. */ + node: Image; +}; + +/** The input fields for an image. */ +export type ImageInput = { + /** A word or phrase to share the nature or contents of an image. */ + altText?: InputMaybe; + /** A globally-unique ID. */ + id?: InputMaybe; + /** The URL of the image. May be a staged upload URL. */ + src?: InputMaybe; +}; + +/** + * The available options for transforming an image. + * + * All transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored. + */ +export type ImageTransformInput = { + /** + * The region of the image to remain after cropping. + * Must be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal. + * The `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while + * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result + * in an image with a width of 5 and height of 10, where the right side of the image is removed. + */ + crop?: InputMaybe; + /** + * Image height in pixels between 1 and 5760. + */ + maxHeight?: InputMaybe; + /** + * Image width in pixels between 1 and 5760. + */ + maxWidth?: InputMaybe; + /** + * Convert the source image into the preferred content type. + * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. + */ + preferredContentType?: InputMaybe; + /** + * Image size multiplier for high-resolution retina displays. Must be within 1..3. + */ + scale?: InputMaybe; +}; + +/** + * A parameter to upload an image. + * + * Deprecated in favor of + * [StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter), + * which is used in + * [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget) + * and returned by the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate). + */ +export type ImageUploadParameter = { + /** The parameter name. */ + name: Scalars["String"]["output"]; + /** The parameter value. */ + value: Scalars["String"]["output"]; +}; + +/** The input fields for the incoming line item. */ +export type IncomingRequestLineItemInput = { + /** The ID of the rejected line item. */ + fulfillmentOrderLineItemId: Scalars["ID"]["input"]; + /** The rejection message of the line item. */ + message?: InputMaybe; +}; + +/** Return type for `inventoryActivate` mutation. */ +export type InventoryActivatePayload = { + /** The inventory level that was activated. */ + inventoryLevel?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for items and their adjustments. */ +export type InventoryAdjustItemInput = { + /** The change applied to the `available` quantity of the item at the location. */ + availableDelta: Scalars["Int"]["input"]; + /** ID of the inventory item to adjust. */ + inventoryItemId: Scalars["ID"]["input"]; +}; + +/** The input fields required to adjust inventory quantities. */ +export type InventoryAdjustQuantitiesInput = { + /** The quantity changes of items at locations to be made. */ + changes: Array; + /** The quantity name to be adjusted. */ + name: Scalars["String"]["input"]; + /** The reason for the quantity changes. */ + reason: Scalars["String"]["input"]; + /** The reference document URI for the changes. Used to denote what's causing the change. */ + referenceDocumentUri?: InputMaybe; +}; + +/** Return type for `inventoryAdjustQuantities` mutation. */ +export type InventoryAdjustQuantitiesPayload = { + /** The group of changes made by the operation. */ + inventoryAdjustmentGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `InventoryAdjustQuantities`. */ +export type InventoryAdjustQuantitiesUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `InventoryAdjustQuantitiesUserError`. */ +export type InventoryAdjustQuantitiesUserErrorCode = + /** The quantities couldn't be adjusted. Try again. */ + | "ADJUST_QUANTITIES_FAILED" + /** Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API. */ + | "INTERNAL_LEDGER_DOCUMENT" + /** A ledger document URI is not allowed when adjusting available. */ + | "INVALID_AVAILABLE_DOCUMENT" + /** The specified inventory item could not be found. */ + | "INVALID_INVENTORY_ITEM" + /** The specified ledger document is invalid. */ + | "INVALID_LEDGER_DOCUMENT" + /** The specified location could not be found. */ + | "INVALID_LOCATION" + /** A ledger document URI is required except when adjusting available. */ + | "INVALID_QUANTITY_DOCUMENT" + /** The specified quantity name is invalid. */ + | "INVALID_QUANTITY_NAME" + /** The quantity can't be higher than 2,000,000,000. */ + | "INVALID_QUANTITY_TOO_HIGH" + /** The quantity can't be lower than -2,000,000,000. */ + | "INVALID_QUANTITY_TOO_LOW" + /** The specified reason is invalid. */ + | "INVALID_REASON" + /** The specified reference document is invalid. */ + | "INVALID_REFERENCE_DOCUMENT" + /** The inventory item is not stocked at the location. */ + | "ITEM_NOT_STOCKED_AT_LOCATION" + /** All changes must have the same ledger document URI or, in the case of adjusting available, no ledger document URI. */ + | "MAX_ONE_LEDGER_DOCUMENT" + /** The specified inventory item is not allowed to be adjusted via API. */ + | "NON_MUTABLE_INVENTORY_ITEM"; + +/** The input fields required to adjust the inventory quantity. */ +export type InventoryAdjustQuantityInput = { + /** The change applied to the `available` quantity of the item at the location. */ + availableDelta: Scalars["Int"]["input"]; + /** ID of the inventory level to adjust. */ + inventoryLevelId: Scalars["ID"]["input"]; +}; + +/** Return type for `inventoryAdjustQuantity` mutation. */ +export type InventoryAdjustQuantityPayload = { + /** Represents the updated inventory quantity of an inventory item at a specific location. */ + inventoryLevel?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents a group of adjustments made as part of the same operation. + */ +export type InventoryAdjustmentGroup = Node & { + /** The app that triggered the inventory event, if one exists. */ + app?: Maybe; + /** The set of inventory quantity changes that occurred in the inventory event. */ + changes: Array; + /** The date and time the inventory adjustment group was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The reason for the group of adjustments. */ + reason: Scalars["String"]["output"]; + /** The reference document URI for the changes. Denotes what's causing the change. */ + referenceDocumentUri?: Maybe; + /** The staff member associated with the inventory event. */ + staffMember?: Maybe; +}; + +/** + * Represents a group of adjustments made as part of the same operation. + */ +export type InventoryAdjustmentGroupChangesArgs = { + inventoryItemIds?: InputMaybe>; + locationIds?: InputMaybe>; + quantityNames?: InputMaybe>; +}; + +/** Return type for `inventoryBulkAdjustQuantityAtLocation` mutation. */ +export type InventoryBulkAdjustQuantityAtLocationPayload = { + /** Represents the updated inventory quantities of an inventory item at the location. */ + inventoryLevels?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields to specify whether the inventory item should be activated or not at the specified location. + */ +export type InventoryBulkToggleActivationInput = { + /** Whether the inventory item can be stocked at the specified location. To deactivate, set the value to false which removes an inventory item's quantities from that location, and turns off inventory at that location. */ + activate: Scalars["Boolean"]["input"]; + /** The ID of the location to modify the inventory item's stocked status. */ + locationId: Scalars["ID"]["input"]; +}; + +/** Return type for `inventoryBulkToggleActivation` mutation. */ +export type InventoryBulkToggleActivationPayload = { + /** The inventory item that was updated. */ + inventoryItem?: Maybe; + /** The activated inventory levels. */ + inventoryLevels?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurred while setting the activation status of an inventory item. */ +export type InventoryBulkToggleActivationUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `InventoryBulkToggleActivationUserError`. */ +export type InventoryBulkToggleActivationUserErrorCode = + /** Cannot unstock an inventory item from the only location at which it is stocked. */ + | "CANNOT_DEACTIVATE_FROM_ONLY_LOCATION" + /** Cannot unstock this inventory item from this location because it has committed and incoming quantities. */ + | "COMMITTED_AND_INCOMING_INVENTORY_AT_LOCATION" + /** Cannot unstock this inventory item from this location because it has committed quantities. */ + | "COMMITTED_INVENTORY_AT_LOCATION" + /** Failed to stock this inventory item at this location. */ + | "FAILED_TO_STOCK_AT_LOCATION" + /** Failed to unstock this inventory item from this location. */ + | "FAILED_TO_UNSTOCK_FROM_LOCATION" + /** An error occurred while setting the activation status. */ + | "GENERIC_ERROR" + /** Cannot unstock this inventory item from this location because it has incoming quantities. */ + | "INCOMING_INVENTORY_AT_LOCATION" + /** The inventory item was not found. */ + | "INVENTORY_ITEM_NOT_FOUND" + /** Cannot stock this inventory item at this location because it is managed by a third-party fulfillment service. */ + | "INVENTORY_MANAGED_BY_3RD_PARTY" + /** Cannot stock this inventory item at this location because it is managed by Shopify. */ + | "INVENTORY_MANAGED_BY_SHOPIFY" + /** The location was not found. */ + | "LOCATION_NOT_FOUND" + /** Cannot stock this inventory item at this location because the variant is missing a SKU. */ + | "MISSING_SKU" + /** Cannot unstock this inventory item from this location because it has unavailable quantities. */ + | "RESERVED_INVENTORY_AT_LOCATION"; + +/** + * Represents a change in an inventory quantity of an inventory item at a location. + */ +export type InventoryChange = { + /** The amount by which the inventory quantity was changed. */ + delta: Scalars["Int"]["output"]; + /** The inventory item associated with this inventory change. */ + item?: Maybe; + /** The ledger document URI for the change. Denotes who the change is applied to. */ + ledgerDocumentUri?: Maybe; + /** The location associated with this inventory change. */ + location?: Maybe; + /** The name of the inventory quantity that was changed. */ + name: Scalars["String"]["output"]; + /** The quantity of named inventory after the change. */ + quantityAfterChange?: Maybe; +}; + +/** + * The input fields for the change to be made to an inventory item at a location. + */ +export type InventoryChangeInput = { + /** The amount by which the inventory quantity will be changed. */ + delta: Scalars["Int"]["input"]; + /** Specifies the inventory item to which the change will be applied. */ + inventoryItemId: Scalars["ID"]["input"]; + /** The ledger document URI to which the quantity change is being applied. Not allowed for 'available' and required for other quantity names. */ + ledgerDocumentUri?: InputMaybe; + /** Specifies the location at which the change will be applied. */ + locationId: Scalars["ID"]["input"]; +}; + +/** Return type for `inventoryDeactivate` mutation. */ +export type InventoryDeactivatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents the goods available to be shipped to a customer. + * It holds essential information about the goods, including SKU and whether it is tracked. + */ +export type InventoryItem = LegacyInteroperability & Node & { + /** The ISO 3166-1 alpha-2 country code of where the item originated from. */ + countryCodeOfOrigin?: Maybe; + /** A list of country specific harmonized system codes. */ + countryHarmonizedSystemCodes: CountryHarmonizedSystemCodeConnection; + /** The date and time when the inventory item was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The number of inventory items that share the same SKU with this item. */ + duplicateSkuCount: Scalars["Int"]["output"]; + /** The harmonized system code of the item. */ + harmonizedSystemCode?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The URL that points to the inventory history for the item. */ + inventoryHistoryUrl?: Maybe; + /** The inventory item's quantities at the specified location. */ + inventoryLevel?: Maybe; + /** A list of the inventory item's quantities for each location that the inventory item can be stocked at. */ + inventoryLevels: InventoryLevelConnection; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The number of locations where this inventory item is stocked. */ + locationsCount: Scalars["Int"]["output"]; + /** The ISO 3166-2 alpha-2 province code of where the item originated from. */ + provinceCodeOfOrigin?: Maybe; + /** Whether the inventory item requires shipping. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** Inventory item SKU. Case-sensitive string. */ + sku?: Maybe; + /** Whether inventory levels are tracked for the item. */ + tracked: Scalars["Boolean"]["output"]; + /** Whether the value of the `tracked` field for the inventory item can be changed. */ + trackedEditable: EditableProperty; + /** Unit cost associated with the inventory item. Note: the user must have "View product costs" permission granted in order to access this field once product granular permissions are enabled. */ + unitCost?: Maybe; + /** The date and time when the inventory item was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The variant that owns this inventory item. */ + variant: ProductVariant; +}; + +/** + * Represents the goods available to be shipped to a customer. + * It holds essential information about the goods, including SKU and whether it is tracked. + */ +export type InventoryItemCountryHarmonizedSystemCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents the goods available to be shipped to a customer. + * It holds essential information about the goods, including SKU and whether it is tracked. + */ +export type InventoryItemInventoryLevelArgs = { + locationId: Scalars["ID"]["input"]; +}; + +/** + * Represents the goods available to be shipped to a customer. + * It holds essential information about the goods, including SKU and whether it is tracked. + */ +export type InventoryItemInventoryLevelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple InventoryItems. + */ +export type InventoryItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in InventoryItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one InventoryItem and a cursor during pagination. + */ +export type InventoryItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of InventoryItemEdge. */ + node: InventoryItem; +}; + +/** The input fields for an inventory item. */ +export type InventoryItemInput = { + /** Unit cost associated with the inventory item, the currency is the shop's default currency. */ + cost?: InputMaybe; + /** Whether the inventory item is tracked. */ + tracked?: InputMaybe; +}; + +/** The input fields for an inventory item. */ +export type InventoryItemUpdateInput = { + /** Unit cost associated with the inventory item, the currency is the shop's default currency. */ + cost?: InputMaybe; + /** The ISO 3166-1 alpha-2 country code of where the item originated from. */ + countryCodeOfOrigin?: InputMaybe; + /** List of country-specific harmonized system codes. */ + countryHarmonizedSystemCodes?: InputMaybe< + Array + >; + /** The harmonized system code of the inventory item. This must be a number between 6 and 13 digits. */ + harmonizedSystemCode?: InputMaybe; + /** The ISO 3166-2 alpha-2 province/state code of where the item originated from. */ + provinceCodeOfOrigin?: InputMaybe; + /** Whether the inventory item is tracked. The value must be true to adjust the item's inventory levels. */ + tracked?: InputMaybe; +}; + +/** Return type for `inventoryItemUpdate` mutation. */ +export type InventoryItemUpdatePayload = { + /** The inventory item that was updated. */ + inventoryItem?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The quantities of an inventory item that are related to a specific location. + */ +export type InventoryLevel = Node & { + /** + * The quantity of inventory items that are available at the inventory level's associated location. + * @deprecated Use `quantities` instead. + */ + available: Scalars["Int"]["output"]; + /** Whether the inventory items associated with the inventory level can be deactivated. */ + canDeactivate: Scalars["Boolean"]["output"]; + /** The date and time when the inventory level was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated. */ + deactivationAlert?: Maybe; + /** + * Describes, in HTML with embedded URLs, either the impact of deactivating the inventory level or why the inventory level can't be deactivated. + * @deprecated Use `deactivationAlert` instead. + */ + deactivationAlertHtml?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The quantity of inventory items that are going to the inventory level's associated location. + * @deprecated Use `quantities` instead. + */ + incoming: Scalars["Int"]["output"]; + /** Inventory item associated with the inventory level. */ + item: InventoryItem; + /** The location associated with the inventory level. */ + location: Location; + /** Quantities for the requested names. */ + quantities: Array; + /** The date and time when the inventory level was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * The quantities of an inventory item that are related to a specific location. + */ +export type InventoryLevelQuantitiesArgs = { + names: Array; +}; + +/** + * An auto-generated type for paginating through multiple InventoryLevels. + */ +export type InventoryLevelConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in InventoryLevelEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one InventoryLevel and a cursor during pagination. + */ +export type InventoryLevelEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of InventoryLevelEdge. */ + node: InventoryLevel; +}; + +/** The input fields for an inventory level. */ +export type InventoryLevelInput = { + /** The available quantity of an inventory item at a location. */ + availableQuantity: Scalars["Int"]["input"]; + /** The ID of a location. */ + locationId: Scalars["ID"]["input"]; +}; + +/** The input fields required to move inventory quantities. */ +export type InventoryMoveQuantitiesInput = { + /** The quantity changes of items at locations to be made. */ + changes: Array; + /** The reason for the quantity changes. */ + reason: Scalars["String"]["input"]; + /** The reference document URI for the changes. Used to denote what's causing the change. */ + referenceDocumentUri: Scalars["String"]["input"]; +}; + +/** Return type for `inventoryMoveQuantities` mutation. */ +export type InventoryMoveQuantitiesPayload = { + /** The group of changes made by the operation. */ + inventoryAdjustmentGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `InventoryMoveQuantities`. */ +export type InventoryMoveQuantitiesUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `InventoryMoveQuantitiesUserError`. */ +export type InventoryMoveQuantitiesUserErrorCode = + /** The quantities can't be moved between different locations. */ + | "DIFFERENT_LOCATIONS" + /** Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API. */ + | "INTERNAL_LEDGER_DOCUMENT" + /** A ledger document URI is not allowed when adjusting available. */ + | "INVALID_AVAILABLE_DOCUMENT" + /** The specified inventory item could not be found. */ + | "INVALID_INVENTORY_ITEM" + /** The specified ledger document is invalid. */ + | "INVALID_LEDGER_DOCUMENT" + /** The specified location could not be found. */ + | "INVALID_LOCATION" + /** A ledger document URI is required except when adjusting available. */ + | "INVALID_QUANTITY_DOCUMENT" + /** The specified quantity name is invalid. */ + | "INVALID_QUANTITY_NAME" + /** The quantity can't be negative. */ + | "INVALID_QUANTITY_NEGATIVE" + /** The quantity can't be higher than 2,000,000,000. */ + | "INVALID_QUANTITY_TOO_HIGH" + /** The specified reason is invalid. */ + | "INVALID_REASON" + /** The specified reference document is invalid. */ + | "INVALID_REFERENCE_DOCUMENT" + /** The inventory item is not stocked at the location. */ + | "ITEM_NOT_STOCKED_AT_LOCATION" + /** Only a maximum of 2 ledger document URIs across all changes is allowed. */ + | "MAXIMUM_LEDGER_DOCUMENT_URIS" + /** The quantities couldn't be moved. Try again. */ + | "MOVE_QUANTITIES_FAILED" + /** The specified inventory item is not allowed to be adjusted via API. */ + | "NON_MUTABLE_INVENTORY_ITEM" + /** The quantity names for each change can't be the same. */ + | "SAME_QUANTITY_NAME"; + +/** + * Represents the change to be made to an inventory item at a location. + * The change can either involve the same quantity name between different locations, + * or involve different quantity names between the same location. + */ +export type InventoryMoveQuantityChange = { + /** The location, quantity name, and ledger document from where the move will be made. */ + from: InventoryMoveQuantityTerminalInput; + /** Specifies the inventory item to which the change will be applied. */ + inventoryItemId: Scalars["ID"]["input"]; + /** The amount by which the inventory quantity will be changed. */ + quantity: Scalars["Int"]["input"]; + /** The location, quantity name, and ledger document to where the move will be made. */ + to: InventoryMoveQuantityTerminalInput; +}; + +/** + * The input fields representing the change to be made to an inventory item at a location. + */ +export type InventoryMoveQuantityTerminalInput = { + /** The ledger document URI for the quantity move. Not allowed for 'available' and required for other quantity names. */ + ledgerDocumentUri?: InputMaybe; + /** Specifies the location at which the change will be applied. */ + locationId: Scalars["ID"]["input"]; + /** The quantity name to be moved. */ + name: Scalars["String"]["input"]; +}; + +/** General inventory properties for the shop. */ +export type InventoryProperties = { + /** All the quantity names. */ + quantityNames: Array; +}; + +/** + * Represents a quantity of an inventory item at a specific location, for a specific name. + */ +export type InventoryQuantity = { + /** The name that identifies the inventory quantity. */ + name: Scalars["String"]["output"]; + /** The quantity for the quantity name. */ + quantity: Scalars["Int"]["output"]; + /** When the quantity was last updated. */ + updatedAt?: Maybe; +}; + +/** Details about an individual quantity name. */ +export type InventoryQuantityName = { + /** List of quantity names that this quantity name belongs to. */ + belongsTo: Array; + /** List of quantity names that comprise this quantity name. */ + comprises: Array; + /** The i18n-friendly display name of the quantity. */ + displayName?: Maybe; + /** Whether the quantity name has been used by the merchant. */ + isInUse: Scalars["Boolean"]["output"]; + /** The quantity name as used by the API. */ + name: Scalars["String"]["output"]; +}; + +/** The input fields required to set inventory on hand quantities. */ +export type InventorySetOnHandQuantitiesInput = { + /** The reason for the quantity changes. */ + reason: Scalars["String"]["input"]; + /** The reference document URI for the changes. Used to denote what's causing the change. */ + referenceDocumentUri?: InputMaybe; + /** The value to which the on hand quantity will be set. */ + setQuantities: Array; +}; + +/** Return type for `inventorySetOnHandQuantities` mutation. */ +export type InventorySetOnHandQuantitiesPayload = { + /** The group of changes made by the operation. */ + inventoryAdjustmentGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `InventorySetOnHandQuantities`. */ +export type InventorySetOnHandQuantitiesUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `InventorySetOnHandQuantitiesUserError`. */ +export type InventorySetOnHandQuantitiesUserErrorCode = + /** The specified inventory item could not be found. */ + | "INVALID_INVENTORY_ITEM" + /** The specified location could not be found. */ + | "INVALID_LOCATION" + /** The quantity can't be negative. */ + | "INVALID_QUANTITY_NEGATIVE" + /** The total quantity can't be higher than 1,000,000,000. */ + | "INVALID_QUANTITY_TOO_HIGH" + /** The specified reason is invalid. */ + | "INVALID_REASON" + /** The specified reference document is invalid. */ + | "INVALID_REFERENCE_DOCUMENT" + /** The inventory item is not stocked at the location. */ + | "ITEM_NOT_STOCKED_AT_LOCATION" + /** The specified inventory item is not allowed to be adjusted via API. */ + | "NON_MUTABLE_INVENTORY_ITEM" + /** The on-hand quantities couldn't be set. Try again. */ + | "SET_ON_HAND_QUANTITIES_FAILED"; + +/** + * The input fields for the quantity to be set for an inventory item at a location. + */ +export type InventorySetQuantityInput = { + /** Specifies the inventory item to which the quantity will be set. */ + inventoryItemId: Scalars["ID"]["input"]; + /** Specifies the location at which the quantity will be set. */ + locationId: Scalars["ID"]["input"]; + /** The quantity to which the inventory quantity will be set. */ + quantity: Scalars["Int"]["input"]; +}; + +/** A job corresponds to some long running task that the client should poll for status. */ +export type Job = { + /** This indicates if the job is still queued or has been run. */ + done: Scalars["Boolean"]["output"]; + /** A globally-unique ID that's returned when running an asynchronous mutation. */ + id: Scalars["ID"]["output"]; + /** This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job. */ + query?: Maybe; +}; + +/** A job corresponds to some long running task that the client should poll for status. */ +export type JobResult = { + /** This indicates if the job is still queued or has been run. */ + done: Scalars["Boolean"]["output"]; + /** A globally-unique ID that's returned when running an asynchronous mutation. */ + id: Scalars["ID"]["output"]; +}; + +/** ISO 639-1 language codes supported by Shopify. */ +export type LanguageCode = + /** Afrikaans. */ + | "AF" + /** Akan. */ + | "AK" + /** Amharic. */ + | "AM" + /** Arabic. */ + | "AR" + /** Assamese. */ + | "AS" + /** Azerbaijani. */ + | "AZ" + /** Belarusian. */ + | "BE" + /** Bulgarian. */ + | "BG" + /** Bambara. */ + | "BM" + /** Bangla. */ + | "BN" + /** Tibetan. */ + | "BO" + /** Breton. */ + | "BR" + /** Bosnian. */ + | "BS" + /** Catalan. */ + | "CA" + /** Chechen. */ + | "CE" + /** Czech. */ + | "CS" + /** Church Slavic. */ + | "CU" + /** Welsh. */ + | "CY" + /** Danish. */ + | "DA" + /** German. */ + | "DE" + /** Dzongkha. */ + | "DZ" + /** Ewe. */ + | "EE" + /** Greek. */ + | "EL" + /** English. */ + | "EN" + /** Esperanto. */ + | "EO" + /** Spanish. */ + | "ES" + /** Estonian. */ + | "ET" + /** Basque. */ + | "EU" + /** Persian. */ + | "FA" + /** Fulah. */ + | "FF" + /** Finnish. */ + | "FI" + /** Faroese. */ + | "FO" + /** French. */ + | "FR" + /** Western Frisian. */ + | "FY" + /** Irish. */ + | "GA" + /** Scottish Gaelic. */ + | "GD" + /** Galician. */ + | "GL" + /** Gujarati. */ + | "GU" + /** Manx. */ + | "GV" + /** Hausa. */ + | "HA" + /** Hebrew. */ + | "HE" + /** Hindi. */ + | "HI" + /** Croatian. */ + | "HR" + /** Hungarian. */ + | "HU" + /** Armenian. */ + | "HY" + /** Interlingua. */ + | "IA" + /** Indonesian. */ + | "ID" + /** Igbo. */ + | "IG" + /** Sichuan Yi. */ + | "II" + /** Icelandic. */ + | "IS" + /** Italian. */ + | "IT" + /** Japanese. */ + | "JA" + /** Javanese. */ + | "JV" + /** Georgian. */ + | "KA" + /** Kikuyu. */ + | "KI" + /** Kazakh. */ + | "KK" + /** Kalaallisut. */ + | "KL" + /** Khmer. */ + | "KM" + /** Kannada. */ + | "KN" + /** Korean. */ + | "KO" + /** Kashmiri. */ + | "KS" + /** Kurdish. */ + | "KU" + /** Cornish. */ + | "KW" + /** Kyrgyz. */ + | "KY" + /** Luxembourgish. */ + | "LB" + /** Ganda. */ + | "LG" + /** Lingala. */ + | "LN" + /** Lao. */ + | "LO" + /** Lithuanian. */ + | "LT" + /** Luba-Katanga. */ + | "LU" + /** Latvian. */ + | "LV" + /** Malagasy. */ + | "MG" + /** Māori. */ + | "MI" + /** Macedonian. */ + | "MK" + /** Malayalam. */ + | "ML" + /** Mongolian. */ + | "MN" + /** Marathi. */ + | "MR" + /** Malay. */ + | "MS" + /** Maltese. */ + | "MT" + /** Burmese. */ + | "MY" + /** Norwegian (Bokmål). */ + | "NB" + /** North Ndebele. */ + | "ND" + /** Nepali. */ + | "NE" + /** Dutch. */ + | "NL" + /** Norwegian Nynorsk. */ + | "NN" + /** Norwegian. */ + | "NO" + /** Oromo. */ + | "OM" + /** Odia. */ + | "OR" + /** Ossetic. */ + | "OS" + /** Punjabi. */ + | "PA" + /** Polish. */ + | "PL" + /** Pashto. */ + | "PS" + /** Portuguese. */ + | "PT" + /** Portuguese (Brazil). */ + | "PT_BR" + /** Portuguese (Portugal). */ + | "PT_PT" + /** Quechua. */ + | "QU" + /** Romansh. */ + | "RM" + /** Rundi. */ + | "RN" + /** Romanian. */ + | "RO" + /** Russian. */ + | "RU" + /** Kinyarwanda. */ + | "RW" + /** Sindhi. */ + | "SD" + /** Northern Sami. */ + | "SE" + /** Sango. */ + | "SG" + /** Sinhala. */ + | "SI" + /** Slovak. */ + | "SK" + /** Slovenian. */ + | "SL" + /** Shona. */ + | "SN" + /** Somali. */ + | "SO" + /** Albanian. */ + | "SQ" + /** Serbian. */ + | "SR" + /** Sundanese. */ + | "SU" + /** Swedish. */ + | "SV" + /** Swahili. */ + | "SW" + /** Tamil. */ + | "TA" + /** Telugu. */ + | "TE" + /** Tajik. */ + | "TG" + /** Thai. */ + | "TH" + /** Tigrinya. */ + | "TI" + /** Turkmen. */ + | "TK" + /** Tongan. */ + | "TO" + /** Turkish. */ + | "TR" + /** Tatar. */ + | "TT" + /** Uyghur. */ + | "UG" + /** Ukrainian. */ + | "UK" + /** Urdu. */ + | "UR" + /** Uzbek. */ + | "UZ" + /** Vietnamese. */ + | "VI" + /** Volapük. */ + | "VO" + /** Wolof. */ + | "WO" + /** Xhosa. */ + | "XH" + /** Yiddish. */ + | "YI" + /** Yoruba. */ + | "YO" + /** Chinese. */ + | "ZH" + /** Chinese (Simplified). */ + | "ZH_CN" + /** Chinese (Traditional). */ + | "ZH_TW" + /** Zulu. */ + | "ZU"; + +/** + * Interoperability metadata for types that directly correspond to a REST Admin API resource. + * For example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API. + */ +export type LegacyInteroperability = { + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; +}; + +/** Units of measurement for length. */ +export type LengthUnit = + /** 100 centimeters equals 1 meter. */ + | "CENTIMETERS" + /** Imperial system unit of length. */ + | "FEET" + /** 12 inches equals 1 foot. */ + | "INCHES" + /** Metric system unit of length. */ + | "METERS" + /** 1000 millimeters equals 1 meter. */ + | "MILLIMETERS" + /** 1 yard equals 3 feet. */ + | "YARDS"; + +/** + * The total number of pending orders on a shop if less then a maximum, or that maximum. + * The atMax field indicates when this maximum has been reached. + */ +export type LimitedPendingOrderCount = { + /** This is set when the number of pending orders has reached the maximum. */ + atMax: Scalars["Boolean"]["output"]; + /** + * The number of pendings orders on the shop. + * Limited to a maximum of 10000. + */ + count: Scalars["Int"]["output"]; +}; + +/** Represents individual products and quantities purchased in the associated order. */ +export type LineItem = Node & { + /** + * Whether the line item can be restocked. + * @deprecated Use `restockable` instead. + */ + canRestock: Scalars["Boolean"]["output"]; + /** The subscription contract associated with this line item. */ + contract?: Maybe; + /** The line item's quantity, minus the removed quantity. */ + currentQuantity: Scalars["Int"]["output"]; + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** The discounts that have been allocated onto the line item by discount applications, not including order edits and refunds. */ + discountAllocations: Array; + /** + * The total line price after discounts are applied, in shop currency. + * @deprecated Use `discountedTotalSet` instead. + */ + discountedTotal: Scalars["Money"]["output"]; + /** The total line price after discounts are applied, in shop and presentment currencies. */ + discountedTotalSet: MoneyBag; + /** + * The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order. + * @deprecated Use `discountedUnitPriceSet` instead. + */ + discountedUnitPrice: Scalars["Money"]["output"]; + /** The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order. */ + discountedUnitPriceSet: MoneyBag; + /** The duties associated with the line item. */ + duties: Array; + /** + * The total number of units to fulfill. + * @deprecated Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead. + */ + fulfillableQuantity: Scalars["Int"]["output"]; + /** + * The fulfillment service that stocks the product variant belonging to a line item. + * + * This is a third-party fulfillment service in the following scenarios: + * + * **Scenario 1** + * - The product variant is stocked by a single fulfillment service. + * - The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`. + * + * **Scenario 2** + * - Multiple fulfillment services stock the product variant. + * - The last time that the line item was unfulfilled, it was awaiting fulfillment by a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`. + * + * If none of the above conditions are met, then the fulfillment service has the `manual` handle. + * + * @deprecated + * The [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked. + * + * If you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available. + * + * Altering the locations which stock a product variant won't change the value of this field for existing orders. + * + * Learn about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states). + */ + fulfillmentService?: Maybe; + /** + * The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, + * 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. + * + * @deprecated Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead + */ + fulfillmentStatus: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated to the line item's variant. */ + image?: Maybe; + /** The line item group associated to the line item. */ + lineItemGroup?: Maybe; + /** Whether the line item can be edited or not. */ + merchantEditable: Scalars["Boolean"]["output"]; + /** The title of the product, optionally appended with the title of the variant (if applicable). */ + name: Scalars["String"]["output"]; + /** The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details. */ + nonFulfillableQuantity: Scalars["Int"]["output"]; + /** + * The total price without discounts applied, in shop currency. + * This value is based on the unit price of the variant x quantity. + * + * @deprecated Use `originalTotalSet` instead. + */ + originalTotal: Scalars["Money"]["output"]; + /** The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity. */ + originalTotalSet: MoneyBag; + /** + * The variant unit price without discounts applied, in shop currency. + * @deprecated Use `originalUnitPriceSet` instead. + */ + originalUnitPrice: Scalars["Money"]["output"]; + /** The variant unit price without discounts applied, in shop and presentment currencies. */ + originalUnitPriceSet: MoneyBag; + /** The Product object associated with this line item's variant. */ + product?: Maybe; + /** The number of variant units ordered. */ + quantity: Scalars["Int"]["output"]; + /** The line item's quantity, minus the removed quantity. */ + refundableQuantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** Whether the line item can be restocked. */ + restockable: Scalars["Boolean"]["output"]; + /** The selling plan details associated with the line item. */ + sellingPlan?: Maybe; + /** The variant SKU number. */ + sku?: Maybe; + /** Staff attributed to the line item. */ + staffMember?: Maybe; + /** The taxes charged for this line item. */ + taxLines: Array; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product at time of order creation. */ + title: Scalars["String"]["output"]; + /** + * The total amount of the discount allocated to the line item in the shop currency. + * @deprecated Use `totalDiscountSet` instead. + */ + totalDiscount: Scalars["Money"]["output"]; + /** The total amount of the discount that's allocated to the line item, in the shop and presentment currencies. This field must be explicitly set using draft orders, Shopify scripts, or the API. */ + totalDiscountSet: MoneyBag; + /** + * The total discounted value of unfulfilled units, in shop currency. + * @deprecated Use `unfulfilledDiscountedTotalSet` instead. + */ + unfulfilledDiscountedTotal: Scalars["Money"]["output"]; + /** The total discounted value of unfulfilled units, in shop and presentment currencies. */ + unfulfilledDiscountedTotalSet: MoneyBag; + /** + * The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency. + * @deprecated Use `unfulfilledOriginalTotalSet` instead. + */ + unfulfilledOriginalTotal: Scalars["Money"]["output"]; + /** The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies. */ + unfulfilledOriginalTotalSet: MoneyBag; + /** The number of units not yet fulfilled. */ + unfulfilledQuantity: Scalars["Int"]["output"]; + /** The Variant object associated with this line item. */ + variant?: Maybe; + /** The title of the variant at time of order creation. */ + variantTitle?: Maybe; + /** The name of the vendor who made the variant. */ + vendor?: Maybe; +}; + +/** Represents individual products and quantities purchased in the associated order. */ +export type LineItemTaxLinesArgs = { + first?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple LineItems. + */ +export type LineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in LineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one LineItem and a cursor during pagination. + */ +export type LineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of LineItemEdge. */ + node: LineItem; +}; + +/** A line item group (bundle) to which a line item belongs to. */ +export type LineItemGroup = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Quantity of the line item group on the order. */ + quantity: Scalars["Int"]["output"]; + /** Title of the line item group. */ + title: Scalars["String"]["output"]; +}; + +/** Represents a single line item on an order. */ +export type LineItemMutable = Node & { + /** + * Whether the line item can be restocked. + * @deprecated Use `restockable` instead. + */ + canRestock: Scalars["Boolean"]["output"]; + /** A list of attributes that represent custom features or special requests. */ + customAttributes: Array; + /** The discounts that have been allocated onto the line item by discount applications. */ + discountAllocations: Array; + /** + * The total line price after discounts are applied, in shop currency. + * @deprecated Use `discountedTotalSet` instead. + */ + discountedTotal: Scalars["Money"]["output"]; + /** The total line price after discounts are applied, in shop and presentment currencies. */ + discountedTotalSet: MoneyBag; + /** + * The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order. + * @deprecated Use `discountedUnitPriceSet` instead. + */ + discountedUnitPrice: Scalars["Money"]["output"]; + /** The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order. */ + discountedUnitPriceSet: MoneyBag; + /** The total number of units to fulfill. */ + fulfillableQuantity: Scalars["Int"]["output"]; + /** + * The service provider that fulfills the line item. + * + * Deleted fulfillment services will return null. + */ + fulfillmentService?: Maybe; + /** + * The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity, + * 'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise. + */ + fulfillmentStatus: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated to the line item's variant. */ + image?: Maybe; + /** Whether the line item can be edited or not. */ + merchantEditable: Scalars["Boolean"]["output"]; + /** The name of the product. */ + name: Scalars["String"]["output"]; + /** The total number of units that can't be fulfilled. For example, if items have been refunded, or the item isn't something that can be fulfilled, like a tip. */ + nonFulfillableQuantity: Scalars["Int"]["output"]; + /** + * The total price without any discounts applied, in shop currency. ""This value is based on the unit price of the variant x quantity. + * + * @deprecated Use `originalTotalSet` instead. + */ + originalTotal: Scalars["Money"]["output"]; + /** The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity. */ + originalTotalSet: MoneyBag; + /** + * The variant unit price without discounts applied, in shop currency. + * @deprecated Use `originalUnitPriceSet` instead. + */ + originalUnitPrice: Scalars["Money"]["output"]; + /** The variant unit price without discounts applied, in shop and presentment currencies. */ + originalUnitPriceSet: MoneyBag; + /** The Product object associated with this line item's variant. */ + product?: Maybe; + /** The number of variant units ordered. */ + quantity: Scalars["Int"]["output"]; + /** The line item's quantity, minus the removed quantity. */ + refundableQuantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** Whether the line item can be restocked. */ + restockable: Scalars["Boolean"]["output"]; + /** The variant SKU number. */ + sku?: Maybe; + /** Staff attributed to the line item. */ + staffMember?: Maybe; + /** The TaxLine object connected to this line item. */ + taxLines: Array; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product. */ + title: Scalars["String"]["output"]; + /** + * The total amount of the discount allocated to the line item in the shop currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information. + * @deprecated Use `totalDiscountSet` instead. + */ + totalDiscount: Scalars["Money"]["output"]; + /** The total amount of the discount allocated to the line item in the presentment currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information. */ + totalDiscountSet: MoneyBag; + /** + * The total discounted value of unfulfilled units, in shop currency. + * @deprecated Use `unfulfilledDiscountedTotalSet` instead. + */ + unfulfilledDiscountedTotal: Scalars["Money"]["output"]; + /** The total discounted value of unfulfilled units, in shop and presentment currencies. */ + unfulfilledDiscountedTotalSet: MoneyBag; + /** + * The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency. + * @deprecated Use `unfulfilledOriginalTotalSet` instead. + */ + unfulfilledOriginalTotal: Scalars["Money"]["output"]; + /** The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies. */ + unfulfilledOriginalTotalSet: MoneyBag; + /** The number of units not yet fulfilled. */ + unfulfilledQuantity: Scalars["Int"]["output"]; + /** The Variant object associated with this line item. */ + variant?: Maybe; + /** The name of the variant. */ + variantTitle?: Maybe; + /** The name of the vendor who made the variant. */ + vendor?: Maybe; +}; + +/** Represents a single line item on an order. */ +export type LineItemMutableTaxLinesArgs = { + first?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple LineItemMutables. + */ +export type LineItemMutableConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in LineItemMutableEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one LineItemMutable and a cursor during pagination. + */ +export type LineItemMutableEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of LineItemMutableEdge. */ + node: LineItemMutable; +}; + +/** Represents the selling plan for a line item. */ +export type LineItemSellingPlan = { + /** The name of the selling plan for display purposes. */ + name: Scalars["String"]["output"]; + /** The ID of the selling plan associated with the line item. */ + sellingPlanId?: Maybe; +}; + +/** A link to direct users to. */ +export type Link = HasPublishedTranslations & { + /** A context-sensitive label for the link. */ + label: Scalars["String"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** The URL that the link visits. */ + url: Scalars["URL"]["output"]; +}; + +/** A link to direct users to. */ +export type LinkTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** A locale. */ +export type Locale = { + /** Locale ISO code. */ + isoCode: Scalars["String"]["output"]; + /** Human-readable locale name. */ + name: Scalars["String"]["output"]; +}; + +/** Specifies the type of the underlying localizable content. This can be used to conditionally render different UI elements such as input fields. */ +export type LocalizableContentType = + /** A file reference. */ + | "FILE_REFERENCE" + /** An HTML. */ + | "HTML" + /** An inline rich text. */ + | "INLINE_RICH_TEXT" + /** A JSON. */ + | "JSON" + /** A JSON string. */ + | "JSON_STRING" + /** A list of file references. */ + | "LIST_FILE_REFERENCE" + /** A list of multi-line texts. */ + | "LIST_MULTI_LINE_TEXT_FIELD" + /** A list of single-line texts. */ + | "LIST_SINGLE_LINE_TEXT_FIELD" + /** A list of URLs. */ + | "LIST_URL" + /** A multi-line text. */ + | "MULTI_LINE_TEXT_FIELD" + /** A rich text. */ + | "RICH_TEXT_FIELD" + /** A single-line text. */ + | "SINGLE_LINE_TEXT_FIELD" + /** A string. */ + | "STRING" + /** A URI. */ + | "URI" + /** A URL. */ + | "URL"; + +/** Represents the value captured by a localization extension. Localization extensions are additional fields required by certain countries on international orders. For example, some countries require additional fields for customs information or tax identification numbers. */ +export type LocalizationExtension = { + /** Country ISO 3166-1 alpha-2 code. */ + countryCode: CountryCode; + /** The localized extension keys that are allowed. */ + key: LocalizationExtensionKey; + /** The purpose of this localization extension. */ + purpose: LocalizationExtensionPurpose; + /** The localized extension title. */ + title: Scalars["String"]["output"]; + /** The value of the field. */ + value: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple LocalizationExtensions. + */ +export type LocalizationExtensionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in LocalizationExtensionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one LocalizationExtension and a cursor during pagination. + */ +export type LocalizationExtensionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of LocalizationExtensionEdge. */ + node: LocalizationExtension; +}; + +/** + * The input fields for a LocalizationExtensionInput. + */ +export type LocalizationExtensionInput = { + /** The key for the localization extension. */ + key: LocalizationExtensionKey; + /** The localization extension value. */ + value: Scalars["String"]["input"]; +}; + +/** The key of a localization extension. */ +export type LocalizationExtensionKey = + /** Extension key 'shipping_credential_br' for country BR. */ + | "SHIPPING_CREDENTIAL_BR" + /** Extension key 'shipping_credential_cn' for country CN. */ + | "SHIPPING_CREDENTIAL_CN" + /** Extension key 'shipping_credential_kr' for country KR. */ + | "SHIPPING_CREDENTIAL_KR" + /** Extension key 'tax_credential_br' for country BR. */ + | "TAX_CREDENTIAL_BR" + /** Extension key 'tax_credential_it' for country IT. */ + | "TAX_CREDENTIAL_IT" + /** Extension key 'tax_email_it' for country IT. */ + | "TAX_EMAIL_IT"; + +/** The purpose of a localization extension. */ +export type LocalizationExtensionPurpose = + /** Extensions that are used for shipping purposes, for example, customs clearance. */ + | "SHIPPING" + /** Extensions that are used for taxes purposes, for example, invoicing. */ + | "TAX"; + +/** + * Represents the location where the physical good resides. + */ +export type Location = + & HasMetafieldDefinitions + & HasMetafields + & LegacyInteroperability + & Node + & { + /** Whether this location can be reactivated. */ + activatable: Scalars["Boolean"]["output"]; + /** The address of this location. */ + address: LocationAddress; + /** Whether the location address has been verified. */ + addressVerified: Scalars["Boolean"]["output"]; + /** Whether this location can be deactivated. */ + deactivatable: Scalars["Boolean"]["output"]; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `"2019-09-07T15:50:00Z`". */ + deactivatedAt?: Maybe; + /** Whether this location can be deleted. */ + deletable: Scalars["Boolean"]["output"]; + /** Name of the service provider that fulfills from this location. */ + fulfillmentService?: Maybe; + /** Whether this location can fulfill online orders. */ + fulfillsOnlineOrders: Scalars["Boolean"]["output"]; + /** Whether this location has active inventory. */ + hasActiveInventory: Scalars["Boolean"]["output"]; + /** Whether this location has orders that need to be fulfilled. */ + hasUnfulfilledOrders: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The quantities of an inventory item at this location. */ + inventoryLevel?: Maybe; + /** A list of the quantities of the inventory items that can be stocked at this location. */ + inventoryLevels: InventoryLevelConnection; + /** Whether the location is active. */ + isActive: Scalars["Boolean"]["output"]; + /** + * Whether the location is your primary location for shipping inventory. + * @deprecated The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location + */ + isPrimary: Scalars["Boolean"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** Local pickup settings for the location. */ + localPickupSettingsV2?: Maybe; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The name of the location. */ + name: Scalars["String"]["output"]; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored. */ + shipsInventory: Scalars["Boolean"]["output"]; + /** List of suggested addresses for this location (empty if none). */ + suggestedAddresses: Array; + }; + +/** + * Represents the location where the physical good resides. + */ +export type LocationInventoryLevelArgs = { + inventoryItemId: Scalars["ID"]["input"]; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationInventoryLevelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * Represents the location where the physical good resides. + */ +export type LocationPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `locationActivate` mutation. */ +export type LocationActivatePayload = { + /** The location that was activated. */ + location?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + locationActivateUserErrors: Array; +}; + +/** An error that occurs while activating a location. */ +export type LocationActivateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `LocationActivateUserError`. */ +export type LocationActivateUserErrorCode = + /** An error occurred while activating the location. */ + | "GENERIC_ERROR" + /** There is already an active location with this name. */ + | "HAS_NON_UNIQUE_NAME" + /** This location currently cannot be activated as inventory, pending orders or transfers are being relocated from this location. */ + | "HAS_ONGOING_RELOCATION" + /** Shop has reached its location limit. */ + | "LOCATION_LIMIT" + /** Location not found. */ + | "LOCATION_NOT_FOUND"; + +/** The input fields to use to specify the address while adding a location. */ +export type LocationAddAddressInput = { + /** The first line of the address. */ + address1?: InputMaybe; + /** The second line of the address. */ + address2?: InputMaybe; + /** The name of the city, district, village, or town. */ + city?: InputMaybe; + /** The two-letter code of country for the address. */ + countryCode: CountryCode; + /** The phone number of the location. */ + phone?: InputMaybe; + /** + * The code for the region of the address, such as the state, province, or district. + * For example CA for California, United States. + */ + provinceCode?: InputMaybe; + /** The ZIP code or postal code of the address. */ + zip?: InputMaybe; +}; + +/** The input fields to use to add a location. */ +export type LocationAddInput = { + /** The address of the location. */ + address: LocationAddAddressInput; + /** Whether inventory at this location is available for sale online. */ + fulfillsOnlineOrders?: InputMaybe; + /** Additional customizable information to associate with the location. */ + metafields?: InputMaybe>; + /** The name of the location. */ + name: Scalars["String"]["input"]; +}; + +/** Return type for `locationAdd` mutation. */ +export type LocationAddPayload = { + /** The location that was added. */ + location?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs while adding a location. */ +export type LocationAddUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `LocationAddUserError`. */ +export type LocationAddUserErrorCode = + /** ApiPermission metafields can only be created or updated by the app owner. */ + | "APP_NOT_AUTHORIZED" + /** The input value is blank. */ + | "BLANK" + /** Owner type can't be used in this mutation. */ + | "DISALLOWED_OWNER_TYPE" + /** An error occurred while adding the location. */ + | "GENERIC_ERROR" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The input value is invalid. */ + | "INVALID" + /** The type is invalid. */ + | "INVALID_TYPE" + /** The ZIP code is not a valid US ZIP code. */ + | "INVALID_US_ZIPCODE" + /** The value is invalid for the metafield type or for the definition options. */ + | "INVALID_VALUE" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** Unstructured reserved namespace. */ + | "UNSTRUCTURED_RESERVED_NAMESPACE"; + +/** + * Represents the address of a location. + */ +export type LocationAddress = { + /** The first line of the address for the location. */ + address1?: Maybe; + /** The second line of the address for the location. */ + address2?: Maybe; + /** The city of the location. */ + city?: Maybe; + /** The country of the location. */ + country?: Maybe; + /** The country code of the location. */ + countryCode?: Maybe; + /** A formatted version of the address for the location. */ + formatted: Array; + /** The latitude coordinates of the location. */ + latitude?: Maybe; + /** The longitude coordinates of the location. */ + longitude?: Maybe; + /** The phone number of the location. */ + phone?: Maybe; + /** The province of the location. */ + province?: Maybe; + /** + * The code for the province, state, or district of the address of the location. + */ + provinceCode?: Maybe; + /** The ZIP code of the location. */ + zip?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple Locations. + */ +export type LocationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in LocationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `locationDeactivate` mutation. */ +export type LocationDeactivatePayload = { + /** The location that was deactivated. */ + location?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + locationDeactivateUserErrors: Array; +}; + +/** The possible errors that can be returned when executing the `locationDeactivate` mutation. */ +export type LocationDeactivateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `LocationDeactivateUserError`. */ +export type LocationDeactivateUserErrorCode = + /** At least one location must fulfill online orders. */ + | "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT" + /** Destination location is the same as the location to be deactivated. */ + | "DESTINATION_LOCATION_IS_THE_SAME_LOCATION" + /** Destination location is not found or inactive. */ + | "DESTINATION_LOCATION_NOT_FOUND_OR_INACTIVE" + /** Failed to relocate active inventories to the destination location. */ + | "FAILED_TO_RELOCATE_ACTIVE_INVENTORIES" + /** Failed to relocate incoming movements to the destination location. */ + | "FAILED_TO_RELOCATE_INCOMING_MOVEMENTS" + /** Failed to relocate open purchase orders to the destination location. */ + | "FAILED_TO_RELOCATE_OPEN_PURCHASE_ORDERS" + /** Failed to relocate open transfers to the destination location. */ + | "FAILED_TO_RELOCATE_OPEN_TRANSFERS" + /** Location could not be deactivated without specifying where to relocate inventory at the location. */ + | "HAS_ACTIVE_INVENTORY_ERROR" + /** Location needs to be removed from Shopify POS for Retail subscription in Point of Sale channel. */ + | "HAS_ACTIVE_RETAIL_SUBSCRIPTIONS" + /** Location could not be deactivated because it has pending orders. */ + | "HAS_FULFILLMENT_ORDERS_ERROR" + /** Location could not be deactivated because it has open Shopify Fulfillment Network transfers. */ + | "HAS_INCOMING_MOVEMENTS_ERROR" + /** Location could not be deactivated because it has open purchase orders. */ + | "HAS_OPEN_PURCHASE_ORDERS_ERROR" + /** Location could not be deactivated because it has open transfers. */ + | "HAS_OPEN_TRANSFERS_ERROR" + /** Location not found. */ + | "LOCATION_NOT_FOUND" + /** Location either has a fulfillment service or is the only location with a shipping address. */ + | "PERMANENTLY_BLOCKED_FROM_DEACTIVATION_ERROR" + /** Location has incoming inventory. The location can be deactivated after the inventory has been received. */ + | "TEMPORARILY_BLOCKED_FROM_DEACTIVATION_ERROR"; + +/** Return type for `locationDelete` mutation. */ +export type LocationDeletePayload = { + /** The ID of the location that was deleted. */ + deletedLocationId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + locationDeleteUserErrors: Array; +}; + +/** An error that occurs while deleting a location. */ +export type LocationDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `LocationDeleteUserError`. */ +export type LocationDeleteUserErrorCode = + /** An error occurred while deleting the location. */ + | "GENERIC_ERROR" + /** The location cannot be deleted while it has any active Retail subscriptions in the Point of Sale channel. */ + | "LOCATION_HAS_ACTIVE_RETAIL_SUBSCRIPTION" + /** The location cannot be deleted while it has inventory. */ + | "LOCATION_HAS_INVENTORY" + /** The location cannot be deleted while it has pending orders. */ + | "LOCATION_HAS_PENDING_ORDERS" + /** The location cannot be deleted while it is active. */ + | "LOCATION_IS_ACTIVE" + /** Location not found. */ + | "LOCATION_NOT_FOUND"; + +/** + * An auto-generated type which holds one Location and a cursor during pagination. + */ +export type LocationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of LocationEdge. */ + node: Location; +}; + +/** The input fields to use to edit the address of a location. */ +export type LocationEditAddressInput = { + /** The first line of the address. */ + address1?: InputMaybe; + /** The second line of the address. */ + address2?: InputMaybe; + /** The name of the city, district, village, or town. */ + city?: InputMaybe; + /** The two-letter code of country for the address. */ + countryCode?: InputMaybe; + /** The phone number of the location. */ + phone?: InputMaybe; + /** + * The code for the region of the address, such as the state, province, or district. + * For example CA for California, United States. + */ + provinceCode?: InputMaybe; + /** The ZIP code or postal code of the location. */ + zip?: InputMaybe; +}; + +/** The input fields to use to edit a location. */ +export type LocationEditInput = { + /** The address of the location. */ + address?: InputMaybe; + /** + * Whether inventory at this location is available for sale online. + * + * **Note:** This can't be disabled for fulfillment service locations. + */ + fulfillsOnlineOrders?: InputMaybe; + /** Additional customizable information to associate with the location. */ + metafields?: InputMaybe>; + /** The name of the location. */ + name?: InputMaybe; +}; + +/** Return type for `locationEdit` mutation. */ +export type LocationEditPayload = { + /** The location that was edited. */ + location?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs while editing a location. */ +export type LocationEditUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `LocationEditUserError`. */ +export type LocationEditUserErrorCode = + /** ApiPermission metafields can only be created or updated by the app owner. */ + | "APP_NOT_AUTHORIZED" + /** The input value is blank. */ + | "BLANK" + /** At least one location must fulfill online orders. */ + | "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT" + /** Owner type can't be used in this mutation. */ + | "DISALLOWED_OWNER_TYPE" + /** An error occurred while editing the location. */ + | "GENERIC_ERROR" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The input value is invalid. */ + | "INVALID" + /** The type is invalid. */ + | "INVALID_TYPE" + /** The ZIP code is not a valid US ZIP code. */ + | "INVALID_US_ZIPCODE" + /** The value is invalid for the metafield type or for the definition options. */ + | "INVALID_VALUE" + /** The record with the ID used as the input value couldn't be found. */ + | "NOT_FOUND" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** Unstructured reserved namespace. */ + | "UNSTRUCTURED_RESERVED_NAMESPACE"; + +/** Return type for `locationLocalPickupDisable` mutation. */ +export type LocationLocalPickupDisablePayload = { + /** The ID of the location for which local pickup was disabled. */ + locationId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `locationLocalPickupEnable` mutation. */ +export type LocationLocalPickupEnablePayload = { + /** The local pickup settings that were enabled. */ + localPickupSettings?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the Location query. */ +export type LocationSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * Represents a suggested address for a location. + */ +export type LocationSuggestedAddress = { + /** The first line of the suggested address. */ + address1?: Maybe; + /** The second line of the suggested address. */ + address2?: Maybe; + /** The city of the suggested address. */ + city?: Maybe; + /** The country of the suggested address. */ + country?: Maybe; + /** The country code of the suggested address. */ + countryCode?: Maybe; + /** A formatted version of the suggested address. */ + formatted: Array; + /** The province of the suggested address. */ + province?: Maybe; + /** The code for the province, state, or district of the suggested address. */ + provinceCode?: Maybe; + /** The ZIP code of the suggested address. */ + zip?: Maybe; +}; + +/** + * Represents a customer mailing address. + * + * For example, a customer's default address and an order's billing address are both mailling addresses. + */ +export type MailingAddress = Node & { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + */ + address2?: Maybe; + /** + * The name of the city, district, village, or town. + */ + city?: Maybe; + /** + * The name of the customer's company or organization. + */ + company?: Maybe; + /** Whether the address coordinates are valid. */ + coordinatesValidated: Scalars["Boolean"]["output"]; + /** + * The name of the country. + */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + * + * @deprecated Use `countryCodeV2` instead. + */ + countryCode?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + */ + countryCodeV2?: Maybe; + /** The first name of the customer. */ + firstName?: Maybe; + /** A formatted version of the address, customized by the provided arguments. */ + formatted: Array; + /** A comma-separated list of the values for city, province, and country. */ + formattedArea?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The last name of the customer. */ + lastName?: Maybe; + /** The latitude coordinate of the customer address. */ + latitude?: Maybe; + /** The longitude coordinate of the customer address. */ + longitude?: Maybe; + /** + * The full name of the customer, based on firstName and lastName. + */ + name?: Maybe; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. + */ + phone?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * + * For example, ON. + */ + provinceCode?: Maybe; + /** The time zone of the address. */ + timeZone?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + +/** + * Represents a customer mailing address. + * + * For example, a customer's default address and an order's billing address are both mailling addresses. + */ +export type MailingAddressFormattedArgs = { + withCompany?: InputMaybe; + withName?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MailingAddresses. + */ +export type MailingAddressConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MailingAddressEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MailingAddress and a cursor during pagination. + */ +export type MailingAddressEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MailingAddressEdge. */ + node: MailingAddress; +}; + +/** The input fields to create or update a mailing address. */ +export type MailingAddressInput = { + /** + * The first line of the address. Typically the street address or PO Box number. + */ + address1?: InputMaybe; + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + */ + address2?: InputMaybe; + /** + * The name of the city, district, village, or town. + */ + city?: InputMaybe; + /** + * The name of the customer's company or organization. + */ + company?: InputMaybe; + /** The two-letter code for the country of the address. */ + countryCode?: InputMaybe; + /** The first name of the customer. */ + firstName?: InputMaybe; + /** The last name of the customer. */ + lastName?: InputMaybe; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. + */ + phone?: InputMaybe; + /** + * The code for the region of the address, such as the province, state, or district. + * For example QC for Quebec, Canada. + */ + provinceCode?: InputMaybe; + /** The zip or postal code of the address. */ + zip?: InputMaybe; +}; + +/** + * Manual discount applications capture the intentions of a discount that was manually created for an order. + * + * Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object. + */ +export type ManualDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is applied to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The description of the discount application. */ + description?: Maybe; + /** + * An ordered index that can be used to identify the discount application and indicate the precedence + * of the discount application for calculations. + */ + index: Scalars["Int"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The title of the discount application. */ + title: Scalars["String"]["output"]; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type Market = HasMetafieldDefinitions & HasMetafields & Node & { + /** The catalogs that belong to the market. */ + catalogs: MarketCatalogConnection; + /** The market’s currency settings. */ + currencySettings: MarketCurrencySettings; + /** + * Whether the market is enabled to receive visitors and sales. **Note**: Regions in inactive + * markets can't be selected on the storefront or in checkout. + */ + enabled: Scalars["Boolean"]["output"]; + /** A short, human-readable unique identifier for the market. This is changeable by the merchant. */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The name of the market. Not shown to customers. */ + name: Scalars["String"]["output"]; + /** + * The market’s price list, which specifies a percentage-based price adjustment as well as + * fixed price overrides for specific variants. + */ + priceList?: Maybe; + /** + * Whether the market is the shop’s primary market. + */ + primary: Scalars["Boolean"]["output"]; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The regions that comprise the market. */ + regions: MarketRegionConnection; + /** + * The market’s web presence, which defines its SEO strategy. This can be a different domain, + * subdomain, or subfolders of the primary domain. Each web presence comprises one or more + * language variants. If a market doesn't have its own web presence, then the market is accessible on the + * shop’s primary domain using [country + * selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector). + */ + webPresence?: Maybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketCatalogsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A market is a group of one or more regions that you want to target for international sales. + * By creating a market, you can configure a distinct, localized shopping experience for + * customers from a specific area of the world. For example, you can + * [change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate), + * [configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists), + * or [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence). + */ +export type MarketRegionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A list of products with publishing and pricing information associated with markets. + */ +export type MarketCatalog = Catalog & Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The markets associated with the catalog. */ + markets: MarketConnection; + /** Most recent catalog operations. */ + operations: Array; + /** The price list associated with the catalog. */ + priceList?: Maybe; + /** A group of products and collections that's published to a catalog. */ + publication?: Maybe; + /** The status of the catalog. */ + status: CatalogStatus; + /** The name of the catalog. */ + title: Scalars["String"]["output"]; +}; + +/** + * A list of products with publishing and pricing information associated with markets. + */ +export type MarketCatalogMarketsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MarketCatalogs. + */ +export type MarketCatalogConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketCatalogEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MarketCatalog and a cursor during pagination. + */ +export type MarketCatalogEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketCatalogEdge. */ + node: MarketCatalog; +}; + +/** + * An auto-generated type for paginating through multiple Markets. + */ +export type MarketConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields required to create a market. */ +export type MarketCreateInput = { + /** + * Whether the market is enabled to receive visitors and sales. If a + * value isn't provided, then the market is enabled by default if all + * included regions have shipping rates, and disabled if any regions don't + * have shipping rates. + * + * **Note**: Regions in inactive markets can't be selected on the + * storefront or in checkout. + */ + enabled?: InputMaybe; + /** + * A unique identifier for the market. For example `"ca"`. + * If the handle isn't provided, then the handle is auto-generated based on the country or name. + */ + handle?: InputMaybe; + /** + * The name of the market. Not shown to customers. + */ + name: Scalars["String"]["input"]; + /** + * The regions to be included in the market. Each region can only be included in one market at + * a time. + */ + regions: Array; +}; + +/** Return type for `marketCreate` mutation. */ +export type MarketCreatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A market's currency settings. */ +export type MarketCurrencySettings = { + /** + * The currency which this market's prices are defined in, and the + * currency which its customers must use if local currencies are disabled. + */ + baseCurrency: CurrencySetting; + /** + * Whether or not local currencies are enabled. If enabled, then prices will + * be converted to give each customer the best experience based on their + * region. If disabled, then all customers in this market will see prices + * in the market's base currency. + */ + localCurrencies: Scalars["Boolean"]["output"]; +}; + +/** The input fields used to update the currency settings of a market. */ +export type MarketCurrencySettingsUpdateInput = { + /** + * The currency which this market’s prices are defined in, and the + * currency which its customers must use if local currencies are disabled. + */ + baseCurrency?: InputMaybe; + /** + * Whether or not local currencies are enabled. If enabled, then prices will + * be converted to give each customer the best experience based on their + * region. If disabled, then all customers in this market will see prices + * in the market's base currency. + */ + localCurrencies?: InputMaybe; +}; + +/** Return type for `marketCurrencySettingsUpdate` mutation. */ +export type MarketCurrencySettingsUpdatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed market multi-currency operations. */ +export type MarketCurrencySettingsUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MarketCurrencySettingsUserError`. */ +export type MarketCurrencySettingsUserErrorCode = + /** The currency settings of the given market cannot be changed because the market manager has exclusive control of pricing. */ + | "MANAGED_MARKET" + /** The specified market wasn't found. */ + | "MARKET_NOT_FOUND" + /** The shop's payment gateway does not support enabling more than one currency. */ + | "MULTIPLE_CURRENCIES_NOT_SUPPORTED" + /** Can't enable or disable local currencies on a single country market. */ + | "NO_LOCAL_CURRENCIES_ON_SINGLE_COUNTRY_MARKET" + /** The primary market must use the shop currency. */ + | "PRIMARY_MARKET_USES_SHOP_CURRENCY" + /** The specified currency is not supported. */ + | "UNSUPPORTED_CURRENCY"; + +/** Return type for `marketDelete` mutation. */ +export type MarketDeletePayload = { + /** The ID of the deleted market. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Market and a cursor during pagination. + */ +export type MarketEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketEdge. */ + node: Market; +}; + +/** The market localizable content of a resource's field. */ +export type MarketLocalizableContent = { + /** The hash digest representation of the content value. */ + digest?: Maybe; + /** The resource field that's being localized. */ + key: Scalars["String"]["output"]; + /** The content value. */ + value?: Maybe; +}; + +/** A resource that has market localizable fields. */ +export type MarketLocalizableResource = { + /** The market localizable content. */ + marketLocalizableContent: Array; + /** Market localizations for the market localizable content. */ + marketLocalizations: Array; + /** The GID of the resource. */ + resourceId: Scalars["ID"]["output"]; +}; + +/** A resource that has market localizable fields. */ +export type MarketLocalizableResourceMarketLocalizationsArgs = { + marketId: Scalars["ID"]["input"]; +}; + +/** + * An auto-generated type for paginating through multiple MarketLocalizableResources. + */ +export type MarketLocalizableResourceConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketLocalizableResourceEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MarketLocalizableResource and a cursor during pagination. + */ +export type MarketLocalizableResourceEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketLocalizableResourceEdge. */ + node: MarketLocalizableResource; +}; + +/** The type of resources that are market localizable. */ +export type MarketLocalizableResourceType = + /** A metafield. Market localizable fields: `value`. */ + "METAFIELD"; + +/** The market localization of a field within a resource, which is determined by the market ID. */ +export type MarketLocalization = { + /** A reference to the value being localized on the resource that this market localization belongs to. */ + key: Scalars["String"]["output"]; + /** The market that the localization is specific to. */ + market: Market; + /** Whether the original content has changed since this market localization was updated. */ + outdated: Scalars["Boolean"]["output"]; + /** The date and time when the market localization was updated. */ + updatedAt?: Maybe; + /** The value of the market localization. */ + value?: Maybe; +}; + +/** The input fields and values for creating or updating a market localization. */ +export type MarketLocalizationRegisterInput = { + /** A reference to the value being localized on the resource that this market localization belongs to. */ + key: Scalars["String"]["input"]; + /** The ID of the market that the localization is specific to. */ + marketId: Scalars["ID"]["input"]; + /** A hash digest representation of the content being localized. */ + marketLocalizableContentDigest: Scalars["String"]["input"]; + /** The value of the market localization. */ + value: Scalars["String"]["input"]; +}; + +/** Return type for `marketLocalizationsRegister` mutation. */ +export type MarketLocalizationsRegisterPayload = { + /** The market localizations that were created or updated. */ + marketLocalizations?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `marketLocalizationsRemove` mutation. */ +export type MarketLocalizationsRemovePayload = { + /** The market localizations that were deleted. */ + marketLocalizations?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A geographic region which comprises a market. */ +export type MarketRegion = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the region. */ + name: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple MarketRegions. + */ +export type MarketRegionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketRegionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** A country which comprises a market. */ +export type MarketRegionCountry = MarketRegion & Node & { + /** The ISO code identifying the country. */ + code: CountryCode; + /** The currency which this country uses given its market settings. */ + currency: CurrencySetting; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the region. */ + name: Scalars["String"]["output"]; +}; + +/** The input fields for creating a market region with exactly one required option. */ +export type MarketRegionCreateInput = { + /** A country code for the region. */ + countryCode: CountryCode; +}; + +/** Return type for `marketRegionDelete` mutation. */ +export type MarketRegionDeletePayload = { + /** The ID of the deleted market region. */ + deletedId?: Maybe; + /** The parent market object of the deleted region. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one MarketRegion and a cursor during pagination. + */ +export type MarketRegionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketRegionEdge. */ + node: MarketRegion; +}; + +/** Return type for `marketRegionsCreate` mutation. */ +export type MarketRegionsCreatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields used to update a market. */ +export type MarketUpdateInput = { + /** + * Whether the market is enabled to receive visitors and sales. **Note**: Regions in + * inactive markets cannot be selected on the storefront or in checkout. + */ + enabled?: InputMaybe; + /** + * A unique identifier for the market. For example `"ca"`. + */ + handle?: InputMaybe; + /** + * The name of the market. Not shown to customers. + */ + name?: InputMaybe; +}; + +/** Return type for `marketUpdate` mutation. */ +export type MarketUpdatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Defines errors encountered while managing a Market. + */ +export type MarketUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MarketUserError`. */ +export type MarketUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Can't add customer account domain to a market. */ + | "CANNOT_ADD_CUSTOMER_DOMAIN" + /** Can't add regions to the primary market. */ + | "CANNOT_ADD_REGIONS_TO_PRIMARY_MARKET" + /** Can't add the web presence to the primary market. */ + | "CANNOT_ADD_WEB_PRESENCE_TO_PRIMARY_MARKET" + /** Can't delete the only region in a market. */ + | "CANNOT_DELETE_ONLY_REGION" + /** Can't delete the primary market. */ + | "CANNOT_DELETE_PRIMARY_MARKET" + /** Can't delete the primary market's web presence. */ + | "CANNOT_DELETE_PRIMARY_MARKET_WEB_PRESENCE" + /** Can't disable the primary market. */ + | "CANNOT_DISABLE_PRIMARY_MARKET" + /** Can't pass both `subfolderSuffix` and `domainId`. */ + | "CANNOT_HAVE_SUBFOLDER_AND_DOMAIN" + /** Can't set default locale to null. */ + | "CANNOT_SET_DEFAULT_LOCALE_TO_NULL" + /** The language isn't enabled on the store. */ + | "DISABLED_LANGUAGE" + /** Domain was not found. */ + | "DOMAIN_NOT_FOUND" + /** Duplicates found in languages. */ + | "DUPLICATE_LANGUAGES" + /** The input value is invalid. */ + | "INVALID" + /** The market wasn't found. */ + | "MARKET_NOT_FOUND" + /** No languages selected. */ + | "NO_LANGUAGES" + /** The primary market must use the primary domain. */ + | "PRIMARY_MARKET_MUST_USE_PRIMARY_DOMAIN" + /** The market region wasn't found. */ + | "REGION_NOT_FOUND" + /** Cannot add region-specific language. */ + | "REGION_SPECIFIC_LANGUAGE" + /** One of `subfolderSuffix` or `domainId` is required. */ + | "REQUIRES_DOMAIN_OR_SUBFOLDER" + /** Exactly one input option is required. */ + | "REQUIRES_EXACTLY_ONE_OPTION" + /** Can't have more than 50 markets. */ + | "SHOP_REACHED_MARKETS_LIMIT" + /** The subfolder suffix is invalid, please provide a different value. */ + | "SUBFOLDER_SUFFIX_CANNOT_BE_SCRIPT_CODE" + /** The subfolder suffix must contain only letters. */ + | "SUBFOLDER_SUFFIX_MUST_CONTAIN_ONLY_LETTERS" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** The language isn't published to the store. */ + | "UNPUBLISHED_LANGUAGE" + /** Can't add unsupported country or region. */ + | "UNSUPPORTED_COUNTRY_REGION" + /** The market web presence wasn't found. */ + | "WEB_PRESENCE_NOT_FOUND"; + +/** + * The market’s web presence, which defines its SEO strategy. This can be a different domain + * (e.g. `example.ca`), subdomain (e.g. `ca.example.com`), or subfolders of the primary + * domain (e.g. `example.com/en-ca`). Each web presence comprises one or more language + * variants. If a market does not have its own web presence, it is accessible on the shop’s + * primary domain via [country + * selectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector). + * + * Note: while the domain/subfolders defined by a market’s web presence are not applicable to + * custom storefronts, which must manage their own domains and routing, the languages chosen + * here do govern [the languages available on the Storefront + * API](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in + * this market. + */ +export type MarketWebPresence = Node & { + /** + * The ISO codes for the alternate locales. When a domain is used, these locales will be + * available as language-specific subfolders. For example, if English is an + * alternate locale, and `example.ca` is the market’s domain, then + * `example.ca/en` will load in English. + */ + alternateLocales: Array; + /** + * The ISO code for the default locale. When a domain is used, this is the locale that will + * be used when the domain root is accessed. For example, if French is the default locale, + * and `example.ca` is the market’s domian, then `example.ca` will load in French. + */ + defaultLocale: Scalars["String"]["output"]; + /** + * The web presence’s domain. + * This field will be null if `subfolderSuffix` isn't null. + */ + domain?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The associated market. */ + market: Market; + /** + * The list of root URLs for each of the web presence’s locales. + */ + rootUrls: Array; + /** The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null. */ + subfolderSuffix?: Maybe; +}; + +/** The input fields used to create a web presence for a market. */ +export type MarketWebPresenceCreateInput = { + /** + * The alternate locales for the market’s web presence. + */ + alternateLocales?: InputMaybe>; + /** + * The default locale for the market’s web presence. + */ + defaultLocale: Scalars["String"]["input"]; + /** + * The web presence's domain ID. This field must be `null` if the `subfolderSuffix` isn't `null`. + */ + domainId?: InputMaybe; + /** + * The market-specific suffix of the subfolders defined by the web presence. + * For example: in `/en-us`, the subfolder suffix is `us`. + * Only ASCII characters are allowed. This field must be `null` if the `domainId` isn't `null`. + */ + subfolderSuffix?: InputMaybe; +}; + +/** Return type for `marketWebPresenceCreate` mutation. */ +export type MarketWebPresenceCreatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `marketWebPresenceDelete` mutation. */ +export type MarketWebPresenceDeletePayload = { + /** The ID of the deleted web presence. */ + deletedId?: Maybe; + /** The market for which the web presence was deleted. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The URL for the homepage of the online store in the context of a particular market and a + * particular locale. + */ +export type MarketWebPresenceRootUrl = { + /** The locale that the storefront loads in. */ + locale: Scalars["String"]["output"]; + /** The URL. */ + url: Scalars["URL"]["output"]; +}; + +/** The input fields used to update a web presence for a market. */ +export type MarketWebPresenceUpdateInput = { + /** + * The alternate locales for the market’s web presence. + */ + alternateLocales?: InputMaybe>; + /** + * The default locale for the market’s web presence. + */ + defaultLocale?: InputMaybe; + /** + * The web presence's domain ID. This field must be null if `subfolderSuffix` is not null. + */ + domainId?: InputMaybe; + /** + * The market-specific suffix of the subfolders defined by the web presence. + * Example: in `/en-us` the subfolder suffix is `us`. + * Only ASCII characters are allowed. This field must be null if `domainId` is not null. + */ + subfolderSuffix?: InputMaybe; +}; + +/** Return type for `marketWebPresenceUpdate` mutation. */ +export type MarketWebPresenceUpdatePayload = { + /** The market object. */ + market?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The marketing activity resource represents marketing that a + * merchant created through an app. + */ +export type MarketingActivity = Node & { + /** The URL of the marketing activity listing page in the marketing section. */ + activityListUrl?: Maybe; + /** The amount spent on the marketing activity. */ + adSpend?: Maybe; + /** The app which created this marketing activity. */ + app: App; + /** The errors generated when an app publishes the marketing activity. */ + appErrors?: Maybe; + /** The allocated budget for the marketing activity. */ + budget?: Maybe; + /** The date and time when the marketing activity was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The completed content in the marketing activity creation form. */ + formData?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * Whether the marketing activity is in the main workflow version of + * the marketing automation. + */ + inMainWorkflowVersion: Scalars["Boolean"]["output"]; + /** The available marketing channels for a marketing activity. */ + marketingChannel: MarketingChannel; + /** Associated marketing event of this marketing activity. */ + marketingEvent?: Maybe; + /** A contextual description of the marketing activity based on the platform and tactic used. */ + sourceAndMedium: Scalars["String"]["output"]; + /** The current state of the marketing activity. */ + status: MarketingActivityStatus; + /** + * The severity of the marketing activity's status. + * @deprecated Use `statusBadgeTypeV2` instead. + */ + statusBadgeType?: Maybe; + /** The severity of the marketing activity's status. */ + statusBadgeTypeV2?: Maybe; + /** The rendered status of the marketing activity. */ + statusLabel: Scalars["String"]["output"]; + /** + * The [date and time]( + * https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601 + * ) when the activity's status last changed. + */ + statusTransitionedAt?: Maybe; + /** The method of marketing used for this marketing activity. */ + tactic: MarketingTactic; + /** The status to which the marketing activity is currently transitioning. */ + targetStatus?: Maybe; + /** The marketing activity's title, which is rendered on the marketing listing page. */ + title: Scalars["String"]["output"]; + /** The date and time when the marketing activity was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * The set of [Urchin Tracking Module]( + * https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters + * ) used in the URL for tracking this marketing activity. + */ + utmParameters?: Maybe; +}; + +/** The input fields combining budget amount and its marketing budget type. */ +export type MarketingActivityBudgetInput = { + /** Budget type for marketing activity. */ + budgetType?: InputMaybe; + /** Amount of budget for the marketing activity. */ + total?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MarketingActivities. + */ +export type MarketingActivityConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketingActivityEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields for creating an externally-managed marketing activity. */ +export type MarketingActivityCreateExternalInput = { + /** The amount spent on the marketing activity. */ + adSpend?: InputMaybe; + /** The budget for this marketing activity. */ + budget?: InputMaybe; + /** The channel of your marketing event. */ + channel: MarketingChannel; + /** When the activity ended. */ + end?: InputMaybe; + /** The referring domain. */ + referringDomain?: InputMaybe; + /** The ID of an activity that's hosted outside of Shopify. */ + remoteId?: InputMaybe; + /** The URL for a preview image that's used for the marketing activity. */ + remotePreviewImageUrl?: InputMaybe; + /** URL for viewing and/or managing the activity outside of Shopify. */ + remoteUrl: Scalars["URL"]["input"]; + /** When the activity is scheduled to end. */ + scheduledEnd?: InputMaybe; + /** When the activity is scheduled to start. */ + scheduledStart?: InputMaybe; + /** When the activity started. */ + start?: InputMaybe; + /** + * Specifies the settings for the marketing platform and the ad format. + * The marketing tactic determines which default fields are included + * in the marketing activity. + */ + tactic: MarketingTactic; + /** The title of the marketing activity. */ + title: Scalars["String"]["input"]; + /** + * The + * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) + * that are associated with a related marketing campaign. `UTMInput` is required for all + * marketing tactics except for the Storefront app marketing tactic. + */ + utm: UtmInput; +}; + +/** Return type for `marketingActivityCreateExternal` mutation. */ +export type MarketingActivityCreateExternalPayload = { + /** The external marketing activity that was created. */ + marketingActivity?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to create a marketing activity. */ +export type MarketingActivityCreateInput = { + /** The budget for this marketing activity. */ + budget?: InputMaybe; + /** Encoded context containing marketing campaign id. */ + context?: InputMaybe; + /** The form data in JSON serialized as a string. */ + formData?: InputMaybe; + /** The ID of the marketing activity extension. */ + marketingActivityExtensionId: Scalars["ID"]["input"]; + /** The title of the marketing activity. */ + marketingActivityTitle?: InputMaybe; + /** The current state of the marketing activity. */ + status: MarketingActivityStatus; + /** + * Specifies the + * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) + * that are associated with a related marketing campaign. UTMInput is required for all Marketing + * tactics except Storefront App. + */ + utm?: InputMaybe; +}; + +/** Return type for `marketingActivityCreate` mutation. */ +export type MarketingActivityCreatePayload = { + /** The created marketing activity. */ + marketingActivity?: Maybe; + /** The path to return back to shopify admin from embedded editor. */ + redirectPath?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one MarketingActivity and a cursor during pagination. + */ +export type MarketingActivityEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketingActivityEdge. */ + node: MarketingActivity; +}; + +/** The error code resulted from the marketing activity extension integration. */ +export type MarketingActivityExtensionAppErrorCode = + /** The app is either not responding or returning unexpected data. */ + | "API_ERROR" + /** The app needs to be installed. */ + | "INSTALL_REQUIRED_ERROR" + /** The shop/user must be onboarded to use the app. */ + | "NOT_ONBOARDED_ERROR" + /** The app has returned an error when invoking the platform. */ + | "PLATFORM_ERROR" + /** The app has returned validation errors. */ + | "VALIDATION_ERROR"; + +/** Represents errors returned from apps when using the marketing activity extension. */ +export type MarketingActivityExtensionAppErrors = { + /** The app error type. */ + code: MarketingActivityExtensionAppErrorCode; + /** The list of errors returned by the app. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the MarketingActivity query. */ +export type MarketingActivitySortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE"; + +/** Status helps to identify if this marketing activity has been completed, queued, failed etc. */ +export type MarketingActivityStatus = + /** This marketing activity is currently running. */ + | "ACTIVE" + /** This marketing activity is permanently unavailable. */ + | "DELETED" + /** This marketing activity was deleted and it was triggered from outside of Shopify. */ + | "DELETED_EXTERNALLY" + /** This marketing activity is disconnected and no longer editable. */ + | "DISCONNECTED" + /** This marketing activity has been edited, but it is not yet created. */ + | "DRAFT" + /** This marketing activity is unable to run. */ + | "FAILED" + /** This marketing activity has completed running. */ + | "INACTIVE" + /** This marketing activity is currently not running. */ + | "PAUSED" + /** This marketing activity is pending creation on the app's marketing platform. */ + | "PENDING" + /** This marketing activity is scheduled to run. */ + | "SCHEDULED" + /** The marketing activity's status is unknown. */ + | "UNDEFINED"; + +/** StatusBadgeType helps to identify the color of the status badge. */ +export type MarketingActivityStatusBadgeType = + /** This status badge has type attention. */ + | "ATTENTION" + /** This status badge has type default. */ + | "DEFAULT" + /** This status badge has type info. */ + | "INFO" + /** This status badge has type success. */ + | "SUCCESS" + /** This status badge has type warning. */ + | "WARNING"; + +/** The input fields required to update an externally managed marketing activity. */ +export type MarketingActivityUpdateExternalInput = { + /** The amount spent on the marketing activity. */ + adSpend?: InputMaybe; + /** The budget for the marketing activity. */ + budget?: InputMaybe; + /** The channel that your marketing event will use. */ + channel?: InputMaybe; + /** The date and time when the activity ended. */ + end?: InputMaybe; + /** The referring domain. */ + referringDomain?: InputMaybe; + /** The preview image URL for the marketing activity. */ + remotePreviewImageUrl?: InputMaybe; + /** The URL for managing the activity outside of Shopify. */ + remoteUrl?: InputMaybe; + /** The date and time when the activity is scheduled to end. */ + scheduledEnd?: InputMaybe; + /** The date and time when the activity is scheduled to start. */ + scheduledStart?: InputMaybe; + /** The date and time when the activity started. */ + start?: InputMaybe; + /** + * The settings for the marketing platform and ad format. + * The selection of the marketing tactic also determines which default fields are included + * in the marketing activity. + */ + tactic?: InputMaybe; + /** The title of the marketing activity. */ + title?: InputMaybe; + /** + * Specifies the + * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) + * that are associated with a related marketing campaign. UTMInput is required for all marketing + * tactics except the storefront app. + */ + utm?: InputMaybe; +}; + +/** Return type for `marketingActivityUpdateExternal` mutation. */ +export type MarketingActivityUpdateExternalPayload = { + /** The updated marketing activity. */ + marketingActivity?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to update a marketing activity. */ +export type MarketingActivityUpdateInput = { + /** The budget for the marketing activity. */ + budget?: InputMaybe; + /** + * The error messages that were generated when the app was trying to complete the activity. + * Learn more about the + * [JSON format expected for error messages](/api/marketing-activities/statuses#failed-status). + */ + errors?: InputMaybe; + /** + * The form data of the marketing activity. This is only used if the marketing activity is + * integrated with the external editor. + */ + formData?: InputMaybe; + /** The ID of the marketing activity. */ + id: Scalars["ID"]["input"]; + /** + * A list of the item IDs that were marketed in this marketing activity. Valid types for these items are: + * * `Product` + * * `Shop` + */ + marketedResources?: InputMaybe>; + /** The ID of the recommendation that the marketing activity was created from, if one exists. */ + marketingRecommendationId?: InputMaybe; + /** + * The current state of the marketing activity. Learn more about + * [marketing activities statuses](/api/marketing-activities/statuses). + */ + status?: InputMaybe; + /** The target state that the marketing activity is transitioning to. Learn more about [marketing activities statuses](/api/marketing-activities/statuses). */ + targetStatus?: InputMaybe; + /** The title of the marketing activity. */ + title?: InputMaybe; + /** + * Specifies the + * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) + * that are associated with a related marketing campaign. UTMInput is required for all Marketing + * tactics except Storefront App. The utm field can only be set once and never modified. + */ + utm?: InputMaybe; +}; + +/** Return type for `marketingActivityUpdate` mutation. */ +export type MarketingActivityUpdatePayload = { + /** The updated marketing activity. */ + marketingActivity?: Maybe; + /** The redirect path from the embedded editor to the Shopify admin. */ + redirectPath?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of a Shopify Marketing mutation. */ +export type MarketingActivityUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MarketingActivityUserError`. */ +export type MarketingActivityUserErrorCode = + /** The input value is invalid. */ + | "INVALID" + /** The input value is already taken. */ + | "TAKEN"; + +/** + * This type combines budget amount and its marketing budget type. + */ +export type MarketingBudget = { + /** The budget type for a marketing activity. */ + budgetType: MarketingBudgetBudgetType; + /** The amount of budget for marketing activity. */ + total: MoneyV2; +}; + +/** The budget type for a marketing activity. */ +export type MarketingBudgetBudgetType = + /** A daily budget. */ + | "DAILY" + /** A budget for the lifetime of a marketing activity. */ + | "LIFETIME"; + +/** + * The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation. + */ +export type MarketingChannel = + /** Displayed ads. */ + | "DISPLAY" + /** Email. */ + | "EMAIL" + /** Referral links. */ + | "REFERRAL" + /** Paid search. */ + | "SEARCH" + /** Social media. */ + | "SOCIAL"; + +/** Marketing engagement represents customer activity taken on a marketing activity or a marketing channel. */ +export type MarketingEngagement = { + /** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */ + adSpend?: Maybe; + /** The total number of clicks on the marketing event for the day. */ + clicksCount?: Maybe; + /** The total number of comments on marketing content for the day. */ + commentsCount?: Maybe; + /** The total number of complaints for the day. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported. */ + complaintsCount?: Maybe; + /** The total number of fails for the day. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages. */ + failsCount?: Maybe; + /** The total number of favorites, likes, saves, or bookmarks for the day. */ + favoritesCount?: Maybe; + /** The date time at which the data was fetched. */ + fetchedAt?: Maybe; + /** The total number of impressions for the day. */ + impressionsCount?: Maybe; + /** Whether the engagements are reported as lifetime values rather than daily totals. */ + isCumulative?: Maybe; + /** The marketing activity object related to this engagement. This corresponds to the marketingActivityId passed in on creation of the engagement. */ + marketingActivity: MarketingActivity; + /** The date that the engagements occurred on. */ + occurredOn: Scalars["Date"]["output"]; + /** The total number of marketing emails or messages that were sent for the day. */ + sendsCount?: Maybe; + /** The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded. */ + sharesCount?: Maybe; + /** The total number of unique clicks on marketing content for the day. */ + uniqueClicksCount?: Maybe; + /** The total number of unique views for the day. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content. */ + uniqueViewsCount?: Maybe; + /** The total number of unsubscribes for the day. For social media platforms, this represents the number of unfollows. */ + unsubscribesCount?: Maybe; + /** The UTC Offset that the app is using to determine which date to allocate spend to. */ + utcOffset?: Maybe; + /** The total number of views for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played. */ + viewsCount?: Maybe; +}; + +/** Return type for `marketingEngagementCreate` mutation. */ +export type MarketingEngagementCreatePayload = { + /** The marketing engagement that was created. */ + marketingEngagement?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for a marketing engagement. */ +export type MarketingEngagementInput = { + /** The total ad spend for the day, if the marketing event is a paid ad with a daily spend. */ + adSpend?: InputMaybe; + /** The total number of clicks on the marketing event for the day. */ + clicksCount?: InputMaybe; + /** The total number of comments on marketing content for the day. */ + commentsCount?: InputMaybe; + /** The total number of complaints for the day. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported. */ + complaintsCount?: InputMaybe; + /** The total number of fails for the day. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages. */ + failsCount?: InputMaybe; + /** The total number of favorites, likes, saves, or bookmarks for the day. */ + favoritesCount?: InputMaybe; + /** The date time at which the data was fetched. */ + fetchedAt?: InputMaybe; + /** The total number of impressions for the day. */ + impressionsCount?: InputMaybe; + /** Whether the engagements are reported as lifetime values rather than daily totals. */ + isCumulative?: InputMaybe; + /** The date that the engagements occurred on. */ + occurredOn: Scalars["Date"]["input"]; + /** The total number of marketing emails or messages that were sent for the day. */ + sendsCount?: InputMaybe; + /** The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded. */ + sharesCount?: InputMaybe; + /** The total number of unique clicks on marketing content for the day. */ + uniqueClicksCount?: InputMaybe; + /** The total number of unique views for the day. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content. */ + uniqueViewsCount?: InputMaybe; + /** The total number of unsubscribes for the day. For social media platforms, this represents the number of unfollows. */ + unsubscribesCount?: InputMaybe; + /** The UTC Offset that the app is using to determine which date to allocate spend to. */ + utcOffset?: InputMaybe; + /** The total number of views for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played. */ + viewsCount?: InputMaybe; +}; + +/** Represents actions that market a merchant's store or products. */ +export type MarketingEvent = LegacyInteroperability & Node & { + /** The app that the marketing event is attributed to. */ + app: App; + /** The marketing channel used by the marketing event. */ + channel?: Maybe; + /** A human-readable description of the marketing event. */ + description?: Maybe; + /** The date and time when the marketing event ended. */ + endedAt?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The URL where the marketing event can be managed. */ + manageUrl?: Maybe; + /** The URL where the marketing event can be previewed. */ + previewUrl?: Maybe; + /** An optional ID that helps Shopify validate engagement data. */ + remoteId?: Maybe; + /** The date and time when the marketing event is scheduled to end. */ + scheduledToEndAt?: Maybe; + /** + * Where the `MarketingEvent` occurred and what kind of content was used. + * Because `utmSource` and `utmMedium` are often used interchangeably, this is + * based on a combination of `marketingChannel`, `referringDomain`, and `type` to + * provide a consistent representation for any given piece of marketing + * regardless of the app that created it. + */ + sourceAndMedium: Scalars["String"]["output"]; + /** The date and time when the marketing event started. */ + startedAt: Scalars["DateTime"]["output"]; + /** + * The display text for the marketing event type. + * @deprecated Use `sourceAndMedium` instead. + */ + targetTypeDisplayText: Scalars["String"]["output"]; + /** The marketing event type. */ + type: MarketingTactic; + /** The name of the marketing campaign. */ + utmCampaign?: Maybe; + /** The medium that the marketing campaign is using. Example values: `cpc`, `banner`. */ + utmMedium?: Maybe; + /** The referrer of the marketing event. Example values: `google`, `newsletter`. */ + utmSource?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple MarketingEvents. + */ +export type MarketingEventConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MarketingEventEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MarketingEvent and a cursor during pagination. + */ +export type MarketingEventEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MarketingEventEdge. */ + node: MarketingEvent; +}; + +/** The set of valid sort keys for the MarketingEvent query. */ +export type MarketingEventSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `started_at` value. */ + | "STARTED_AT"; + +/** The available types of marketing event. */ +export type MarketingTactic = + /** An abandoned cart recovery email. */ + | "ABANDONED_CART" + /** An ad, such as a Facebook ad. */ + | "AD" + /** An affiliate link. */ + | "AFFILIATE" + /** A direct visit to the online store. */ + | "DIRECT" + /** A display ad. */ + | "DISPLAY" + /** A follow-up email. */ + | "FOLLOW_UP" + /** A link. */ + | "LINK" + /** A loyalty program. */ + | "LOYALTY" + /** A messaging app, such as Facebook Messenger. */ + | "MESSAGE" + /** A newsletter. */ + | "NEWSLETTER" + /** A notification in the Shopify admin. */ + | "NOTIFICATION" + /** A blog post. */ + | "POST" + /** A promotional receipt. */ + | "RECEIPT" + /** A retargeting ad. */ + | "RETARGETING" + /** Paid search. */ + | "SEARCH" + /** Search engine optimization. */ + | "SEO" + /** A popup on the online store. */ + | "STOREFRONT_APP" + /** A transactional email. */ + | "TRANSACTIONAL"; + +/** Represents a media interface. */ +export type Media = { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The media content type. */ + mediaContentType: MediaContentType; + /** Any errors which have occurred on the media. */ + mediaErrors: Array; + /** The warnings attached to the media. */ + mediaWarnings: Array; + /** The preview image for the media. */ + preview?: Maybe; + /** Current status of the media. */ + status: MediaStatus; +}; + +/** + * An auto-generated type for paginating through multiple Media. + */ +export type MediaConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MediaEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The possible content types for a media object. */ +export type MediaContentType = + /** An externally hosted video. */ + | "EXTERNAL_VIDEO" + /** A Shopify-hosted image. */ + | "IMAGE" + /** A 3d model. */ + | "MODEL_3D" + /** A Shopify-hosted video. */ + | "VIDEO"; + +/** + * An auto-generated type which holds one Media and a cursor during pagination. + */ +export type MediaEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MediaEdge. */ + node: Media; +}; + +/** + * Represents a media error. This typically occurs when there is an issue with the media itself causing it to fail validation. + * Check the media before attempting to upload again. + */ +export type MediaError = { + /** Code representing the type of error. */ + code: MediaErrorCode; + /** Additional details regarding the error. */ + details?: Maybe; + /** Translated error message. */ + message: Scalars["String"]["output"]; +}; + +/** Error types for media. */ +export type MediaErrorCode = + /** Media could not be created because a file with the same name already exists. */ + | "DUPLICATE_FILENAME_ERROR" + /** Media could not be created because embed permissions are disabled for this video. */ + | "EXTERNAL_VIDEO_EMBED_DISABLED" + /** Media could not be created because video is either not found or still transcoding. */ + | "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING" + /** Media could not be created because the external video has an invalid aspect ratio. */ + | "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO" + /** Media could not be created because the external video could not be found. */ + | "EXTERNAL_VIDEO_NOT_FOUND" + /** Media could not be created because the external video is not listed or is private. */ + | "EXTERNAL_VIDEO_UNLISTED" + /** Media could not be created because the cumulative file storage limit would be exceeded. */ + | "FILE_STORAGE_LIMIT_EXCEEDED" + /** File could not be processed because the source could not be downloaded. */ + | "GENERIC_FILE_DOWNLOAD_FAILURE" + /** File could not be created because the size is too large. */ + | "GENERIC_FILE_INVALID_SIZE" + /** Media could not be processed because the image could not be downloaded. */ + | "IMAGE_DOWNLOAD_FAILURE" + /** Media could not be processed because the image could not be processed. */ + | "IMAGE_PROCESSING_FAILURE" + /** Media could not be created because the image has an invalid aspect ratio. */ + | "INVALID_IMAGE_ASPECT_RATIO" + /** Media could not be created because the image size is too large. */ + | "INVALID_IMAGE_FILE_SIZE" + /** Media could not be created because the image's resolution exceeds the max limit. */ + | "INVALID_IMAGE_RESOLUTION" + /** Media could not be processed because the signed URL was invalid. */ + | "INVALID_SIGNED_URL" + /** Media timed out because it is currently being modified by another operation. */ + | "MEDIA_TIMEOUT_ERROR" + /** Media could not be created because the model file failed processing. */ + | "MODEL3D_GLB_OUTPUT_CREATION_ERROR" + /** Media could not be created because the model can't be converted to USDZ format. */ + | "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR" + /** Media could not be created because the model file failed processing. */ + | "MODEL3D_PROCESSING_FAILURE" + /** Media could not be created because the model's thumbnail generation failed. */ + | "MODEL3D_THUMBNAIL_GENERATION_ERROR" + /** There was an issue while trying to generate a new thumbnail. */ + | "MODEL3D_THUMBNAIL_REGENERATION_ERROR" + /** Model failed validation. */ + | "MODEL3D_VALIDATION_ERROR" + /** Media error has occured for unknown reason. */ + | "UNKNOWN" + /** Media could not be created because the image is an unsupported file type. */ + | "UNSUPPORTED_IMAGE_FILE_TYPE" + /** Media could not be created because it has an invalid file type. */ + | "VIDEO_INVALID_FILETYPE_ERROR" + /** Media could not be created because it does not meet the maximum duration requirement. */ + | "VIDEO_MAX_DURATION_ERROR" + /** Media could not be created because it does not meet the maximum height requirement. */ + | "VIDEO_MAX_HEIGHT_ERROR" + /** Media could not be created because it does not meet the maximum width requirement. */ + | "VIDEO_MAX_WIDTH_ERROR" + /** Media could not be created because the metadata could not be read. */ + | "VIDEO_METADATA_READ_ERROR" + /** Media could not be created because it does not meet the minimum duration requirement. */ + | "VIDEO_MIN_DURATION_ERROR" + /** Media could not be created because it does not meet the minimum height requirement. */ + | "VIDEO_MIN_HEIGHT_ERROR" + /** Media could not be created because it does not meet the minimum width requirement. */ + | "VIDEO_MIN_WIDTH_ERROR" + /** Video failed validation. */ + | "VIDEO_VALIDATION_ERROR"; + +/** Host for a Media Resource. */ +export type MediaHost = + /** Host for Vimeo embedded videos. */ + | "VIMEO" + /** Host for YouTube embedded videos. */ + | "YOUTUBE"; + +/** + * An image hosted on Shopify. + */ +export type MediaImage = File & HasMetafields & Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** Any errors that have occurred on the file. */ + fileErrors: Array; + /** The status of the file. */ + fileStatus: FileStatus; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image for the media. Returns `null` until `status` is `READY`. */ + image?: Maybe; + /** The media content type. */ + mediaContentType: MediaContentType; + /** Any errors which have occurred on the media. */ + mediaErrors: Array; + /** The warnings attached to the media. */ + mediaWarnings: Array; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The MIME type of the image. */ + mimeType?: Maybe; + /** The original source of the image. */ + originalSource?: Maybe; + /** The preview image for the media. */ + preview?: Maybe; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** Current status of the media. */ + status: MediaStatus; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An image hosted on Shopify. + */ +export type MediaImageMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * An image hosted on Shopify. + */ +export type MediaImageMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An image hosted on Shopify. + */ +export type MediaImagePrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * An image hosted on Shopify. + */ +export type MediaImagePrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The original source for an image. + */ +export type MediaImageOriginalSource = { + /** The size of the original file in bytes. */ + fileSize?: Maybe; +}; + +/** Represents the preview image for a media. */ +export type MediaPreviewImage = { + /** The preview image for the media. Returns `null` until `status` is `READY`. */ + image?: Maybe; + /** Current status of the preview image. */ + status: MediaPreviewImageStatus; +}; + +/** The possible statuses for a media preview image. */ +export type MediaPreviewImageStatus = + /** Preview image processing has failed. */ + | "FAILED" + /** Preview image is being processed. */ + | "PROCESSING" + /** Preview image is ready to be displayed. */ + | "READY" + /** Preview image is uploaded but not yet processed. */ + | "UPLOADED"; + +/** The possible statuses for a media object. */ +export type MediaStatus = + /** Media processing has failed. */ + | "FAILED" + /** Media is being processed. */ + | "PROCESSING" + /** Media is ready to be displayed. */ + | "READY" + /** Media has been uploaded but not yet processed. */ + | "UPLOADED"; + +/** Represents an error that happens during execution of a Media query or mutation. */ +export type MediaUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MediaUserError`. */ +export type MediaUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The input value is invalid. */ + | "INVALID" + /** Invalid media type. */ + | "INVALID_MEDIA_TYPE" + /** Exceeded the maximum number of 100 variant-media pairs per mutation call. */ + | "MAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED" + /** Media cannot be modified. It is currently being modified by another operation. */ + | "MEDIA_CANNOT_BE_MODIFIED" + /** Media does not exist. */ + | "MEDIA_DOES_NOT_EXIST" + /** Media does not exist on the given product. */ + | "MEDIA_DOES_NOT_EXIST_ON_PRODUCT" + /** The specified media is not attached to the specified variant. */ + | "MEDIA_IS_NOT_ATTACHED_TO_VARIANT" + /** Model3d creation throttle was exceeded. */ + | "MODEL3D_THROTTLE_EXCEEDED" + /** Model validation failed. */ + | "MODEL3D_VALIDATION_ERROR" + /** Non-ready media are not supported. */ + | "NON_READY_MEDIA" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST" + /** Exceeded the limit of media per product. */ + | "PRODUCT_MEDIA_LIMIT_EXCEEDED" + /** Product variant already has attached media. */ + | "PRODUCT_VARIANT_ALREADY_HAS_MEDIA" + /** Variant does not exist on the given product. */ + | "PRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT" + /** Variant specified in more than one pair. */ + | "PRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES" + /** Exceeded the limit of media per shop. */ + | "SHOP_MEDIA_LIMIT_EXCEEDED" + /** Only one mediaId is allowed per variant-media input pair. */ + | "TOO_MANY_MEDIA_PER_INPUT_PAIR" + /** Video creation throttle was exceeded. */ + | "VIDEO_THROTTLE_EXCEEDED" + /** Video validation failed. */ + | "VIDEO_VALIDATION_ERROR"; + +/** + * Represents a media warning. This occurs when there is a non-blocking concern regarding your media. + * Consider reviewing your media to ensure it is correct and its parameters are as expected. + */ +export type MediaWarning = { + /** The code representing the type of warning. */ + code: MediaWarningCode; + /** Translated warning message. */ + message?: Maybe; +}; + +/** Warning types for media. */ +export type MediaWarningCode = + /** 3D model physical size might be invalid. The dimensions of your model are very large. Consider reviewing your model to ensure they are correct. */ + | "MODEL_LARGE_PHYSICAL_SIZE" + /** 3D model physical size might be invalid. The dimensions of your model are very small. Consider reviewing your model to ensure they are correct. */ + | "MODEL_SMALL_PHYSICAL_SIZE"; + +/** The class of the discount for combining purposes. */ +export type MerchandiseDiscountClass = + /** Combined as an order discount. */ + | "ORDER" + /** Combined as a product discount. */ + | "PRODUCT"; + +/** Merchant approval for accelerated onboarding to channel integration apps. */ +export type MerchantApprovalSignals = { + /** Whether the shop's Shopify Payments account identity is verified. Returns `false` if the identity is unverified or if the shop doesn't have a Shopify Payments account. */ + identityVerified: Scalars["Boolean"]["output"]; + /** Whether Shopify has pre-verified the merchant's business for onboarding to channel integration apps. Returns `false` if the shop isn't marked for verification. */ + verifiedByShopify: Scalars["Boolean"]["output"]; + /** Which tier of the Shopify verification was determined for the merchant's business for onboarding to channel integration apps. */ + verifiedByShopifyTier: Scalars["String"]["output"]; +}; + +/** + * Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). + * For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields). + * Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. + * Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value. + */ +export type Metafield = LegacyInteroperability & Node & { + /** The date and time when the metafield was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The metafield definition that the metafield belongs to, if any. */ + definition?: Maybe; + /** The description of the metafield. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The unique identifier for the metafield within its namespace. */ + key: Scalars["String"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** + * The container for a group of metafields that the metafield is associated with. + */ + namespace: Scalars["String"]["output"]; + /** The resource that the metafield is attached to. */ + owner: HasMetafields; + /** + * The type of resource that the metafield is attached to. + */ + ownerType: MetafieldOwnerType; + /** Returns a reference object if the metafield definition's type is a resource reference. */ + reference?: Maybe; + /** A list of reference objects if the metafield's type is a resource reference list. */ + references?: Maybe; + /** + * The type of data that is stored in the metafield. + * Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). + */ + type: Scalars["String"]["output"]; + /** The date and time when the metafield was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * The data stored in the metafield. Always stored as a string, regardless of the metafield's type. + */ + value: Scalars["String"]["output"]; +}; + +/** + * Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). + * For more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields). + * Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. + * Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value. + */ +export type MetafieldReferencesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + +/** The access settings for this metafield definition. */ +export type MetafieldAccess = { + /** The admin access setting used for the metafields under this definition. */ + admin?: Maybe; +}; + +/** + * The input fields for the access settings for the metafields under the definition. + */ +export type MetafieldAccessInput = { + /** The admin access setting to use for the metafields under this definition. */ + admin: MetafieldAdminAccess; +}; + +/** Possible admin access settings for metafields. */ +export type MetafieldAdminAccess = + /** Owner gets full access. The merchant has read-only access. No one else has access rights. */ + | "MERCHANT_READ" + /** Owner gets full access. The merchant has read and write access. No one else has access rights. */ + | "MERCHANT_READ_WRITE" + /** Owner gets full access. No one else has access rights. */ + | "PRIVATE" + /** Owner gets full access. All applications and the merchant have read-only access. */ + | "PUBLIC_READ"; + +/** + * An auto-generated type for paginating through multiple Metafields. + */ +export type MetafieldConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * Metafield definitions enable you to define additional validation constraints for metafields, and enable the + * merchant to edit metafield values in context. + */ +export type MetafieldDefinition = Node & { + /** The access settings associated with the metafield definition. */ + access: MetafieldAccess; + /** The description of the metafield definition. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The unique identifier for the metafield definition within its namespace. */ + key: Scalars["String"]["output"]; + /** The metafields that belong to the metafield definition. */ + metafields: MetafieldConnection; + /** The count of the metafields that belong to the metafield definition. */ + metafieldsCount: Scalars["Int"]["output"]; + /** The human-readable name of the metafield definition. */ + name: Scalars["String"]["output"]; + /** The container for a group of metafields that the metafield definition is associated with. */ + namespace: Scalars["String"]["output"]; + /** The resource type that the metafield definition is attached to. */ + ownerType: MetafieldOwnerType; + /** The position of the metafield definition in the pinned list. */ + pinnedPosition?: Maybe; + /** The standard metafield definition template associated with the metafield definition. */ + standardTemplate?: Maybe; + /** + * The type of data that each of the metafields that belong to the metafield definition will store. + * Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). + */ + type: MetafieldDefinitionType; + /** Whether the metafield definition can be used as a collection condition. */ + useAsCollectionCondition: Scalars["Boolean"]["output"]; + /** The validation status for the metafields that belong to the metafield definition. */ + validationStatus: MetafieldDefinitionValidationStatus; + /** + * A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for + * the metafields that belong to the metafield definition. For example, for a metafield definition with the + * type `date`, you can set a minimum date validation so that each of the metafields that belong to it can only + * store dates after the specified minimum. + */ + validations: Array; + /** + * Whether each of the metafields that belong to the metafield definition are visible from the Storefront API. + */ + visibleToStorefrontApi: Scalars["Boolean"]["output"]; +}; + +/** + * Metafield definitions enable you to define additional validation constraints for metafields, and enable the + * merchant to edit metafield values in context. + */ +export type MetafieldDefinitionMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + validationStatus?: InputMaybe; +}; + +/** + * Metafield definitions enable you to define additional validation constraints for metafields, and enable the + * merchant to edit metafield values in context. + */ +export type MetafieldDefinitionMetafieldsCountArgs = { + validationStatus?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MetafieldDefinitions. + */ +export type MetafieldDefinitionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldDefinitionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `metafieldDefinitionCreate` mutation. */ +export type MetafieldDefinitionCreatePayload = { + /** The metafield definition that was created. */ + createdDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `MetafieldDefinitionCreate`. */ +export type MetafieldDefinitionCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldDefinitionCreateUserError`. */ +export type MetafieldDefinitionCreateUserErrorCode = + /** A duplicate option. */ + | "DUPLICATE_OPTION" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The input value is invalid. */ + | "INVALID" + /** A field contains an invalid character. */ + | "INVALID_CHARACTER" + /** An invalid option. */ + | "INVALID_OPTION" + /** The maximum limit of definitions per owner type has exceeded. */ + | "LIMIT_EXCEEDED" + /** You have reached the maximum allowed definitions for automated collections. */ + | "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS" + /** The pinned limit has been reached for the owner type. */ + | "PINNED_LIMIT_REACHED" + /** The input value needs to be blank. */ + | "PRESENT" + /** This namespace and key combination is reserved for standard definitions. */ + | "RESERVED_NAMESPACE_KEY" + /** The definition limit per owner type has exceeded. */ + | "RESOURCE_TYPE_LIMIT_EXCEEDED" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** The definition type is not eligible to be used as collection condition. */ + | "TYPE_NOT_ALLOWED_FOR_CONDITIONS" + /** This namespace and key combination is already in use for a set of your metafields. */ + | "UNSTRUCTURED_ALREADY_EXISTS"; + +/** Return type for `metafieldDefinitionDelete` mutation. */ +export type MetafieldDefinitionDeletePayload = { + /** The ID of the deleted metafield definition. */ + deletedDefinitionId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `MetafieldDefinitionDelete`. */ +export type MetafieldDefinitionDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldDefinitionDeleteUserError`. */ +export type MetafieldDefinitionDeleteUserErrorCode = + /** Owner type can't be used in this mutation. */ + | "DISALLOWED_OWNER_TYPE" + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** Action cannot proceed. Definition is currently in use. */ + | "METAFIELD_DEFINITION_IN_USE" + /** Definition not found. */ + | "NOT_FOUND" + /** The input value needs to be blank. */ + | "PRESENT" + /** Deleting a reference type metafield definition requires deletion of its associated metafields. */ + | "REFERENCE_TYPE_DELETION_ERROR"; + +/** + * An auto-generated type which holds one MetafieldDefinition and a cursor during pagination. + */ +export type MetafieldDefinitionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetafieldDefinitionEdge. */ + node: MetafieldDefinition; +}; + +/** + * The input fields required to create a metafield definition. + */ +export type MetafieldDefinitionInput = { + /** The access settings that apply to each of the metafields that belong to the metafield definition. */ + access?: InputMaybe; + /** The description for the metafield definition. */ + description?: InputMaybe; + /** + * The unique identifier for the metafield definition within its namespace. + * + * Must be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters. + */ + key: Scalars["String"]["input"]; + /** The human-readable name for the metafield definition. */ + name: Scalars["String"]["input"]; + /** + * The container for a group of metafields that the metafield definition will be associated with. + * + * Must be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters. + */ + namespace: Scalars["String"]["input"]; + /** The resource type that the metafield definition is attached to. */ + ownerType: MetafieldOwnerType; + /** + * Whether to [pin](https://help.shopify.com/manual/custom-data/metafields/pinning-metafield-definitions) + * the metafield definition. + */ + pin?: InputMaybe; + /** + * The type of data that each of the metafields that belong to the metafield definition will store. + * Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). + */ + type: Scalars["String"]["input"]; + /** Whether the metafield definition can be used as a collection condition. */ + useAsCollectionCondition?: InputMaybe; + /** + * A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for + * the metafields that belong to the metafield definition. For example, for a metafield definition with the + * type `date`, you can set a minimum date validation so that each of the metafields that belong to it can only + * store dates after the specified minimum. + */ + validations?: InputMaybe>; + /** Whether metafields for the metafield definition are visible using the Storefront API. */ + visibleToStorefrontApi?: InputMaybe; +}; + +/** Return type for `metafieldDefinitionPin` mutation. */ +export type MetafieldDefinitionPinPayload = { + /** The metafield definition that was pinned. */ + pinnedDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `MetafieldDefinitionPin`. */ +export type MetafieldDefinitionPinUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldDefinitionPinUserError`. */ +export type MetafieldDefinitionPinUserErrorCode = + /** The metafield definition is already pinned. */ + | "ALREADY_PINNED" + /** Owner type can't be used in this mutation. */ + | "DISALLOWED_OWNER_TYPE" + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** The metafield definition was not found. */ + | "NOT_FOUND" + /** The pinned limit has been reached for owner type. */ + | "PINNED_LIMIT_REACHED"; + +/** Possible metafield definition pinned statuses. */ +export type MetafieldDefinitionPinnedStatus = + /** All metafield definitions. */ + | "ANY" + /** Only metafield definitions that are pinned. */ + | "PINNED" + /** Only metafield definitions that are not pinned. */ + | "UNPINNED"; + +/** The set of valid sort keys for the MetafieldDefinition query. */ +export type MetafieldDefinitionSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** Sort by the `pinned_position` value. */ + | "PINNED_POSITION" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * The type and name for the optional validation configuration of a metafield. + * + * For example, a supported validation might consist of a `max` name and a `number_integer` type. + * This validation can then be used to enforce a maximum character length for a `single_line_text_field` metafield. + */ +export type MetafieldDefinitionSupportedValidation = { + /** The name of the metafield definition validation. */ + name: Scalars["String"]["output"]; + /** The type of input for the validation. */ + type: Scalars["String"]["output"]; +}; + +/** + * A metafield definition type provides basic foundation and validation for a metafield. + */ +export type MetafieldDefinitionType = { + /** The category associated with the metafield definition type. */ + category: Scalars["String"]["output"]; + /** + * The name of the type for the metafield definition. + * See the list of [supported types](https://shopify.dev/apps/metafields/types). + */ + name: Scalars["String"]["output"]; + /** The supported validations for a metafield definition type. */ + supportedValidations: Array; + /** Whether metafields without a definition can be migrated to a definition of this type. */ + supportsDefinitionMigrations: Scalars["Boolean"]["output"]; + /** + * The value type for a metafield created with this definition type. + * @deprecated `valueType` is deprecated and `name` should be used for type information. + */ + valueType: MetafieldValueType; +}; + +/** Return type for `metafieldDefinitionUnpin` mutation. */ +export type MetafieldDefinitionUnpinPayload = { + /** The metafield definition that was unpinned. */ + unpinnedDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `MetafieldDefinitionUnpin`. */ +export type MetafieldDefinitionUnpinUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldDefinitionUnpinUserError`. */ +export type MetafieldDefinitionUnpinUserErrorCode = + /** Owner type can't be used in this mutation. */ + | "DISALLOWED_OWNER_TYPE" + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** The metafield definition was not found. */ + | "NOT_FOUND" + /** The metafield definition isn't pinned. */ + | "NOT_PINNED"; + +/** + * The input fields required to update a metafield definition. + */ +export type MetafieldDefinitionUpdateInput = { + /** The access settings that apply to each of the metafields that belong to the metafield definition. */ + access?: InputMaybe; + /** The description for the metafield definition. */ + description?: InputMaybe; + /** + * The unique identifier for the metafield definition within its namespace. Used to help identify the metafield + * definition, but can't be updated itself. + */ + key: Scalars["String"]["input"]; + /** The human-readable name for the metafield definition. */ + name?: InputMaybe; + /** + * The container for a group of metafields that the metafield definition is associated with. Used to help identify + * the metafield definition, but cannot be updated itself. + */ + namespace: Scalars["String"]["input"]; + /** + * The resource type that the metafield definition is attached to. Used to help identify the metafield definition, + * but can't be updated itself. + */ + ownerType: MetafieldOwnerType; + /** Whether to pin the metafield definition. */ + pin?: InputMaybe; + /** Whether the metafield definition can be used as a collection condition. */ + useAsCollectionCondition?: InputMaybe; + /** + * A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for + * the metafields that belong to the metafield definition. For example, for a metafield definition with the + * type `date`, you can set a minimum date validation so that each of the metafields that belong to it can only + * store dates after the specified minimum. + */ + validations?: InputMaybe>; + /** + * Whether each of the metafields that belong to the metafield definition are visible from the Storefront API. + */ + visibleToStorefrontApi?: InputMaybe; +}; + +/** Return type for `metafieldDefinitionUpdate` mutation. */ +export type MetafieldDefinitionUpdatePayload = { + /** The metafield definition that was updated. */ + updatedDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The asynchronous job updating the metafield definition's validation_status. */ + validationJob?: Maybe; +}; + +/** An error that occurs during the execution of `MetafieldDefinitionUpdate`. */ +export type MetafieldDefinitionUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldDefinitionUpdateUserError`. */ +export type MetafieldDefinitionUpdateUserErrorCode = + /** An internal error occurred. */ + | "INTERNAL_ERROR" + /** An invalid input. */ + | "INVALID_INPUT" + /** Action cannot proceed. Definition is currently in use. */ + | "METAFIELD_DEFINITION_IN_USE" + /** The metafield definition wasn't found. */ + | "NOT_FOUND" + /** You have reached the maximum allowed definitions for automated collections. */ + | "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS" + /** The pinned limit has been reached for the owner type. */ + | "PINNED_LIMIT_REACHED" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is too long. */ + | "TOO_LONG" + /** The definition type is not eligible to be used as collection condition. */ + | "TYPE_NOT_ALLOWED_FOR_CONDITIONS"; + +/** + * A configured metafield definition validation. + * + * For example, for a metafield definition of `number_integer` type, you can set a validation with the name `max` + * and a value of `15`. This validation will ensure that the value of the metafield is a number less than or equal to 15. + * + * Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types). + */ +export type MetafieldDefinitionValidation = { + /** The validation name. */ + name: Scalars["String"]["output"]; + /** The name for the metafield type of this validation. */ + type: Scalars["String"]["output"]; + /** The validation value. */ + value?: Maybe; +}; + +/** + * The name and value for a metafield definition validation. + * + * For example, for a metafield definition of `single_line_text_field` type, you can set a validation with the name `min` and a value of `10`. + * This validation will ensure that the value of the metafield is at least 10 characters. + * + * Refer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types). + */ +export type MetafieldDefinitionValidationInput = { + /** The name for the metafield definition validation. */ + name: Scalars["String"]["input"]; + /** The value for the metafield definition validation. */ + value: Scalars["String"]["input"]; +}; + +/** Possible metafield definition validation statuses. */ +export type MetafieldDefinitionValidationStatus = + /** All of this definition's metafields are valid. */ + | "ALL_VALID" + /** Asynchronous validation of this definition's metafields is in progress. */ + | "IN_PROGRESS" + /** Some of this definition's metafields are invalid. */ + | "SOME_INVALID"; + +/** The input fields to delete a metafield. */ +export type MetafieldDeleteInput = { + /** The ID of the metafield to delete. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `metafieldDelete` mutation. */ +export type MetafieldDeletePayload = { + /** The ID of the deleted metafield. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Metafield and a cursor during pagination. + */ +export type MetafieldEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetafieldEdge. */ + node: Metafield; +}; + +/** + * The input fields to use to create or update a metafield through a mutation on the owning resource. + * An alternative way to create or update a metafield is by using the + * [metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation. + */ +export type MetafieldInput = { + /** + * The unique ID of the metafield. + * + * Required when updating a metafield, but shouldn't be included when creating as it's created automatically. + */ + id?: InputMaybe; + /** + * The unique identifier for a metafield within its namespace. + * + * Required when creating a metafield, but optional when updating. Used to help identify the metafield when + * updating, but can't be updated itself. + * + * Must be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters. + */ + key?: InputMaybe; + /** + * The container for a group of metafields that the metafield is or will be associated with. Used in tandem with + * `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the same `key`. + * + * Required when creating a metafield, but optional when updating. Used to help identify the metafield when + * updating, but can't be updated itself. + * + * Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters. + */ + namespace?: InputMaybe; + /** + * The type of data that is stored in the metafield. + * Refer to the list of [supported types](https://shopify.dev/apps/metafields/types). + * + * Required when creating a metafield, but optional when updating. + */ + type?: InputMaybe; + /** + * The data stored in the metafield. Always stored as a string, regardless of the metafield's type. + */ + value?: InputMaybe; +}; + +/** Possible types of a metafield's owner resource. */ +export type MetafieldOwnerType = + /** The Api Permission metafield owner type. */ + | "API_PERMISSION" + /** The Article metafield owner type. */ + | "ARTICLE" + /** The Blog metafield owner type. */ + | "BLOG" + /** The Collection metafield owner type. */ + | "COLLECTION" + /** The Company metafield owner type. */ + | "COMPANY" + /** The Company Location metafield owner type. */ + | "COMPANY_LOCATION" + /** The Customer metafield owner type. */ + | "CUSTOMER" + /** The Delivery Customization metafield owner type. */ + | "DELIVERY_CUSTOMIZATION" + /** The Discount metafield owner type. */ + | "DISCOUNT" + /** The Draft Order metafield owner type. */ + | "DRAFTORDER" + /** The Location metafield owner type. */ + | "LOCATION" + /** The Market metafield owner type. */ + | "MARKET" + /** The Media Image metafield owner type. */ + | "MEDIA_IMAGE" + /** The Order metafield owner type. */ + | "ORDER" + /** The Page metafield owner type. */ + | "PAGE" + /** The Payment Customization metafield owner type. */ + | "PAYMENT_CUSTOMIZATION" + /** The Product metafield owner type. */ + | "PRODUCT" + /** The Product Image metafield owner type. */ + | "PRODUCTIMAGE" + /** The Product Variant metafield owner type. */ + | "PRODUCTVARIANT" + /** The Shop metafield owner type. */ + | "SHOP"; + +/** + * The resource referenced by the metafield value. + */ +export type MetafieldReference = + | Collection + | GenericFile + | MediaImage + | Metaobject + | OnlineStorePage + | Product + | ProductVariant + | Video; + +/** + * An auto-generated type for paginating through multiple MetafieldReferences. + */ +export type MetafieldReferenceConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldReferenceEdge. */ + nodes: Array>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MetafieldReference and a cursor during pagination. + */ +export type MetafieldReferenceEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetafieldReferenceEdge. */ + node?: Maybe; +}; + +/** + * Types of resources that may use metafields to reference other resources. + */ +export type MetafieldReferencer = + | AppInstallation + | Collection + | Customer + | DeliveryCustomization + | DiscountAutomaticNode + | DiscountCodeNode + | DiscountNode + | DraftOrder + | FulfillmentOrder + | Location + | Market + | Metaobject + | OnlineStoreArticle + | OnlineStoreBlog + | OnlineStorePage + | Order + | PaymentCustomization + | Product + | ProductVariant + | Shop; + +/** + * Defines a relation between two resources via a reference metafield. + * The referencer owns the joining field with a given namespace and key, + * while the target is referenced by the field. + */ +export type MetafieldRelation = { + /** The key of the field making the reference. */ + key: Scalars["String"]["output"]; + /** The name of the field making the reference. */ + name: Scalars["String"]["output"]; + /** The namespace of the metafield making the reference, or type of the metaobject. */ + namespace: Scalars["String"]["output"]; + /** The resource making the reference. */ + referencer: MetafieldReferencer; + /** The referenced resource. */ + target: MetafieldReference; +}; + +/** + * An auto-generated type for paginating through multiple MetafieldRelations. + */ +export type MetafieldRelationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldRelationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MetafieldRelation and a cursor during pagination. + */ +export type MetafieldRelationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetafieldRelationEdge. */ + node: MetafieldRelation; +}; + +/** + * By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API, + * you need to create a `MetafieldStorefrontVisibility` record. A `MetafieldStorefrontVisibility` record is a list + * of the metafields, defined by the `owner_type`, `namespace`, and `key`, to make visible in the Storefront API. + * + * Learn about [exposing metafields in the Storefront API] + * (https://shopify.dev/custom-storefronts/products-collections/metafields) + * for more details. + */ +export type MetafieldStorefrontVisibility = LegacyInteroperability & Node & { + /** The date and time when the metafield was set to visible in the Storefront API. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The key of a metafield to make visible in the Storefront API. */ + key: Scalars["String"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The namespace of a metafield to make visible in the Storefront API. */ + namespace: Scalars["String"]["output"]; + /** The owner type of a metafield to make visible in the Storefront API. */ + ownerType: MetafieldOwnerType; + /** + * The date and time when the `MetafieldStorefrontVisilibty` record was updated. + */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities. + */ +export type MetafieldStorefrontVisibilityConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldStorefrontVisibilityEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `metafieldStorefrontVisibilityCreate` mutation. */ +export type MetafieldStorefrontVisibilityCreatePayload = { + /** The `MetafieldStorefrontVisibility` that was created. */ + metafieldStorefrontVisibility?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `metafieldStorefrontVisibilityDelete` mutation. */ +export type MetafieldStorefrontVisibilityDeletePayload = { + /** The ID of the deleted `MetafieldStorefrontVisibility` record. */ + deletedMetafieldStorefrontVisibilityId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination. + */ +export type MetafieldStorefrontVisibilityEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetafieldStorefrontVisibilityEdge. */ + node: MetafieldStorefrontVisibility; +}; + +/** + * The input fields to create a MetafieldStorefrontVisibility record. + */ +export type MetafieldStorefrontVisibilityInput = { + /** The key of a metafield to make visible in the Storefront API. */ + key: Scalars["String"]["input"]; + /** The namespace of a metafield to make visible in the Storefront API. */ + namespace: Scalars["String"]["input"]; + /** The owner type of a metafield to make visible in the Storefront API. */ + ownerType: MetafieldOwnerType; +}; + +/** Possible metafield validation statuses. */ +export type MetafieldValidationStatus = + /** Any validation status (valid or invalid). */ + | "ANY" + /** Invalid (according to definition). */ + | "INVALID" + /** Valid (according to definition). */ + | "VALID"; + +/** + * Legacy type information for the stored value. + * Replaced by `type`. + */ +export type MetafieldValueType = + /** A `true` or `false` value. */ + | "BOOLEAN" + /** A whole number. */ + | "INTEGER" + /** A JSON string. */ + | "JSON_STRING" + /** A text field. */ + | "STRING"; + +/** The input fields for a metafield value to set. */ +export type MetafieldsSetInput = { + /** + * The unique identifier for a metafield within its namespace. + * + * Must be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters. + */ + key: Scalars["String"]["input"]; + /** + * The container for a group of metafields that the metafield is or will be associated with. Used in tandem + * with `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the + * same `key`. + * + * Must be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters. + */ + namespace: Scalars["String"]["input"]; + /** The unique ID of the resource that the metafield is attached to. */ + ownerId: Scalars["ID"]["input"]; + /** + * The type of data that is stored in the metafield. + * The type must be one of the [supported types](https://shopify.dev/apps/metafields/types). + * + * Required when there is no corresponding definition for the given `namespace`, `key`, and + * owner resource type (derived from `ownerId`). + */ + type?: InputMaybe; + /** + * The data stored in the metafield. Always stored as a string, regardless of the metafield's type. + */ + value: Scalars["String"]["input"]; +}; + +/** Return type for `metafieldsSet` mutation. */ +export type MetafieldsSetPayload = { + /** The list of metafields that were set. */ + metafields?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `MetafieldsSet`. */ +export type MetafieldsSetUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The index of the array element that's causing the error. */ + elementIndex?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetafieldsSetUserError`. */ +export type MetafieldsSetUserErrorCode = + /** ApiPermission metafields can only be created or updated by the app owner. */ + | "APP_NOT_AUTHORIZED" + /** The input value is blank. */ + | "BLANK" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The type is invalid. */ + | "INVALID_TYPE" + /** The value is invalid for metafield type or for definition options. */ + | "INVALID_VALUE" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT"; + +/** Provides an object instance represented by a MetaobjectDefinition. */ +export type Metaobject = Node & { + /** Metaobject capabilities for this Metaobject. */ + capabilities: MetaobjectCapabilityData; + /** The app used to create the object. */ + createdBy: App; + /** The MetaobjectDefinition that models this object type. */ + definition: MetaobjectDefinition; + /** The preferred display name field value of the metaobject. */ + displayName: Scalars["String"]["output"]; + /** The field for an object key, or null if the key has no field definition. */ + field?: Maybe; + /** All ordered fields of the metaobject with their definitions and values. */ + fields: Array; + /** The unique handle of the object, useful as a custom ID. */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** List of back references metafields that belong to the resource. */ + referencedBy: MetafieldRelationConnection; + /** The staff member who created the metaobject. */ + staffMember?: Maybe; + /** The type of the metaobject. */ + type: Scalars["String"]["output"]; + /** When the object was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** Provides an object instance represented by a MetaobjectDefinition. */ +export type MetaobjectFieldArgs = { + key: Scalars["String"]["input"]; +}; + +/** Provides an object instance represented by a MetaobjectDefinition. */ +export type MetaobjectReferencedByArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Provides metaobject definition's access configuration. */ +export type MetaobjectAccess = { + /** + * Access configuration for Admin API surface areas, including the GraphQL Admin API. + */ + admin: MetaobjectAdminAccess; + /** + * Access configuration for Storefront surface areas, including the GraphQL Storefront API and Liquid. + */ + storefront: MetaobjectStorefrontAccess; +}; + +/** The input fields for configuring metaobject access controls. */ +export type MetaobjectAccessInput = { + /** + * Access configuration for Admin API surface areas, including the GraphQL Admin API. + */ + admin?: InputMaybe; + /** + * Access configuration for Storefront API surface areas, including the GraphQL Storefront API and Liquid. + */ + storefront?: InputMaybe; +}; + +/** Defines how the metaobjects of a definition can be accessed in admin API surface areas. */ +export type MetaobjectAdminAccess = + /** + * Applications that act on behalf of merchants can read metaobjects. + * Only the owning application can write metaobjects. + */ + | "MERCHANT_READ" + /** + * The owning application, as well as applications that act on behalf of merchants can read and write metaobjects. + * No other applications can read or write metaobjects. + */ + | "MERCHANT_READ_WRITE" + /** + * Only the application that owns a metaobject can read and write to it. + */ + | "PRIVATE" + /** + * All applications with the `metaobjects` access scope can read metaobjects. + * Only the owning application can write metaobjects. + */ + | "PUBLIC_READ" + /** + * All applications with the `metaobjects` access scope can read and write metaobjects. + */ + | "PUBLIC_READ_WRITE"; + +/** Return type for `metaobjectBulkDelete` mutation. */ +export type MetaobjectBulkDeletePayload = { + /** The asynchronous job that deletes the metaobjects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Specifies the condition by which metaobjects are deleted. + * Exactly one field of input is required. + */ +export type MetaobjectBulkDeleteWhereCondition = { + /** A list of metaobjects IDs to delete. */ + ids?: InputMaybe>; + /** Deletes all metaobjects with the specified `type`. */ + type?: InputMaybe; +}; + +/** Provides the capabilities of a metaobject definition. */ +export type MetaobjectCapabilities = { + /** Indicate whether a metaobject definition is publishable. */ + publishable: MetaobjectCapabilitiesPublishable; + /** Indicate whether a metaobject definition is translatable. */ + translatable: MetaobjectCapabilitiesTranslatable; +}; + +/** The publishable capability of a metaobject definition. */ +export type MetaobjectCapabilitiesPublishable = { + /** Indicates if the capability is enabled. */ + enabled: Scalars["Boolean"]["output"]; +}; + +/** The translatable capability of a metaobject definition. */ +export type MetaobjectCapabilitiesTranslatable = { + /** Indicates if the capability is enabled. */ + enabled: Scalars["Boolean"]["output"]; +}; + +/** The input fields for creating a metaobject capability. */ +export type MetaobjectCapabilityCreateInput = { + /** The input for enabling the publishable capability. */ + publishable?: InputMaybe; + /** The input for enabling the translatable capability. */ + translatable?: InputMaybe; +}; + +/** Provides the capabilities of a metaobject. */ +export type MetaobjectCapabilityData = { + /** The publishable capability for this metaobject. */ + publishable?: Maybe; +}; + +/** The input fields for metaobject capabilities. */ +export type MetaobjectCapabilityDataInput = { + /** Publishable capability input. */ + publishable?: InputMaybe; +}; + +/** The publishable capability for the parent metaobject. */ +export type MetaobjectCapabilityDataPublishable = { + /** The visibility status of this metaobject across all channels. */ + status: MetaobjectStatus; +}; + +/** The input fields for publishable capability to adjust visibility on channels. */ +export type MetaobjectCapabilityDataPublishableInput = { + /** The visibility status of this metaobject across all channels. */ + status: MetaobjectStatus; +}; + +/** The input fields for enabling and disabling the publishable capability. */ +export type MetaobjectCapabilityPublishableInput = { + /** Indicates whether the capability should be enabled or disabled. */ + enabled: Scalars["Boolean"]["input"]; +}; + +/** The input fields for enabling and disabling the translatable capability. */ +export type MetaobjectCapabilityTranslatableInput = { + /** Indicates whether the capability should be enabled or disabled. */ + enabled: Scalars["Boolean"]["input"]; +}; + +/** The input fields for updating a metaobject capability. */ +export type MetaobjectCapabilityUpdateInput = { + /** The input for updating the publishable capability. */ + publishable?: InputMaybe; + /** The input for updating the translatable capability. */ + translatable?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Metaobjects. + */ +export type MetaobjectConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetaobjectEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields for creating a metaobject. */ +export type MetaobjectCreateInput = { + /** Capabilities for the metaobject. */ + capabilities?: InputMaybe; + /** Values for fields. These are mapped by key to fields of the metaobject definition. */ + fields?: InputMaybe>; + /** A unique handle for the metaobject. This value is auto-generated when omitted. */ + handle?: InputMaybe; + /** The type of the metaobject. Must match an existing metaobject definition type. */ + type: Scalars["String"]["input"]; +}; + +/** Return type for `metaobjectCreate` mutation. */ +export type MetaobjectCreatePayload = { + /** The created metaobject. */ + metaobject?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Provides the definition of a generic object structure composed of metafields. */ +export type MetaobjectDefinition = Node & { + /** Access configuration for the metaobject definition. */ + access: MetaobjectAccess; + /** The capabilities of the metaobject definition. */ + capabilities: MetaobjectCapabilities; + /** The administrative description. */ + description?: Maybe; + /** The key of a field to reference as the display name for each object. */ + displayNameKey?: Maybe; + /** The fields defined for this object type. */ + fieldDefinitions: Array; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** A paginated connection to the metaobjects associated with the definition. */ + metaobjects: MetaobjectConnection; + /** The count of metaobjects created for the definition. */ + metaobjectsCount: Scalars["Int"]["output"]; + /** The human-readable name. */ + name: Scalars["String"]["output"]; + /** The type of the object definition. Defines the namespace of associated metafields. */ + type: Scalars["String"]["output"]; +}; + +/** Provides the definition of a generic object structure composed of metafields. */ +export type MetaobjectDefinitionMetaobjectsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MetaobjectDefinitions. + */ +export type MetaobjectDefinitionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetaobjectDefinitionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields for creating a metaobject definition. */ +export type MetaobjectDefinitionCreateInput = { + /** Access configuration for the metaobjects created with this definition. */ + access?: InputMaybe; + /** The capabilities of the metaobject definition. */ + capabilities?: InputMaybe; + /** An administrative description of the definition. */ + description?: InputMaybe; + /** The key of a field to reference as the display name for metaobjects of this type. */ + displayNameKey?: InputMaybe; + /** A set of field definitions to create on this metaobject definition. */ + fieldDefinitions: Array; + /** A human-readable name for the definition. This can be changed at any time. */ + name?: InputMaybe; + /** + * The type of the metaobject definition. This can't be changed. + * + * Must be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters. + */ + type: Scalars["String"]["input"]; +}; + +/** Return type for `metaobjectDefinitionCreate` mutation. */ +export type MetaobjectDefinitionCreatePayload = { + /** The created metaobject definition. */ + metaobjectDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `metaobjectDefinitionDelete` mutation. */ +export type MetaobjectDefinitionDeletePayload = { + /** The ID of the deleted metaobjects definition. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one MetaobjectDefinition and a cursor during pagination. + */ +export type MetaobjectDefinitionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetaobjectDefinitionEdge. */ + node: MetaobjectDefinition; +}; + +/** The input fields for updating a metaobject definition. */ +export type MetaobjectDefinitionUpdateInput = { + /** Access configuration for the metaobjects created with this definition. */ + access?: InputMaybe; + /** The capabilities of the metaobject definition. */ + capabilities?: InputMaybe; + /** An administrative description of the definition. */ + description?: InputMaybe; + /** The key of a metafield to reference as the display name for objects of this type. */ + displayNameKey?: InputMaybe; + /** A set of operations for modifying field definitions. */ + fieldDefinitions?: InputMaybe>; + /** A human-readable name for the definition. */ + name?: InputMaybe; + /** + * Whether the field order should be reset while updating. + * If `true`, then the order is assigned based on submitted fields followed by alphabetized field omissions. + * If `false`, then no changes are made to the existing field order and new fields are appended at the end. + */ + resetFieldOrder?: InputMaybe; +}; + +/** Return type for `metaobjectDefinitionUpdate` mutation. */ +export type MetaobjectDefinitionUpdatePayload = { + /** The updated metaobject definition. */ + metaobjectDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `metaobjectDelete` mutation. */ +export type MetaobjectDeletePayload = { + /** The ID of the deleted metaobject. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Metaobject and a cursor during pagination. + */ +export type MetaobjectEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of MetaobjectEdge. */ + node: Metaobject; +}; + +/** Provides a field definition and the data value assigned to it. */ +export type MetaobjectField = { + /** The field definition for this object key. */ + definition: MetaobjectFieldDefinition; + /** The object key of this field. */ + key: Scalars["String"]["output"]; + /** For resource reference fields, provides the referenced object. */ + reference?: Maybe; + /** For resource reference list fields, provides the list of referenced objects. */ + references?: Maybe; + /** The type of the field. */ + type: Scalars["String"]["output"]; + /** The assigned field value, always stored as a string regardless of the field type. */ + value?: Maybe; +}; + +/** Provides a field definition and the data value assigned to it. */ +export type MetaobjectFieldReferencesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + +/** + * Defines a field for a MetaobjectDefinition with properties + * such as the field's data type and validations. + */ +export type MetaobjectFieldDefinition = { + /** The administrative description. */ + description?: Maybe; + /** A key name used to identify the field within the metaobject composition. */ + key: Scalars["String"]["output"]; + /** The human-readable name. */ + name: Scalars["String"]["output"]; + /** Required status of the field within the metaobject composition. */ + required: Scalars["Boolean"]["output"]; + /** The type of data that the field stores. */ + type: MetafieldDefinitionType; + /** + * A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for + * the field. For example, a field with the type `date` can set a minimum date requirement. + */ + validations: Array; +}; + +/** The input fields for creating a metaobject field definition. */ +export type MetaobjectFieldDefinitionCreateInput = { + /** An administrative description of the field. */ + description?: InputMaybe; + /** + * The key of the new field definition. This can't be changed. + * + * Must be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters. + */ + key: Scalars["String"]["input"]; + /** A human-readable name for the field. This can be changed at any time. */ + name?: InputMaybe; + /** Whether metaobjects require a saved value for the field. */ + required?: InputMaybe; + /** The metafield type applied to values of the field. */ + type: Scalars["String"]["input"]; + /** Custom validations that apply to values assigned to the field. */ + validations?: InputMaybe>; +}; + +/** The input fields for deleting a metaobject field definition. */ +export type MetaobjectFieldDefinitionDeleteInput = { + /** The key of the field definition to delete. */ + key: Scalars["String"]["input"]; +}; + +/** + * The input fields for possible operations for modifying field definitions. Exactly one option is required. + */ +export type MetaobjectFieldDefinitionOperationInput = { + /** The input fields for creating a metaobject field definition. */ + create?: InputMaybe; + /** The input fields for deleting a metaobject field definition. */ + delete?: InputMaybe; + /** The input fields for updating a metaobject field definition. */ + update?: InputMaybe; +}; + +/** The input fields for updating a metaobject field definition. */ +export type MetaobjectFieldDefinitionUpdateInput = { + /** An administrative description of the field. */ + description?: InputMaybe; + /** The key of the field definition to update. */ + key: Scalars["String"]["input"]; + /** A human-readable name for the field. */ + name?: InputMaybe; + /** Whether metaobjects require a saved value for the field. */ + required?: InputMaybe; + /** Custom validations that apply to values assigned to the field. */ + validations?: InputMaybe>; +}; + +/** The input fields for a metaobject field value. */ +export type MetaobjectFieldInput = { + /** The key of the field. */ + key: Scalars["String"]["input"]; + /** The value of the field. */ + value: Scalars["String"]["input"]; +}; + +/** The input fields for retrieving a metaobject by handle. */ +export type MetaobjectHandleInput = { + /** The handle of the metaobject to create or update. */ + handle: Scalars["String"]["input"]; + /** The type of the metaobject. Must match an existing metaobject definition type. */ + type: Scalars["String"]["input"]; +}; + +/** Defines visibility status for metaobjects. */ +export type MetaobjectStatus = + /** The metaobjects is active for public use. */ + | "ACTIVE" + /** The metaobjects is an internal record. */ + | "DRAFT"; + +/** + * Defines how the metaobjects of a definition can be accessed in Storefront API surface areas, including Liquid and the GraphQL Storefront API. + */ +export type MetaobjectStorefrontAccess = + /** + * Metaobjects are not accessible in any Storefront API surface area. + */ + | "NONE" + /** + * Metaobjects are accessible in the GraphQL Storefront API by any application with the `unauthenticated_read_metaobjects` access scope. + * Metaobjects are accessible in online store Liquid templates. + */ + | "PUBLIC_READ"; + +/** The input fields for updating a metaobject. */ +export type MetaobjectUpdateInput = { + /** Capabilities for the metaobject. */ + capabilities?: InputMaybe; + /** Values for fields. These are mapped by key to fields of the metaobject definition. */ + fields?: InputMaybe>; + /** A unique handle for the metaobject. */ + handle?: InputMaybe; +}; + +/** Return type for `metaobjectUpdate` mutation. */ +export type MetaobjectUpdatePayload = { + /** The updated metaobject. */ + metaobject?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for upserting a metaobject. */ +export type MetaobjectUpsertInput = { + /** Capabilities for the metaobject. */ + capabilities?: InputMaybe; + /** Values for fields. These are mapped by key to fields of the metaobject definition. */ + fields?: InputMaybe>; + /** The handle of the metaobject. */ + handle?: InputMaybe; +}; + +/** Return type for `metaobjectUpsert` mutation. */ +export type MetaobjectUpsertPayload = { + /** The created or updated metaobject. */ + metaobject?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Defines errors encountered while managing metaobject resources. */ +export type MetaobjectUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The index of the failing list element in an array. */ + elementIndex?: Maybe; + /** The key of the failing object element. */ + elementKey?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `MetaobjectUserError`. */ +export type MetaobjectUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The capability you are using is not enabled. */ + | "CAPABILITY_NOT_ENABLED" + /** Duplicate inputs were provided for this field key. */ + | "DUPLICATE_FIELD_INPUT" + /** The targeted object cannot be modified. */ + | "IMMUTABLE" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** An unexpected error occurred. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** The value for the metafield definition option was invalid. */ + | "INVALID_OPTION" + /** The metafield type is invalid. */ + | "INVALID_TYPE" + /** The value is invalid for the metafield type or the definition options. */ + | "INVALID_VALUE" + /** The maximum number of metaobjects definitions has been exceeded. */ + | "MAX_DEFINITIONS_EXCEEDED" + /** The maximum number of metaobjects per shop has been exceeded. */ + | "MAX_OBJECTS_EXCEEDED" + /** Not authorized. */ + | "NOT_AUTHORIZED" + /** Missing required fields were found for this object. */ + | "OBJECT_FIELD_REQUIRED" + /** The specified field key is already in use. */ + | "OBJECT_FIELD_TAKEN" + /** The input value needs to be blank. */ + | "PRESENT" + /** The requested record couldn't be found. */ + | "RECORD_NOT_FOUND" + /** The provided name is reserved for system use. */ + | "RESERVED_NAME" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** No field definition found for this key. */ + | "UNDEFINED_OBJECT_FIELD" + /** No metaobject definition found for this type. */ + | "UNDEFINED_OBJECT_TYPE"; + +/** The set of valid sort keys for the MethodDefinition query. */ +export type MethodDefinitionSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `rate_provider_type` value. */ + | "RATE_PROVIDER_TYPE" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * Represents a Shopify hosted 3D model. + */ +export type Model3d = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** The 3d model's bounding box information. */ + boundingBox?: Maybe; + /** The 3d model's filename. */ + filename: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The media content type. */ + mediaContentType: MediaContentType; + /** Any errors which have occurred on the media. */ + mediaErrors: Array; + /** The warnings attached to the media. */ + mediaWarnings: Array; + /** The 3d model's original source. */ + originalSource?: Maybe; + /** The preview image for the media. */ + preview?: Maybe; + /** The 3d model's sources. */ + sources: Array; + /** Current status of the media. */ + status: MediaStatus; +}; + +/** + * Bounding box information of a 3d model. + */ +export type Model3dBoundingBox = { + /** + * Size in meters of the smallest volume which contains the 3d model. + */ + size: Vector3; +}; + +/** + * A source for a Shopify-hosted 3d model. + * + * Types of sources include GLB and USDZ formatted 3d models, where the former + * is an original 3d model and the latter has been converted from the original. + * + * If the original source is in GLB format and over 15 MBs in size, then both the + * original and the USDZ formatted source are optimized to reduce the file size. + */ +export type Model3dSource = { + /** The 3d model source's filesize. */ + filesize: Scalars["Int"]["output"]; + /** The 3d model source's format. */ + format: Scalars["String"]["output"]; + /** The 3d model source's MIME type. */ + mimeType: Scalars["String"]["output"]; + /** The 3d model source's URL. */ + url: Scalars["String"]["output"]; +}; + +/** + * A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions, + * when an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency). + */ +export type MoneyBag = { + /** Amount in presentment currency. */ + presentmentMoney: MoneyV2; + /** Amount in shop currency. */ + shopMoney: MoneyV2; +}; + +/** The input fields for a monetary value with currency. */ +export type MoneyInput = { + /** Decimal money amount. */ + amount: Scalars["Decimal"]["input"]; + /** Currency of the money. */ + currencyCode: CurrencyCode; +}; + +/** + * A monetary value with currency. + */ +export type MoneyV2 = { + /** Decimal money amount. */ + amount: Scalars["Decimal"]["output"]; + /** Currency of the money. */ + currencyCode: CurrencyCode; +}; + +/** + * The input fields for a single move of an object to a specific position in a set, using a zero-based index. + */ +export type MoveInput = { + /** The ID of the object to be moved. */ + id: Scalars["ID"]["input"]; + /** The new position of the object in the set. */ + newPosition: Scalars["UnsignedInt64"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type Mutation = { + /** + * Updates the email state value for an abandonment. + * @deprecated Use `abandonmentUpdateActivitiesDeliveryStatuses` instead. + */ + abandonmentEmailStateUpdate?: Maybe; + /** Updates the marketing activities delivery statuses for an abandonment. */ + abandonmentUpdateActivitiesDeliveryStatuses?: Maybe< + AbandonmentUpdateActivitiesDeliveryStatusesPayload + >; + /** + * Charges a shop for features or services one time. + * This type of charge is recommended for apps that aren't billed on a recurring basis. + * Test and demo shops aren't charged. + */ + appPurchaseOneTimeCreate?: Maybe; + /** + * Creates a record of the attributed revenue for the app. This mutation should only be used to capture transactions that are not managed by the Billing API. + * @deprecated This mutation will be removed in a future version. + */ + appRevenueAttributionRecordCreate?: Maybe< + AppRevenueAttributionRecordCreatePayload + >; + /** + * Deletes a record of the attributed revenue for the app. + * @deprecated This mutation will be removed in a future version. + */ + appRevenueAttributionRecordDelete?: Maybe< + AppRevenueAttributionRecordDeletePayload + >; + /** Cancels an app subscription on a store. */ + appSubscriptionCancel?: Maybe; + /** Allows an app to charge a store for features or services on a recurring basis. */ + appSubscriptionCreate?: Maybe; + /** Updates the capped amount on the usage pricing plan of an app subscription line item. */ + appSubscriptionLineItemUpdate?: Maybe; + /** Extends the trial of an app subscription. */ + appSubscriptionTrialExtend?: Maybe; + /** + * Enables an app to charge a store for features or services on a per-use basis. + * The usage charge value is counted towards the `cappedAmount` limit that was specified in the `appUsagePricingDetails` field when the app subscription was created. + * If you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then a `Total price exceeds balance remaining` error is returned. + */ + appUsageRecordCreate?: Maybe; + /** + * Starts the cancelation process of a running bulk operation. + * + * There may be a short delay from when a cancelation starts until the operation is actually canceled. + */ + bulkOperationCancel?: Maybe; + /** + * Creates and runs a bulk operation mutation. + * + * To learn how to bulk import large volumes of data asynchronously, refer to the + * [bulk import data guide](https://shopify.dev/api/usage/bulk-operations/imports). + */ + bulkOperationRunMutation?: Maybe; + /** + * Creates and runs a bulk operation query. + * + * See the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details. + */ + bulkOperationRunQuery?: Maybe; + /** Creates product feedback for multiple products. */ + bulkProductResourceFeedbackCreate?: Maybe< + BulkProductResourceFeedbackCreatePayload + >; + /** Create a CartTransform function to the Shop. */ + cartTransformCreate?: Maybe; + /** Destroy a cart transform function from the Shop. */ + cartTransformDelete?: Maybe; + /** Updates the context of a catalog. */ + catalogContextUpdate?: Maybe; + /** Creates a new catalog. */ + catalogCreate?: Maybe; + /** Delete a catalog. */ + catalogDelete?: Maybe; + /** Updates an existing catalog. */ + catalogUpdate?: Maybe; + /** Adds products to a collection. */ + collectionAddProducts?: Maybe; + /** Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled. */ + collectionAddProductsV2?: Maybe; + /** + * Creates a collection. + */ + collectionCreate?: Maybe; + /** Deletes a collection. */ + collectionDelete?: Maybe; + /** + * Publishes a collection to a channel. + * @deprecated Use `publishablePublish` instead. + */ + collectionPublish?: Maybe; + /** Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). For use with manual collections only. */ + collectionRemoveProducts?: Maybe; + /** Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. Displaced products will have their position altered in a consistent manner, with no gaps. */ + collectionReorderProducts?: Maybe; + /** + * Unpublishes a collection. + * @deprecated Use `publishableUnpublish` instead. + */ + collectionUnpublish?: Maybe; + /** Updates a collection. */ + collectionUpdate?: Maybe; + /** Deletes a list of companies. */ + companiesDelete?: Maybe; + /** Deletes a company address. */ + companyAddressDelete?: Maybe; + /** Assigns the customer as a company contact. */ + companyAssignCustomerAsContact?: Maybe; + /** Assigns the main contact for the company. */ + companyAssignMainContact?: Maybe; + /** Assigns a role to a contact for a location. */ + companyContactAssignRole?: Maybe; + /** Assigns roles on a company contact. */ + companyContactAssignRoles?: Maybe; + /** Creates a company contact. */ + companyContactCreate?: Maybe; + /** Deletes a company contact. */ + companyContactDelete?: Maybe; + /** Removes a company contact from a Company. */ + companyContactRemoveFromCompany?: Maybe< + CompanyContactRemoveFromCompanyPayload + >; + /** Revokes a role on a company contact. */ + companyContactRevokeRole?: Maybe; + /** Revokes roles on a company contact. */ + companyContactRevokeRoles?: Maybe; + /** Sends the company contact a welcome email. */ + companyContactSendWelcomeEmail?: Maybe; + /** Updates a company contact. */ + companyContactUpdate?: Maybe; + /** Deletes one or more company contacts. */ + companyContactsDelete?: Maybe; + /** Creates a company. */ + companyCreate?: Maybe; + /** Deletes a company. */ + companyDelete?: Maybe; + /** Updates an address on a company location. */ + companyLocationAssignAddress?: Maybe; + /** Assigns roles on a company location. */ + companyLocationAssignRoles?: Maybe; + /** Assigns tax exemptions to the company location. */ + companyLocationAssignTaxExemptions?: Maybe< + CompanyLocationAssignTaxExemptionsPayload + >; + /** Creates a company location. */ + companyLocationCreate?: Maybe; + /** Creates a tax registration for a company location. */ + companyLocationCreateTaxRegistration?: Maybe< + CompanyLocationCreateTaxRegistrationPayload + >; + /** Deletes a company location. */ + companyLocationDelete?: Maybe; + /** Revokes roles on a company location. */ + companyLocationRevokeRoles?: Maybe; + /** Revokes tax exemptions from the company location. */ + companyLocationRevokeTaxExemptions?: Maybe< + CompanyLocationRevokeTaxExemptionsPayload + >; + /** Revokes tax registration on a company location. */ + companyLocationRevokeTaxRegistration?: Maybe< + CompanyLocationRevokeTaxRegistrationPayload + >; + /** Updates a company location. */ + companyLocationUpdate?: Maybe; + /** Deletes a list of company locations. */ + companyLocationsDelete?: Maybe; + /** Revokes the main contact from the company. */ + companyRevokeMainContact?: Maybe; + /** Updates a company. */ + companyUpdate?: Maybe; + /** Add tax exemptions for the customer. */ + customerAddTaxExemptions?: Maybe; + /** Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). */ + customerCreate?: Maybe; + /** Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). */ + customerDelete?: Maybe; + /** + * Update a customer's email marketing information information. + */ + customerEmailMarketingConsentUpdate?: Maybe< + CustomerEmailMarketingConsentUpdatePayload + >; + /** Generate an account activation URL for a customer. */ + customerGenerateAccountActivationUrl?: Maybe< + CustomerGenerateAccountActivationUrlPayload + >; + /** Merges two customers. */ + customerMerge?: Maybe; + /** + * Creates a vaulted payment method for a customer from duplication data. + * + * This data must be obtained from another shop within the same organization. + * + * Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps. + */ + customerPaymentMethodCreateFromDuplicationData?: Maybe< + CustomerPaymentMethodCreateFromDuplicationDataPayload + >; + /** + * Creates a credit card payment method for a customer using a session id. + * These values are only obtained through card imports happening from a PCI compliant environment. + * Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly. + */ + customerPaymentMethodCreditCardCreate?: Maybe< + CustomerPaymentMethodCreditCardCreatePayload + >; + /** Updates the credit card payment method for a customer. */ + customerPaymentMethodCreditCardUpdate?: Maybe< + CustomerPaymentMethodCreditCardUpdatePayload + >; + /** + * Returns encrypted data that can be used to duplicate the payment method in another shop within the same organization. + * + * Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps. + */ + customerPaymentMethodGetDuplicationData?: Maybe< + CustomerPaymentMethodGetDuplicationDataPayload + >; + /** + * Returns a URL that allows the customer to update a specific payment method. + * + * Currently, `customerPaymentMethodGetUpdateUrl` only supports Shop Pay. + */ + customerPaymentMethodGetUpdateUrl?: Maybe< + CustomerPaymentMethodGetUpdateUrlPayload + >; + /** Creates a PayPal billing agreement for a customer. */ + customerPaymentMethodPaypalBillingAgreementCreate?: Maybe< + CustomerPaymentMethodPaypalBillingAgreementCreatePayload + >; + /** Updates a PayPal billing agreement for a customer. */ + customerPaymentMethodPaypalBillingAgreementUpdate?: Maybe< + CustomerPaymentMethodPaypalBillingAgreementUpdatePayload + >; + /** Create a payment method from remote gateway identifiers. */ + customerPaymentMethodRemoteCreate?: Maybe< + CustomerPaymentMethodRemoteCreatePayload + >; + /** + * Create a payment method from a credit card stored by Stripe. + * @deprecated Use `customerPaymentMethodRemoteCreate` instead. + */ + customerPaymentMethodRemoteCreditCardCreate?: Maybe< + CustomerPaymentMethodRemoteCreditCardCreatePayload + >; + /** Revokes a customer's payment method. */ + customerPaymentMethodRevoke?: Maybe; + /** Sends a link to the customer so they can update a specific payment method. */ + customerPaymentMethodSendUpdateEmail?: Maybe< + CustomerPaymentMethodSendUpdateEmailPayload + >; + /** Remove tax exemptions from a customer. */ + customerRemoveTaxExemptions?: Maybe; + /** Replace tax exemptions for a customer. */ + customerReplaceTaxExemptions?: Maybe; + /** Creates a customer segment members query. */ + customerSegmentMembersQueryCreate?: Maybe< + CustomerSegmentMembersQueryCreatePayload + >; + /** + * Update a customer's SMS marketing consent information. + */ + customerSmsMarketingConsentUpdate?: Maybe< + CustomerSmsMarketingConsentUpdatePayload + >; + /** Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data). */ + customerUpdate?: Maybe; + /** Updates a customer's default address. */ + customerUpdateDefaultAddress?: Maybe; + /** + * Creates a delegate access token. + * + * To learn more about creating delegate access tokens, refer to + * [Delegate OAuth access tokens to subsystems] + * (https://shopify.dev/apps/auth/oauth/delegate-access-tokens). + */ + delegateAccessTokenCreate?: Maybe; + /** Destroys a delegate access token. */ + delegateAccessTokenDestroy?: Maybe; + /** Activates and deactivates delivery customizations. */ + deliveryCustomizationActivation?: Maybe< + DeliveryCustomizationActivationPayload + >; + /** Creates a delivery customization. */ + deliveryCustomizationCreate?: Maybe; + /** Creates a delivery customization. */ + deliveryCustomizationDelete?: Maybe; + /** Updates a delivery customization. */ + deliveryCustomizationUpdate?: Maybe; + /** Create a delivery profile. */ + deliveryProfileCreate?: Maybe; + /** Enqueue the removal of a delivery profile. */ + deliveryProfileRemove?: Maybe; + /** Update a delivery profile. */ + deliveryProfileUpdate?: Maybe; + /** Set the delivery settings for a shop. */ + deliverySettingUpdate?: Maybe; + /** + * Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles. + */ + deliveryShippingOriginAssign?: Maybe; + /** Activates an automatic discount. */ + discountAutomaticActivate?: Maybe; + /** Creates an app discount. */ + discountAutomaticAppCreate?: Maybe; + /** Updates an automatic app discount. */ + discountAutomaticAppUpdate?: Maybe; + /** Creates a basic automatic discount. */ + discountAutomaticBasicCreate?: Maybe; + /** Updates a basic automatic discount. */ + discountAutomaticBasicUpdate?: Maybe; + /** + * Asynchronously delete automatic discounts in bulk if a `search` or `saved_search_id` argument is provided or if a + * maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. + * **Warning:** All automatic discounts will be deleted if a blank `search` argument is provided. + */ + discountAutomaticBulkDelete?: Maybe; + /** Creates a BXGY automatic discount. */ + discountAutomaticBxgyCreate?: Maybe; + /** Updates an existing Buy X, Get Y (BXGY) automatic discount. */ + discountAutomaticBxgyUpdate?: Maybe; + /** Deactivates an automatic discount. */ + discountAutomaticDeactivate?: Maybe; + /** Deletes an automatic discount. */ + discountAutomaticDelete?: Maybe; + /** Activates a code discount. */ + discountCodeActivate?: Maybe; + /** Creates a code app discount. */ + discountCodeAppCreate?: Maybe; + /** Updates a code app discount. */ + discountCodeAppUpdate?: Maybe; + /** Creates a basic code discount. */ + discountCodeBasicCreate?: Maybe; + /** Updates a basic code discount. */ + discountCodeBasicUpdate?: Maybe; + /** + * Asynchronously activate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. + */ + discountCodeBulkActivate?: Maybe; + /** + * Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. + */ + discountCodeBulkDeactivate?: Maybe; + /** + * Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs. + */ + discountCodeBulkDelete?: Maybe; + /** Creates a Buy X get Y (BXGY) code discount. */ + discountCodeBxgyCreate?: Maybe; + /** Updates a Buy X, Get Y (BXGY) code discount. */ + discountCodeBxgyUpdate?: Maybe; + /** Deactivates a code discount. */ + discountCodeDeactivate?: Maybe; + /** Deletes a code discount. */ + discountCodeDelete?: Maybe; + /** Creates a free shipping code discount. */ + discountCodeFreeShippingCreate?: Maybe; + /** Updates a free shipping code discount. */ + discountCodeFreeShippingUpdate?: Maybe; + /** + * Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a + * search query, a saved search ID, or a list of redeem code IDs. + */ + discountCodeRedeemCodeBulkDelete?: Maybe< + DiscountCodeRedeemCodeBulkDeletePayload + >; + /** + * Asynchronously add discount redeem codes in bulk. Specify the codes to add + * and the discount code ID that the codes will belong to. + */ + discountRedeemCodeBulkAdd?: Maybe; + /** Updates a dispute evidence. */ + disputeEvidenceUpdate?: Maybe; + /** Adds tags to multiple draft orders. */ + draftOrderBulkAddTags?: Maybe; + /** Deletes multiple draft orders. */ + draftOrderBulkDelete?: Maybe; + /** Removes tags from multiple draft orders. */ + draftOrderBulkRemoveTags?: Maybe; + /** + * Calculates the properties of a draft order. Useful for determining information + * such as total taxes or price without actually creating a draft order. + */ + draftOrderCalculate?: Maybe; + /** Completes a draft order and creates an order. */ + draftOrderComplete?: Maybe; + /** Creates a draft order. */ + draftOrderCreate?: Maybe; + /** Creates a Draft Order from Order. */ + draftOrderCreateFromOrder?: Maybe; + /** Creates a merchant checkout for the given draft order. */ + draftOrderCreateMerchantCheckout?: Maybe< + DraftOrderCreateMerchantCheckoutPayload + >; + /** Deletes a draft order. */ + draftOrderDelete?: Maybe; + /** Duplicates a draft order. */ + draftOrderDuplicate?: Maybe; + /** Previews a draft order invoice email. */ + draftOrderInvoicePreview?: Maybe; + /** Sends an email invoice for a draft order. */ + draftOrderInvoiceSend?: Maybe; + /** + * Updates a draft order. + * + * If a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts + * are created but not immediately completed when opening the merchant credit card modal in the admin, and when a + * buyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress + * and the draft is updated before the checkout completes. This will not interfere with the checkout and order + * creation, but if the link from draft to checkout is broken the draft will remain open even after the order is + * created. + */ + draftOrderUpdate?: Maybe; + /** + * Updates the server pixel to connect to an EventBridge endpoint. + * Running this mutation deletes any previous subscriptions for the server pixel. + */ + eventBridgeServerPixelUpdate?: Maybe; + /** + * Creates a new Amazon EventBridge webhook subscription. + */ + eventBridgeWebhookSubscriptionCreate?: Maybe< + EventBridgeWebhookSubscriptionCreatePayload + >; + /** + * Updates an Amazon EventBridge webhook subscription. + */ + eventBridgeWebhookSubscriptionUpdate?: Maybe< + EventBridgeWebhookSubscriptionUpdatePayload + >; + /** Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors. */ + fileAcknowledgeUpdateFailed?: Maybe; + /** + * Creates file assets using an external URL or for files that were previously uploaded using the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate). + * These files are added to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin. + */ + fileCreate?: Maybe; + /** Deletes existing file assets that were uploaded to Shopify. */ + fileDelete?: Maybe; + /** Updates an existing file asset that was uploaded to Shopify. */ + fileUpdate?: Maybe; + /** Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers). */ + flowTriggerReceive?: Maybe; + /** Cancels a fulfillment. */ + fulfillmentCancel?: Maybe; + /** + * Creates a fulfillment for one or many fulfillment orders. + * The fulfillment orders are associated with the same order and are assigned to the same location. + */ + fulfillmentCreateV2?: Maybe; + /** Creates a fulfillment event for a specified fulfillment. */ + fulfillmentEventCreate?: Maybe; + /** Accept a cancellation request sent to a fulfillment service for a fulfillment order. */ + fulfillmentOrderAcceptCancellationRequest?: Maybe< + FulfillmentOrderAcceptCancellationRequestPayload + >; + /** Accepts a fulfillment request sent to a fulfillment service for a fulfillment order. */ + fulfillmentOrderAcceptFulfillmentRequest?: Maybe< + FulfillmentOrderAcceptFulfillmentRequestPayload + >; + /** Marks a fulfillment order as canceled. */ + fulfillmentOrderCancel?: Maybe; + /** Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order. */ + fulfillmentOrderClose?: Maybe; + /** Applies a fulfillment hold on an open fulfillment order. */ + fulfillmentOrderHold?: Maybe; + /** + * Mark line items associated with a fulfillment order as being ready for pickup by a customer. + * + * Sends a Ready For Pickup notification to the customer to let them know that their order is ready + * to be picked up. + */ + fulfillmentOrderLineItemsPreparedForPickup?: Maybe< + FulfillmentOrderLineItemsPreparedForPickupPayload + >; + /** + * Merges a set or multiple sets of fulfillment orders together into one based on + * line item inputs and quantities. + */ + fulfillmentOrderMerge?: Maybe; + /** + * Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items. + * + * Moving a fulfillment order will fail in the following circumstances: + * + * * The fulfillment order is closed. + * * The destination location has never stocked the requested inventory item. + * * The API client doesn't have the correct permissions. + * + * Line items which have already been fulfilled can't be re-assigned + * and will always remain assigned to the original location. + * + * You can't change the assigned location while a fulfillment order has a + * [request status](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus) + * of `SUBMITTED`, `ACCEPTED`, `CANCELLATION_REQUESTED`, or `CANCELLATION_REJECTED`. + * These request statuses mean that a fulfillment order is awaiting action by a fulfillment service + * and can't be re-assigned without first having the fulfillment service accept a cancellation request. + * This behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services. + * + * ### How re-assigning line items affects fulfillment orders + * + * **First scenario:** Re-assign all line items belonging to a fulfillment order to a new location. + * + * In this case, the + * [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation) + * of the original fulfillment order will be updated to the new location. + * + * **Second scenario:** Re-assign a subset of the line items belonging to a fulfillment order to a new location. + * You can specify a subset of line items using the `fulfillmentOrderLineItems` parameter + * (available as of the `2023-04` API version), + * or specify that the original fulfillment order contains line items which have already been fulfilled. + * + * If the new location is already assigned to another active fulfillment order, on the same order, + * then the line items are moved to the existing fulfillment order. + * Otherwise, a new fulfillment order is created for the new location, and the line items are moved to the new location. + */ + fulfillmentOrderMove?: Maybe; + /** Marks a scheduled fulfillment order as open. */ + fulfillmentOrderOpen?: Maybe; + /** Rejects a cancellation request sent to a fulfillment service for a fulfillment order. */ + fulfillmentOrderRejectCancellationRequest?: Maybe< + FulfillmentOrderRejectCancellationRequestPayload + >; + /** Rejects a fulfillment request sent to a fulfillment service for a fulfillment order. */ + fulfillmentOrderRejectFulfillmentRequest?: Maybe< + FulfillmentOrderRejectFulfillmentRequestPayload + >; + /** Releases the fulfillment hold on a fulfillment order. */ + fulfillmentOrderReleaseHold?: Maybe; + /** Reschedules a scheduled fulfillment order. */ + fulfillmentOrderReschedule?: Maybe; + /** Splits a fulfillment order or orders based on line item inputs and quantities. */ + fulfillmentOrderSplit?: Maybe; + /** Sends a cancellation request to the fulfillment service of a fulfillment order. */ + fulfillmentOrderSubmitCancellationRequest?: Maybe< + FulfillmentOrderSubmitCancellationRequestPayload + >; + /** Sends a fulfillment request to the fulfillment service of a fulfillment order. */ + fulfillmentOrderSubmitFulfillmentRequest?: Maybe< + FulfillmentOrderSubmitFulfillmentRequestPayload + >; + /** Releases the fulfillment holds on a list of fulfillment orders. */ + fulfillmentOrdersReleaseHolds?: Maybe; + /** Sets the latest date and time by which the fulfillment orders need to be fulfilled. */ + fulfillmentOrdersSetFulfillmentDeadline?: Maybe< + FulfillmentOrdersSetFulfillmentDeadlinePayload + >; + /** + * Creates a fulfillment service. + * + * ## Fulfillment service location + * + * When creating a fulfillment service, a new location will be automatically created on the shop + * and will be associated with this fulfillment service. + * This location will be named after the fulfillment service and inherit the shop's address. + * + * If you are using API version `2023-10` or later, and you need to specify custom attributes for the fulfillment service location + * (for example, to change its address to a country different from the shop's country), + * use the + * [LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) + * mutation after creating the fulfillment service. + */ + fulfillmentServiceCreate?: Maybe; + /** Deletes a fulfillment service. */ + fulfillmentServiceDelete?: Maybe; + /** + * Updates a fulfillment service. + * + * If you are using API version `2023-10` or later, + * and you need to update the location managed by the fulfillment service + * (for example, to change the address of a fulfillment service), + * use the + * [LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) + * mutation. + */ + fulfillmentServiceUpdate?: Maybe; + /** Updates tracking information for a fulfillment. */ + fulfillmentTrackingInfoUpdateV2?: Maybe< + FulfillmentTrackingInfoUpdateV2Payload + >; + /** Create a gift card. */ + giftCardCreate?: Maybe; + /** + * Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled. + */ + giftCardDisable?: Maybe; + /** Update a gift card. */ + giftCardUpdate?: Maybe; + /** Activate an inventory item at a location. */ + inventoryActivate?: Maybe; + /** Apply changes to inventory quantities. */ + inventoryAdjustQuantities?: Maybe; + /** + * Adjusts the inventory by a certain quantity. + * @deprecated Use `inventoryAdjustQuantities` instead. + */ + inventoryAdjustQuantity?: Maybe; + /** + * Adjusts the inventory at a location for multiple inventory items. + * @deprecated Use `inventoryAdjustQuantities` instead. + */ + inventoryBulkAdjustQuantityAtLocation?: Maybe< + InventoryBulkAdjustQuantityAtLocationPayload + >; + /** Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item's quantities and turns off the inventory item from that location. */ + inventoryBulkToggleActivation?: Maybe; + /** Removes an inventory item's quantities from a location, and turns off inventory at the location. */ + inventoryDeactivate?: Maybe; + /** Updates an inventory item. */ + inventoryItemUpdate?: Maybe; + /** Moves inventory between inventory quantity names at a single location. */ + inventoryMoveQuantities?: Maybe; + /** Set inventory on-hand quantities using absolute values. */ + inventorySetOnHandQuantities?: Maybe; + /** Activates a location. */ + locationActivate?: Maybe; + /** Adds a new location. */ + locationAdd?: Maybe; + /** Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location. */ + locationDeactivate?: Maybe; + /** Deletes a location. */ + locationDelete?: Maybe; + /** + * Edits an existing location. + * + * [As of the 2023-10 API version](https://shopify.dev/changelog/apps-can-now-change-the-name-and-address-of-their-fulfillment-service-locations), apps can change the name and address of their fulfillment service locations. + */ + locationEdit?: Maybe; + /** Disables local pickup for a location. */ + locationLocalPickupDisable?: Maybe; + /** Enables local pickup for a location. */ + locationLocalPickupEnable?: Maybe; + /** Creates a new market. */ + marketCreate?: Maybe; + /** Updates currency settings of a market. */ + marketCurrencySettingsUpdate?: Maybe; + /** Deletes a market definition. */ + marketDelete?: Maybe; + /** Creates or updates market localizations. */ + marketLocalizationsRegister?: Maybe; + /** Deletes market localizations. */ + marketLocalizationsRemove?: Maybe; + /** Deletes a market region. */ + marketRegionDelete?: Maybe; + /** Creates regions that belong to an existing market. */ + marketRegionsCreate?: Maybe; + /** Updates the properties of a market. */ + marketUpdate?: Maybe; + /** Creates a web presence for a market. */ + marketWebPresenceCreate?: Maybe; + /** Deletes a market web presence. */ + marketWebPresenceDelete?: Maybe; + /** Updates a market web presence. */ + marketWebPresenceUpdate?: Maybe; + /** Create new marketing activity. */ + marketingActivityCreate?: Maybe; + /** Creates a new external marketing activity. */ + marketingActivityCreateExternal?: Maybe< + MarketingActivityCreateExternalPayload + >; + /** Updates a marketing activity with the latest information. */ + marketingActivityUpdate?: Maybe; + /** Update an external marketing activity. */ + marketingActivityUpdateExternal?: Maybe< + MarketingActivityUpdateExternalPayload + >; + /** Creates a new marketing event engagement for a marketing activity or a marketing channel. */ + marketingEngagementCreate?: Maybe; + /** + * Creates a metafield definition. + */ + metafieldDefinitionCreate?: Maybe; + /** + * Delete a metafield definition. + * Optionally deletes all associated metafields asynchronously when specified. + */ + metafieldDefinitionDelete?: Maybe; + /** + * You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. + * The order of your pinned metafield definitions determines the order in which your metafields are displayed + * on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed. + */ + metafieldDefinitionPin?: Maybe; + /** + * You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. + * The order of your pinned metafield definitions determines the order in which your metafields are displayed + * on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed. + */ + metafieldDefinitionUnpin?: Maybe; + /** + * Updates a metafield definition. + */ + metafieldDefinitionUpdate?: Maybe; + /** Deletes a metafield. */ + metafieldDelete?: Maybe; + /** + * Creates a `MetafieldStorefrontVisibility` record to make all metafields that belong to the specified resource + * and have the established `namespace` and `key` combination visible in the Storefront API. + */ + metafieldStorefrontVisibilityCreate?: Maybe< + MetafieldStorefrontVisibilityCreatePayload + >; + /** + * Deletes a `MetafieldStorefrontVisibility` record. All metafields that belongs to the specified record will no + * longer be visible in the Storefront API. + */ + metafieldStorefrontVisibilityDelete?: Maybe< + MetafieldStorefrontVisibilityDeletePayload + >; + /** + * Sets metafield values. Metafield values will be set regardless if they were previously created or not. + * + * Allows a maximum of 25 metafields to be set at a time. + * + * Note that this operation is atomic as of `2023-01`, meaning no changes are persisted if any error is + * encountered. + */ + metafieldsSet?: Maybe; + /** Asynchronously delete metaobjects and their associated metafields in bulk. */ + metaobjectBulkDelete?: Maybe; + /** Creates a new metaobject. */ + metaobjectCreate?: Maybe; + /** Creates a new metaobject definition. */ + metaobjectDefinitionCreate?: Maybe; + /** + * Deletes the specified metaobject definition. + * Also deletes all related metafield definitions, metaobjects, and metafields asynchronously. + */ + metaobjectDefinitionDelete?: Maybe; + /** Updates a metaobject definition with new settings and metafield definitions. */ + metaobjectDefinitionUpdate?: Maybe; + /** Deletes the specified metaobject and its associated metafields. */ + metaobjectDelete?: Maybe; + /** Updates an existing metaobject. */ + metaobjectUpdate?: Maybe; + /** + * Retrieves a metaobject by handle, then updates it with the provided input values. + * If no matching metaobject is found, a new metaobject is created with the provided input values. + */ + metaobjectUpsert?: Maybe; + /** Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. */ + orderCapture?: Maybe; + /** + * Closes an open order. + */ + orderClose?: Maybe; + /** Creates a payment for an order by mandate. */ + orderCreateMandatePayment?: Maybe; + /** Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). */ + orderEditAddCustomItem?: Maybe; + /** Adds a discount to a newly added line item on the current order edit. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). */ + orderEditAddLineItemDiscount?: Maybe; + /** Adds a line item from an existing product variant. */ + orderEditAddVariant?: Maybe; + /** + * Starts editing an order. Mutations are operating on `OrderEdit`. + * All order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`. + */ + orderEditBegin?: Maybe; + /** + * Applies and saves staged changes to an order. Mutations are operating on `OrderEdit`. + * All order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`. + */ + orderEditCommit?: Maybe; + /** Removes a line item discount that was applied as part of an order edit. */ + orderEditRemoveLineItemDiscount?: Maybe< + OrderEditRemoveLineItemDiscountPayload + >; + /** Sets the quantity of a line item on an order that is being edited. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). */ + orderEditSetQuantity?: Maybe; + /** Sends an email invoice for an order. */ + orderInvoiceSend?: Maybe; + /** + * Marks an order as paid. You can only mark an order as paid if it isn't already fully paid. + */ + orderMarkAsPaid?: Maybe; + /** + * Opens a closed order. + */ + orderOpen?: Maybe; + /** Updates the fields of an order. */ + orderUpdate?: Maybe; + /** Activates and deactivates payment customizations. */ + paymentCustomizationActivation?: Maybe; + /** Creates a payment customization. */ + paymentCustomizationCreate?: Maybe; + /** Deletes a payment customization. */ + paymentCustomizationDelete?: Maybe; + /** Updates a payment customization. */ + paymentCustomizationUpdate?: Maybe; + /** Sends an email payment reminder for a payment schedule. */ + paymentReminderSend?: Maybe; + /** Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`. */ + paymentTermsCreate?: Maybe; + /** Delete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`. */ + paymentTermsDelete?: Maybe; + /** Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`. */ + paymentTermsUpdate?: Maybe; + /** Creates a price list. You can use the `priceListCreate` mutation to create a new price list for a country. This enables you to sell your products with international pricing. */ + priceListCreate?: Maybe; + /** Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market. */ + priceListDelete?: Maybe; + /** Creates or updates fixed prices on a price list. You can use the `priceListFixedPricesAdd` mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten. */ + priceListFixedPricesAdd?: Maybe; + /** Updates the fixed prices for all variants for a product on a price list. You can use the `priceListFixedPricesByProductUpdate` mutation to set or remove a fixed price for all variants of a product associated with the price list. */ + priceListFixedPricesByProductUpdate?: Maybe< + PriceListFixedPricesByProductUpdatePayload + >; + /** Deletes specific fixed prices from a price list using a product variant ID. You can use the `priceListFixedPricesDelete` mutation to delete a set of fixed prices from a price list. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment. */ + priceListFixedPricesDelete?: Maybe; + /** Updates fixed prices on a price list. You can use the `priceListFixedPricesUpdate` mutation to set a fixed price for specific product variants or to delete prices for variants associated with the price list. */ + priceListFixedPricesUpdate?: Maybe; + /** + * Updates a price list. + * If you modify the currency, then any fixed prices set on the price list will be deleted. + */ + priceListUpdate?: Maybe; + /** + * Activate a price rule. + * @deprecated Use `discountCodeActivate` instead. + */ + priceRuleActivate?: Maybe; + /** + * Create a price rule using the input. + * @deprecated Use `discountCodeBasicCreate` instead. + */ + priceRuleCreate?: Maybe; + /** + * Deactivate a price rule. + * @deprecated Use `discountCodeDeactivate` instead. + */ + priceRuleDeactivate?: Maybe; + /** + * Delete a price rule. + * @deprecated Use `discountCodeDelete` instead. + */ + priceRuleDelete?: Maybe; + /** + * Create a discount code for a price rule. + * @deprecated Use `discountRedeemCodeBulkAdd` instead. + */ + priceRuleDiscountCodeCreate?: Maybe; + /** + * Update a discount code for a price rule. + * @deprecated Use `discountCodeBasicUpdate` instead. + */ + priceRuleDiscountCodeUpdate?: Maybe; + /** + * Updates a price rule using its ID and an input. + * @deprecated Use `discountCodeBasicUpdate` instead. + */ + priceRuleUpdate?: Maybe; + /** + * Deletes a private metafield. + * Private metafields are automatically deleted when the app that created them is uninstalled. + * + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafieldDelete?: Maybe; + /** + * Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps. + * Private metafields are accessible only by the application that created them and only from the GraphQL Admin API. + * + * An application can create a maximum of 10 private metafields per shop resource. + * + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafieldUpsert?: Maybe; + /** + * Appends images to a product. + * @deprecated Use `productCreateMedia` instead. + */ + productAppendImages?: Maybe; + /** Changes the status of a product. This allows you to set the availability of the product across all channels. */ + productChangeStatus?: Maybe; + /** + * Creates a product. + * + * If you need to create a product with many + * [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) + * that are active at several + * [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), + * especially with a lot of + * [collections](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-collectionstojoin) + * and + * [tags](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-tags), + * then you should first create the product with just the variants. + * + * After the product is created, you can activate the variants at locations + * and add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will + * complete before the operation times out. + * + * The following example shows how you might break up product creation and object association into multiple steps: + * + * 1. Create the product with variants. Don't specify any tags or collections on the product, and don't specify + * [inventory quantities](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput#field-productvariantinput-inventoryquantities) + * for each variant. + * + * 2. After the product is created, add tags to the product using the + * [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsAdd) mutation, and add collections using the + * [collectionsAddProducts](https://shopify.dev/api/admin-graphql/latest/mutations/collectionAddProducts) mutation. + * + * 3. Use the [inventoryBulkToggleActivation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkToggleActivation) mutation + * on each [inventory item](https://shopify.dev/api/admin-graphql/latest/objects/InventoryItem) to activate it at the appropriate locations. + * + * 4. After activating the variants at the locations, adjust inventory quantities at each location using the + * [inventoryBulkAdjustQuantityAtLocation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkAdjustQuantityAtLocation) mutation. + */ + productCreate?: Maybe; + /** Creates media for a product. */ + productCreateMedia?: Maybe; + /** + * Deletes a product, including all associated variants and media. + * + * As of API version `2023-01`, if you need to delete a large product, such as one that has many + * [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) + * that are active at several + * [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), + * you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous + * [ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync) + * mutation. + */ + productDelete?: Maybe; + /** + * Deletes a product asynchronously, including all associated variants and media. + */ + productDeleteAsync?: Maybe; + /** + * Removes product images from the product. + * @deprecated Use `productDeleteMedia` instead. + */ + productDeleteImages?: Maybe; + /** Deletes media for a product. */ + productDeleteMedia?: Maybe; + /** + * Duplicates a product. + * + * As of API version `2023-01`, if you need to duplicate a large product, such as one that has many + * [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) + * that are active at several + * [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), + * you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous + * [ProductDuplicateAsyncV2](https://shopify.dev/api/admin-graphql/latest/mutations/productDuplicateAsyncV2) + * mutation. + */ + productDuplicate?: Maybe; + /** + * Asynchronously duplicate a single product. + * + * @deprecated Use `productDuplicateAsyncV2` instead. + */ + productDuplicateAsync?: Maybe; + /** + * Asynchronously duplicate a single product. + */ + productDuplicateAsyncV2?: Maybe; + /** Creates a product feed for a specific publication. */ + productFeedCreate?: Maybe; + /** Deletes a product feed for a specific publication. */ + productFeedDelete?: Maybe; + /** Runs the full product sync for a given shop. */ + productFullSync?: Maybe; + /** + * Updates an image of a product. + * @deprecated Use `productUpdateMedia` instead. + */ + productImageUpdate?: Maybe; + /** + * Adds multiple selling plan groups to a product. + */ + productJoinSellingPlanGroups?: Maybe; + /** + * Removes multiple groups from a product. + */ + productLeaveSellingPlanGroups?: Maybe; + /** + * Publishes a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be published on online stores. + * @deprecated Use `publishablePublish` instead. + */ + productPublish?: Maybe; + /** + * Asynchronously reorders a set of images for a given product. + * @deprecated Use `productReorderMedia` instead. + */ + productReorderImages?: Maybe; + /** Asynchronously reorders the media attached to a product. */ + productReorderMedia?: Maybe; + /** + * Unpublishes a product. + * @deprecated Use `publishableUnpublish` instead. + */ + productUnpublish?: Maybe; + /** + * Updates a product. If you update a product and only include some variants in the update, + * then any variants not included will be deleted. To safely manage variants without the risk of + * deleting excluded variants, use + * [productVariantsBulkUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantsbulkupdate). + * If you want to update a single variant, then use + * [productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate). + */ + productUpdate?: Maybe; + /** Updates media for a product. */ + productUpdateMedia?: Maybe; + /** Appends media from a product to variants of the product. */ + productVariantAppendMedia?: Maybe; + /** Creates a product variant. */ + productVariantCreate?: Maybe; + /** Deletes a product variant. */ + productVariantDelete?: Maybe; + /** Detaches media from product variants. */ + productVariantDetachMedia?: Maybe; + /** + * Adds multiple selling plan groups to a product variant. + */ + productVariantJoinSellingPlanGroups?: Maybe< + ProductVariantJoinSellingPlanGroupsPayload + >; + /** + * Remove multiple groups from a product variant. + */ + productVariantLeaveSellingPlanGroups?: Maybe< + ProductVariantLeaveSellingPlanGroupsPayload + >; + /** Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles. */ + productVariantRelationshipBulkUpdate?: Maybe< + ProductVariantRelationshipBulkUpdatePayload + >; + /** Updates a product variant. */ + productVariantUpdate?: Maybe; + /** + * Creates product variants in bulk. If you want to create a single variant, then use + * [productVariantCreate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantcreate). + */ + productVariantsBulkCreate?: Maybe; + /** + * Deletes product variants in bulk. If you want to delete a single variant, then use + * [productVariantDelete](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantdelete). + */ + productVariantsBulkDelete?: Maybe; + /** Reorder product variants in bulk. */ + productVariantsBulkReorder?: Maybe; + /** + * Updates product variants in bulk. If you want to update a single variant, then use + * [productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate). + */ + productVariantsBulkUpdate?: Maybe; + /** + * Updates the server pixel to connect to a Google PubSub endpoint. + * Running this mutation deletes any previous subscriptions for the server pixel. + */ + pubSubServerPixelUpdate?: Maybe; + /** Creates a new Google Cloud Pub/Sub webhook subscription. */ + pubSubWebhookSubscriptionCreate?: Maybe< + PubSubWebhookSubscriptionCreatePayload + >; + /** Updates a Google Cloud Pub/Sub webhook subscription. */ + pubSubWebhookSubscriptionUpdate?: Maybe< + PubSubWebhookSubscriptionUpdatePayload + >; + /** + * Creates a publication. + */ + publicationCreate?: Maybe; + /** + * Deletes a publication. + */ + publicationDelete?: Maybe; + /** + * Updates a publication. + */ + publicationUpdate?: Maybe; + /** Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores. */ + publishablePublish?: Maybe; + /** Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores. */ + publishablePublishToCurrentChannel?: Maybe< + PublishablePublishToCurrentChannelPayload + >; + /** Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. */ + publishableUnpublish?: Maybe; + /** Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. */ + publishableUnpublishToCurrentChannel?: Maybe< + PublishableUnpublishToCurrentChannelPayload + >; + /** + * Creates or updates existing quantity rules on a price list. + * You can use the `quantityRulesAdd` mutation to set order level minimums, maximumums and increments for specific product variants. + */ + quantityRulesAdd?: Maybe; + /** + * Deletes specific quantity rules from a price list using a product variant ID. + * You can use the `quantityRulesDelete` mutation to delete a set of quantity rules from a price list. + */ + quantityRulesDelete?: Maybe; + /** Creates a refund. */ + refundCreate?: Maybe; + /** + * Approves a customer's return request. + * If this mutation is successful, then the `Return.status` field of the + * approved return is set to `OPEN`. + */ + returnApproveRequest?: Maybe; + /** + * Cancels a return and restores the items back to being fulfilled. + * Canceling a return is only available before any work has been done + * on the return (such as an inspection or refund). + */ + returnCancel?: Maybe; + /** + * Indicates a return is complete, either when a refund has been made and items restocked, + * or simply when it has been marked as returned in the system. + */ + returnClose?: Maybe; + /** Creates a return. */ + returnCreate?: Maybe; + /** + * Declines a return on an order. + * When a return is declined, each `ReturnLineItem.fulfillmentLineItem` can be associated to a new return. + * Use the `ReturnCreate` or `ReturnRequest` mutation to initiate a new return. + */ + returnDeclineRequest?: Maybe; + /** Refunds a return and associates it with the related return request. */ + returnRefund?: Maybe; + /** Reopens a closed return. */ + returnReopen?: Maybe; + /** + * A customer's return request that hasn't been approved or declined. + * This mutation sets the value of the `Return.status` field to `REQUESTED`. + * To create a return that has the `Return.status` field set to `OPEN`, use the `returnCreate` mutation. + */ + returnRequest?: Maybe; + /** Creates a new reverse delivery with associated external shipping information. */ + reverseDeliveryCreateWithShipping?: Maybe< + ReverseDeliveryCreateWithShippingPayload + >; + /** + * Disposes reverse delivery line items for a reverse delivery on the same shop. + */ + reverseDeliveryDispose?: Maybe; + /** Updates a reverse delivery with associated external shipping information. */ + reverseDeliveryShippingUpdate?: Maybe; + /** + * Disposes reverse fulfillment order line items. + */ + reverseFulfillmentOrderDispose?: Maybe; + /** Creates a saved search. */ + savedSearchCreate?: Maybe; + /** Delete a saved search. */ + savedSearchDelete?: Maybe; + /** Updates a saved search. */ + savedSearchUpdate?: Maybe; + /** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * Creates a new script tag. + */ + scriptTagCreate?: Maybe; + /** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * Deletes a script tag. + */ + scriptTagDelete?: Maybe; + /** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * Updates a script tag. + */ + scriptTagUpdate?: Maybe; + /** Creates a segment. */ + segmentCreate?: Maybe; + /** Deletes a segment. */ + segmentDelete?: Maybe; + /** Updates a segment. */ + segmentUpdate?: Maybe; + /** + * Adds multiple product variants to a selling plan group. + */ + sellingPlanGroupAddProductVariants?: Maybe< + SellingPlanGroupAddProductVariantsPayload + >; + /** + * Adds multiple products to a selling plan group. + */ + sellingPlanGroupAddProducts?: Maybe; + /** Creates a Selling Plan Group. */ + sellingPlanGroupCreate?: Maybe; + /** Delete a Selling Plan Group. */ + sellingPlanGroupDelete?: Maybe; + /** + * Removes multiple product variants from a selling plan group. + */ + sellingPlanGroupRemoveProductVariants?: Maybe< + SellingPlanGroupRemoveProductVariantsPayload + >; + /** + * Removes multiple products from a selling plan group. + */ + sellingPlanGroupRemoveProducts?: Maybe; + /** Update a Selling Plan Group. */ + sellingPlanGroupUpdate?: Maybe; + /** Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return. */ + serverPixelCreate?: Maybe; + /** Deletes the Server Pixel associated with the current app & shop. */ + serverPixelDelete?: Maybe; + /** Deletes a shipping package. */ + shippingPackageDelete?: Maybe; + /** + * Set a shipping package as the default. + * The default shipping package is the one used to calculate shipping costs on checkout. + */ + shippingPackageMakeDefault?: Maybe; + /** Updates a shipping package. */ + shippingPackageUpdate?: Maybe; + /** Deletes a locale for a shop. This also deletes all translations of this locale. */ + shopLocaleDisable?: Maybe; + /** Adds a locale for a shop. The newly added locale is in the unpublished state. */ + shopLocaleEnable?: Maybe; + /** Updates a locale for a shop. */ + shopLocaleUpdate?: Maybe; + /** Updates a shop policy. */ + shopPolicyUpdate?: Maybe; + /** + * The `ResourceFeedback` object lets your app report the status of shops and their resources. For example, if + * your app is a marketplace channel, then you can use resource feedback to alert merchants that they need to connect their marketplace account by signing in. + * + * Resource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app. + * + * This resource should be used only in cases where you're describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don't use resource feedback to let merchants know about them. + * + * ## Sending feedback on a shop + * + * You can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: `requires_action` or `success`. You need to send a `requires_action` feedback request for each step that the merchant is required to complete. + * + * If there are multiple set-up steps that require merchant action, then send feedback with a state of `requires_action` as merchants complete prior steps. And to remove the feedback message from the Shopify admin, send a `success` feedback request. + * + * #### Important + * Sending feedback replaces previously sent feedback for the shop. Send a new `shopResourceFeedbackCreate` mutation to push the latest state of a shop or its resources to Shopify. + */ + shopResourceFeedbackCreate?: Maybe; + /** + * Generates the URL and signed paramaters needed to upload an asset to Shopify. + * @deprecated Use `stagedUploadsCreate` instead. + */ + stagedUploadTargetGenerate?: Maybe; + /** + * Uploads multiple images. + * @deprecated Use `stagedUploadsCreate` instead. + */ + stagedUploadTargetsGenerate?: Maybe; + /** + * Creates staged upload targets for each input. This is the first step in the upload process. + * The returned staged upload targets' URL and parameter fields can be used to send a request + * to upload the file described in the corresponding input. + * + * For more information on the upload process, refer to + * [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify). + */ + stagedUploadsCreate?: Maybe; + /** + * Activates the specified standard metafield definition from its template. + * + * Refer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions). + */ + standardMetafieldDefinitionEnable?: Maybe< + StandardMetafieldDefinitionEnablePayload + >; + /** + * Enables the specified standard metaobject definition from its template. + */ + standardMetaobjectDefinitionEnable?: Maybe< + StandardMetaobjectDefinitionEnablePayload + >; + /** Creates a storefront access token. An app can have a maximum of 100 active storefront access tokens for each shop. */ + storefrontAccessTokenCreate?: Maybe; + /** Deletes a storefront access token. */ + storefrontAccessTokenDelete?: Maybe; + /** + * Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt). + */ + subscriptionBillingAttemptCreate?: Maybe< + SubscriptionBillingAttemptCreatePayload + >; + /** Commits the updates of a Subscription Billing Cycle Contract draft. */ + subscriptionBillingCycleContractDraftCommit?: Maybe< + SubscriptionBillingCycleContractDraftCommitPayload + >; + /** Concatenates a contract to a Subscription Draft. */ + subscriptionBillingCycleContractDraftConcatenate?: Maybe< + SubscriptionBillingCycleContractDraftConcatenatePayload + >; + /** Edit the contents of a subscription contract for the specified billing cycle. */ + subscriptionBillingCycleContractEdit?: Maybe< + SubscriptionBillingCycleContractEditPayload + >; + /** Delete the schedule and contract edits of the selected subscription billing cycle. */ + subscriptionBillingCycleEditDelete?: Maybe< + SubscriptionBillingCycleEditDeletePayload + >; + /** Delete the current and future schedule and contract edits of a list of subscription billing cycles. */ + subscriptionBillingCycleEditsDelete?: Maybe< + SubscriptionBillingCycleEditsDeletePayload + >; + /** Modify the schedule of a specific billing cycle. */ + subscriptionBillingCycleScheduleEdit?: Maybe< + SubscriptionBillingCycleScheduleEditPayload + >; + /** Creates a Subscription Contract. */ + subscriptionContractAtomicCreate?: Maybe< + SubscriptionContractAtomicCreatePayload + >; + /** Creates a Subscription Contract. */ + subscriptionContractCreate?: Maybe; + /** Allows for the easy change of a Product in a Contract or a Product price change. */ + subscriptionContractProductChange?: Maybe< + SubscriptionContractProductChangePayload + >; + /** Sets the next billing date of a Subscription Contract. */ + subscriptionContractSetNextBillingDate?: Maybe< + SubscriptionContractSetNextBillingDatePayload + >; + /** Updates a Subscription Contract. */ + subscriptionContractUpdate?: Maybe; + /** Commits the updates of a Subscription Contract draft. */ + subscriptionDraftCommit?: Maybe; + /** Adds a subscription discount to a subscription draft. */ + subscriptionDraftDiscountAdd?: Maybe; + /** Applies a code discount on the subscription draft. */ + subscriptionDraftDiscountCodeApply?: Maybe< + SubscriptionDraftDiscountCodeApplyPayload + >; + /** Removes a subscription discount from a subscription draft. */ + subscriptionDraftDiscountRemove?: Maybe< + SubscriptionDraftDiscountRemovePayload + >; + /** Updates a subscription discount on a subscription draft. */ + subscriptionDraftDiscountUpdate?: Maybe< + SubscriptionDraftDiscountUpdatePayload + >; + /** Adds a subscription free shipping discount to a subscription draft. */ + subscriptionDraftFreeShippingDiscountAdd?: Maybe< + SubscriptionDraftFreeShippingDiscountAddPayload + >; + /** Updates a subscription free shipping discount on a subscription draft. */ + subscriptionDraftFreeShippingDiscountUpdate?: Maybe< + SubscriptionDraftFreeShippingDiscountUpdatePayload + >; + /** Adds a subscription line to a subscription draft. */ + subscriptionDraftLineAdd?: Maybe; + /** Removes a subscription line from a subscription draft. */ + subscriptionDraftLineRemove?: Maybe; + /** Updates a subscription line on a subscription draft. */ + subscriptionDraftLineUpdate?: Maybe; + /** Updates a Subscription Draft. */ + subscriptionDraftUpdate?: Maybe; + /** Add tags to an order, a draft order, a customer, a product, or an online store article. */ + tagsAdd?: Maybe; + /** Remove tags from an order, a draft order, a customer, a product, or an online store article. */ + tagsRemove?: Maybe; + /** + * Allows tax app configurations for tax partners. + */ + taxAppConfigure?: Maybe; + /** Creates or updates translations. */ + translationsRegister?: Maybe; + /** Deletes translations. */ + translationsRemove?: Maybe; + /** + * Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk. + */ + urlRedirectBulkDeleteAll?: Maybe; + /** + * Asynchronously delete [URLRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) + * objects in bulk by IDs. + * Learn more about [URLRedirect](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect) + * objects. + */ + urlRedirectBulkDeleteByIds?: Maybe; + /** Asynchronously delete redirects in bulk. */ + urlRedirectBulkDeleteBySavedSearch?: Maybe< + UrlRedirectBulkDeleteBySavedSearchPayload + >; + /** Asynchronously delete redirects in bulk. */ + urlRedirectBulkDeleteBySearch?: Maybe; + /** + * Creates a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object. + */ + urlRedirectCreate?: Maybe; + /** + * Deletes a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object. + */ + urlRedirectDelete?: Maybe; + /** + * Creates a [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object. + * + * After creating the `UrlRedirectImport` object, the `UrlRedirectImport` request can be performed using the [`urlRedirectImportSubmit`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportSubmit) mutation. + */ + urlRedirectImportCreate?: Maybe; + /** + * Submits a `UrlRedirectImport` request to be processed. + * + * The `UrlRedirectImport` request is first created with the [`urlRedirectImportCreate`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate) mutation. + */ + urlRedirectImportSubmit?: Maybe; + /** + * Updates a URL redirect. + */ + urlRedirectUpdate?: Maybe; + /** Creates a new web pixel settings. */ + webPixelCreate?: Maybe; + /** Deletes the web pixel shop settings. */ + webPixelDelete?: Maybe; + /** Updates the web pixel settings. */ + webPixelUpdate?: Maybe; + /** + * Creates a new webhook subscription. + */ + webhookSubscriptionCreate?: Maybe; + /** + * Deletes a webhook subscription. + */ + webhookSubscriptionDelete?: Maybe; + /** + * Updates a webhook subscription. + */ + webhookSubscriptionUpdate?: Maybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAbandonmentEmailStateUpdateArgs = { + emailSentAt?: InputMaybe; + emailState: AbandonmentEmailState; + emailStateChangeReason?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAbandonmentUpdateActivitiesDeliveryStatusesArgs = { + abandonmentId: Scalars["ID"]["input"]; + deliveredAt?: InputMaybe; + deliveryStatus: AbandonmentDeliveryState; + deliveryStatusChangeReason?: InputMaybe; + marketingActivityId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppPurchaseOneTimeCreateArgs = { + name: Scalars["String"]["input"]; + price: MoneyInput; + returnUrl: Scalars["URL"]["input"]; + test?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppRevenueAttributionRecordCreateArgs = { + appRevenueAttributionRecord: AppRevenueAttributionRecordInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppRevenueAttributionRecordDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppSubscriptionCancelArgs = { + id: Scalars["ID"]["input"]; + prorate?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppSubscriptionCreateArgs = { + lineItems: Array; + name: Scalars["String"]["input"]; + replacementBehavior?: InputMaybe; + returnUrl: Scalars["URL"]["input"]; + test?: InputMaybe; + trialDays?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppSubscriptionLineItemUpdateArgs = { + cappedAmount: MoneyInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppSubscriptionTrialExtendArgs = { + days: Scalars["Int"]["input"]; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationAppUsageRecordCreateArgs = { + description: Scalars["String"]["input"]; + idempotencyKey?: InputMaybe; + price: MoneyInput; + subscriptionLineItemId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationBulkOperationCancelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationBulkOperationRunMutationArgs = { + clientIdentifier?: InputMaybe; + mutation: Scalars["String"]["input"]; + stagedUploadPath: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationBulkOperationRunQueryArgs = { + query: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationBulkProductResourceFeedbackCreateArgs = { + feedbackInput: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCartTransformCreateArgs = { + functionId: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCartTransformDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCatalogContextUpdateArgs = { + catalogId: Scalars["ID"]["input"]; + contextsToAdd?: InputMaybe; + contextsToRemove?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCatalogCreateArgs = { + input: CatalogCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCatalogDeleteArgs = { + deleteDependentResources?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCatalogUpdateArgs = { + id: Scalars["ID"]["input"]; + input: CatalogUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionAddProductsArgs = { + id: Scalars["ID"]["input"]; + productIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionAddProductsV2Args = { + id: Scalars["ID"]["input"]; + productIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionCreateArgs = { + input: CollectionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionDeleteArgs = { + input: CollectionDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionPublishArgs = { + input: CollectionPublishInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionRemoveProductsArgs = { + id: Scalars["ID"]["input"]; + productIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionReorderProductsArgs = { + id: Scalars["ID"]["input"]; + moves: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionUnpublishArgs = { + input: CollectionUnpublishInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCollectionUpdateArgs = { + input: CollectionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompaniesDeleteArgs = { + companyIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyAddressDeleteArgs = { + addressId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyAssignCustomerAsContactArgs = { + companyId: Scalars["ID"]["input"]; + customerId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyAssignMainContactArgs = { + companyContactId: Scalars["ID"]["input"]; + companyId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactAssignRoleArgs = { + companyContactId: Scalars["ID"]["input"]; + companyContactRoleId: Scalars["ID"]["input"]; + companyLocationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactAssignRolesArgs = { + companyContactId: Scalars["ID"]["input"]; + rolesToAssign: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactCreateArgs = { + companyId: Scalars["ID"]["input"]; + input: CompanyContactInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactDeleteArgs = { + companyContactId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactRemoveFromCompanyArgs = { + companyContactId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactRevokeRoleArgs = { + companyContactId: Scalars["ID"]["input"]; + companyContactRoleAssignmentId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactRevokeRolesArgs = { + companyContactId: Scalars["ID"]["input"]; + revokeAll?: InputMaybe; + roleAssignmentIds?: InputMaybe>; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactSendWelcomeEmailArgs = { + companyContactId: Scalars["ID"]["input"]; + email?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactUpdateArgs = { + companyContactId: Scalars["ID"]["input"]; + input: CompanyContactInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyContactsDeleteArgs = { + companyContactIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyCreateArgs = { + input: CompanyCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationAssignAddressArgs = { + address: CompanyAddressInput; + addressTypes: Array; + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationAssignRolesArgs = { + companyLocationId: Scalars["ID"]["input"]; + rolesToAssign: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationAssignTaxExemptionsArgs = { + companyLocationId: Scalars["ID"]["input"]; + taxExemptions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationCreateArgs = { + companyId: Scalars["ID"]["input"]; + input: CompanyLocationInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationCreateTaxRegistrationArgs = { + locationId: Scalars["ID"]["input"]; + taxId: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationDeleteArgs = { + companyLocationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationRevokeRolesArgs = { + companyLocationId: Scalars["ID"]["input"]; + rolesToRevoke: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationRevokeTaxExemptionsArgs = { + companyLocationId: Scalars["ID"]["input"]; + taxExemptions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationRevokeTaxRegistrationArgs = { + companyLocationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationUpdateArgs = { + companyLocationId: Scalars["ID"]["input"]; + input: CompanyLocationUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyLocationsDeleteArgs = { + companyLocationIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyRevokeMainContactArgs = { + companyId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCompanyUpdateArgs = { + companyId: Scalars["ID"]["input"]; + input: CompanyInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerAddTaxExemptionsArgs = { + customerId: Scalars["ID"]["input"]; + taxExemptions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerCreateArgs = { + input: CustomerInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerDeleteArgs = { + input: CustomerDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerEmailMarketingConsentUpdateArgs = { + input: CustomerEmailMarketingConsentUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerGenerateAccountActivationUrlArgs = { + customerId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerMergeArgs = { + customerOneId: Scalars["ID"]["input"]; + customerTwoId: Scalars["ID"]["input"]; + overrideFields?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodCreateFromDuplicationDataArgs = { + billingAddress: MailingAddressInput; + customerId: Scalars["ID"]["input"]; + encryptedDuplicationData: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodCreditCardCreateArgs = { + billingAddress: MailingAddressInput; + customerId: Scalars["ID"]["input"]; + sessionId: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodCreditCardUpdateArgs = { + billingAddress: MailingAddressInput; + id: Scalars["ID"]["input"]; + sessionId: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodGetDuplicationDataArgs = { + customerPaymentMethodId: Scalars["ID"]["input"]; + targetCustomerId: Scalars["ID"]["input"]; + targetShopId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodGetUpdateUrlArgs = { + customerPaymentMethodId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodPaypalBillingAgreementCreateArgs = { + billingAddress?: InputMaybe; + billingAgreementId: Scalars["String"]["input"]; + customerId: Scalars["ID"]["input"]; + inactive?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodPaypalBillingAgreementUpdateArgs = { + billingAddress: MailingAddressInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodRemoteCreateArgs = { + customerId: Scalars["ID"]["input"]; + remoteReference: CustomerPaymentMethodRemoteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodRemoteCreditCardCreateArgs = { + customerId: Scalars["ID"]["input"]; + stripeCustomerId: Scalars["String"]["input"]; + stripePaymentMethodId?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodRevokeArgs = { + customerPaymentMethodId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerPaymentMethodSendUpdateEmailArgs = { + customerPaymentMethodId: Scalars["ID"]["input"]; + email?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerRemoveTaxExemptionsArgs = { + customerId: Scalars["ID"]["input"]; + taxExemptions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerReplaceTaxExemptionsArgs = { + customerId: Scalars["ID"]["input"]; + taxExemptions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerSegmentMembersQueryCreateArgs = { + input: CustomerSegmentMembersQueryInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerSmsMarketingConsentUpdateArgs = { + input: CustomerSmsMarketingConsentUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerUpdateArgs = { + input: CustomerInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationCustomerUpdateDefaultAddressArgs = { + addressId: Scalars["ID"]["input"]; + customerId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDelegateAccessTokenCreateArgs = { + input: DelegateAccessTokenInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDelegateAccessTokenDestroyArgs = { + accessToken: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryCustomizationActivationArgs = { + enabled: Scalars["Boolean"]["input"]; + ids: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryCustomizationCreateArgs = { + deliveryCustomization: DeliveryCustomizationInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryCustomizationDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryCustomizationUpdateArgs = { + deliveryCustomization: DeliveryCustomizationInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryProfileCreateArgs = { + profile: DeliveryProfileInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryProfileRemoveArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryProfileUpdateArgs = { + id: Scalars["ID"]["input"]; + leaveLegacyModeProfiles?: InputMaybe; + profile: DeliveryProfileInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliverySettingUpdateArgs = { + setting: DeliverySettingInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDeliveryShippingOriginAssignArgs = { + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticActivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticAppCreateArgs = { + automaticAppDiscount: DiscountAutomaticAppInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticAppUpdateArgs = { + automaticAppDiscount: DiscountAutomaticAppInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticBasicCreateArgs = { + automaticBasicDiscount: DiscountAutomaticBasicInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticBasicUpdateArgs = { + automaticBasicDiscount: DiscountAutomaticBasicInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticBulkDeleteArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticBxgyCreateArgs = { + automaticBxgyDiscount: DiscountAutomaticBxgyInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticBxgyUpdateArgs = { + automaticBxgyDiscount: DiscountAutomaticBxgyInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticDeactivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountAutomaticDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeActivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeAppCreateArgs = { + codeAppDiscount: DiscountCodeAppInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeAppUpdateArgs = { + codeAppDiscount: DiscountCodeAppInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBasicCreateArgs = { + basicCodeDiscount: DiscountCodeBasicInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBasicUpdateArgs = { + basicCodeDiscount: DiscountCodeBasicInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBulkActivateArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBulkDeactivateArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBulkDeleteArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBxgyCreateArgs = { + bxgyCodeDiscount: DiscountCodeBxgyInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeBxgyUpdateArgs = { + bxgyCodeDiscount: DiscountCodeBxgyInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeDeactivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeFreeShippingCreateArgs = { + freeShippingCodeDiscount: DiscountCodeFreeShippingInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeFreeShippingUpdateArgs = { + freeShippingCodeDiscount: DiscountCodeFreeShippingInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountCodeRedeemCodeBulkDeleteArgs = { + discountId: Scalars["ID"]["input"]; + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDiscountRedeemCodeBulkAddArgs = { + codes: Array; + discountId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDisputeEvidenceUpdateArgs = { + id: Scalars["ID"]["input"]; + input: ShopifyPaymentsDisputeEvidenceUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderBulkAddTagsArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; + tags: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderBulkDeleteArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderBulkRemoveTagsArgs = { + ids?: InputMaybe>; + savedSearchId?: InputMaybe; + search?: InputMaybe; + tags: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderCalculateArgs = { + input: DraftOrderInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderCompleteArgs = { + id: Scalars["ID"]["input"]; + paymentGatewayId?: InputMaybe; + paymentPending?: InputMaybe; + sourceName?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderCreateArgs = { + input: DraftOrderInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderCreateFromOrderArgs = { + orderId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderCreateMerchantCheckoutArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderDeleteArgs = { + input: DraftOrderDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderDuplicateArgs = { + id?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderInvoicePreviewArgs = { + email?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderInvoiceSendArgs = { + email?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationDraftOrderUpdateArgs = { + id: Scalars["ID"]["input"]; + input: DraftOrderInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationEventBridgeServerPixelUpdateArgs = { + arn: Scalars["ARN"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationEventBridgeWebhookSubscriptionCreateArgs = { + topic: WebhookSubscriptionTopic; + webhookSubscription: EventBridgeWebhookSubscriptionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationEventBridgeWebhookSubscriptionUpdateArgs = { + id: Scalars["ID"]["input"]; + webhookSubscription: EventBridgeWebhookSubscriptionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFileAcknowledgeUpdateFailedArgs = { + fileIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFileCreateArgs = { + files: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFileDeleteArgs = { + fileIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFileUpdateArgs = { + files: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFlowTriggerReceiveArgs = { + body: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentCancelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentCreateV2Args = { + fulfillment: FulfillmentV2Input; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentEventCreateArgs = { + fulfillmentEvent: FulfillmentEventInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderAcceptCancellationRequestArgs = { + id: Scalars["ID"]["input"]; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderAcceptFulfillmentRequestArgs = { + id: Scalars["ID"]["input"]; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderCancelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderCloseArgs = { + id: Scalars["ID"]["input"]; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderHoldArgs = { + fulfillmentHold: FulfillmentOrderHoldInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderLineItemsPreparedForPickupArgs = { + input: FulfillmentOrderLineItemsPreparedForPickupInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderMergeArgs = { + fulfillmentOrderMergeInputs: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderMoveArgs = { + fulfillmentOrderLineItems?: InputMaybe>; + id: Scalars["ID"]["input"]; + newLocationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderOpenArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderRejectCancellationRequestArgs = { + id: Scalars["ID"]["input"]; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderRejectFulfillmentRequestArgs = { + id: Scalars["ID"]["input"]; + lineItems?: InputMaybe>; + message?: InputMaybe; + reason?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderReleaseHoldArgs = { + externalId?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderRescheduleArgs = { + fulfillAt: Scalars["DateTime"]["input"]; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderSplitArgs = { + fulfillmentOrderSplits: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderSubmitCancellationRequestArgs = { + id: Scalars["ID"]["input"]; + message?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrderSubmitFulfillmentRequestArgs = { + fulfillmentOrderLineItems?: InputMaybe>; + id: Scalars["ID"]["input"]; + message?: InputMaybe; + notifyCustomer?: InputMaybe; + shippingMethod?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrdersReleaseHoldsArgs = { + externalId?: InputMaybe; + ids: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentOrdersSetFulfillmentDeadlineArgs = { + fulfillmentDeadline: Scalars["DateTime"]["input"]; + fulfillmentOrderIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentServiceCreateArgs = { + callbackUrl: Scalars["URL"]["input"]; + fulfillmentOrdersOptIn: Scalars["Boolean"]["input"]; + inventoryManagement?: InputMaybe; + name: Scalars["String"]["input"]; + permitsSkuSharing?: InputMaybe; + trackingSupport?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentServiceDeleteArgs = { + destinationLocationId?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentServiceUpdateArgs = { + callbackUrl?: InputMaybe; + fulfillmentOrdersOptIn?: InputMaybe; + id: Scalars["ID"]["input"]; + name?: InputMaybe; + permitsSkuSharing?: InputMaybe; + trackingSupport?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationFulfillmentTrackingInfoUpdateV2Args = { + fulfillmentId: Scalars["ID"]["input"]; + notifyCustomer?: InputMaybe; + trackingInfoInput: FulfillmentTrackingInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationGiftCardCreateArgs = { + input: GiftCardCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationGiftCardDisableArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationGiftCardUpdateArgs = { + id: Scalars["ID"]["input"]; + input: GiftCardUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryActivateArgs = { + available?: InputMaybe; + inventoryItemId: Scalars["ID"]["input"]; + locationId: Scalars["ID"]["input"]; + onHand?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryAdjustQuantitiesArgs = { + input: InventoryAdjustQuantitiesInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryAdjustQuantityArgs = { + input: InventoryAdjustQuantityInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryBulkAdjustQuantityAtLocationArgs = { + inventoryItemAdjustments: Array; + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryBulkToggleActivationArgs = { + inventoryItemId: Scalars["ID"]["input"]; + inventoryItemUpdates: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryDeactivateArgs = { + inventoryLevelId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryItemUpdateArgs = { + id: Scalars["ID"]["input"]; + input: InventoryItemUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventoryMoveQuantitiesArgs = { + input: InventoryMoveQuantitiesInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationInventorySetOnHandQuantitiesArgs = { + input: InventorySetOnHandQuantitiesInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationActivateArgs = { + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationAddArgs = { + input: LocationAddInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationDeactivateArgs = { + destinationLocationId?: InputMaybe; + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationDeleteArgs = { + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationEditArgs = { + id: Scalars["ID"]["input"]; + input: LocationEditInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationLocalPickupDisableArgs = { + locationId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationLocationLocalPickupEnableArgs = { + localPickupSettings: DeliveryLocationLocalPickupEnableInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketCreateArgs = { + input: MarketCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketCurrencySettingsUpdateArgs = { + input: MarketCurrencySettingsUpdateInput; + marketId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketLocalizationsRegisterArgs = { + marketLocalizations: Array; + resourceId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketLocalizationsRemoveArgs = { + marketIds: Array; + marketLocalizationKeys: Array; + resourceId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketRegionDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketRegionsCreateArgs = { + marketId: Scalars["ID"]["input"]; + regions: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketUpdateArgs = { + id: Scalars["ID"]["input"]; + input: MarketUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketWebPresenceCreateArgs = { + marketId: Scalars["ID"]["input"]; + webPresence: MarketWebPresenceCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketWebPresenceDeleteArgs = { + marketId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketWebPresenceUpdateArgs = { + marketId: Scalars["ID"]["input"]; + webPresence: MarketWebPresenceUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketingActivityCreateArgs = { + input: MarketingActivityCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketingActivityCreateExternalArgs = { + input: MarketingActivityCreateExternalInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketingActivityUpdateArgs = { + input: MarketingActivityUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketingActivityUpdateExternalArgs = { + input: MarketingActivityUpdateExternalInput; + marketingActivityId?: InputMaybe; + remoteId?: InputMaybe; + utm?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMarketingEngagementCreateArgs = { + marketingActivityId: Scalars["ID"]["input"]; + marketingEngagement: MarketingEngagementInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDefinitionCreateArgs = { + definition: MetafieldDefinitionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDefinitionDeleteArgs = { + deleteAllAssociatedMetafields?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDefinitionPinArgs = { + definitionId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDefinitionUnpinArgs = { + definitionId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDefinitionUpdateArgs = { + definition: MetafieldDefinitionUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldDeleteArgs = { + input: MetafieldDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldStorefrontVisibilityCreateArgs = { + input: MetafieldStorefrontVisibilityInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldStorefrontVisibilityDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetafieldsSetArgs = { + metafields: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectBulkDeleteArgs = { + where: MetaobjectBulkDeleteWhereCondition; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectCreateArgs = { + metaobject: MetaobjectCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectDefinitionCreateArgs = { + definition: MetaobjectDefinitionCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectDefinitionDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectDefinitionUpdateArgs = { + definition: MetaobjectDefinitionUpdateInput; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectUpdateArgs = { + id: Scalars["ID"]["input"]; + metaobject: MetaobjectUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationMetaobjectUpsertArgs = { + handle: MetaobjectHandleInput; + metaobject: MetaobjectUpsertInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderCaptureArgs = { + input: OrderCaptureInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderCloseArgs = { + input: OrderCloseInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderCreateMandatePaymentArgs = { + autoCapture?: InputMaybe; + id: Scalars["ID"]["input"]; + idempotencyKey: Scalars["String"]["input"]; + mandateId: Scalars["ID"]["input"]; + paymentScheduleId?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditAddCustomItemArgs = { + id: Scalars["ID"]["input"]; + locationId?: InputMaybe; + price: MoneyInput; + quantity: Scalars["Int"]["input"]; + requiresShipping?: InputMaybe; + taxable?: InputMaybe; + title: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditAddLineItemDiscountArgs = { + discount: OrderEditAppliedDiscountInput; + id: Scalars["ID"]["input"]; + lineItemId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditAddVariantArgs = { + allowDuplicates?: InputMaybe; + id: Scalars["ID"]["input"]; + locationId?: InputMaybe; + quantity: Scalars["Int"]["input"]; + variantId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditBeginArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditCommitArgs = { + id: Scalars["ID"]["input"]; + notifyCustomer?: InputMaybe; + staffNote?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditRemoveLineItemDiscountArgs = { + discountApplicationId: Scalars["ID"]["input"]; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderEditSetQuantityArgs = { + id: Scalars["ID"]["input"]; + lineItemId: Scalars["ID"]["input"]; + quantity: Scalars["Int"]["input"]; + restock?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderInvoiceSendArgs = { + email?: InputMaybe; + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderMarkAsPaidArgs = { + input: OrderMarkAsPaidInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderOpenArgs = { + input: OrderOpenInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationOrderUpdateArgs = { + input: OrderInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentCustomizationActivationArgs = { + enabled: Scalars["Boolean"]["input"]; + ids: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentCustomizationCreateArgs = { + paymentCustomization: PaymentCustomizationInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentCustomizationDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentCustomizationUpdateArgs = { + id: Scalars["ID"]["input"]; + paymentCustomization: PaymentCustomizationInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentReminderSendArgs = { + paymentScheduleId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentTermsCreateArgs = { + paymentTermsAttributes: PaymentTermsCreateInput; + referenceId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentTermsDeleteArgs = { + input: PaymentTermsDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPaymentTermsUpdateArgs = { + input: PaymentTermsUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListCreateArgs = { + input: PriceListCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListFixedPricesAddArgs = { + priceListId: Scalars["ID"]["input"]; + prices: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListFixedPricesByProductUpdateArgs = { + priceListId: Scalars["ID"]["input"]; + pricesToAdd?: InputMaybe>; + pricesToDeleteByProductIds?: InputMaybe>; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListFixedPricesDeleteArgs = { + priceListId: Scalars["ID"]["input"]; + variantIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListFixedPricesUpdateArgs = { + priceListId: Scalars["ID"]["input"]; + pricesToAdd: Array; + variantIdsToDelete: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceListUpdateArgs = { + id: Scalars["ID"]["input"]; + input: PriceListUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleActivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleCreateArgs = { + priceRule: PriceRuleInput; + priceRuleDiscountCode?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleDeactivateArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleDiscountCodeCreateArgs = { + code: Scalars["String"]["input"]; + priceRuleId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleDiscountCodeUpdateArgs = { + code: Scalars["String"]["input"]; + priceRuleId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPriceRuleUpdateArgs = { + id: Scalars["ID"]["input"]; + priceRule: PriceRuleInput; + priceRuleDiscountCode?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPrivateMetafieldDeleteArgs = { + input: PrivateMetafieldDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPrivateMetafieldUpsertArgs = { + input: PrivateMetafieldInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductAppendImagesArgs = { + input: ProductAppendImagesInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductChangeStatusArgs = { + productId: Scalars["ID"]["input"]; + status: ProductStatus; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductCreateArgs = { + input: ProductInput; + media?: InputMaybe>; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductCreateMediaArgs = { + media: Array; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDeleteArgs = { + input: ProductDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDeleteAsyncArgs = { + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDeleteImagesArgs = { + id: Scalars["ID"]["input"]; + imageIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDeleteMediaArgs = { + mediaIds: Array; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDuplicateArgs = { + includeImages?: InputMaybe; + newStatus?: InputMaybe; + newTitle: Scalars["String"]["input"]; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDuplicateAsyncArgs = { + input: ProductDuplicateAsyncInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductDuplicateAsyncV2Args = { + input: ProductDuplicateAsyncInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductFeedCreateArgs = { + input?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductFeedDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductFullSyncArgs = { + beforeUpdatedAt?: InputMaybe; + id: Scalars["ID"]["input"]; + updatedAtSince?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductImageUpdateArgs = { + image: ImageInput; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductJoinSellingPlanGroupsArgs = { + id: Scalars["ID"]["input"]; + sellingPlanGroupIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductLeaveSellingPlanGroupsArgs = { + id: Scalars["ID"]["input"]; + sellingPlanGroupIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductPublishArgs = { + input: ProductPublishInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductReorderImagesArgs = { + id: Scalars["ID"]["input"]; + moves: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductReorderMediaArgs = { + id: Scalars["ID"]["input"]; + moves: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductUnpublishArgs = { + input: ProductUnpublishInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductUpdateArgs = { + input: ProductInput; + media?: InputMaybe>; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductUpdateMediaArgs = { + media: Array; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantAppendMediaArgs = { + productId: Scalars["ID"]["input"]; + variantMedia: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantCreateArgs = { + input: ProductVariantInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantDetachMediaArgs = { + productId: Scalars["ID"]["input"]; + variantMedia: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantJoinSellingPlanGroupsArgs = { + id: Scalars["ID"]["input"]; + sellingPlanGroupIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantLeaveSellingPlanGroupsArgs = { + id: Scalars["ID"]["input"]; + sellingPlanGroupIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantRelationshipBulkUpdateArgs = { + input: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantUpdateArgs = { + input: ProductVariantInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantsBulkCreateArgs = { + media?: InputMaybe>; + productId: Scalars["ID"]["input"]; + variants: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantsBulkDeleteArgs = { + productId: Scalars["ID"]["input"]; + variantsIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantsBulkReorderArgs = { + positions: Array; + productId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationProductVariantsBulkUpdateArgs = { + allowPartialUpdates?: InputMaybe; + media?: InputMaybe>; + productId: Scalars["ID"]["input"]; + variants: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPubSubServerPixelUpdateArgs = { + pubSubProject: Scalars["String"]["input"]; + pubSubTopic: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPubSubWebhookSubscriptionCreateArgs = { + topic: WebhookSubscriptionTopic; + webhookSubscription: PubSubWebhookSubscriptionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPubSubWebhookSubscriptionUpdateArgs = { + id: Scalars["ID"]["input"]; + webhookSubscription?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublicationCreateArgs = { + input: PublicationCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublicationDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublicationUpdateArgs = { + id: Scalars["ID"]["input"]; + input: PublicationUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublishablePublishArgs = { + id: Scalars["ID"]["input"]; + input: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublishablePublishToCurrentChannelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublishableUnpublishArgs = { + id: Scalars["ID"]["input"]; + input: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationPublishableUnpublishToCurrentChannelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationQuantityRulesAddArgs = { + priceListId: Scalars["ID"]["input"]; + quantityRules: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationQuantityRulesDeleteArgs = { + priceListId: Scalars["ID"]["input"]; + variantIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationRefundCreateArgs = { + input: RefundInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnApproveRequestArgs = { + input: ReturnApproveRequestInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnCancelArgs = { + id: Scalars["ID"]["input"]; + notifyCustomer?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnCloseArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnCreateArgs = { + returnInput: ReturnInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnDeclineRequestArgs = { + input: ReturnDeclineRequestInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnRefundArgs = { + returnRefundInput: ReturnRefundInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnReopenArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReturnRequestArgs = { + input: ReturnRequestInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReverseDeliveryCreateWithShippingArgs = { + labelInput?: InputMaybe; + notifyCustomer?: InputMaybe; + reverseDeliveryLineItems: Array; + reverseFulfillmentOrderId: Scalars["ID"]["input"]; + trackingInput?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReverseDeliveryDisposeArgs = { + dispositionInputs: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReverseDeliveryShippingUpdateArgs = { + labelInput?: InputMaybe; + notifyCustomer?: InputMaybe; + reverseDeliveryId: Scalars["ID"]["input"]; + trackingInput?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationReverseFulfillmentOrderDisposeArgs = { + dispositionInputs: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSavedSearchCreateArgs = { + input: SavedSearchCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSavedSearchDeleteArgs = { + input: SavedSearchDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSavedSearchUpdateArgs = { + input: SavedSearchUpdateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationScriptTagCreateArgs = { + input: ScriptTagInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationScriptTagDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationScriptTagUpdateArgs = { + id: Scalars["ID"]["input"]; + input: ScriptTagInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSegmentCreateArgs = { + name: Scalars["String"]["input"]; + query: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSegmentDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSegmentUpdateArgs = { + id: Scalars["ID"]["input"]; + name?: InputMaybe; + query?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupAddProductVariantsArgs = { + id: Scalars["ID"]["input"]; + productVariantIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupAddProductsArgs = { + id: Scalars["ID"]["input"]; + productIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupCreateArgs = { + input: SellingPlanGroupInput; + resources?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupRemoveProductVariantsArgs = { + id: Scalars["ID"]["input"]; + productVariantIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupRemoveProductsArgs = { + id: Scalars["ID"]["input"]; + productIds: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSellingPlanGroupUpdateArgs = { + id: Scalars["ID"]["input"]; + input: SellingPlanGroupInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShippingPackageDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShippingPackageMakeDefaultArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShippingPackageUpdateArgs = { + id: Scalars["ID"]["input"]; + shippingPackage: CustomShippingPackageInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShopLocaleDisableArgs = { + locale: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShopLocaleEnableArgs = { + locale: Scalars["String"]["input"]; + marketWebPresenceIds?: InputMaybe>; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShopLocaleUpdateArgs = { + locale: Scalars["String"]["input"]; + shopLocale: ShopLocaleInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShopPolicyUpdateArgs = { + shopPolicy: ShopPolicyInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationShopResourceFeedbackCreateArgs = { + input: ResourceFeedbackCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStagedUploadTargetGenerateArgs = { + input: StagedUploadTargetGenerateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStagedUploadTargetsGenerateArgs = { + input: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStagedUploadsCreateArgs = { + input: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStandardMetafieldDefinitionEnableArgs = { + id?: InputMaybe; + key?: InputMaybe; + namespace?: InputMaybe; + ownerType: MetafieldOwnerType; + pin?: Scalars["Boolean"]["input"]; + useAsCollectionCondition?: InputMaybe; + visibleToStorefrontApi?: InputMaybe; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStandardMetaobjectDefinitionEnableArgs = { + type: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStorefrontAccessTokenCreateArgs = { + input: StorefrontAccessTokenInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationStorefrontAccessTokenDeleteArgs = { + input: StorefrontAccessTokenDeleteInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingAttemptCreateArgs = { + subscriptionBillingAttemptInput: SubscriptionBillingAttemptInput; + subscriptionContractId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleContractDraftCommitArgs = { + draftId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleContractDraftConcatenateArgs = { + concatenatedBillingCycleContracts: Array; + draftId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleContractEditArgs = { + billingCycleInput: SubscriptionBillingCycleInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleEditDeleteArgs = { + billingCycleInput: SubscriptionBillingCycleInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleEditsDeleteArgs = { + contractId: Scalars["ID"]["input"]; + targetSelection: SubscriptionBillingCyclesTargetSelection; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionBillingCycleScheduleEditArgs = { + billingCycleInput: SubscriptionBillingCycleInput; + input: SubscriptionBillingCycleScheduleEditInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionContractAtomicCreateArgs = { + input: SubscriptionContractAtomicCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionContractCreateArgs = { + input: SubscriptionContractCreateInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionContractProductChangeArgs = { + input: SubscriptionContractProductChangeInput; + lineId: Scalars["ID"]["input"]; + subscriptionContractId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionContractSetNextBillingDateArgs = { + contractId: Scalars["ID"]["input"]; + date: Scalars["DateTime"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionContractUpdateArgs = { + contractId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftCommitArgs = { + draftId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftDiscountAddArgs = { + draftId: Scalars["ID"]["input"]; + input: SubscriptionManualDiscountInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftDiscountCodeApplyArgs = { + draftId: Scalars["ID"]["input"]; + redeemCode: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftDiscountRemoveArgs = { + discountId: Scalars["ID"]["input"]; + draftId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftDiscountUpdateArgs = { + discountId: Scalars["ID"]["input"]; + draftId: Scalars["ID"]["input"]; + input: SubscriptionManualDiscountInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftFreeShippingDiscountAddArgs = { + draftId: Scalars["ID"]["input"]; + input: SubscriptionFreeShippingDiscountInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftFreeShippingDiscountUpdateArgs = { + discountId: Scalars["ID"]["input"]; + draftId: Scalars["ID"]["input"]; + input: SubscriptionFreeShippingDiscountInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftLineAddArgs = { + draftId: Scalars["ID"]["input"]; + input: SubscriptionLineInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftLineRemoveArgs = { + draftId: Scalars["ID"]["input"]; + lineId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftLineUpdateArgs = { + draftId: Scalars["ID"]["input"]; + input: SubscriptionLineUpdateInput; + lineId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationSubscriptionDraftUpdateArgs = { + draftId: Scalars["ID"]["input"]; + input: SubscriptionDraftInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationTagsAddArgs = { + id: Scalars["ID"]["input"]; + tags: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationTagsRemoveArgs = { + id: Scalars["ID"]["input"]; + tags: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationTaxAppConfigureArgs = { + ready: Scalars["Boolean"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationTranslationsRegisterArgs = { + resourceId: Scalars["ID"]["input"]; + translations: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationTranslationsRemoveArgs = { + locales: Array; + marketIds?: InputMaybe>; + resourceId: Scalars["ID"]["input"]; + translationKeys: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectBulkDeleteByIdsArgs = { + ids: Array; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectBulkDeleteBySavedSearchArgs = { + savedSearchId: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectBulkDeleteBySearchArgs = { + search: Scalars["String"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectCreateArgs = { + urlRedirect: UrlRedirectInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectImportCreateArgs = { + url: Scalars["URL"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectImportSubmitArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationUrlRedirectUpdateArgs = { + id: Scalars["ID"]["input"]; + urlRedirect: UrlRedirectInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebPixelCreateArgs = { + webPixel: WebPixelInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebPixelDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebPixelUpdateArgs = { + id: Scalars["ID"]["input"]; + webPixel: WebPixelInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebhookSubscriptionCreateArgs = { + topic: WebhookSubscriptionTopic; + webhookSubscription: WebhookSubscriptionInput; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebhookSubscriptionDeleteArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry point for all mutation operations. */ +export type MutationWebhookSubscriptionUpdateArgs = { + id: Scalars["ID"]["input"]; + webhookSubscription: WebhookSubscriptionInput; +}; + +/** + * A signed upload parameter for uploading an asset to Shopify. + * + * Deprecated in favor of + * [StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter), + * which is used in + * [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget) + * and returned by the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate). + */ +export type MutationsStagedUploadTargetGenerateUploadParameter = { + /** The upload parameter name. */ + name: Scalars["String"]["output"]; + /** The upload parameter value. */ + value: Scalars["String"]["output"]; +}; + +/** + * A default cursor that you can use in queries to paginate your results. Each edge in a connection can + * return a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as + * the starting point to retrieve the nodes before or after it in a connection. + * + * To learn more about using cursor-based pagination, refer to + * [Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql). + */ +export type Navigable = { + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; +}; + +/** A navigation item, holding basic link attributes. */ +export type NavigationItem = { + /** The unique identifier of the navigation item. */ + id: Scalars["String"]["output"]; + /** The name of the navigation item. */ + title: Scalars["String"]["output"]; + /** The URL of the page that the navigation item links to. */ + url: Scalars["URL"]["output"]; +}; + +/** + * An object with an ID field to support global identification, in accordance with the + * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). + * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) + * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + */ +export type Node = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; +}; + +/** The input fields for dimensions of an object. */ +export type ObjectDimensionsInput = { + /** The height in `unit`s. */ + height: Scalars["Float"]["input"]; + /** The length in `unit`s. */ + length: Scalars["Float"]["input"]; + /** Unit of measurement for `length`, `width`, and `height`. */ + unit: LengthUnit; + /** The width in `unit`s. */ + width: Scalars["Float"]["input"]; +}; + +/** + * An article in the blogging system. You can query articles from + * [the REST API](https://shopify.dev/api/admin-rest/latest/resources/article) + * if you need to access more information about an article. Currently, `OnlineStoreArticle` is + * only useful to pass an article `id` to the `tagsAdd` mutation. For more information, refer to + * the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. + */ +export type OnlineStoreArticle = HasPublishedTranslations & Navigable & Node & { + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The translations associated with the resource. */ + translations: Array; +}; + +/** + * An article in the blogging system. You can query articles from + * [the REST API](https://shopify.dev/api/admin-rest/latest/resources/article) + * if you need to access more information about an article. Currently, `OnlineStoreArticle` is + * only useful to pass an article `id` to the `tagsAdd` mutation. For more information, refer to + * the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation. + */ +export type OnlineStoreArticleTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** + * Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant + * to be used as a type of magazine or newsletter for the shop, with content that changes over time. + */ +export type OnlineStoreBlog = HasPublishedTranslations & Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The translations associated with the resource. */ + translations: Array; +}; + +/** + * Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant + * to be used as a type of magazine or newsletter for the shop, with content that changes over time. + */ +export type OnlineStoreBlogTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** A custom page on the Online Store. */ +export type OnlineStorePage = HasPublishedTranslations & Navigable & Node & { + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The translations associated with the resource. */ + translations: Array; +}; + +/** A custom page on the Online Store. */ +export type OnlineStorePageTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** Online Store preview URL of the object. */ +export type OnlineStorePreviewable = { + /** The online store preview URL. */ + onlineStorePreviewUrl?: Maybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type Order = + & CommentEventSubject + & HasEvents + & HasLocalizationExtensions + & HasMetafieldDefinitions + & HasMetafields + & LegacyInteroperability + & Node + & { + /** A list of addtional fees applied to the order. */ + additionalFees: Array; + /** A list of sales agreements associated with the order. */ + agreements: SalesAgreementConnection; + /** + * A list of messages that appear on the order page in the Shopify admin. + */ + alerts: Array; + /** The application that created the order. */ + app?: Maybe; + /** The billing address of the customer. */ + billingAddress?: Maybe; + /** Whether the billing address matches the shipping address. */ + billingAddressMatchesShippingAddress: Scalars["Boolean"]["output"]; + /** Whether the order can be manually marked as paid. */ + canMarkAsPaid: Scalars["Boolean"]["output"]; + /** Whether a customer email exists for the order. */ + canNotifyCustomer: Scalars["Boolean"]["output"]; + /** + * The reason provided when the order was canceled. + * Returns `null` if the order wasn't canceled. + */ + cancelReason?: Maybe; + /** + * The date and time when the order was canceled. + * Returns `null` if the order wasn't canceled. + */ + cancelledAt?: Maybe; + /** + * Whether payment for the order can be captured. + */ + capturable: Scalars["Boolean"]["output"]; + /** + * The total order-level discount amount, before returns, in shop currency. + * @deprecated Use `cartDiscountAmountSet` instead. + */ + cartDiscountAmount?: Maybe; + /** The total order-level discount amount, before returns, in shop and presentment currencies. */ + cartDiscountAmountSet?: Maybe; + /** + * The channel that created the order. + * @deprecated Use `publication` instead. + */ + channel?: Maybe; + /** Details about the channel that created the order. */ + channelInformation?: Maybe; + /** The IP address of the API client that created the order. */ + clientIp?: Maybe; + /** Whether the order is closed. */ + closed: Scalars["Boolean"]["output"]; + /** + * The date and time when the order was closed. + * Returns `null` if the order isn't closed. + */ + closedAt?: Maybe; + /** + * A randomly generated alpha-numeric identifier for the order that may be shown to the customer + * instead of the sequential order name. For example, "XPAV284CT", "R50KELTJP" or "35PKUN0UJ". + * This value isn't guaranteed to be unique. + */ + confirmationNumber?: Maybe; + /** Whether inventory has been reserved for the order. */ + confirmed: Scalars["Boolean"]["output"]; + /** Date and time when the order was created in Shopify. */ + createdAt: Scalars["DateTime"]["output"]; + /** The shop currency when the order was placed. */ + currencyCode: CurrencyCode; + /** + * The current order-level discount amount after all order updates, in shop and presentment currencies. + */ + currentCartDiscountAmountSet: MoneyBag; + /** The sum of the quantities for all line items that contribute to the order's current subtotal price. */ + currentSubtotalLineItemsQuantity: Scalars["Int"]["output"]; + /** + * The sum of the prices for all line items after discounts and returns, in shop and presentment currencies. + * If `taxesIncluded` is `true`, then the subtotal also includes tax. + */ + currentSubtotalPriceSet: MoneyBag; + /** + * A list of all tax lines applied to line items on the order, after returns. + * Tax line prices represent the total price for all tax lines with the same `rate` and `title`. + */ + currentTaxLines: Array; + /** + * The total amount of additional fees after returns, in shop and presentment currencies. + * Returns `null` if there are no additional fees for the order. + */ + currentTotalAdditionalFeesSet?: Maybe; + /** + * The total amount discounted on the order after returns, in shop and presentment currencies. + * This includes both order and line level discounts. + */ + currentTotalDiscountsSet: MoneyBag; + /** + * The total amount of duties after returns, in shop and presentment currencies. + * Returns `null` if duties aren't applicable. + */ + currentTotalDutiesSet?: Maybe; + /** + * The total price of the order, after returns, in shop and presentment currencies. + * This includes taxes and discounts. + */ + currentTotalPriceSet: MoneyBag; + /** + * The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies. + */ + currentTotalTaxSet: MoneyBag; + /** The total weight of the order after returns, in grams. */ + currentTotalWeight: Scalars["UnsignedInt64"]["output"]; + /** + * A list of the custom attributes added to the order. + */ + customAttributes: Array; + /** The customer that placed the order. */ + customer?: Maybe; + /** Whether the customer agreed to receive marketing materials. */ + customerAcceptsMarketing: Scalars["Boolean"]["output"]; + /** + * The customer's visits and interactions with the online store before placing the order. + * + * @deprecated Use `customerJourneySummary` instead. + */ + customerJourney?: Maybe; + /** + * The customer's visits and interactions with the online store before placing the order. + */ + customerJourneySummary?: Maybe; + /** + * A two-letter or three-letter language code, optionally followed by a region modifier. + */ + customerLocale?: Maybe; + /** A list of discounts that are applied to the order, not including order edits and refunds. */ + discountApplications: DiscountApplicationConnection; + /** The discount code used for the order. */ + discountCode?: Maybe; + /** The discount codes used for the order. */ + discountCodes: Array; + /** + * The primary address of the customer. + * Returns `null` if neither the shipping address nor the billing address was provided. + */ + displayAddress?: Maybe; + /** + * The financial status of the order that can be shown to the merchant. + * This field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes. + */ + displayFinancialStatus?: Maybe; + /** + * The fulfillment status for the order that can be shown to the merchant. + * This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes. + * For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. + */ + displayFulfillmentStatus: OrderDisplayFulfillmentStatus; + /** A list of the disputes associated with the order. */ + disputes: Array; + /** Whether the order has had any edits applied. */ + edited: Scalars["Boolean"]["output"]; + /** The email address associated with the customer. */ + email?: Maybe; + /** + * Whether taxes on the order are estimated. + * This field returns `false` when taxes on the order are finalized and aren't subject to any changes. + */ + estimatedTaxes: Scalars["Boolean"]["output"]; + /** A list of events associated with the order. */ + events: EventConnection; + /** A list of ExchangeV2s for the order. */ + exchangeV2s: ExchangeV2Connection; + /** + * Whether there are line items that can be fulfilled. + * This field returns `false` when the order has no fulfillable line items. + * For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. + */ + fulfillable: Scalars["Boolean"]["output"]; + /** + * A list of fulfillment orders for a specific order. + * + * [FulfillmentOrder API access scopes](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder#api-access-scopes) + * govern which fulfillments orders are returned. + * An API client will only receive a subset of the fulfillment orders which belong to an order + * if they don't have the necessary access scopes to view all of the fulfillment orders. + * In the case that an API client does not have the access scopes necessary to view + * any of the fulfillment orders that belong to an order, an empty array will be returned. + */ + fulfillmentOrders: FulfillmentOrderConnection; + /** List of shipments for the order. */ + fulfillments: Array; + /** Whether the order has been paid in full. */ + fullyPaid: Scalars["Boolean"]["output"]; + /** Whether the merchant added a timeline comment to the order. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The URL of the first page of the online store that the customer visited before they submitted the order. + * @deprecated Use `customerJourneySummary.lastVisit.landingPageHtml` instead + */ + landingPageDisplayText?: Maybe; + /** + * The first page of the online store that the customer visited before they submitted the order. + * @deprecated Use `customerJourneySummary.lastVisit.landingPage` instead + */ + landingPageUrl?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** A list of the order's line items. */ + lineItems: LineItemConnection; + /** + * A list of the order's line items. + * @deprecated Use `lineItems` instead. + */ + lineItemsMutable: LineItemMutableConnection; + /** List of localization extensions for the resource. */ + localizationExtensions: LocalizationExtensionConnection; + /** + * The fulfillment location that was assigned when the order was created. + * Orders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.location` field will only point to one of these locations. + * Use the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder) + * object for up-to-date fulfillment location information. + * + * @deprecated Use `physicalLocation` instead. + */ + location?: Maybe; + /** Whether the order can be edited by the merchant. For example, canceled orders can’t be edited. */ + merchantEditable: Scalars["Boolean"]["output"]; + /** + * A list of reasons why the order can't be edited. For example, "Canceled orders can’t be edited". + */ + merchantEditableErrors: Array; + /** The application acting as the Merchant of Record for the order. */ + merchantOfRecordApp?: Maybe; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * The unique identifier for the order that appears on the order page in the Shopify admin and the order status page. + * For example, "#1001", "EN1001", or "1001-A". + * This value isn't unique across multiple stores. + */ + name: Scalars["String"]["output"]; + /** + * The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency. + * + * @deprecated Use `netPaymentSet` instead. + */ + netPayment: Scalars["Money"]["output"]; + /** The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies. */ + netPaymentSet: MoneyBag; + /** + * A list of line items that can't be fulfilled. + * For example, tips and fully refunded line items can't be fulfilled. + * For a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object. + */ + nonFulfillableLineItems: LineItemConnection; + /** + * The contents of the note associated with the order. + */ + note?: Maybe; + /** + * The total amount of additional fees after returns, in shop and presentment currencies. + * Returns `null` if there are no additional fees for the order. + */ + originalTotalAdditionalFeesSet?: Maybe; + /** + * The total amount of duties before returns, in shop and presentment currencies. + * Returns `null` if duties aren't applicable. + */ + originalTotalDutiesSet?: Maybe; + /** The total price of the order at the time of order creation, in shop and presentment currencies. */ + originalTotalPriceSet: MoneyBag; + /** The payment collection details for the order. */ + paymentCollectionDetails: OrderPaymentCollectionDetails; + /** + * A list of the names of all payment gateways used for the order. + * For example, "Shopify Payments" and "Cash on Delivery (COD)". + */ + paymentGatewayNames: Array; + /** The payment terms associated with the order. */ + paymentTerms?: Maybe; + /** The phone number associated with the customer. */ + phone?: Maybe; + /** + * The fulfillment location that was assigned when the order was created. + * Orders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.physicalLocation` field will only point to one of these locations. + * Use the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder) + * object for up to date fulfillment location information. + */ + physicalLocation?: Maybe; + /** The PO number associated with the order. */ + poNumber?: Maybe; + /** The payment `CurrencyCode` of the customer for the order. */ + presentmentCurrencyCode: CurrencyCode; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** + * The date and time when the order was processed. + * This date and time might not match the date and time when the order was created. + */ + processedAt: Scalars["DateTime"]["output"]; + /** The publication that the order was created from. */ + publication?: Maybe; + /** The purchasing entity for the order. */ + purchasingEntity?: Maybe; + /** + * The marketing referral code from the link that the customer clicked to visit the store. + * Supports the following URL attributes: "ref", "source", or "r". + * For example, if the URL is `{shop}.myshopify.com/products/slide?ref=j2tj1tn2`, then this value is `j2tj1tn2`. + * + * @deprecated Use `customerJourneySummary.lastVisit.referralCode` instead + */ + referralCode?: Maybe; + /** + * A web domain or short description of the source that sent the customer to your online store. For example, "shopify.com" or "email". + * + * @deprecated Use `customerJourneySummary.lastVisit.referralInfoHtml` instead + */ + referrerDisplayText?: Maybe; + /** + * The URL of the webpage where the customer clicked a link that sent them to your online store. + * + * @deprecated Use `customerJourneySummary.lastVisit.referrerUrl` instead + */ + referrerUrl?: Maybe; + /** The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor. */ + refundDiscrepancySet: MoneyBag; + /** + * Whether the order can be refunded. + */ + refundable: Scalars["Boolean"]["output"]; + /** A list of refunds that have been applied to the order. */ + refunds: Array; + /** The URL of the source that the order originated from, if found in the domain registry. */ + registeredSourceUrl?: Maybe; + /** + * Whether the order has shipping lines or at least one line item on the order that requires shipping. + */ + requiresShipping: Scalars["Boolean"]["output"]; + /** + * Whether any line item on the order can be restocked. + */ + restockable: Scalars["Boolean"]["output"]; + /** The order's aggregated return status for display purposes. */ + returnStatus: OrderReturnStatus; + /** A list of returns for the order. */ + returns: ReturnConnection; + /** The fraud risk level of the order. */ + riskLevel: OrderRiskLevel; + /** A list of risks associated with the order. */ + risks: Array; + /** The mailing address of the customer. */ + shippingAddress?: Maybe; + /** A summary of all shipping costs on the order. */ + shippingLine?: Maybe; + /** A list of the order's shipping lines. */ + shippingLines: ShippingLineConnection; + /** + * A unique POS or third party order identifier. + * For example, "1234-12-1000" or "111-98567-54". The `receipt_number` field is derived from this value for POS orders. + */ + sourceIdentifier?: Maybe; + /** The sum of the quantities for all line items that contribute to the order's subtotal price. */ + subtotalLineItemsQuantity: Scalars["Int"]["output"]; + /** + * The sum of the prices for all line items after discounts and before returns, in shop currency. + * If `taxesIncluded` is `true`, then the subtotal also includes tax. + * + * @deprecated Use `subtotalPriceSet` instead. + */ + subtotalPrice?: Maybe; + /** + * The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies. + * If `taxesIncluded` is `true`, then the subtotal also includes tax. + */ + subtotalPriceSet?: Maybe; + /** A suggested refund for the order. */ + suggestedRefund?: Maybe; + /** + * A comma separated list of tags associated with the order. Updating `tags` overwrites + * any existing tags that were previously added to the order. To add new tags without overwriting + * existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) + * mutation. + */ + tags: Array; + /** Whether taxes are exempt on the order. */ + taxExempt: Scalars["Boolean"]["output"]; + /** + * A list of all tax lines applied to line items on the order, before returns. + * Tax line prices represent the total price for all tax lines with the same `rate` and `title`. + */ + taxLines: Array; + /** Whether taxes are included in the subtotal price of the order. */ + taxesIncluded: Scalars["Boolean"]["output"]; + /** + * Whether the order is a test. + * Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. + * A test order can't be converted into a real order and vice versa. + */ + test: Scalars["Boolean"]["output"]; + /** + * The authorized amount that's uncaptured or undercaptured, in shop currency. + * This amount isn't adjusted for returns. + * + * @deprecated Use `totalCapturableSet` instead. + */ + totalCapturable: Scalars["Money"]["output"]; + /** + * The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies. + * This amount isn't adjusted for returns. + */ + totalCapturableSet: MoneyBag; + /** + * The total amount discounted on the order before returns, in shop currency. + * This includes both order and line level discounts. + * + * @deprecated Use `totalDiscountsSet` instead. + */ + totalDiscounts?: Maybe; + /** + * The total amount discounted on the order before returns, in shop and presentment currencies. + * This includes both order and line level discounts. + */ + totalDiscountsSet?: Maybe; + /** + * The total amount not yet transacted for the order, in shop and presentment currencies. + * A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer). + */ + totalOutstandingSet: MoneyBag; + /** + * The total price of the order, before returns, in shop currency. + * This includes taxes and discounts. + * + * @deprecated Use `totalPriceSet` instead. + */ + totalPrice: Scalars["Money"]["output"]; + /** + * The total price of the order, before returns, in shop and presentment currencies. + * This includes taxes and discounts. + */ + totalPriceSet: MoneyBag; + /** + * The total amount received from the customer before returns, in shop currency. + * @deprecated Use `totalReceivedSet` instead. + */ + totalReceived: Scalars["Money"]["output"]; + /** The total amount received from the customer before returns, in shop and presentment currencies. */ + totalReceivedSet: MoneyBag; + /** + * The total amount that was refunded, in shop currency. + * @deprecated Use `totalRefundedSet` instead. + */ + totalRefunded: Scalars["Money"]["output"]; + /** The total amount that was refunded, in shop and presentment currencies. */ + totalRefundedSet: MoneyBag; + /** The total amount of shipping that was refunded, in shop and presentment currencies. */ + totalRefundedShippingSet: MoneyBag; + /** + * The total shipping amount before discounts and returns, in shop currency. + * @deprecated Use `totalShippingPriceSet` instead. + */ + totalShippingPrice: Scalars["Money"]["output"]; + /** The total shipping amount before discounts and returns, in shop and presentment currencies. */ + totalShippingPriceSet: MoneyBag; + /** + * The total tax amount before returns, in shop currency. + * @deprecated Use `totalTaxSet` instead. + */ + totalTax?: Maybe; + /** The total tax amount before returns, in shop and presentment currencies. */ + totalTaxSet?: Maybe; + /** + * The sum of all tip amounts for the order, in shop currency. + * @deprecated Use `totalTipReceivedSet` instead. + */ + totalTipReceived: MoneyV2; + /** The sum of all tip amounts for the order, in shop and presentment currencies. */ + totalTipReceivedSet: MoneyBag; + /** The total weight of the order before returns, in grams. */ + totalWeight?: Maybe; + /** A list of transactions associated with the order. */ + transactions: Array; + /** + * Whether no payments have been made for the order. + */ + unpaid: Scalars["Boolean"]["output"]; + /** The date and time when the order was modified last. */ + updatedAt: Scalars["DateTime"]["output"]; + }; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderAgreementsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderDiscountApplicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderExchangeV2sArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + displayable?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderFulfillmentsArgs = { + first?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderLineItemsMutableArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderLocalizationExtensionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + countryCodes?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + purposes?: InputMaybe>; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderNonFulfillableLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderRefundsArgs = { + first?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderReturnsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderRisksArgs = { + first?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderShippingLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderSuggestedRefundArgs = { + refundDuties?: InputMaybe>; + refundLineItems?: InputMaybe>; + refundShipping?: InputMaybe; + shippingAmount?: InputMaybe; + suggestFullRefund?: InputMaybe; +}; + +/** + * An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object. + * Learn more about + * [editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). + * + * Only the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders, + * then you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted + * access, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`. + * [Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope. + * + * **Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data. + */ +export type OrderTransactionsArgs = { + capturable?: InputMaybe; + first?: InputMaybe; + manuallyResolvable?: InputMaybe; +}; + +/** + * The possible order action types for a + * [sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement). + */ +export type OrderActionType = + /** An order with a purchase or charge. */ + | "ORDER" + /** An edit to the order. */ + | "ORDER_EDIT" + /** A refund on the order. */ + | "REFUND" + /** An unknown agreement action. Represents new actions that may be added in future versions. */ + | "UNKNOWN"; + +/** An agreement associated with an order placement. */ +export type OrderAgreement = SalesAgreement & { + /** The application that created the agreement. */ + app?: Maybe; + /** The date and time at which the agreement occured. */ + happenedAt: Scalars["DateTime"]["output"]; + /** The unique ID for the agreement. */ + id: Scalars["ID"]["output"]; + /** The order associated with the agreement. */ + order: Order; + /** The reason the agremeent was created. */ + reason: OrderActionType; + /** The sales associated with the agreement. */ + sales: SaleConnection; + /** The staff member associated with the agreement. */ + user?: Maybe; +}; + +/** An agreement associated with an order placement. */ +export type OrderAgreementSalesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The [application](https://shopify.dev/apps) that created the order. + */ +export type OrderApp = { + /** The application icon. */ + icon: Image; + /** The application ID. */ + id: Scalars["ID"]["output"]; + /** The name of the application. */ + name: Scalars["String"]["output"]; +}; + +/** Represents the reason for the order's cancellation. */ +export type OrderCancelReason = + /** The customer wanted to cancel the order. */ + | "CUSTOMER" + /** Payment was declined. */ + | "DECLINED" + /** The order was fraudulent. */ + | "FRAUD" + /** There was insufficient inventory. */ + | "INVENTORY" + /** The order was canceled for an unlisted reason. */ + | "OTHER"; + +/** The input fields for the authorized transaction to capture and the total amount to capture from it. */ +export type OrderCaptureInput = { + /** The amount to capture. The capture amount can't be greater than the amount of the authorized transaction. */ + amount: Scalars["Money"]["input"]; + /** The currency (in ISO format) that's used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ. */ + currency?: InputMaybe; + /** The ID of the order to capture. */ + id: Scalars["ID"]["input"]; + /** The ID of the authorized transaction to capture. */ + parentTransactionId: Scalars["ID"]["input"]; +}; + +/** Return type for `orderCapture` mutation. */ +export type OrderCapturePayload = { + /** The created capture transaction. */ + transaction?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for specifying an open order to close. */ +export type OrderCloseInput = { + /** The ID of the order to close. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `orderClose` mutation. */ +export type OrderClosePayload = { + /** The closed order. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Orders. + */ +export type OrderConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in OrderEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `orderCreateMandatePayment` mutation. */ +export type OrderCreateMandatePaymentPayload = { + /** The async job used for charging the payment. */ + job?: Maybe; + /** The Unique ID for the created payment. */ + paymentReferenceId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `OrderCreateMandatePayment`. */ +export type OrderCreateMandatePaymentUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `OrderCreateMandatePaymentUserError`. */ +export type OrderCreateMandatePaymentUserErrorCode = + /** Errors for mandate payment on order. */ + "ORDER_MANDATE_PAYMENT_ERROR_CODE"; + +/** Represents the order's current financial status. */ +export type OrderDisplayFinancialStatus = + /** Displayed as **Authorized**. */ + | "AUTHORIZED" + /** Displayed as **Expired**. */ + | "EXPIRED" + /** Displayed as **Paid**. */ + | "PAID" + /** Displayed as **Partially paid**. */ + | "PARTIALLY_PAID" + /** Displayed as **Partially refunded**. */ + | "PARTIALLY_REFUNDED" + /** Displayed as **Pending**. */ + | "PENDING" + /** Displayed as **Refunded**. */ + | "REFUNDED" + /** Displayed as **Voided**. */ + | "VOIDED"; + +/** Represents the order's aggregated fulfillment status for display purposes. */ +export type OrderDisplayFulfillmentStatus = + /** Displayed as **Fulfilled**. All the items in the order have been fulfilled. */ + | "FULFILLED" + /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ + | "IN_PROGRESS" + /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ + | "ON_HOLD" + /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ + | "OPEN" + /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ + | "PARTIALLY_FULFILLED" + /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by the "IN_PROGRESS" status. */ + | "PENDING_FULFILLMENT" + /** Displayed as **Restocked**. All the items in the order have been restocked. Replaced by the "UNFULFILLED" status. */ + | "RESTOCKED" + /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ + | "SCHEDULED" + /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ + | "UNFULFILLED"; + +/** A summary of the important details for a dispute on an order. */ +export type OrderDisputeSummary = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The type that the dispute was initiated as. */ + initiatedAs: DisputeType; + /** The current status of the dispute. */ + status: DisputeStatus; +}; + +/** + * An auto-generated type which holds one Order and a cursor during pagination. + */ +export type OrderEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of OrderEdge. */ + node: Order; +}; + +/** Return type for `orderEditAddCustomItem` mutation. */ +export type OrderEditAddCustomItemPayload = { + /** The custom line item that will be added to the order based on the current edits. */ + calculatedLineItem?: Maybe; + /** An order with the edits applied but not saved. */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `orderEditAddLineItemDiscount` mutation. */ +export type OrderEditAddLineItemDiscountPayload = { + /** The discount applied to a line item during this order edit. */ + addedDiscountStagedChange?: Maybe; + /** The line item with the edits applied but not saved. */ + calculatedLineItem?: Maybe; + /** An order with the edits applied but not saved. */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `orderEditAddVariant` mutation. */ +export type OrderEditAddVariantPayload = { + /** + * The [calculated line item](https://shopify.dev/api/admin-graphql/latest/objects/calculatedlineitem) + * that's added during this order edit. + */ + calculatedLineItem?: Maybe; + /** + * The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) + * with the edits applied but not saved. + */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An agreement associated with an edit to the order. */ +export type OrderEditAgreement = SalesAgreement & { + /** The application that created the agreement. */ + app?: Maybe; + /** The date and time at which the agreement occured. */ + happenedAt: Scalars["DateTime"]["output"]; + /** The unique ID for the agreement. */ + id: Scalars["ID"]["output"]; + /** The reason the agremeent was created. */ + reason: OrderActionType; + /** The sales associated with the agreement. */ + sales: SaleConnection; + /** The staff member associated with the agreement. */ + user?: Maybe; +}; + +/** An agreement associated with an edit to the order. */ +export type OrderEditAgreementSalesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields used to add a discount during an order edit. */ +export type OrderEditAppliedDiscountInput = { + /** The description of the discount. */ + description?: InputMaybe; + /** The value of the discount as a fixed amount. */ + fixedValue?: InputMaybe; + /** The value of the discount as a percentage. */ + percentValue?: InputMaybe; +}; + +/** Return type for `orderEditBegin` mutation. */ +export type OrderEditBeginPayload = { + /** The order that will be edited. */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `orderEditCommit` mutation. */ +export type OrderEditCommitPayload = { + /** The order with changes applied. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `orderEditRemoveLineItemDiscount` mutation. */ +export type OrderEditRemoveLineItemDiscountPayload = { + /** The calculated line item after removal of the discount. */ + calculatedLineItem?: Maybe; + /** An order with the edits applied but not saved. */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `orderEditSetQuantity` mutation. */ +export type OrderEditSetQuantityPayload = { + /** The calculated line item with the edits applied but not saved. */ + calculatedLineItem?: Maybe; + /** The calculated order with the edits applied but not saved. */ + calculatedOrder?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for specifying the information to be updated on an order when using the orderUpdate mutation. */ +export type OrderInput = { + /** A new list of custom attributes for the order. Overwrites the existing custom attributes. */ + customAttributes?: InputMaybe>; + /** A new customer email address for the order. Overwrites the existing email address. */ + email?: InputMaybe; + /** The ID of the order to update. */ + id: Scalars["ID"]["input"]; + /** A list of new [localization extensions](https://shopify.dev/api/admin-graphql/latest/objects/localizationextension) to add to the existing list of localization extensions for the order. */ + localizationExtensions?: InputMaybe>; + /** A list of new metafields to add to the existing metafields for the order. */ + metafields?: InputMaybe>; + /** The new contents for the note associated with the order. Overwrites the existing note. */ + note?: InputMaybe; + /** The new purchase order number for the order. */ + poNumber?: InputMaybe; + /** The new shipping address for the order. Overwrites the existing shipping address. */ + shippingAddress?: InputMaybe; + /** A new list of tags for the order. Overwrites the existing tags. */ + tags?: InputMaybe>; +}; + +/** Return type for `orderInvoiceSend` mutation. */ +export type OrderInvoiceSendPayload = { + /** The order associated with the invoice email. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `OrderInvoiceSend`. */ +export type OrderInvoiceSendUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `OrderInvoiceSendUserError`. */ +export type OrderInvoiceSendUserErrorCode = + /** An error occurred while sending the invoice. */ + "ORDER_INVOICE_SEND_UNSUCCESSFUL"; + +/** The input fields for specifying the order to mark as paid. */ +export type OrderMarkAsPaidInput = { + /** The ID of the order to mark as paid. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `orderMarkAsPaid` mutation. */ +export type OrderMarkAsPaidPayload = { + /** The order marked as paid. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for specifying a closed order to open. */ +export type OrderOpenInput = { + /** The ID of the order to open. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `orderOpen` mutation. */ +export type OrderOpenPayload = { + /** The opened order. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The payment collection details for an order that requires additional payment following an edit to the order. */ +export type OrderPaymentCollectionDetails = { + /** The URL to use for collecting an additional payment on the order. */ + additionalPaymentCollectionUrl?: Maybe; + /** The list of vaulted payment methods for the order with their permissions. */ + vaultedPaymentMethods?: Maybe>; +}; + +/** The status of a customer's payment for an order. */ +export type OrderPaymentStatus = { + /** A message describing an error during the asynchronous processing of a payment. */ + errorMessage?: Maybe; + /** The ID of the payment, initially returned by an `orderCreateMandatePayment` or `orderCreatePayment` mutation. */ + paymentReferenceId: Scalars["String"]["output"]; + /** The status of the payment. */ + status: OrderPaymentStatusResult; + /** A translated message describing an error during the asynchronous processing of a payment. */ + translatedErrorMessage?: Maybe; +}; + +/** The type of a payment status. */ +export type OrderPaymentStatusResult = + /** The payment is authorized. */ + | "AUTHORIZED" + /** The payment is captured. */ + | "CAPTURED" + /** There was an error initiating the payment. */ + | "ERROR" + /** The payment is still being processed. */ + | "PROCESSING" + /** The payment is in purchased status. */ + | "PURCHASED" + /** Redirect required. */ + | "REDIRECT_REQUIRED" + /** The payment is refunded. */ + | "REFUNDED" + /** Payment can be retried. */ + | "RETRYABLE" + /** The payment succeeded. */ + | "SUCCESS" + /** Status is unknown. */ + | "UNKNOWN" + /** The payment is voided. */ + | "VOIDED"; + +/** + * The order's aggregated return status that's used for display purposes. + * An order might have multiple returns, so this field communicates the prioritized return status. + * The `OrderReturnStatus` enum is a supported filter parameter in the [`orders` query](https://shopify.dev/api/admin-graphql/latest/queries/orders#:~:text=reference_location_id-,return_status,-risk_level). + */ +export type OrderReturnStatus = + /** All return shipments from a return in this order were inspected. */ + | "INSPECTION_COMPLETE" + /** Some items in the order are being returned. */ + | "IN_PROGRESS" + /** No items in the order were returned. */ + | "NO_RETURN" + /** Some items in the order were returned. */ + | "RETURNED" + /** Some returns in the order were not completed successfully. */ + | "RETURN_FAILED" + /** A return was requested for some items in the order. */ + | "RETURN_REQUESTED"; + +/** Represents a fraud check on an order. */ +export type OrderRisk = { + /** Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order. */ + display: Scalars["Boolean"]["output"]; + /** + * The likelihood that an order is fraudulent, based on this order risk. + * + * The level can be set by Shopify risk analysis or by an app. + */ + level?: Maybe; + /** The risk message that's shown to the merchant in the Shopify admin. */ + message?: Maybe; +}; + +/** The likelihood that an order is fraudulent. */ +export type OrderRiskLevel = + /** There is a high level of risk that this order is fraudulent. */ + | "HIGH" + /** There is a low level of risk that this order is fraudulent. */ + | "LOW" + /** There is a medium level of risk that this order is fraudulent. */ + | "MEDIUM"; + +/** The set of valid sort keys for the Order query. */ +export type OrderSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `customer_name` value. */ + | "CUSTOMER_NAME" + /** Sort orders by their shipping address country and city. */ + | "DESTINATION" + /** Sort by the `financial_status` value. */ + | "FINANCIAL_STATUS" + /** Sort by the `fulfillment_status` value. */ + | "FULFILLMENT_STATUS" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `order_number` value. */ + | "ORDER_NUMBER" + /** Sort orders by their purchase order number. */ + | "PO_NUMBER" + /** Sort by the `processed_at` value. */ + | "PROCESSED_AT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort orders by the total quantity of all line items. */ + | "TOTAL_ITEMS_QUANTITY" + /** Sort by the `total_price` value. */ + | "TOTAL_PRICE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** + * A change that has been applied to an order. + */ +export type OrderStagedChange = + | OrderStagedChangeAddCustomItem + | OrderStagedChangeAddLineItemDiscount + | OrderStagedChangeAddShippingLine + | OrderStagedChangeAddVariant + | OrderStagedChangeDecrementItem + | OrderStagedChangeIncrementItem; + +/** + * A change to the order representing the addition of a + * custom line item. For example, you might want to add gift wrapping service + * as a custom line item. + */ +export type OrderStagedChangeAddCustomItem = { + /** The price of an individual item without any discounts applied. This value can't be negative. */ + originalUnitPrice: MoneyV2; + /** The quantity of the custom item to add to the order. This value must be greater than zero. */ + quantity: Scalars["Int"]["output"]; + /** The title of the custom item. */ + title: Scalars["String"]["output"]; +}; + +/** + * The discount applied to an item that was added during the current order edit. + */ +export type OrderStagedChangeAddLineItemDiscount = { + /** The description of the discount. */ + description: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The pricing value of the discount. */ + value: PricingValue; +}; + +/** + * A new [shipping line](https://shopify.dev/api/admin-graphql/latest/objects/shippingline) + * added as part of an order edit. + */ +export type OrderStagedChangeAddShippingLine = { + /** The phone number at the shipping address. */ + phone?: Maybe; + /** + * The shipping line's title that's shown to the buyer. + */ + presentmentTitle?: Maybe; + /** The price that applies to the shipping line. */ + price: MoneyV2; + /** The title of the shipping line. */ + title?: Maybe; +}; + +/** + * A change to the order representing the addition of an existing product variant. + */ +export type OrderStagedChangeAddVariant = { + /** The quantity of the product variant that was added. */ + quantity: Scalars["Int"]["output"]; + /** The product variant that was added. */ + variant: ProductVariant; +}; + +/** + * An auto-generated type for paginating through multiple OrderStagedChanges. + */ +export type OrderStagedChangeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in OrderStagedChangeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An removal of items from an existing line item on the order. + */ +export type OrderStagedChangeDecrementItem = { + /** The number of items removed. */ + delta: Scalars["Int"]["output"]; + /** The original line item. */ + lineItem: LineItem; + /** The intention to restock the removed items. */ + restock: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type which holds one OrderStagedChange and a cursor during pagination. + */ +export type OrderStagedChangeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of OrderStagedChangeEdge. */ + node: OrderStagedChange; +}; + +/** + * An addition of items to an existing line item on the order. + */ +export type OrderStagedChangeIncrementItem = { + /** The number of items added. */ + delta: Scalars["Int"]["output"]; + /** The original line item. */ + lineItem: LineItem; +}; + +/** + * A payment transaction in the context of an order. + */ +export type OrderTransaction = Node & { + /** The masked account number associated with the payment method. */ + accountNumber?: Maybe; + /** + * The amount of money. + * @deprecated Use `amountSet` instead. + */ + amount: Scalars["Money"]["output"]; + /** The amount and currency of the transaction in shop and presentment currencies. */ + amountSet: MoneyBag; + /** + * The amount and currency of the transaction. + * @deprecated Use `amountSet` instead. + */ + amountV2: MoneyV2; + /** Authorization code associated with the transaction. */ + authorizationCode?: Maybe; + /** + * The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations. + */ + authorizationExpiresAt?: Maybe; + /** Date and time when the transaction was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A standardized error code, independent of the payment provider. */ + errorCode?: Maybe; + /** + * The transaction fees charged on the order transaction. Only present for Shopify Payments transactions. + */ + fees: Array; + /** The human-readable payment gateway name used to process the transaction. */ + formattedGateway?: Maybe; + /** The payment gateway used to process the transaction. */ + gateway?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The kind of transaction. */ + kind: OrderTransactionKind; + /** Whether the transaction can be manually captured. */ + manuallyCapturable: Scalars["Boolean"]["output"]; + /** + * Specifies the available amount to refund on the gateway. + * This value is only available for transactions of type `SuggestedRefund`. + * + * @deprecated Use `maximumRefundableV2` instead. + */ + maximumRefundable?: Maybe; + /** + * Specifies the available amount with currency to refund on the gateway. + * This value is only available for transactions of type `SuggestedRefund`. + */ + maximumRefundableV2?: Maybe; + /** The associated order. */ + order?: Maybe; + /** The associated parent transaction, for example the authorization of a capture. */ + parentTransaction?: Maybe; + /** The payment details for the transaction. */ + paymentDetails?: Maybe; + /** The payment icon to display for the transaction. */ + paymentIcon?: Maybe; + /** The payment ID associated with the transaction. */ + paymentId?: Maybe; + /** + * The payment method used for the transaction. This value is `null` if the payment method is unknown. + * @deprecated Use `paymentIcon` instead. + */ + paymentMethod?: Maybe; + /** Date and time when the transaction was processed. */ + processedAt?: Maybe; + /** + * The transaction receipt that the payment gateway attaches to the transaction. + * The value of this field depends on which payment gateway processed the transaction. + * + * @deprecated Use `receiptJson` instead. + */ + receipt?: Maybe; + /** + * The transaction receipt that the payment gateway attaches to the transaction. + * The value of this field depends on which payment gateway processed the transaction. + */ + receiptJson?: Maybe; + /** The settlement currency. */ + settlementCurrency?: Maybe; + /** The rate used when converting the transaction amount to settlement currency. */ + settlementCurrencyRate?: Maybe; + /** + * Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan. + */ + shopifyPaymentsSet?: Maybe; + /** The status of this transaction. */ + status: OrderTransactionStatus; + /** Whether the transaction is a test transaction. */ + test: Scalars["Boolean"]["output"]; + /** + * Specifies the available amount to capture on the gateway. + * Only available when an amount is capturable or manually mark as paid. + * + * @deprecated Use `totalUnsettledSet` instead. + */ + totalUnsettled?: Maybe; + /** + * Specifies the available amount with currency to capture on the gateway in shop and presentment currencies. + * Only available when an amount is capturable or manually mark as paid. + */ + totalUnsettledSet?: Maybe; + /** + * Specifies the available amount with currency to capture on the gateway. + * Only available when an amount is capturable or manually mark as paid. + * + * @deprecated Use `totalUnsettledSet` instead. + */ + totalUnsettledV2?: Maybe; + /** Staff member who was logged into the Shopify POS device when the transaction was processed. */ + user?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple OrderTransactions. + */ +export type OrderTransactionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in OrderTransactionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one OrderTransaction and a cursor during pagination. + */ +export type OrderTransactionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of OrderTransactionEdge. */ + node: OrderTransaction; +}; + +/** A standardized error code, independent of the payment provider. */ +export type OrderTransactionErrorCode = + /** The payment method was invalid. */ + | "AMAZON_PAYMENTS_INVALID_PAYMENT_METHOD" + /** The maximum amount has been captured. */ + | "AMAZON_PAYMENTS_MAX_AMOUNT_CHARGED" + /** The maximum amount has been refunded. */ + | "AMAZON_PAYMENTS_MAX_AMOUNT_REFUNDED" + /** The maximum of 10 authorizations has been captured for an order. */ + | "AMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTURED" + /** The maximum of 10 refunds has been processed for an order. */ + | "AMAZON_PAYMENTS_MAX_REFUNDS_PROCESSED" + /** The order was canceled, which canceled all open authorizations. */ + | "AMAZON_PAYMENTS_ORDER_REFERENCE_CANCELED" + /** The order was not confirmed within three hours. */ + | "AMAZON_PAYMENTS_STALE" + /** Call the card issuer. */ + | "CALL_ISSUER" + /** The card was declined. */ + | "CARD_DECLINED" + /** There is an error in the gateway or merchant configuration. */ + | "CONFIG_ERROR" + /** The card is expired. */ + | "EXPIRED_CARD" + /** There was an unknown error with processing the payment. */ + | "GENERIC_ERROR" + /** The address does not match the card number. */ + | "INCORRECT_ADDRESS" + /** The CVC does not match the card number. */ + | "INCORRECT_CVC" + /** The card number is incorrect. */ + | "INCORRECT_NUMBER" + /** The entered PIN is incorrect. */ + | "INCORRECT_PIN" + /** The ZIP or postal code does not match the card number. */ + | "INCORRECT_ZIP" + /** The amount is either too high or too low for the provider. */ + | "INVALID_AMOUNT" + /** The payment method is not available in the customer's country. */ + | "INVALID_COUNTRY" + /** The format of the CVC is incorrect. */ + | "INVALID_CVC" + /** The format of the expiry date is incorrect. */ + | "INVALID_EXPIRY_DATE" + /** The format of the card number is incorrect. */ + | "INVALID_NUMBER" + /** The payment method is momentarily unavailable. */ + | "PAYMENT_METHOD_UNAVAILABLE" + /** + * The card has been reported as lost or stolen, and the card issuer has requested that the merchant keep the card and call the number on the back. + */ + | "PICK_UP_CARD" + /** There was an error while processing the payment. */ + | "PROCESSING_ERROR" + /** A real card was used but the gateway was in test mode. */ + | "TEST_MODE_LIVE_CARD" + /** The gateway or merchant configuration doesn't support a feature, such as network tokenization. */ + | "UNSUPPORTED_FEATURE"; + +/** The input fields for the information needed to create an order transaction. */ +export type OrderTransactionInput = { + /** The amount of money for this transaction. */ + amount: Scalars["Money"]["input"]; + /** The payment gateway to use for this transaction. */ + gateway: Scalars["String"]["input"]; + /** The kind of transaction. */ + kind: OrderTransactionKind; + /** The ID of the order associated with the transaction. */ + orderId: Scalars["ID"]["input"]; + /** The ID of the optional parent transaction, for example the authorization of a capture. */ + parentId?: InputMaybe; +}; + +/** The different kinds of order transactions. */ +export type OrderTransactionKind = + /** + * An amount reserved against the cardholder's funding source. + * Money does not change hands until the authorization is captured. + */ + | "AUTHORIZATION" + /** A transfer of the money that was reserved by an authorization. */ + | "CAPTURE" + /** + * The money returned to the customer when they've paid too much during a cash transaction. + */ + | "CHANGE" + /** An authorization for a payment taken with an EMV credit card reader. */ + | "EMV_AUTHORIZATION" + /** + * A partial or full return of captured funds to the cardholder. + * A refund can happen only after a capture is processed. + */ + | "REFUND" + /** An authorization and capture performed together in a single step. */ + | "SALE" + /** A suggested refund transaction that can be used to create a refund. */ + | "SUGGESTED_REFUND" + /** A cancelation of an authorization transaction. */ + | "VOID"; + +/** The different states that an `OrderTransaction` can have. */ +export type OrderTransactionStatus = + /** Awaiting a response. */ + | "AWAITING_RESPONSE" + /** There was an error while processing the transaction. */ + | "ERROR" + /** The transaction failed. */ + | "FAILURE" + /** The transaction is pending. */ + | "PENDING" + /** The transaction succeeded. */ + | "SUCCESS" + /** The transaction status is unknown. */ + | "UNKNOWN"; + +/** Return type for `orderUpdate` mutation. */ +export type OrderUpdatePayload = { + /** The updated order. */ + order?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Returns information about pagination in a connection, in accordance with the + * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). + * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). + */ +export type PageInfo = { + /** The cursor corresponding to the last node in edges. */ + endCursor?: Maybe; + /** Whether there are more pages to fetch following the current page. */ + hasNextPage: Scalars["Boolean"]["output"]; + /** Whether there are any pages prior to the current page. */ + hasPreviousPage: Scalars["Boolean"]["output"]; + /** The cursor corresponding to the first node in edges. */ + startCursor?: Maybe; +}; + +/** A ShopifyQL parsing error. */ +export type ParseError = { + /** An error code for the error. */ + code: ParseErrorCode; + /** The description of the parsing error. */ + message: Scalars["String"]["output"]; + /** The start and end range for the error. */ + range?: Maybe; +}; + +/** ShopifyQL parsing errors. */ +export type ParseErrorCode = + /** When using `GROUP BY` with the `ALL` modifier, `SINCE` or `DURING` must be defined. */ + | "BACKFILL_DATE_RANGE_NOT_FOUND" + /** Column not found. */ + | "COLUMN_NOT_FOUND" + /** The time period for `COMPARE TO` must be the same length as `DURING`. */ + | "COMPARE_TO_INCOMPATIBLE_PERIOD" + /** Invalid `COMPARE TO` period specified. Make sure it's not the same as the `DURING` clause. */ + | "COMPARE_TO_INVALID_PERIOD" + /** Cannot use a `COMPARE TO` clause without `DURING` or `SINCE`. */ + | "COMPARE_TO_MISSING_PERIOD" + /** Comparison queries must only contain aggregated fields. */ + | "COMPARISON_WITH_NON_AGGREGATE_FIELDS" + /** Date interval not found. */ + | "DATE_INTERVAL_NOT_FOUND" + /** Date isn't parsable. */ + | "DATE_NOT_PARSABLE" + /** Datetime value isn't parsable. */ + | "DATE_TIME_NOT_PARSABLE" + /** The `GROUP BY` function is limited to one parameter with the `ALL` modifier. */ + | "EXCESS_BACKFILL_DIMENSIONS" + /** + * The `GROUP BY` function has too many parameters. + * When using `VISUALIZE` with `COMPARE TO` use only one `GROUP BY` parameter. + */ + | "EXCESS_DIMENSIONS" + /** Mixing of `SINCE` and/or `UNTIL` with `DURING` is not allowed. */ + | "EXCESS_PERIODS" + /** Use the correct syntax for either `SHOW` or `VISUALIZE`. */ + | "EXCESS_PRESENTMENTS" + /** Keyword `FROM` not found. */ + | "FROM_NOT_FOUND" + /** Function is missing required argument(s). */ + | "FUNCTION_ARGUMENTS_NOT_FOUND" + /** Function has too many arguments. */ + | "FUNCTION_EXCESS_ARGUMENTS" + /** Function has incompatible types. */ + | "FUNCTION_INCOMPATIBLE_TYPES" + /** Function does not have any valid modifiers. */ + | "FUNCTION_MODIFIER_NOT_FOUND" + /** An aggregate function received a nested aggregate argument, which is not allowed. */ + | "FUNCTION_NESTED_AGGREGATE" + /** Function not found. */ + | "FUNCTION_NOT_FOUND" + /** The `SINCE` date must be before or the same as the `UNTIL` date. */ + | "INVALID_DATE_RANGE" + /** Limit is invalid. */ + | "LIMIT_INVALID" + /** Mixing of `IN` list arguments of different data types is not allowed. */ + | "LIST_MIXED_ARGUMENT_TYPES" + /** Mixing an aggregate expression and a non-aggregate expression is not allowed. */ + | "MIXED_AGGREGATE_AND_NON_AGGREGATE" + /** Named date not found. */ + | "NAMED_DATE_NOT_FOUND" + /** Invalid arguments for operator. */ + | "OPERATOR_INCOMPATIBLE_TYPES" + /** Query is missing `SHOW` or `VISUALIZE`. */ + | "PRESENTMENT_NOT_FOUND" + /** Column must include `GROUP BY` arg1. */ + | "REQUIRED_GROUP_BY_NOT_FOUND" + /** Semantically invalid. */ + | "SEMANTICALLY_INVALID" + /** Sort field not found. */ + | "SORT_FIELD_NOT_FOUND" + /** A semantic predicate failed during validation. */ + | "SYNTAX_FAILED_PREDICATE" + /** Identifier or function out of place. */ + | "SYNTAX_INPUT_MISMATCH" + /** Invalid entry. */ + | "SYNTAX_INVALID_TOKEN" + /** Query is incomplete. */ + | "SYNTAX_MISSING_TOKEN" + /** Syntax not recognized. */ + | "SYNTAX_NOT_RECOGNIZED" + /** Identifier after `SHOW` is not valid in its current position. */ + | "SYNTAX_NO_VIABLE_ALTERNATIVE" + /** Identifier or function out of place. */ + | "SYNTAX_UNWANTED_TOKEN" + /** Table not found. */ + | "TABLE_NOT_FOUND" + /** Time function is incompatible in a `GROUP BY` clause with the `ALL` modifier. */ + | "TIME_FUNCTION_NOT_FOUND" + /** When using `COMPARE TO` with a time-based `GROUP BY`, `ALL` must be used. */ + | "UNBACKFILLED_TIME_GROUP_BY_COMPARISON" + /** Unknown error. */ + | "UNKNOWN" + /** Value isn't parsable. */ + | "VALUE_NOT_PARSABLE" + /** The type of visualization is invalid. Acceptable types: bar, line. */ + | "VISUALIZE_CHART_TYPE_NOT_FOUND" + /** Visualize has too many projections. */ + | "VISUALIZE_EXCESS_PROJECTIONS" + /** Function `VISUALIZE` can only use `GROUP BY` or `GROUP BY` with the `ALL` modifier, not both. */ + | "VISUALIZE_GROUP_BY_MIXED_BACKFILL" + /** Function `VISUALIZE` requires `GROUP BY`. */ + | "VISUALIZE_GROUP_BY_NOT_FOUND" + /** Function `VISUALIZE` contains a data type which cannot be plotted. */ + | "VISUALIZE_INCOMPATIBLE_TYPES"; + +/** A range of ShopifyQL parsing errors. */ +export type ParseErrorRange = { + /** The ending position of the error. */ + end: ErrorPosition; + /** The starting position of the error. */ + start: ErrorPosition; +}; + +/** A payment customization. */ +export type PaymentCustomization = + & HasMetafieldDefinitions + & HasMetafields + & Node + & { + /** The enabled status of the payment customization. */ + enabled: Scalars["Boolean"]["output"]; + /** The error history on the most recent version of the payment customization. */ + errorHistory?: Maybe; + /** The ID of the Shopify Function implementing the payment customization. */ + functionId: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The Shopify Function implementing the payment customization. */ + shopifyFunction: ShopifyFunction; + /** The title of the payment customization. */ + title: Scalars["String"]["output"]; + }; + +/** A payment customization. */ +export type PaymentCustomizationMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** A payment customization. */ +export type PaymentCustomizationMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A payment customization. */ +export type PaymentCustomizationMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A payment customization. */ +export type PaymentCustomizationPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** A payment customization. */ +export type PaymentCustomizationPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `paymentCustomizationActivation` mutation. */ +export type PaymentCustomizationActivationPayload = { + /** The IDs of the updated payment customizations. */ + ids?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple PaymentCustomizations. + */ +export type PaymentCustomizationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PaymentCustomizationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `paymentCustomizationCreate` mutation. */ +export type PaymentCustomizationCreatePayload = { + /** Returns the created payment customization. */ + paymentCustomization?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `paymentCustomizationDelete` mutation. */ +export type PaymentCustomizationDeletePayload = { + /** Returns the deleted payment customization ID. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one PaymentCustomization and a cursor during pagination. + */ +export type PaymentCustomizationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PaymentCustomizationEdge. */ + node: PaymentCustomization; +}; + +/** An error that occurs during the execution of a payment customization mutation. */ +export type PaymentCustomizationError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PaymentCustomizationError`. */ +export type PaymentCustomizationErrorCode = + /** Shop plan not eligible to use Functions from a custom app. */ + | "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE" + /** Function does not implement the required interface. */ + | "FUNCTION_DOES_NOT_IMPLEMENT" + /** Function ID cannot be changed. */ + | "FUNCTION_ID_CANNOT_BE_CHANGED" + /** Function not found. */ + | "FUNCTION_NOT_FOUND" + /** Function is pending deletion. */ + | "FUNCTION_PENDING_DELETION" + /** The input value is invalid. */ + | "INVALID" + /** Could not create or update metafields. */ + | "INVALID_METAFIELDS" + /** Maximum payment customizations are already enabled. */ + | "MAXIMUM_ACTIVE_PAYMENT_CUSTOMIZATIONS" + /** Shop must be on a Shopify Plus plan to activate payment customizations from a custom app. */ + | "PAYMENT_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE" + /** Payment customization not found. */ + | "PAYMENT_CUSTOMIZATION_NOT_FOUND" + /** Required input field must be present. */ + | "REQUIRED_INPUT_FIELD"; + +/** The input fields to create and update a payment customization. */ +export type PaymentCustomizationInput = { + /** The enabled status of the payment customization. */ + enabled?: InputMaybe; + /** The ID of the function providing the payment customization. */ + functionId?: InputMaybe; + /** Additional metafields to associate to the payment customization. */ + metafields?: InputMaybe>; + /** The title of the payment customization. */ + title?: InputMaybe; +}; + +/** Return type for `paymentCustomizationUpdate` mutation. */ +export type PaymentCustomizationUpdatePayload = { + /** Returns the updated payment customization. */ + paymentCustomization?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Payment details related to a transaction. */ +export type PaymentDetails = CardPaymentDetails; + +/** All possible instrument outputs for Payment Mandates. */ +export type PaymentInstrument = VaultCreditCard | VaultPaypalBillingAgreement; + +/** + * A payment instrument and the permission + * the owner of the instrument gives to the merchant to debit it. + */ +export type PaymentMandate = Node & { + /** The unique ID of a payment mandate. */ + id: Scalars["ID"]["output"]; + /** The outputs details of the payment instrument. */ + paymentInstrument: PaymentInstrument; +}; + +/** Some of the payment methods used in Shopify. */ +export type PaymentMethods = + | "AMERICAN_EXPRESS" + | "BITCOIN" + | "BOGUS" + | "DANKORT" + | "DINERS_CLUB" + | "DISCOVER" + | "DOGECOIN" + /** The payment method for eftpos_au payment. */ + | "EFTPOS" + /** The payment method for Elo payment. */ + | "ELO" + | "FORBRUGSFORENINGEN" + /** The payment method for Interac payment. */ + | "INTERAC" + | "JCB" + | "LITECOIN" + | "MAESTRO" + | "MASTERCARD" + | "PAYPAL" + /** The payment method for UnionPay payment. */ + | "UNIONPAY" + | "VISA"; + +/** Return type for `paymentReminderSend` mutation. */ +export type PaymentReminderSendPayload = { + /** Whether the payment reminder email was successfully sent. */ + success?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `PaymentReminderSend`. */ +export type PaymentReminderSendUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PaymentReminderSendUserError`. */ +export type PaymentReminderSendUserErrorCode = + /** An error occurred while sending the payment reminder. */ + "PAYMENT_REMINDER_SEND_UNSUCCESSFUL"; + +/** Represents the payment schedule for a single payment defined in the payment terms. */ +export type PaymentSchedule = Node & { + /** Amount owed for this payment schedule. */ + amount: MoneyV2; + /** Date and time when the payment schedule is paid or fulfilled. */ + completedAt?: Maybe; + /** Date and time when the payment schedule is due. */ + dueAt?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Date and time when the invoice is sent. */ + issuedAt?: Maybe; + /** The payment terms the payment schedule belongs to. */ + paymentTerms: PaymentTerms; +}; + +/** + * An auto-generated type for paginating through multiple PaymentSchedules. + */ +export type PaymentScheduleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PaymentScheduleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one PaymentSchedule and a cursor during pagination. + */ +export type PaymentScheduleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PaymentScheduleEdge. */ + node: PaymentSchedule; +}; + +/** The input fields used to create a payment schedule for payment terms. */ +export type PaymentScheduleInput = { + /** Specifies the date and time when the payment schedule is due. This field must be provided for fixed type payment terms. */ + dueAt?: InputMaybe; + /** Specifies the date and time that the payment schedule was issued. This field must be provided for net type payment terms. */ + issuedAt?: InputMaybe; +}; + +/** Settings related to payments. */ +export type PaymentSettings = { + /** List of the digital wallets which the shop supports. */ + supportedDigitalWallets: Array; +}; + +/** Represents the payment terms for an order or draft order. */ +export type PaymentTerms = Node & { + /** The draft order associated with the payment terms. */ + draftOrder?: Maybe; + /** + * Duration of payment terms in days based on the payment terms template used to create the payment terms. + */ + dueInDays?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The order associated with the payment terms. */ + order?: Maybe; + /** Whether the payment terms have overdue payment schedules. */ + overdue: Scalars["Boolean"]["output"]; + /** List of schedules for the payment terms. */ + paymentSchedules: PaymentScheduleConnection; + /** The name of the payment terms template used to create the payment terms. */ + paymentTermsName: Scalars["String"]["output"]; + /** The payment terms template type used to create the payment terms. */ + paymentTermsType: PaymentTermsType; + /** The payment terms name, translated into the shop admin's preferred language. */ + translatedName: Scalars["String"]["output"]; +}; + +/** Represents the payment terms for an order or draft order. */ +export type PaymentTermsPaymentSchedulesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields used to create a payment terms. */ +export type PaymentTermsCreateInput = { + /** Specifies the payment schedules for the payment terms. */ + paymentSchedules?: InputMaybe>; + /** Specifies the payment terms template ID used to generate payment terms. */ + paymentTermsTemplateId: Scalars["ID"]["input"]; +}; + +/** Return type for `paymentTermsCreate` mutation. */ +export type PaymentTermsCreatePayload = { + /** The created payment terms. */ + paymentTerms?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `PaymentTermsCreate`. */ +export type PaymentTermsCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PaymentTermsCreateUserError`. */ +export type PaymentTermsCreateUserErrorCode = + /** An error occurred while creating payment terms. */ + "PAYMENT_TERMS_CREATION_UNSUCCESSFUL"; + +/** The input fields used to delete the payment terms. */ +export type PaymentTermsDeleteInput = { + /** The ID of the payment terms being deleted. */ + paymentTermsId: Scalars["ID"]["input"]; +}; + +/** Return type for `paymentTermsDelete` mutation. */ +export type PaymentTermsDeletePayload = { + /** The deleted payment terms ID. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `PaymentTermsDelete`. */ +export type PaymentTermsDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PaymentTermsDeleteUserError`. */ +export type PaymentTermsDeleteUserErrorCode = + /** An error occurred while deleting payment terms. */ + "PAYMENT_TERMS_DELETE_UNSUCCESSFUL"; + +/** The input fields to create payment terms. Payment terms set the date that payment is due. */ +export type PaymentTermsInput = { + /** Specifies the payment schedules for the payment terms. */ + paymentSchedules?: InputMaybe>; + /** + * Specifies the ID of the payment terms template. + * Payment terms templates provide preset configurations to create common payment terms. + * Refer to the + * [PaymentTermsTemplate](https://shopify.dev/api/admin-graphql/latest/objects/paymenttermstemplate) + * object for more details. + */ + paymentTermsTemplateId?: InputMaybe; +}; + +/** Represents the payment terms template object. */ +export type PaymentTermsTemplate = Node & { + /** The description of the payment terms template. */ + description: Scalars["String"]["output"]; + /** The number of days between the issued date and due date if this is the net type of payment terms. */ + dueInDays?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the payment terms template. */ + name: Scalars["String"]["output"]; + /** The type of the payment terms template. */ + paymentTermsType: PaymentTermsType; + /** The translated payment terms template name. */ + translatedName: Scalars["String"]["output"]; +}; + +/** The type of a payment terms or a payment terms template. */ +export type PaymentTermsType = + /** The payment terms or payment terms template is a fixed type. It's due on a specified date. */ + | "FIXED" + /** The payment terms or payment terms template is due on fulfillment. */ + | "FULFILLMENT" + /** The payment terms or payment terms template is a net type. It's due a number of days after issue. */ + | "NET" + /** The payment terms or payment terms template is due on receipt. */ + | "RECEIPT" + /** The type of the payment terms or payment terms template is unknown. */ + | "UNKNOWN"; + +/** The input fields used to update the payment terms. */ +export type PaymentTermsUpdateInput = { + /** The attributes used to update the payment terms. */ + paymentTermsAttributes: PaymentTermsInput; + /** The ID of the payment terms being updated. */ + paymentTermsId: Scalars["ID"]["input"]; +}; + +/** Return type for `paymentTermsUpdate` mutation. */ +export type PaymentTermsUpdatePayload = { + /** The updated payment terms. */ + paymentTerms?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `PaymentTermsUpdate`. */ +export type PaymentTermsUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PaymentTermsUpdateUserError`. */ +export type PaymentTermsUpdateUserErrorCode = + /** An error occurred while updating payment terms. */ + "PAYMENT_TERMS_UPDATE_UNSUCCESSFUL"; + +/** Represents a valid PayPal Express subscriptions gateway status. */ +export type PaypalExpressSubscriptionsGatewayStatus = + /** The status is disabled. */ + | "DISABLED" + /** The status is enabled. */ + | "ENABLED" + /** The status is pending. */ + | "PENDING"; + +/** A PolarisViz data point structure for ShopifyQL query. */ +export type PolarisVizDataPoint = { + /** The data key. Typically a category, dimension, or other qualitative data. */ + key: Scalars["String"]["output"]; + /** The data value is numeric and quantitative. */ + value?: Maybe; +}; + +/** The data series used for PolarisViz visualization. */ +export type PolarisVizDataSeries = { + /** An array of data points. */ + data: Array; + /** Whether the series represents comparison data. */ + isComparison: Scalars["Boolean"]["output"]; + /** The name of the series. */ + name: Scalars["String"]["output"]; +}; + +/** A PolarisViz response to a ShopifyQL query. */ +export type PolarisVizResponse = ShopifyqlResponse & { + /** The PolarisViz visualization of data. */ + data: Array; + /** A list of parse errors, if parsing fails. */ + parseErrors?: Maybe>; + /** + * The result in a tabular format with schema and row data. + * It's always present even if query has a `VISUALIZE` keyword. + */ + tableData?: Maybe; + /** The type of visualization. For example, a line chart. */ + vizType: VisualizationType; +}; + +/** + * The input fields used to include the line items of a specified fulfillment order that should be marked as prepared for pickup by a customer. + */ +export type PreparedFulfillmentOrderLineItemsInput = { + /** The ID of the fulfillment order. */ + fulfillmentOrderId: Scalars["ID"]["input"]; +}; + +/** How to caluclate the parent product variant's price while bulk updating variant relationships. */ +export type PriceCalculationType = + /** The price of the parent will be the sum of the components price times their quantity. */ + | "COMPONENTS_SUM" + /** The price of the parent will be set to the price provided. */ + | "FIXED" + /** The price of the parent will not be adjusted. */ + | "NONE"; + +/** The input fields for updating the price of a parent product variant. */ +export type PriceInput = { + /** + * The specific type of calculation done to determine the price of the parent variant. + * The price is calculated during Bundle creation. Updating a component variant won't recalculate the price. + */ + calculation?: InputMaybe; + /** The price of the parent product variant. This will be be used if calcualtion is set to 'FIXED'. */ + price?: InputMaybe; +}; + +/** + * Represents a price list, including information about related prices and eligibility rules. + * You can use price lists to specify either fixed prices or adjusted relative prices that + * override initial product variant prices. Price lists are applied to customers + * using context rules, which determine price list eligibility. + * + * For more information on price lists, refer to + * [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists). + */ +export type PriceList = Node & { + /** The catalog that the price list is associated with. */ + catalog?: Maybe; + /** The currency for fixed prices associated with this price list. */ + currency: CurrencyCode; + /** The number of fixed prices on the price list. */ + fixedPricesCount: Scalars["Int"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The unique name of the price list, used as a human-readable identifier. */ + name: Scalars["String"]["output"]; + /** Relative adjustments to other prices. */ + parent?: Maybe; + /** A list of prices associated with the price list. */ + prices: PriceListPriceConnection; + /** A list of quantity rules associated with the price list, ordered by product variants. */ + quantityRules: QuantityRuleConnection; +}; + +/** + * Represents a price list, including information about related prices and eligibility rules. + * You can use price lists to specify either fixed prices or adjusted relative prices that + * override initial product variant prices. Price lists are applied to customers + * using context rules, which determine price list eligibility. + * + * For more information on price lists, refer to + * [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists). + */ +export type PriceListPricesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + originType?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a price list, including information about related prices and eligibility rules. + * You can use price lists to specify either fixed prices or adjusted relative prices that + * override initial product variant prices. Price lists are applied to customers + * using context rules, which determine price list eligibility. + * + * For more information on price lists, refer to + * [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists). + */ +export type PriceListQuantityRulesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + originType?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * The type and value of a price list adjustment. + * + * For more information on price lists, refer to + * [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists). + */ +export type PriceListAdjustment = { + /** The type of price adjustment, such as percentage increase or decrease. */ + type: PriceListAdjustmentType; + /** + * The value of price adjustment, where positive numbers reduce the prices and negative numbers + * increase them. + */ + value: Scalars["Float"]["output"]; +}; + +/** The input fields to set a price list adjustment. */ +export type PriceListAdjustmentInput = { + /** The type of price adjustment, such as percentage increase or decrease. */ + type: PriceListAdjustmentType; + /** The value of the price adjustment as specified by the `type`. */ + value: Scalars["Float"]["input"]; +}; + +/** Represents the settings of price list adjustments. */ +export type PriceListAdjustmentSettings = { + /** The type of price list adjustment setting for compare at price. */ + compareAtMode: PriceListCompareAtMode; +}; + +/** The input fields to set a price list's adjustment settings. */ +export type PriceListAdjustmentSettingsInput = { + /** Determines how adjustments are applied to compare at prices. */ + compareAtMode?: PriceListCompareAtMode; +}; + +/** Represents a percentage price adjustment type. */ +export type PriceListAdjustmentType = + /** Percentage decrease type. Prices will have a lower value. */ + | "PERCENTAGE_DECREASE" + /** Percentage increase type. Prices will have a higher value. */ + | "PERCENTAGE_INCREASE"; + +/** Represents how the compare at price will be determined for a price list. */ +export type PriceListCompareAtMode = + /** The compare at price is adjusted based on percentage specified in price list. */ + | "ADJUSTED" + /** The compare at prices are set to `null` unless explicitly defined by a fixed price value. */ + | "NULLIFY"; + +/** + * An auto-generated type for paginating through multiple PriceLists. + */ +export type PriceListConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PriceListEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields to create a price list. */ +export type PriceListCreateInput = { + /** The ID of the catalog to associate with this price list.If the catalog was already associated with another price list then it will be unlinked. */ + catalogId?: InputMaybe; + /** Three letter currency code for fixed prices associated with this price list. */ + currency: CurrencyCode; + /** The unique name of the price list, used as a human-readable identifier. */ + name: Scalars["String"]["input"]; + /** Relative adjustments to other prices. */ + parent: PriceListParentCreateInput; +}; + +/** Return type for `priceListCreate` mutation. */ +export type PriceListCreatePayload = { + /** The newly created price list. */ + priceList?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `priceListDelete` mutation. */ +export type PriceListDeletePayload = { + /** The ID of the deleted price list. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one PriceList and a cursor during pagination. + */ +export type PriceListEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PriceListEdge. */ + node: PriceList; +}; + +/** Return type for `priceListFixedPricesAdd` mutation. */ +export type PriceListFixedPricesAddPayload = { + /** The list of fixed prices that were added to or updated in the price list. */ + prices?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed price list fixed prices by product bulk update operations. */ +export type PriceListFixedPricesByProductBulkUpdateUserError = + & DisplayableError + & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; + }; + +/** Possible error codes that can be returned by `PriceListFixedPricesByProductBulkUpdateUserError`. */ +export type PriceListFixedPricesByProductBulkUpdateUserErrorCode = + /** Duplicate ID in input. */ + | "DUPLICATE_ID_IN_INPUT" + /** IDs must be mutually exclusive across add or delete operations. */ + | "ID_MUST_BE_MUTUALLY_EXCLUSIVE" + /** No update operations specified. */ + | "NO_UPDATE_OPERATIONS_SPECIFIED" + /** The currency specified does not match the price list's currency. */ + | "PRICES_TO_ADD_CURRENCY_MISMATCH" + /** Exceeded the 10000 prices to add limit. */ + | "PRICE_LIMIT_EXCEEDED" + /** Price list does not exist. */ + | "PRICE_LIST_DOES_NOT_EXIST" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST"; + +/** Return type for `priceListFixedPricesByProductUpdate` mutation. */ +export type PriceListFixedPricesByProductUpdatePayload = { + /** The price list for which the fixed prices were modified. */ + priceList?: Maybe; + /** The product for which the fixed prices were added. */ + pricesToAddProducts?: Maybe>; + /** The product for which the fixed prices were deleted. */ + pricesToDeleteProducts?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `priceListFixedPricesDelete` mutation. */ +export type PriceListFixedPricesDeletePayload = { + /** A list of product variant IDs whose fixed prices were removed from the price list. */ + deletedFixedPriceVariantIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `priceListFixedPricesUpdate` mutation. */ +export type PriceListFixedPricesUpdatePayload = { + /** A list of deleted variant IDs for prices. */ + deletedFixedPriceVariantIds?: Maybe>; + /** The price list for which the fixed prices were modified. */ + priceList?: Maybe; + /** The prices that were added to the price list. */ + pricesAdded?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents relative adjustments from one price list to other prices. + * You can use a `PriceListParent` to specify an adjusted relative price using a percentage-based + * adjustment. Adjusted prices work in conjunction with exchange rules and rounding. + * + * [Adjustment types](https://shopify.dev/api/admin-graphql/latest/enums/pricelistadjustmenttype) + * support both percentage increases and decreases. + */ +export type PriceListParent = { + /** A price list adjustment. */ + adjustment: PriceListAdjustment; + /** A price list's settings for adjustment. */ + settings: PriceListAdjustmentSettings; +}; + +/** The input fields to create a price list adjustment. */ +export type PriceListParentCreateInput = { + /** The relative adjustments to other prices. */ + adjustment: PriceListAdjustmentInput; + /** The price list adjustment settings. */ + settings?: InputMaybe; +}; + +/** The input fields used to update a price list's adjustment. */ +export type PriceListParentUpdateInput = { + /** The relative adjustments to other prices.. */ + adjustment: PriceListAdjustmentInput; + /** The price list adjustment settings. */ + settings?: InputMaybe; +}; + +/** + * Represents information about pricing for a product variant + * as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant. + */ +export type PriceListPrice = { + /** The compare-at price of the product variant on this price list. */ + compareAtPrice?: Maybe; + /** + * The origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration). + */ + originType: PriceListPriceOriginType; + /** The price of the product variant on this price list. */ + price: MoneyV2; + /** The product variant associated with this price. */ + variant: ProductVariant; +}; + +/** + * An auto-generated type for paginating through multiple PriceListPrices. + */ +export type PriceListPriceConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PriceListPriceEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one PriceListPrice and a cursor during pagination. + */ +export type PriceListPriceEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PriceListPriceEdge. */ + node: PriceListPrice; +}; + +/** + * The input fields for providing the fields and values to use when creating or updating a fixed price list price. + */ +export type PriceListPriceInput = { + /** The compare-at price of the product variant on this price list. */ + compareAtPrice?: InputMaybe; + /** The price of the product variant on this price list. */ + price: MoneyInput; + /** The product variant ID associated with the price list price. */ + variantId: Scalars["ID"]["input"]; +}; + +/** + * Represents the origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration). + */ +export type PriceListPriceOriginType = + /** The price is defined on the price list. */ + | "FIXED" + /** The price is relative to the adjustment type and value. */ + | "RELATIVE"; + +/** An error for a failed price list price operation. */ +export type PriceListPriceUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PriceListPriceUserError`. */ +export type PriceListPriceUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The specified currency doesn't match the price list's currency. */ + | "PRICE_LIST_CURRENCY_MISMATCH" + /** The price list doesn't exist. */ + | "PRICE_LIST_NOT_FOUND" + /** Only fixed prices can be deleted. */ + | "PRICE_NOT_FIXED" + /** A fixed price for the specified product variant doesn't exist. */ + | "VARIANT_NOT_FOUND"; + +/** The input fields representing the price for all variants of a product. */ +export type PriceListProductPriceInput = { + /** The price of the product to use for all variants with its currency. */ + price: MoneyInput; + /** Specifies the ID of the product to update its variants for. */ + productId: Scalars["ID"]["input"]; +}; + +/** The set of valid sort keys for the PriceList query. */ +export type PriceListSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The input fields used to update a price list. */ +export type PriceListUpdateInput = { + /** The ID of the catalog to associate with this price list. */ + catalogId?: InputMaybe; + /** The three-letter currency code for fixed prices associated with this price list. */ + currency?: InputMaybe; + /** The unique name of the price list, used as a human-readable identifier. */ + name?: InputMaybe; + /** Relative adjustments to other prices. */ + parent?: InputMaybe; +}; + +/** Return type for `priceListUpdate` mutation. */ +export type PriceListUpdatePayload = { + /** The updated price list. */ + priceList?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed contextual pricing operations. */ +export type PriceListUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PriceListUserError`. */ +export type PriceListUserErrorCode = + /** An app catalog cannot be assigned to a price list. */ + | "APP_CATALOG_PRICE_LIST_ASSIGNMENT" + /** The input value is blank. */ + | "BLANK" + /** Cannot assign a catalog to a price list that also has context rules. */ + | "CATALOG_ASSIGNMENT_NOT_ALLOWED" + /** The context type of a catalog cannot be changed. */ + | "CATALOG_CANNOT_CHANGE_CONTEXT_TYPE" + /** Quantity rules can be associated only with company location catalogs. */ + | "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES" + /** The specified catalog does not exist. */ + | "CATALOG_DOES_NOT_EXIST" + /** The price list currency must match the market catalog currency. */ + | "CATALOG_MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH" + /** Catalog has a price list already assigned. */ + | "CATALOG_TAKEN" + /** A price list context rule cannot have more than one country. */ + | "CONTEXT_RULE_COUNTRIES_LIMIT" + /** A price list for this country is already taken. */ + | "CONTEXT_RULE_COUNTRY_TAKEN" + /** Only one context rule option may be specified. */ + | "CONTEXT_RULE_LIMIT_ONE_OPTION" + /** Cannot save the price list with context rule because the limit of context rules per shop was reached. */ + | "CONTEXT_RULE_LIMIT_REACHED" + /** The specified market wasn't found. */ + | "CONTEXT_RULE_MARKET_NOT_FOUND" + /** A price list for this market is already taken. */ + | "CONTEXT_RULE_MARKET_TAKEN" + /** A country in a context rule must use a valid currency. */ + | "COUNTRY_CURRENCY_MISMATCH" + /** A country catalog cannot be assigned to a price list. */ + | "COUNTRY_PRICE_LIST_ASSIGNMENT" + /** A price list’s currency must be of the pricing rule’s country. */ + | "CURRENCY_COUNTRY_MISMATCH" + /** A price list’s currency must be the market currency. */ + | "CURRENCY_MARKET_MISMATCH" + /** The price list currency is not supported by the shop's payment gateway. */ + | "CURRENCY_NOT_SUPPORTED" + /** Something went wrong when trying to save the price list. Please try again. */ + | "GENERIC_ERROR" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The adjustment value must not be greater than 1000% for `type` `PERCENTAGE_INCREASE`. */ + | "INVALID_ADJUSTMENT_MAX_VALUE" + /** The adjustment value must not be greater than 100% for `type` `PERCENTAGE_DECREASE`. */ + | "INVALID_ADJUSTMENT_MIN_VALUE" + /** The adjustment value must be a positive value and not be greater than 100% for `type` `PERCENTAGE_DECREASE` and not be greater than 1000% for `type` `PERCENTAGE_INCREASE`. */ + | "INVALID_ADJUSTMENT_VALUE" + /** The context rule's market does not use the price list currency. */ + | "MARKET_CURRENCY_MISMATCH" + /** The price list is currently being modified. Please try again later. */ + | "PRICE_LIST_LOCKED" + /** Cannot create price list for a primary market. */ + | "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET" + /** The specified price list doesn't exist. */ + | "PRICE_LIST_NOT_FOUND" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG"; + +/** + * Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. + * + * We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources. + */ +export type PriceRule = + & CommentEventSubject + & HasEvents + & LegacyInteroperability + & Node + & { + /** The maximum number of times that the price rule can be allocated onto an order. */ + allocationLimit?: Maybe; + /** The method by which the price rule's value is allocated to its entitled items. */ + allocationMethod: PriceRuleAllocationMethod; + /** The application that created the price rule. */ + app?: Maybe; + /** Determines which discount classes the discount can combine with. */ + combinesWith: DiscountCombinesWith; + /** The date and time when the price rule was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The customers that can use this price rule. */ + customerSelection: PriceRuleCustomerSelection; + /** The class of the discount for combining purposes. */ + discountClass: DiscountClass; + /** List of the price rule's discount codes. */ + discountCodes: PriceRuleDiscountCodeConnection; + /** How many discount codes associated with the price rule. */ + discountCodesCount: Scalars["Int"]["output"]; + /** The date and time when the price rule ends. For open-ended price rules, use `null`. */ + endsAt?: Maybe; + /** + * Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. + * @deprecated Use `prerequisiteToEntitlementQuantityRatio` instead. + */ + entitlementToPrerequisiteQuantityRatio?: Maybe< + PriceRuleEntitlementToPrerequisiteQuantityRatio + >; + /** The paginated list of events associated with the price rule. */ + events: EventConnection; + /** A list of the price rule's features. */ + features: Array; + /** Indicates whether there are any timeline comments on the price rule. */ + hasTimelineComment: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The items to which the price rule applies. */ + itemEntitlements: PriceRuleItemEntitlements; + /** The items required for the price rule to be applicable. */ + itemPrerequisites: PriceRuleLineItemPrerequisites; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** Whether the price rule can be applied only once per customer. */ + oncePerCustomer: Scalars["Boolean"]["output"]; + /** The number of the entitled items must fall within this range for the price rule to be applicable. */ + prerequisiteQuantityRange?: Maybe; + /** The shipping cost must fall within this range for the price rule to be applicable. */ + prerequisiteShippingPriceRange?: Maybe; + /** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */ + prerequisiteSubtotalRange?: Maybe; + /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ + prerequisiteToEntitlementQuantityRatio?: Maybe< + PriceRulePrerequisiteToEntitlementQuantityRatio + >; + /** URLs that can be used to share the discount. */ + shareableUrls: Array; + /** The shipping lines to which the price rule applies. */ + shippingEntitlements: PriceRuleShippingLineEntitlements; + /** The date and time when the price rule starts. */ + startsAt: Scalars["DateTime"]["output"]; + /** The status of the price rule. */ + status: PriceRuleStatus; + /** A detailed summary of the price rule. */ + summary?: Maybe; + /** The type of lines (line_item or shipping_line) to which the price rule applies. */ + target: PriceRuleTarget; + /** The title of the price rule. */ + title: Scalars["String"]["output"]; + /** The total sales from orders where the price rule was used. */ + totalSales?: Maybe; + /** + * A list of the price rule's features. + * @deprecated Use `features` instead. + */ + traits: Array; + /** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */ + usageCount: Scalars["Int"]["output"]; + /** The maximum number of times that the price rule can be used in total. */ + usageLimit?: Maybe; + /** A time period during which a price rule is applicable. */ + validityPeriod: PriceRuleValidityPeriod; + /** + * The value of the price rule. + * @deprecated Use `valueV2` instead. + */ + value: PriceRuleValue; + /** The value of the price rule. */ + valueV2: PricingValue; + }; + +/** + * Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. + * + * We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources. + */ +export type PriceRuleDiscountCodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply. + * + * We recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources. + */ +export type PriceRuleEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Return type for `priceRuleActivate` mutation. */ +export type PriceRuleActivatePayload = { + /** The activated price rule. */ + priceRule?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** The method by which the price rule's value is allocated to its entitled items. */ +export type PriceRuleAllocationMethod = + /** The value will be applied once across the entitled items. */ + | "ACROSS" + /** The value will be applied to each of the entitled items. */ + | "EACH"; + +/** + * An auto-generated type for paginating through multiple PriceRules. + */ +export type PriceRuleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PriceRuleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `priceRuleCreate` mutation. */ +export type PriceRuleCreatePayload = { + /** The newly created price rule. */ + priceRule?: Maybe; + /** The newly created discount code. */ + priceRuleDiscountCode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** A selection of customers for whom the price rule applies. */ +export type PriceRuleCustomerSelection = { + /** List of customers to whom the price rule applies. */ + customers: CustomerConnection; + /** Whether the price rule applies to all customers. */ + forAllCustomers: Scalars["Boolean"]["output"]; + /** A list of customer segments that contain the customers who can use the price rule. */ + segments: Array; +}; + +/** A selection of customers for whom the price rule applies. */ +export type PriceRuleCustomerSelectionCustomersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The input fields to update a price rule customer selection. */ +export type PriceRuleCustomerSelectionInput = { + /** List of customers to add to the current list of customers to whom the price rule applies. `savedSearchIds` must be empty. */ + customerIdsToAdd?: InputMaybe>; + /** A list of customers to remove from the current list of customers to whom the price rule applies. */ + customerIdsToRemove?: InputMaybe>; + /** Whether the price rule applies to all customers. */ + forAllCustomers?: InputMaybe; + /** List of customer segments that contain the customers to whom the price rule applies. No single customer IDs may be present. */ + segmentIds?: InputMaybe>; +}; + +/** Return type for `priceRuleDeactivate` mutation. */ +export type PriceRuleDeactivatePayload = { + /** The deactivated price rule. */ + priceRule?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `priceRuleDelete` mutation. */ +export type PriceRuleDeletePayload = { + /** The ID price of the deleted price rule. */ + deletedPriceRuleId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** The shop of the deleted price rule. */ + shop: Shop; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** A discount code of a price rule. */ +export type PriceRuleDiscountCode = Node & { + /** The application that created the discount code. */ + app?: Maybe; + /** The code to apply the discount. */ + code: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count. */ + usageCount: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple PriceRuleDiscountCodes. + */ +export type PriceRuleDiscountCodeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PriceRuleDiscountCodeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `priceRuleDiscountCodeCreate` mutation. */ +export type PriceRuleDiscountCodeCreatePayload = { + /** The updated price rule. */ + priceRule?: Maybe; + /** The newly created discount code. */ + priceRuleDiscountCode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination. + */ +export type PriceRuleDiscountCodeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PriceRuleDiscountCodeEdge. */ + node: PriceRuleDiscountCode; +}; + +/** The input fields to manipulate a discount code. */ +export type PriceRuleDiscountCodeInput = { + /** The code to use the discount. */ + code?: InputMaybe; +}; + +/** Return type for `priceRuleDiscountCodeUpdate` mutation. */ +export type PriceRuleDiscountCodeUpdatePayload = { + /** The updated price rule. */ + priceRule?: Maybe; + /** The updated discount code. */ + priceRuleDiscountCode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one PriceRule and a cursor during pagination. + */ +export type PriceRuleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PriceRuleEdge. */ + node: PriceRule; +}; + +/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ +export type PriceRuleEntitlementToPrerequisiteQuantityRatio = { + /** The quantity of entitled items in the ratio. */ + entitlementQuantity: Scalars["Int"]["output"]; + /** The quantity of prerequisite items in the ratio. */ + prerequisiteQuantity: Scalars["Int"]["output"]; +}; + +/** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ +export type PriceRuleEntitlementToPrerequisiteQuantityRatioInput = { + /** The quantity of entitled items in the ratio. */ + entitlementQuantity?: InputMaybe; + /** The quantity of prerequisite items in the ratio. */ + prerequisiteQuantity?: InputMaybe; +}; + +/** Possible error codes that could be returned by a price rule mutation. */ +export type PriceRuleErrorCode = + /** The allocation method must be `ACROSS` for the provided target selection. */ + | "ALLOCATION_METHOD_MUST_BE_ACROSS_FOR_GIVEN_TARGET_SELECTION" + /** The discount must apply on either one-time purchase or subscription items, or both. */ + | "APPLIES_ON_NOTHING" + /** The input value is blank. */ + | "BLANK" + /** Invalid BOGO target selection. */ + | "BOGO_INVALID_TARGET_SELECTION" + /** Invalid BOGO target type. */ + | "BOGO_INVALID_TARGET_TYPE" + /** Invalid BOGO value type. */ + | "BOGO_INVALID_VALUE_TYPE" + /** Can't use both prerequisite customers and saved search. */ + | "BOTH_CUSTOMER_AND_SAVED_SEARCH_PREREQUISITES_SELECTED" + /** Can't have both prerequisite customers and prerequisite segments. */ + | "BOTH_CUSTOMER_AND_SEGMENT_PREREQUISITES_SELECTED" + /** Can't have both saved searches and segments prerequisites. */ + | "BOTH_SAVED_SEARCH_AND_SEGMENT_PREREQUISITES_SELECTED" + /** Can't entitle collections in combination with product variants or products. */ + | "CANNOT_ENTITLE_COLLECTIONS_WITH_PRODUCTS_OR_VARIANTS" + /** Can't use collections as a prequisite in combination with product variants or products. */ + | "CANNOT_PREREQUISITE_COLLECTION_WITH_PRODUCT_OR_VARIANTS" + /** The customer prerequisites exceeded the maximum number. */ + | "CUSTOMER_PREREQUISITES_EXCEEDED_MAX" + /** Invalid customer prerequisites selection. */ + | "CUSTOMER_PREREQUISITES_INVALID_SELECTION" + /** Customer prerequisites are missing. */ + | "CUSTOMER_PREREQUISITES_MISSING" + /** A duplicate customer prerequisite ID exists. */ + | "CUSTOMER_PREREQUISITE_DUPLICATE" + /** A duplicate customer saved search exists. */ + | "CUSTOMER_SAVED_SEARCH_DUPLICATE" + /** The customer saved search exceeded the maximum number. */ + | "CUSTOMER_SAVED_SEARCH_EXCEEDED_MAX" + /** Invalid customer saved search. */ + | "CUSTOMER_SAVED_SEARCH_INVALID" + /** The customer segment prerequisites exceeded the maximum number. */ + | "CUSTOMER_SEGMENT_EXCEEDED_MAX" + /** The customer segment prerequisite ID is invalid. */ + | "CUSTOMER_SEGMENT_INVALID" + /** A duplicate customer segment prerequisite ID exists. */ + | "CUSTOMER_SEGMENT_PREREQUISITE_DUPLICATE" + /** A duplicate discount code exists. */ + | "DISCOUNT_CODE_DUPLICATE" + /** The discount end date must be after the start date. */ + | "END_DATE_BEFORE_START_DATE" + /** The input value should be equal to the value allowed. */ + | "EQUAL_TO" + /** Can't exceed the maximum number. */ + | "EXCEEDED_MAX" + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** The input value should be greater than or equal to the minimum value allowed. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** The `combinesWith` settings are invalid for the discount class. */ + | "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS" + /** The discountClass is invalid for the price rule. */ + | "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE" + /** The target type is invalid when defining a prerequisite shipping price range. */ + | "INVALID_TARGET_TYPE_PREREQUISITE_SHIPPING_PRICE_RANGE" + /** Can't add the same collection twice. */ + | "ITEM_ENTITLEMENTS_DUPLICATE_COLLECTION" + /** Can't add the same product twice. */ + | "ITEM_ENTITLEMENTS_DUPLICATE_PRODUCT" + /** Can't add the same collection twice. */ + | "ITEM_ENTITLEMENTS_DUPLICATE_VARIANT" + /** Can't exceed the maximum number of collection entitlements. */ + | "ITEM_ENTITLEMENTS_EXCEEDED_MAX_COLLECTION" + /** Can't exceed the maximum number of product entitlements. */ + | "ITEM_ENTITLEMENTS_EXCEEDED_MAX_PRODUCT" + /** Can't exceed the maximum number of variant entitlements. */ + | "ITEM_ENTITLEMENTS_EXCEEDED_MAX_VARIANT" + /** Invalid collection. */ + | "ITEM_ENTITLEMENTS_INVALID_COLLECTION" + /** Invalid product. */ + | "ITEM_ENTITLEMENTS_INVALID_PRODUCT" + /** Invalid combination of target type and selection. */ + | "ITEM_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION" + /** Invalid variant. */ + | "ITEM_ENTITLEMENTS_INVALID_VARIANT" + /** Entitlements are missing. */ + | "ITEM_ENTITLEMENTS_MISSING" + /** Invalid entitlement type. */ + | "ITEM_ENTITLEMENT_INVALID_TYPE" + /** Can't add the same collection twice. */ + | "ITEM_PREREQUISITES_DUPLICATE_COLLECTION" + /** Can't add the same product twice. */ + | "ITEM_PREREQUISITES_DUPLICATE_PRODUCT" + /** Can't add the same variant twice. */ + | "ITEM_PREREQUISITES_DUPLICATE_VARIANT" + /** Can't exceed the maximum number of item prerequisites. */ + | "ITEM_PREREQUISITES_EXCEEDED_MAX" + /** Invalid collection. */ + | "ITEM_PREREQUISITES_INVALID_COLLECTION" + /** Invalid product. */ + | "ITEM_PREREQUISITES_INVALID_PRODUCT" + /** Invalid type. */ + | "ITEM_PREREQUISITES_INVALID_TYPE" + /** Invalid variant. */ + | "ITEM_PREREQUISITES_INVALID_VARIANT" + /** Item prerequisites must have at least one item prerequisite if the prerequisite quantity ratio is defined. */ + | "ITEM_PREREQUISITES_MISSING" + /** Item prerequisites must be empty if the prerequisite quantity ratio isn't defined. */ + | "ITEM_PREREQUISITES_MUST_BE_EMPTY" + /** The input value should be less than the maximum value allowed. */ + | "LESS_THAN" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** Missing a required argument. */ + | "MISSING_ARGUMENT" + /** The recurring cycle limit must be 1 when a discount doesn't apply on subscription items. */ + | "MULTIPLE_RECURRING_CYCLE_LIMIT_FOR_NON_SUBSCRIPTION_ITEMS" + /** Only one of the minimum subtotal or minimum quantity condition can be defined. */ + | "PREREQUISITE_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT" + /** The allocation limit must be a non-zero positive number. */ + | "PRICE_RULE_ALLOCATION_LIMIT_IS_ZERO" + /** The allocation limit can only be set on Buy x, get y (BXGY) discounts. */ + | "PRICE_RULE_ALLOCATION_LIMIT_ON_NON_BOGO" + /** The number of discount codes in the shop has reached its limit. */ + | "PRICE_RULE_EXCEEDED_MAX_DISCOUNT_CODE" + /** The percentage value must be between 0 and -100. */ + | "PRICE_RULE_PERCENTAGE_VALUE_OUTSIDE_RANGE" + /** A duplicate country code exists. */ + | "SHIPPING_ENTITLEMENTS_DUPLICATE_COUNTRY" + /** Can't exceed the maximum number of entitlements. */ + | "SHIPPING_ENTITLEMENTS_EXCEEDED_MAX" + /** The country is unknown. */ + | "SHIPPING_ENTITLEMENTS_INVALID_COUNTRY" + /** Invalid target type or selection. */ + | "SHIPPING_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION" + /** Missing entitlements. */ + | "SHIPPING_ENTITLEMENTS_MISSING" + /** Unsupported destination type. */ + | "SHIPPING_ENTITLEMENTS_UNSUPPORTED_DESTINATION_TYPE" + /** The number of discounts in the shop has reached its limit. */ + | "SHOP_EXCEEDED_MAX_PRICE_RULES" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** Too many arguments provided. */ + | "TOO_MANY_ARGUMENTS" + /** The input value is too short. */ + | "TOO_SHORT" + /** The variant is already entitled through a product. */ + | "VARIANT_ALREADY_ENTITLED_THROUGH_PRODUCT"; + +/** The list of features that can be supported by a price rule. */ +export type PriceRuleFeature = + /** The price rule supports bulk discounts. */ + | "BULK" + /** The price rule supports Buy X, Get Y (BXGY) discounts. */ + | "BUY_ONE_GET_ONE" + /** The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit. */ + | "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT" + /** The price rule supports discounts that require a quantity. */ + | "QUANTITY_DISCOUNTS" + /** The price rule targets specific customers. */ + | "SPECIFIC_CUSTOMERS"; + +/** The value of a fixed amount price rule. */ +export type PriceRuleFixedAmountValue = { + /** The monetary value of the price rule. */ + amount: Scalars["Money"]["output"]; +}; + +/** The input fields to manipulate a price rule. */ +export type PriceRuleInput = { + /** The maximum number of times that the price rule can be allocated onto an order. */ + allocationLimit?: InputMaybe; + /** The method by which the price rule's value is allocated to its entitled items. */ + allocationMethod?: InputMaybe; + /** Determines which discount classes the discount can combine with. */ + combinesWith?: InputMaybe; + /** The customers that can use this price rule. */ + customerSelection?: InputMaybe; + /** The items to which the price rule applies. */ + itemEntitlements?: InputMaybe; + /** The items required for the price rule to be applicable. */ + itemPrerequisites?: InputMaybe; + /** Whether the price rule can be applied only once per customer. */ + oncePerCustomer?: InputMaybe; + /** The number of the entitled items must fall within this range for the price rule to be applicable. */ + prerequisiteQuantityRange?: InputMaybe; + /** The shipping cost must fall within this range for the price rule to be applicable. */ + prerequisiteShippingPriceRange?: InputMaybe; + /** The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable. */ + prerequisiteSubtotalRange?: InputMaybe; + /** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ + prerequisiteToEntitlementQuantityRatio?: InputMaybe< + PriceRulePrerequisiteToEntitlementQuantityRatioInput + >; + /** The shipping lines to which the price rule applies. */ + shippingEntitlements?: InputMaybe; + /** The type of lines (line_item or shipping_line) to which the price rule applies. */ + target?: InputMaybe; + /** Title of the price rule. */ + title?: InputMaybe; + /** The maximum number of times that the price rule can be used in total. */ + usageLimit?: InputMaybe; + /** PriceRuleValidityPeriod for the price rule. */ + validityPeriod?: InputMaybe; + /** The value of the price rule. */ + value?: InputMaybe; +}; + +/** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ +export type PriceRuleItemEntitlements = { + /** The collections to which the price rule applies. */ + collections: CollectionConnection; + /** The product variants to which the price rule applies. */ + productVariants: ProductVariantConnection; + /** The products to which the price rule applies. */ + products: ProductConnection; + /** Whether the price rule applies to all line items. */ + targetAllLineItems: Scalars["Boolean"]["output"]; +}; + +/** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ +export type PriceRuleItemEntitlementsCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ +export type PriceRuleItemEntitlementsProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned. */ +export type PriceRuleItemEntitlementsProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields to update a price rule line item entitlement. */ +export type PriceRuleItemEntitlementsInput = { + /** The collections to which the price rule applies. */ + collectionIds?: InputMaybe>; + /** The products to which the price rule applies. */ + productIds?: InputMaybe>; + /** The product variants to which the price rule applies. */ + productVariantIds?: InputMaybe>; + /** Whether the price rule applies to all items. */ + targetAllLineItems?: InputMaybe; +}; + +/** The input fields to update a price rule's item prerequisites. */ +export type PriceRuleItemPrerequisitesInput = { + /** The collections needed for the price rule to be applied. */ + collectionIds?: InputMaybe>; + /** The products needed for the price rule to be applied. */ + productIds?: InputMaybe>; + /** The product variants needed for the price rule to be applied. */ + productVariantIds?: InputMaybe>; +}; + +/** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ +export type PriceRuleLineItemPrerequisites = { + /** The collections required for the price rule to be applicable. */ + collections: CollectionConnection; + /** The product variants required for the price rule to be applicable. */ + productVariants: ProductVariantConnection; + /** The products required for the price rule to be applicable. */ + products: ProductConnection; +}; + +/** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ +export type PriceRuleLineItemPrerequisitesCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ +export type PriceRuleLineItemPrerequisitesProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination. */ +export type PriceRuleLineItemPrerequisitesProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** A money range within which the price rule is applicable. */ +export type PriceRuleMoneyRange = { + /** The lower bound of the money range. */ + greaterThan?: Maybe; + /** The lower bound or equal of the money range. */ + greaterThanOrEqualTo?: Maybe; + /** The upper bound of the money range. */ + lessThan?: Maybe; + /** The upper bound or equal of the money range. */ + lessThanOrEqualTo?: Maybe; +}; + +/** + * The input fields to update the money range within which the price rule is applicable. + */ +export type PriceRuleMoneyRangeInput = { + /** The lower bound of the money range. */ + greaterThan?: InputMaybe; + /** The lower or equal bound of the money range. */ + greaterThanOrEqualTo?: InputMaybe; + /** The upper bound of the money range. */ + lessThan?: InputMaybe; + /** The upper or equal bound of the money range. */ + lessThanOrEqualTo?: InputMaybe; +}; + +/** The value of a percent price rule. */ +export type PriceRulePercentValue = { + /** The percent value of the price rule. */ + percentage: Scalars["Float"]["output"]; +}; + +/** Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ +export type PriceRulePrerequisiteToEntitlementQuantityRatio = { + /** The quantity of entitled items in the ratio. */ + entitlementQuantity: Scalars["Int"]["output"]; + /** The quantity of prerequisite items in the ratio. */ + prerequisiteQuantity: Scalars["Int"]["output"]; +}; + +/** Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items. */ +export type PriceRulePrerequisiteToEntitlementQuantityRatioInput = { + /** The quantity of entitled items in the ratio. */ + entitlementQuantity?: InputMaybe; + /** The quantity of prerequisite items in the ratio. */ + prerequisiteQuantity?: InputMaybe; +}; + +/** A quantity range within which the price rule is applicable. */ +export type PriceRuleQuantityRange = { + /** The lower bound of the quantity range. */ + greaterThan?: Maybe; + /** The lower bound or equal of the quantity range. */ + greaterThanOrEqualTo?: Maybe; + /** The upper bound of the quantity range. */ + lessThan?: Maybe; + /** The upper bound or equal of the quantity range. */ + lessThanOrEqualTo?: Maybe; +}; + +/** + * The input fields to update the quantity range within which the price rule is applicable. + */ +export type PriceRuleQuantityRangeInput = { + /** The lower bound of the quantity range. */ + greaterThan?: InputMaybe; + /** The lower or equal bound of the quantity range. */ + greaterThanOrEqualTo?: InputMaybe; + /** The upper bound of the quantity range. */ + lessThan?: InputMaybe; + /** The upper or equal bound of the quantity range. */ + lessThanOrEqualTo?: InputMaybe; +}; + +/** Shareable URL for the discount code associated with the price rule. */ +export type PriceRuleShareableUrl = { + /** The image URL of the item (product or collection) to which the discount applies. */ + targetItemImage?: Maybe; + /** The type of page that's associated with the URL. */ + targetType: PriceRuleShareableUrlTargetType; + /** The title of the page that's associated with the URL. */ + title: Scalars["String"]["output"]; + /** The URL for the discount code. */ + url: Scalars["URL"]["output"]; +}; + +/** The type of page where a shareable price rule URL lands. */ +export type PriceRuleShareableUrlTargetType = + /** The URL lands on a collection page. */ + | "COLLECTION" + /** The URL lands on a home page. */ + | "HOME" + /** The URL lands on a product page. */ + | "PRODUCT"; + +/** The input fields to update a price rule shipping entitlement. */ +export type PriceRuleShippingEntitlementsInput = { + /** The codes for the countries to which the price rule applies to. */ + countryCodes?: InputMaybe>; + /** Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones. */ + includeRestOfWorld?: InputMaybe; + /** Whether the price rule applies to all shipping lines. */ + targetAllShippingLines?: InputMaybe; +}; + +/** The shipping lines to which the price rule applies to. */ +export type PriceRuleShippingLineEntitlements = { + /** The codes for the countries to which the price rule applies to. */ + countryCodes: Array; + /** Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones. */ + includeRestOfWorld: Scalars["Boolean"]["output"]; + /** Whether the price rule applies to all shipping lines. */ + targetAllShippingLines: Scalars["Boolean"]["output"]; +}; + +/** The set of valid sort keys for the PriceRule query. */ +export type PriceRuleSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `ends_at` value. */ + | "ENDS_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `starts_at` value. */ + | "STARTS_AT" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** The status of the price rule. */ +export type PriceRuleStatus = + /** The price rule is active. */ + | "ACTIVE" + /** The price rule is expired. */ + | "EXPIRED" + /** The price rule is scheduled. */ + | "SCHEDULED"; + +/** The type of lines (line_item or shipping_line) to which the price rule applies. */ +export type PriceRuleTarget = + /** The price rule applies to line items. */ + | "LINE_ITEM" + /** The price rule applies to shipping lines. */ + | "SHIPPING_LINE"; + +/** The list of features that can be supported by a price rule. */ +export type PriceRuleTrait = + /** The price rule supports bulk discounts. */ + | "BULK" + /** The price rule supports Buy X, Get Y (BXGY) discounts. */ + | "BUY_ONE_GET_ONE" + /** The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit. */ + | "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT" + /** The price rule supports discounts that require a quantity. */ + | "QUANTITY_DISCOUNTS" + /** The price rule targets specific customers. */ + | "SPECIFIC_CUSTOMERS"; + +/** Return type for `priceRuleUpdate` mutation. */ +export type PriceRuleUpdatePayload = { + /** The updated price rule. */ + priceRule?: Maybe; + /** The updated discount code. */ + priceRuleDiscountCode?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + priceRuleUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `priceRuleUserErrors` instead. + */ + userErrors: Array; +}; + +/** Represents an error that happens during execution of a price rule mutation. */ +export type PriceRuleUserError = DisplayableError & { + /** Error code to uniquely identify the error. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** A time period during which a price rule is applicable. */ +export type PriceRuleValidityPeriod = { + /** The time after which the price rule becomes invalid. */ + end?: Maybe; + /** The time after which the price rule is valid. */ + start: Scalars["DateTime"]["output"]; +}; + +/** The input fields to update the validity period of a price rule. */ +export type PriceRuleValidityPeriodInput = { + /** The time after which the price rule becomes invalid. */ + end?: InputMaybe; + /** The time after which the price rule is valid. */ + start: Scalars["DateTime"]["input"]; +}; + +/** The type of the price rule value. The price rule value might be a percentage value, or a fixed amount. */ +export type PriceRuleValue = PriceRuleFixedAmountValue | PriceRulePercentValue; + +/** The input fields to update a price rule. */ +export type PriceRuleValueInput = { + /** The fixed amount value of the price rule. */ + fixedAmountValue?: InputMaybe; + /** The percentage value of the price rule. */ + percentageValue?: InputMaybe; +}; + +/** + * One type of value given to a customer when a discount is applied to an order. + * The application of a discount with this value gives the customer the specified percentage off a specified item. + */ +export type PricingPercentageValue = { + /** + * The percentage value of the object. This is a number between -100 (free) and 0 (no discount). + */ + percentage: Scalars["Float"]["output"]; +}; + +/** The type of value given to a customer when a discount is applied to an order. For example, the application of the discount might give the customer a percentage off a specified item. Alternatively, the application of the discount might give the customer a monetary value in a given currency off an order. */ +export type PricingValue = MoneyV2 | PricingPercentageValue; + +/** + * Private metafields represent custom metadata that is attached to a resource. + * Private metafields are accessible only by the application that created them and only from the GraphQL Admin API. + * + * An application can create a maximum of 10 private metafields per shop resource. + */ +export type PrivateMetafield = Node & { + /** The date and time when the private metafield was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The ID of the private metafield. */ + id: Scalars["ID"]["output"]; + /** The key name of the private metafield. */ + key: Scalars["String"]["output"]; + /** The namespace of the private metafield. */ + namespace: Scalars["String"]["output"]; + /** The date and time when the private metafield was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + /** The value of a private metafield. */ + value: Scalars["String"]["output"]; + /** Represents the private metafield value type. */ + valueType: PrivateMetafieldValueType; +}; + +/** + * An auto-generated type for paginating through multiple PrivateMetafields. + */ +export type PrivateMetafieldConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PrivateMetafieldEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * The input fields for the private metafield to delete. + */ +export type PrivateMetafieldDeleteInput = { + /** The key of the private metafield. */ + key: Scalars["String"]["input"]; + /** The namespace of the private metafield. */ + namespace: Scalars["String"]["input"]; + /** The ID of the resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield. */ + owner?: InputMaybe; +}; + +/** Return type for `privateMetafieldDelete` mutation. */ +export type PrivateMetafieldDeletePayload = { + /** The ID of private metafield that was deleted. */ + deletedPrivateMetafieldId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one PrivateMetafield and a cursor during pagination. + */ +export type PrivateMetafieldEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PrivateMetafieldEdge. */ + node: PrivateMetafield; +}; + +/** + * The input fields for a private metafield. + */ +export type PrivateMetafieldInput = { + /** The key of the private metafield. */ + key: Scalars["String"]["input"]; + /** The namespace of the private metafield. */ + namespace: Scalars["String"]["input"]; + /** The resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield. */ + owner?: InputMaybe; + /** The `value` and `valueType` of the private metafield, wrapped in a `ValueInput` object. */ + valueInput: PrivateMetafieldValueInput; +}; + +/** Return type for `privateMetafieldUpsert` mutation. */ +export type PrivateMetafieldUpsertPayload = { + /** The private metafield that was created or updated. */ + privateMetafield?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for the value and value type of the private metafield. + */ +export type PrivateMetafieldValueInput = { + /** The value of a private metafield. */ + value: Scalars["String"]["input"]; + /** Represents the private metafield value type. */ + valueType: PrivateMetafieldValueType; +}; + +/** Supported private metafield value types. */ +export type PrivateMetafieldValueType = + /** An integer metafield. */ + | "INTEGER" + /** A JSON string metafield. */ + | "JSON_STRING" + /** A string metafield. */ + | "STRING"; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type Product = + & HasMetafieldDefinitions + & HasMetafields + & HasPublishedTranslations + & LegacyInteroperability + & Navigable + & Node + & OnlineStorePreviewable + & Publishable + & { + /** The number of publications a resource is published to without feedback errors. */ + availablePublicationCount: Scalars["Int"]["output"]; + /** + * The description of the product, complete with HTML formatting. + * @deprecated Use `descriptionHtml` instead. + */ + bodyHtml?: Maybe; + /** A list of the collections that include the product. */ + collections: CollectionConnection; + /** The pricing that applies for a customer in a given context. */ + contextualPricing: ProductContextualPricing; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** + * The custom product type specified by the merchant. + * @deprecated Deprecated in API version 2022-10. Use `productType` instead. + */ + customProductType?: Maybe; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** A stripped description of the product, single line with HTML tags removed. */ + description: Scalars["String"]["output"]; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml: Scalars["HTML"]["output"]; + /** + * Stripped description of the product, single line with HTML tags removed. + * Truncated to 60 characters. + * + * @deprecated Use `description` instead. + */ + descriptionPlainSummary: Scalars["String"]["output"]; + /** The featured image for the product. */ + featuredImage?: Maybe; + /** The featured media for the product. */ + featuredMedia?: Maybe; + /** Information about the product that's provided through resource feedback. */ + feedback?: Maybe; + /** The theme template used when viewing the gift card in a store. */ + giftCardTemplateSuffix?: Maybe; + /** A unique human-friendly string of the product's title. */ + handle: Scalars["String"]["output"]; + /** Whether the product has only a single variant with the default option and value. */ + hasOnlyDefaultVariant: Scalars["Boolean"]["output"]; + /** Whether the product has out of stock variants. */ + hasOutOfStockVariants: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The images associated with the product. */ + images: ImageConnection; + /** Whether the product is in a given collection. */ + inCollection: Scalars["Boolean"]["output"]; + /** Whether the product is a gift card. */ + isGiftCard: Scalars["Boolean"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The media associated with the product. This can include images, 3D models, or videos. */ + media: MediaConnection; + /** Total count of media belonging to a product. */ + mediaCount: Scalars["Int"]["output"]; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The online store preview URL. */ + onlineStorePreviewUrl?: Maybe; + /** + * The online store URL for the product. + * A value of `null` indicates that the product isn't published to the Online Store sales channel. + */ + onlineStoreUrl?: Maybe; + /** A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions. */ + options: Array; + /** + * The price range of the product. + * @deprecated Deprecated in API version 2020-10. Use `priceRangeV2` instead. + */ + priceRange: ProductPriceRange; + /** The price range of the product with prices formatted as decimals. */ + priceRangeV2: ProductPriceRangeV2; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The product category specified by the merchant. */ + productCategory?: Maybe; + /** + * A list of the channels where the product is published. + * @deprecated Use `resourcePublications` instead. + */ + productPublications: ProductPublicationConnection; + /** The product type specified by the merchant. */ + productType: Scalars["String"]["output"]; + /** The number of publications a resource is published on. */ + publicationCount: Scalars["Int"]["output"]; + /** + * A list of the channels where the product is published. + * @deprecated Use `resourcePublications` instead. + */ + publications: ProductPublicationConnection; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store. + */ + publishedAt?: Maybe; + /** Whether or not the product is published for a customer in the given context. */ + publishedInContext: Scalars["Boolean"]["output"]; + /** + * Check to see whether the resource is published to a given channel. + * @deprecated Use `publishedOnPublication` instead. + */ + publishedOnChannel: Scalars["Boolean"]["output"]; + /** + * Check to see whether the resource is published to the calling app's channel. + * @deprecated Use `publishedOnCurrentPublication` instead. + */ + publishedOnCurrentChannel: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to the calling app's publication. */ + publishedOnCurrentPublication: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to a given publication. */ + publishedOnPublication: Scalars["Boolean"]["output"]; + /** Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store. */ + requiresSellingPlan: Scalars["Boolean"]["output"]; + /** The resource that's either published or staged to be published to the calling app's publication. Requires the `read_product_listings` scope. */ + resourcePublicationOnCurrentPublication?: Maybe; + /** The list of resources that are published to a publication. */ + resourcePublications: ResourcePublicationConnection; + /** The list of resources that are either published or staged to be published to a publication. */ + resourcePublicationsV2: ResourcePublicationV2Connection; + /** Count of selling plan groups associated with the product. */ + sellingPlanGroupCount: Scalars["Int"]["output"]; + /** A list of all selling plan groups defined in the current shop associated with the product either directly or through any of its variants. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** SEO information of the product. */ + seo: Seo; + /** + * The standardized product type in the Shopify product taxonomy. + * @deprecated Deprecated in API version 2022-10. Use `productCategory` instead. + */ + standardizedProductType?: Maybe; + /** The product status. This controls visibility across all channels. */ + status: ProductStatus; + /** + * The Storefront GraphQL API ID of the `Product`. + * + * As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. + * + * @deprecated Use `id` instead. + */ + storefrontId: Scalars["StorefrontID"]["output"]; + /** + * A comma separated list of tags associated with the product. Updating `tags` overwrites + * any existing tags that were previously added to the product. To add new tags without overwriting + * existing tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) + * mutation. + */ + tags: Array; + /** The theme template used when viewing the product in a store. */ + templateSuffix?: Maybe; + /** The title of the product. */ + title: Scalars["String"]["output"]; + /** The quantity of inventory in stock. */ + totalInventory: Scalars["Int"]["output"]; + /** The number of variants that are associated with the product. */ + totalVariants: Scalars["Int"]["output"]; + /** Whether inventory tracking has been enabled for the product. */ + tracksInventory: Scalars["Boolean"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** + * The list of channels that the resource is not published to. + * @deprecated Use `unpublishedPublications` instead. + */ + unpublishedChannels: ChannelConnection; + /** The list of publications that the resource is not published to. */ + unpublishedPublications: PublicationConnection; + /** + * The date and time when the product was last modified. + * A product's `updatedAt` value can change for different reasons. For example, if an order + * is placed for a product that has inventory tracking set up, then the inventory adjustment + * is counted as an update. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** A list of variants associated with the product. */ + variants: ProductVariantConnection; + /** The name of the product's vendor. */ + vendor: Scalars["String"]["output"]; + }; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductContextualPricingArgs = { + context: ContextualPricingContext; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductDescriptionArgs = { + truncateAt?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductImagesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductInCollectionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductMediaArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductOptionsArgs = { + first?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductProductPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPublicationCountArgs = { + onlyPublished?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPublishedInContextArgs = { + context: ContextualPublicationContext; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPublishedOnChannelArgs = { + channelId: Scalars["ID"]["input"]; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductPublishedOnPublicationArgs = { + publicationId: Scalars["ID"]["input"]; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductResourcePublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductResourcePublicationsV2Args = { + after?: InputMaybe; + before?: InputMaybe; + catalogType?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductSellingPlanGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductUnpublishedChannelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductUnpublishedPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection). */ +export type ProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The input fields for specifying product images to append. */ +export type ProductAppendImagesInput = { + /** The ID of the product. */ + id: Scalars["ID"]["input"]; + /** A list of images to be appended to the product. */ + images: Array; +}; + +/** Return type for `productAppendImages` mutation. */ +export type ProductAppendImagesPayload = { + /** List of new images appended to the product. */ + newImages?: Maybe>; + /** The product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The details of a specific product category within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt). */ +export type ProductCategory = { + /** The product taxonomy node associated with the product category. */ + productTaxonomyNode?: Maybe; +}; + +/** The input fields to use when adding a product category to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values. */ +export type ProductCategoryInput = { + /** The ID of the node in the Shopify taxonomy that represents the product category. */ + productTaxonomyNodeId: Scalars["ID"]["input"]; +}; + +/** Return type for `productChangeStatus` mutation. */ +export type ProductChangeStatusPayload = { + /** The product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ProductChangeStatus`. */ +export type ProductChangeStatusUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductChangeStatusUserError`. */ +export type ProductChangeStatusUserErrorCode = + /** Product could not be found. */ + "PRODUCT_NOT_FOUND"; + +/** The set of valid sort keys for the ProductCollection query. */ +export type ProductCollectionSortKeys = + /** Sort by the `best-selling` value. */ + | "BEST_SELLING" + /** Sort by the `collection-default` value. */ + | "COLLECTION_DEFAULT" + /** Sort by the `created` value. */ + | "CREATED" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `manual` value. */ + | "MANUAL" + /** Sort by the `price` value. */ + | "PRICE" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE"; + +/** + * An auto-generated type for paginating through multiple Products. + */ +export type ProductConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * The price of a product in a specific country. + * Prices vary between countries. + */ +export type ProductContextualPricing = { + /** The number of fixed quantity rules for the product's variants on the price list. */ + fixedQuantityRulesCount: Scalars["Int"]["output"]; + /** The pricing of the variant with the highest price in the given context. */ + maxVariantPricing?: Maybe; + /** The pricing of the variant with the lowest price in the given context. */ + minVariantPricing?: Maybe; + /** The price range of the product with prices formatted as decimals. */ + priceRange: ProductPriceRangeV2; +}; + +/** Return type for `productCreateMedia` mutation. */ +export type ProductCreateMediaPayload = { + /** The newly created media. */ + media?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + mediaUserErrors: Array; + /** The product associated with the media. */ + product?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `mediaUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `productCreate` mutation. */ +export type ProductCreatePayload = { + /** The product object. */ + product?: Maybe; + /** The shop associated with the product. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productDeleteAsync` mutation. */ +export type ProductDeleteAsyncPayload = { + /** The ID of the product that was requested to be deleted. */ + deleteProductId?: Maybe; + /** The background job that will delete the product and its associated variants and media. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productDeleteImages` mutation. */ +export type ProductDeleteImagesPayload = { + /** The array of image IDs to delete. */ + deletedImageIds: Array; + /** The product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for specifying the product to delete. */ +export type ProductDeleteInput = { + /** The ID of the product. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `productDeleteMedia` mutation. */ +export type ProductDeleteMediaPayload = { + /** List of media IDs which were deleted. */ + deletedMediaIds?: Maybe>; + /** List of product image IDs which were deleted. */ + deletedProductImageIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + mediaUserErrors: Array; + /** The product associated with the deleted media. */ + product?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `mediaUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `productDelete` mutation. */ +export type ProductDeletePayload = { + /** The ID of the deleted product. */ + deletedProductId?: Maybe; + /** The shop associated with the product. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurred while setting the activation status of an inventory item. */ +export type ProductDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductDeleteUserError`. */ +export type ProductDeleteUserErrorCode = + /** Something went wrong, please try again. */ + | "GENERIC_ERROR" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST"; + +/** The input fields for the product async duplicate mutation. */ +export type ProductDuplicateAsyncInput = { + /** Specifies whether or not to duplicate images. */ + includeImages?: InputMaybe; + /** The new status of the product. If no value is provided the status will be inherited from the original product. */ + newStatus?: InputMaybe; + /** The new title of the product. */ + newTitle: Scalars["String"]["input"]; + /** The ID of the product to be duplicated. */ + productId: Scalars["ID"]["input"]; +}; + +/** Return type for `productDuplicateAsync` mutation. */ +export type ProductDuplicateAsyncPayload = { + /** The duplicated product ID. */ + duplicatedProductId?: Maybe; + /** The asynchronous job for duplicating the products. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productDuplicateAsyncV2` mutation. */ +export type ProductDuplicateAsyncV2Payload = { + /** The duplicated product ID. */ + duplicatedProductId?: Maybe; + /** The asynchronous job for duplicating the product. */ + productDuplicateJobId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a product duplication job. */ +export type ProductDuplicateJob = { + /** This indicates if the job is still queued or has been run. */ + done: Scalars["Boolean"]["output"]; + /** A globally-unique ID that's returned when running an asynchronous mutation. */ + id: Scalars["ID"]["output"]; +}; + +/** Return type for `productDuplicate` mutation. */ +export type ProductDuplicatePayload = { + /** The asynchronous job that duplicates the product images. */ + imageJob?: Maybe; + /** The duplicated product. */ + newProduct?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurred while duplicating the product. */ +export type ProductDuplicateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductDuplicateUserError`. */ +export type ProductDuplicateUserErrorCode = + /** Cannot duplicate a bundle product. */ + | "BUNDLES_ERROR" + /** The title cannot be empty. */ + | "EMPTY_TITLE" + /** Cannot duplicate a product which has no variants. */ + | "EMPTY_VARIANT" + /** Something went wrong when saving the product, please try again. */ + | "FAILED_TO_SAVE" + /** Something went wrong, please try again. */ + | "GENERIC_ERROR" + /** The product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST"; + +/** + * An auto-generated type which holds one Product and a cursor during pagination. + */ +export type ProductEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductEdge. */ + node: Product; +}; + +/** A product feed. */ +export type ProductFeed = Node & { + /** The country of the product feed. */ + country?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The language of the product feed. */ + language?: Maybe; + /** The status of the product feed. */ + status: ProductFeedStatus; +}; + +/** + * An auto-generated type for paginating through multiple ProductFeeds. + */ +export type ProductFeedConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductFeedEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `productFeedCreate` mutation. */ +export type ProductFeedCreatePayload = { + /** The newly created product feed. */ + productFeed?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ProductFeedCreate`. */ +export type ProductFeedCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductFeedCreateUserError`. */ +export type ProductFeedCreateUserErrorCode = + /** The input value is invalid. */ + | "INVALID" + /** The input value is already taken. */ + | "TAKEN"; + +/** Return type for `productFeedDelete` mutation. */ +export type ProductFeedDeletePayload = { + /** The ID of the product feed that was deleted. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ProductFeedDelete`. */ +export type ProductFeedDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductFeedDeleteUserError`. */ +export type ProductFeedDeleteUserErrorCode = /** The input value is invalid. */ + "INVALID"; + +/** + * An auto-generated type which holds one ProductFeed and a cursor during pagination. + */ +export type ProductFeedEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductFeedEdge. */ + node: ProductFeed; +}; + +/** The input fields required to create a product feed. */ +export type ProductFeedInput = { + /** The country of the product feed. */ + country: CountryCode; + /** The language of the product feed. */ + language: LanguageCode; +}; + +/** The valid values for the status of product feed. */ +export type ProductFeedStatus = + /** The product feed is active. */ + | "ACTIVE" + /** The product feed is inactive. */ + | "INACTIVE"; + +/** Return type for `productFullSync` mutation. */ +export type ProductFullSyncPayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ProductFullSync`. */ +export type ProductFullSyncUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductFullSyncUserError`. */ +export type ProductFullSyncUserErrorCode = /** The input value is invalid. */ + "INVALID"; + +/** The set of valid sort keys for the ProductImage query. */ +export type ProductImageSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `position` value. */ + | "POSITION" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** Return type for `productImageUpdate` mutation. */ +export type ProductImageUpdatePayload = { + /** The image that has been updated. */ + image?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to create a product. */ +export type ProductInput = { + /** The IDs of the collections that this product will be added to. */ + collectionsToJoin?: InputMaybe>; + /** The IDs of collections that will no longer include the existing product. */ + collectionsToLeave?: InputMaybe>; + /** The custom product type specified by the merchant. */ + customProductType?: InputMaybe; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml?: InputMaybe; + /** Whether the product is a gift card. */ + giftCard?: InputMaybe; + /** The theme template used when viewing the gift card in a store. */ + giftCardTemplateSuffix?: InputMaybe; + /** + * A unique, human-friendly string for the product. + * Automatically generated from the product's title unless otherwise specified. + */ + handle?: InputMaybe; + /** Specifies the product to update in productUpdate or creates a new product if absent in productCreate. */ + id?: InputMaybe; + /** The metafields to associate with this product. */ + metafields?: InputMaybe>; + /** List of custom product options (maximum of 3 per product). */ + options?: InputMaybe>; + /** The product category in the Shopify product taxonomy. */ + productCategory?: InputMaybe; + /** The product type specified by the merchant. */ + productType?: InputMaybe; + /** + * Whether a redirect is required after a new handle has been provided. + * If true, then the old handle is redirected to the new one automatically. + */ + redirectNewHandle?: InputMaybe; + /** Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions. */ + requiresSellingPlan?: InputMaybe; + /** The SEO information associated with the product. */ + seo?: InputMaybe; + /** The standardized product type in the Shopify product taxonomy. */ + standardizedProductType?: InputMaybe; + /** The status of the product. */ + status?: InputMaybe; + /** A comma separated list of tags that have been added to the product. */ + tags?: InputMaybe>; + /** The theme template used when viewing the product in a store. */ + templateSuffix?: InputMaybe; + /** The title of the product. */ + title?: InputMaybe; + /** + * A list of variants associated with the product. + */ + variants?: InputMaybe>; + /** The name of the product's vendor. */ + vendor?: InputMaybe; +}; + +/** Return type for `productJoinSellingPlanGroups` mutation. */ +export type ProductJoinSellingPlanGroupsPayload = { + /** The product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productLeaveSellingPlanGroups` mutation. */ +export type ProductLeaveSellingPlanGroupsPayload = { + /** The product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The set of valid sort keys for the ProductMedia query. */ +export type ProductMediaSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `position` value. */ + | "POSITION" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * The product property names. For example, "Size", "Color", and "Material". + * Variants are selected based on permutations of these options. + * The limit for each product property name is 255 characters. + */ +export type ProductOption = HasPublishedTranslations & Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The product option’s name. */ + name: Scalars["String"]["output"]; + /** The product option's position. */ + position: Scalars["Int"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** The corresponding value to the product option name. */ + values: Array; +}; + +/** + * The product property names. For example, "Size", "Color", and "Material". + * Variants are selected based on permutations of these options. + * The limit for each product property name is 255 characters. + */ +export type ProductOptionTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** The price range of the product. */ +export type ProductPriceRange = { + /** The highest variant's price. */ + maxVariantPrice: MoneyV2; + /** The lowest variant's price. */ + minVariantPrice: MoneyV2; +}; + +/** The price range of the product. */ +export type ProductPriceRangeV2 = { + /** The highest variant's price. */ + maxVariantPrice: MoneyV2; + /** The lowest variant's price. */ + minVariantPrice: MoneyV2; +}; + +/** Represents the channels where a product is published. */ +export type ProductPublication = { + /** The channel where the product was or is published. */ + channel: Channel; + /** Whether the publication is published or not. */ + isPublished: Scalars["Boolean"]["output"]; + /** The product that was or is going to be published on the channel. */ + product: Product; + /** The date that the product was or is going to be published on the channel. */ + publishDate?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple ProductPublications. + */ +export type ProductPublicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductPublicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ProductPublication and a cursor during pagination. + */ +export type ProductPublicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductPublicationEdge. */ + node: ProductPublication; +}; + +/** The input fields for specifying a publication to which a product will be published. */ +export type ProductPublicationInput = { + /** ID of the publication. */ + publicationId?: InputMaybe; + /** The date and time that the product was (or will be) published. */ + publishDate?: InputMaybe; +}; + +/** The input fields for specifying a product to publish and the channels to publish it to. */ +export type ProductPublishInput = { + /** The product to create or update publications for. */ + id: Scalars["ID"]["input"]; + /** The publication that the product is published to. */ + productPublications: Array; +}; + +/** Return type for `productPublish` mutation. */ +export type ProductPublishPayload = { + /** The product that has been published. */ + product?: Maybe; + /** + * The channels where the product is published. + * @deprecated Use Product.publications instead. + */ + productPublications?: Maybe>; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productReorderImages` mutation. */ +export type ProductReorderImagesPayload = { + /** The asynchronous job which reorders the images. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productReorderMedia` mutation. */ +export type ProductReorderMediaPayload = { + /** The asynchronous job which reorders the media. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + mediaUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `mediaUserErrors` instead. + */ + userErrors: Array; +}; + +/** + * Reports the status of product for a Sales Channel or Storefront API. + * This might include why a product is not available in a Sales Channel + * and how a merchant might fix this. + */ +export type ProductResourceFeedback = { + /** + * The time when the feedback was generated. Used to help determine whether + * incoming feedback is outdated compared to existing feedback. + */ + feedbackGeneratedAt: Scalars["DateTime"]["output"]; + /** The feedback messages presented to the merchant. */ + messages: Array; + /** The ID of the product associated with the feedback. */ + productId: Scalars["ID"]["output"]; + /** The timestamp of the product associated with the feedback. */ + productUpdatedAt: Scalars["DateTime"]["output"]; + /** Conveys the state of the feedback and whether it requires merchant action or not. */ + state: ResourceFeedbackState; +}; + +/** The input fields used to create a product feedback. */ +export type ProductResourceFeedbackInput = { + /** + * The date and time when the payload is constructed. + * Used to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival. + */ + feedbackGeneratedAt: Scalars["DateTime"]["input"]; + /** + * A concise set of copy strings to be displayed to merchants. Used to guide merchants in resolving problems that your app encounters when trying to make use of their products. + * You can specify up to four messages. Each message is limited to 100 characters. + */ + messages?: InputMaybe>; + /** The ID of the product that the feedback was created on. */ + productId: Scalars["ID"]["input"]; + /** The timestamp of the product associated with the feedback. */ + productUpdatedAt: Scalars["DateTime"]["input"]; + /** Whether the merchant needs to take action on the product. */ + state: ResourceFeedbackState; +}; + +/** A sale associated with a product. */ +export type ProductSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line item for the associated sale. */ + lineItem: LineItem; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** The set of valid sort keys for the Product query. */ +export type ProductSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `inventory_total` value. */ + | "INVENTORY_TOTAL" + /** Sort by the `product_type` value. */ + | "PRODUCT_TYPE" + /** Sort by the `published_at` value. */ + | "PUBLISHED_AT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * Pagination isn't supported when using this sort key. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT" + /** Sort by the `vendor` value. */ + | "VENDOR"; + +/** The possible product statuses. */ +export type ProductStatus = + /** The product is ready to sell and can be published to sales channels and apps. Products with an active status aren't automatically published to sales channels, such as the online store, or apps. By default, existing products are set to active. */ + | "ACTIVE" + /** The product is no longer being sold and isn't available to customers on sales channels and apps. */ + | "ARCHIVED" + /** The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft. */ + | "DRAFT"; + +/** Represents a [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) node. */ +export type ProductTaxonomyNode = Node & { + /** The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds. */ + fullName: Scalars["String"]["output"]; + /** The ID of the product taxonomy node. */ + id: Scalars["ID"]["output"]; + /** Whether the node is a leaf node. */ + isLeaf: Scalars["Boolean"]["output"]; + /** Whether the node is a root node. */ + isRoot: Scalars["Boolean"]["output"]; + /** The name of the product taxonomy node. For example, Dog Beds. */ + name: Scalars["String"]["output"]; +}; + +/** + * The input fields for specifying a product to unpublish from a channel and the sales channels to unpublish it from. + */ +export type ProductUnpublishInput = { + /** The ID of the product to create or update publications for. */ + id: Scalars["ID"]["input"]; + /** The channels to unpublish the product from. */ + productPublications: Array; +}; + +/** Return type for `productUnpublish` mutation. */ +export type ProductUnpublishPayload = { + /** The product that has been unpublished. */ + product?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productUpdateMedia` mutation. */ +export type ProductUpdateMediaPayload = { + /** The updated media object. */ + media?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + mediaUserErrors: Array; + /** The product on which media was updated. */ + product?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `mediaUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `productUpdate` mutation. */ +export type ProductUpdatePayload = { + /** The updated product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a product variant. */ +export type ProductVariant = + & HasMetafieldDefinitions + & HasMetafields + & HasPublishedTranslations + & LegacyInteroperability + & Navigable + & Node + & { + /** Whether the product variant is available for sale. */ + availableForSale: Scalars["Boolean"]["output"]; + /** The value of the barcode associated with the product. */ + barcode?: Maybe; + /** The compare-at price of the variant in the default shop currency. */ + compareAtPrice?: Maybe; + /** The pricing that applies for a customer in a given context. */ + contextualPricing: ProductVariantContextualPricing; + /** The date and time when the variant was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** + * A default cursor that returns the single next record, sorted ascending by ID. + */ + defaultCursor: Scalars["String"]["output"]; + /** The delivery profile for the variant. */ + deliveryProfile?: Maybe; + /** Display name of the variant, based on product's title + variant's title. */ + displayName: Scalars["String"]["output"]; + /** + * The fulfillment service that stocks a product variant. + * + * This is a third-party fulfillment service if the following conditions are met: + * - The product variant is stocked by a single fulfillment service. + * - The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`. + * - The fulfillment service hasn't [opted into SKU sharing](/api/admin-graphql/latest/objects/FulfillmentService#field-fulfillmentservice-permitsskusharing). + * + * If the conditions aren't met, then the fulfillment service has the `manual` handle. + * + * @deprecated + * The [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked. + * + * If you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available. + * + * Learn more about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states). + */ + fulfillmentService?: Maybe; + /** Whether changes to the fulfillment service for the product variant are allowed. */ + fulfillmentServiceEditable: EditableProperty; + /** + * The Harmonized System Code (or HS Tariff Code) for the variant. + * @deprecated Use `InventoryItem.harmonizedSystemCode` instead. + */ + harmonizedSystemCode?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The featured image for the variant. */ + image?: Maybe; + /** The inventory item, which is used to query for inventory information. */ + inventoryItem: InventoryItem; + /** + * The fulfillment service that tracks the number of items in stock for the product variant. + * @deprecated Use tracked attribute on `inventoryItem` instead. + */ + inventoryManagement: ProductVariantInventoryManagement; + /** Whether customers are allowed to place an order for the product variant when it's out of stock. */ + inventoryPolicy: ProductVariantInventoryPolicy; + /** The total sellable quantity of the variant. */ + inventoryQuantity?: Maybe; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The media associated with the product variant. */ + media: MediaConnection; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** + * The order of the product variant in the list of product variants. The first position in the list is 1. + */ + position: Scalars["Int"]["output"]; + /** + * List of prices and compare-at prices in the presentment currencies for this shop. + * @deprecated Use `contextualPricing` instead. + */ + presentmentPrices: ProductVariantPricePairConnection; + /** The price of the product variant in the default shop currency. */ + price: Scalars["Money"]["output"]; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** The product that this variant belongs to. */ + product: Product; + /** A list of the product variant components. */ + productVariantComponents: ProductVariantComponentConnection; + /** + * Whether a product variant requires components. The default value is `false`. + * If `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted + * from channels that don't support bundles. + */ + requiresComponents: Scalars["Boolean"]["output"]; + /** + * Whether a customer needs to provide a shipping address when placing an order for the product variant. + * + * @deprecated Use `InventoryItem.requiresShipping` instead. + */ + requiresShipping: Scalars["Boolean"]["output"]; + /** List of product options applied to the variant. */ + selectedOptions: Array; + /** + * The total sellable quantity of the variant for online channels. + * This doesn't represent the total available inventory or capture + * [limitations based on customer location](https://help.shopify.com/manual/markets/inventory_and_fulfillment). + */ + sellableOnlineQuantity: Scalars["Int"]["output"]; + /** Count of selling plan groups associated with the product variant. */ + sellingPlanGroupCount: Scalars["Int"]["output"]; + /** A list of all selling plan groups defined in the current shop associated with the product variant. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** + * A case-sensitive identifier for the product variant in the shop. + * Required in order to connect to a fulfillment service. + */ + sku?: Maybe; + /** + * The Storefront GraphQL API ID of the `ProductVariant`. + * + * As of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead. + * + * @deprecated Use `id` instead. + */ + storefrontId: Scalars["StorefrontID"]["output"]; + /** The tax code for the product variant. */ + taxCode?: Maybe; + /** Whether a tax is charged when the product variant is sold. */ + taxable: Scalars["Boolean"]["output"]; + /** The title of the product variant. */ + title: Scalars["String"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** + * The date and time (ISO 8601 format) when the product variant was last modified. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** The weight of the product variant in the unit system specified with weight_unit. */ + weight?: Maybe; + /** + * The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`. + */ + weightUnit: WeightUnit; + }; + +/** Represents a product variant. */ +export type ProductVariantContextualPricingArgs = { + context: ContextualPricingContext; +}; + +/** Represents a product variant. */ +export type ProductVariantMediaArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantPresentmentPricesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + presentmentCurrencies?: InputMaybe>; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** Represents a product variant. */ +export type ProductVariantPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantProductVariantComponentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantSellingPlanGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a product variant. */ +export type ProductVariantTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** The input fields required to append media to a single variant. */ +export type ProductVariantAppendMediaInput = { + /** Specifies the media to append to the variant. */ + mediaIds: Array; + /** Specifies the variant to which media will be appended. */ + variantId: Scalars["ID"]["input"]; +}; + +/** Return type for `productVariantAppendMedia` mutation. */ +export type ProductVariantAppendMediaPayload = { + /** The product associated with the variants and media. */ + product?: Maybe; + /** The product variants that were updated. */ + productVariants?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A product variant component associated with a product variant. */ +export type ProductVariantComponent = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The product variant associated with the component. */ + productVariant: ProductVariant; + /** The required quantity of the component. */ + quantity: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ProductVariantComponents. + */ +export type ProductVariantComponentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductVariantComponentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ProductVariantComponent and a cursor during pagination. + */ +export type ProductVariantComponentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductVariantComponentEdge. */ + node: ProductVariantComponent; +}; + +/** + * An auto-generated type for paginating through multiple ProductVariants. + */ +export type ProductVariantConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductVariantEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * The price of a product variant in a specific country. + * Prices vary between countries. + */ +export type ProductVariantContextualPricing = { + /** The final compare-at price after all adjustments are applied. */ + compareAtPrice?: Maybe; + /** The final price after all adjustments are applied. */ + price: MoneyV2; + /** The quantity rule applied for a given context. */ + quantityRule: QuantityRule; +}; + +/** Return type for `productVariantCreate` mutation. */ +export type ProductVariantCreatePayload = { + /** The product associated with the variant. */ + product?: Maybe; + /** The successfully created variant. */ + productVariant?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productVariantDelete` mutation. */ +export type ProductVariantDeletePayload = { + /** The ID of the deleted product variant. */ + deletedProductVariantId?: Maybe; + /** The product associated with the deleted product variant. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to detach media from a single variant. */ +export type ProductVariantDetachMediaInput = { + /** Specifies the media to detach from the variant. */ + mediaIds: Array; + /** Specifies the variant from which media will be detached. */ + variantId: Scalars["ID"]["input"]; +}; + +/** Return type for `productVariantDetachMedia` mutation. */ +export type ProductVariantDetachMediaPayload = { + /** The product associated with the variants and media. */ + product?: Maybe; + /** The product variants that were updated. */ + productVariants?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one ProductVariant and a cursor during pagination. + */ +export type ProductVariantEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductVariantEdge. */ + node: ProductVariant; +}; + +/** The input fields for the bundle components for core. */ +export type ProductVariantGroupRelationshipInput = { + /** The ID of the product variant that's a component of the bundle. */ + id: Scalars["ID"]["input"]; + /** The number of units of the product variant required to construct one unit of the bundle. */ + quantity: Scalars["Int"]["input"]; +}; + +/** The input fields for specifying a product variant to create or update. */ +export type ProductVariantInput = { + /** The value of the barcode associated with the product. */ + barcode?: InputMaybe; + /** The compare-at price of the variant. */ + compareAtPrice?: InputMaybe; + /** The Harmonized System code (or HS Tariff code) for the variant. */ + harmonizedSystemCode?: InputMaybe; + /** Specifies the product variant to update or create a new variant if absent. */ + id?: InputMaybe; + /** The inventory item associated with the variant. Used for unit cost. */ + inventoryItem?: InputMaybe; + /** Whether customers are allowed to place an order for the product variant when it's out of stock. */ + inventoryPolicy?: InputMaybe; + /** The inventory quantities at each location where the variant is stocked. */ + inventoryQuantities?: InputMaybe>; + /** The ID of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the IDs being created on the product. This field only accepts one value. */ + mediaId?: InputMaybe; + /** The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value. */ + mediaSrc?: InputMaybe>; + /** Additional customizable information about the product variant. */ + metafields?: InputMaybe>; + /** The custom properties that a shop owner uses to define product variants. */ + options?: InputMaybe>; + /** + * The order of the product variant in the list of product variants. The first position in the list is 1. + */ + position?: InputMaybe; + /** The price of the variant. */ + price?: InputMaybe; + /** The product to create the variant for. Used as input only to the `productVariantCreate` mutation. */ + productId?: InputMaybe; + /** + * Whether a product variant requires components. The default value is `false`. + * If `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted + * from channels that don't support bundles. + */ + requiresComponents?: InputMaybe; + /** Whether the variant requires shipping. */ + requiresShipping?: InputMaybe; + /** The SKU for the variant. Case-sensitive string. */ + sku?: InputMaybe; + /** The tax code associated with the variant. */ + taxCode?: InputMaybe; + /** Whether the variant is taxable. */ + taxable?: InputMaybe; + /** The weight of the variant. */ + weight?: InputMaybe; + /** The unit of weight that's used to measure the variant. */ + weightUnit?: InputMaybe; +}; + +/** The valid values for the method of inventory tracking for a product variant. */ +export type ProductVariantInventoryManagement = + /** This product variant's inventory is tracked by a third-party fulfillment service. */ + | "FULFILLMENT_SERVICE" + /** This product variant's inventory is not tracked. */ + | "NOT_MANAGED" + /** This product variant's inventory is tracked by Shopify. Inventory can be tracked by store location(s) and/or third-party fulfillment service(s). */ + | "SHOPIFY"; + +/** + * The valid values for the inventory policy of a product variant once it is out of stock. + */ +export type ProductVariantInventoryPolicy = + /** Customers can buy this product variant after it's out of stock. */ + | "CONTINUE" + /** Customers can't buy this product variant after it's out of stock. */ + | "DENY"; + +/** Return type for `productVariantJoinSellingPlanGroups` mutation. */ +export type ProductVariantJoinSellingPlanGroupsPayload = { + /** The product variant object. */ + productVariant?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productVariantLeaveSellingPlanGroups` mutation. */ +export type ProductVariantLeaveSellingPlanGroupsPayload = { + /** The product variant object. */ + productVariant?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields representing a product variant position. */ +export type ProductVariantPositionInput = { + /** Specifies the ID of the product variant to update. */ + id: Scalars["ID"]["input"]; + /** The order of the product variant in the list of product variants. The first position in the list is 1. */ + position: Scalars["Int"]["input"]; +}; + +/** + * The compare-at price and price of a variant sharing a currency. + */ +export type ProductVariantPricePair = { + /** The compare-at price of the variant with associated currency. */ + compareAtPrice?: Maybe; + /** The price of the variant with associated currency. */ + price: MoneyV2; +}; + +/** + * An auto-generated type for paginating through multiple ProductVariantPricePairs. + */ +export type ProductVariantPricePairConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductVariantPricePairEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. + */ +export type ProductVariantPricePairEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ProductVariantPricePairEdge. */ + node: ProductVariantPricePair; +}; + +/** Return type for `productVariantRelationshipBulkUpdate` mutation. */ +export type ProductVariantRelationshipBulkUpdatePayload = { + /** The product variants with successfully updated product variant relationships. */ + parentProductVariants?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ProductVariantRelationshipBulkUpdate`. */ +export type ProductVariantRelationshipBulkUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductVariantRelationshipBulkUpdateUserError`. */ +export type ProductVariantRelationshipBulkUpdateUserErrorCode = + /** A parent product variant cannot contain itself as a component. */ + | "CIRCULAR_REFERENCE" + /** A parent product variant must not contain duplicate product variant relationships. */ + | "DUPLICATE_PRODUCT_VARIANT_RELATIONSHIP" + /** Exceeded the maximum allowable product variant relationships in a parent product variant. */ + | "EXCEEDED_PRODUCT_VARIANT_RELATIONSHIP_LIMIT" + /** Unable to create parent product variant. */ + | "FAILED_TO_CREATE" + /** Unable to remove product variant relationships. */ + | "FAILED_TO_REMOVE" + /** Unable to update product variant relationships. */ + | "FAILED_TO_UPDATE" + /** Unable to update parent product variant price. */ + | "FAILED_TO_UPDATE_PARENT_PRODUCT_VARIANT_PRICE" + /** Product variant relationships must have a quantity greater than 0. */ + | "INVALID_QUANTITY" + /** The product variant relationships to remove must be specified if all the parent product variant's components aren't being removed. */ + | "MUST_SPECIFY_COMPONENTS" + /** Nested parent product variants aren't supported. */ + | "NESTED_PARENT_PRODUCT_VARIANT" + /** Gift cards cannot be parent product variants. */ + | "PARENT_PRODUCT_VARIANT_CANNOT_BE_GIFT_CARD" + /** Parent product variants cannot require a selling plan. */ + | "PARENT_PRODUCT_VARIANT_CANNOT_REQUIRE_SELLING_PLAN" + /** A parent product variant ID or product ID must be provided. */ + | "PARENT_REQUIRED" + /** The products for these product variants are already owned by another App. */ + | "PRODUCT_EXPANDER_APP_OWNERSHIP_ALREADY_EXISTS" + /** Some of the provided product variants are not components of the specified parent product variant. */ + | "PRODUCT_VARIANTS_NOT_COMPONENTS" + /** The product variants were not found. */ + | "PRODUCT_VARIANTS_NOT_FOUND" + /** A Core type relationship cannot be added to a composite product variant with SFN type relationships. */ + | "PRODUCT_VARIANT_RELATIONSHIP_TYPE_CONFLICT" + /** Unexpected error. */ + | "UNEXPECTED_ERROR" + /** Multipack bundles are not supported. */ + | "UNSUPPORTED_MULTIPACK_RELATIONSHIP" + /** A price must be provided for a parent product variant if the price calucation is set to fixed. */ + | "UPDATE_PARENT_VARIANT_PRICE_REQUIRED"; + +/** The input fields for updating a composite product variant. */ +export type ProductVariantRelationshipUpdateInput = { + /** A product ID which contains product variants that have relationships with other variants. */ + parentProductId?: InputMaybe; + /** The product variant ID representing that which contains the relationships with other variants. */ + parentProductVariantId?: InputMaybe; + /** Method in which to update the price of the parent product variant. */ + priceInput?: InputMaybe; + /** The product variants and associated quantitites to add to the product variant. */ + productVariantRelationshipsToCreate?: InputMaybe< + Array + >; + /** The bundle component product variants to be removed from the product variant. */ + productVariantRelationshipsToRemove?: InputMaybe< + Array + >; + /** The product variants and associated quantitites to update in specified product variant. */ + productVariantRelationshipsToUpdate?: InputMaybe< + Array + >; + /** Whether to remove all components from the product variant. The default value is `false`. */ + removeAllProductVariantRelationships?: InputMaybe< + Scalars["Boolean"]["input"] + >; +}; + +/** The set of valid sort keys for the ProductVariant query. */ +export type ProductVariantSortKeys = + /** Sort by the `full_title` value. */ + | "FULL_TITLE" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by available inventory quantity in the location specified by the `query:"location_id:"` argument. + * Don't use this sort key when no `location_id` in query is specified. + */ + | "INVENTORY_LEVELS_AVAILABLE" + /** Sort by the `inventory_management` value. */ + | "INVENTORY_MANAGEMENT" + /** Sort by the `inventory_policy` value. */ + | "INVENTORY_POLICY" + /** Sort by the `inventory_quantity` value. */ + | "INVENTORY_QUANTITY" + /** Sort by the `name` value. */ + | "NAME" + /** Sort by the `popular` value. */ + | "POPULAR" + /** Sort by the `position` value. */ + | "POSITION" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `sku` value. */ + | "SKU" + /** Sort by the `title` value. */ + | "TITLE"; + +/** Return type for `productVariantUpdate` mutation. */ +export type ProductVariantUpdatePayload = { + /** The product associated with the variant. */ + product?: Maybe; + /** The updated variant. */ + productVariant?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `productVariantsBulkCreate` mutation. */ +export type ProductVariantsBulkCreatePayload = { + /** The updated product object. */ + product?: Maybe; + /** The newly created variants. */ + productVariants?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed product variant bulk create mutations. */ +export type ProductVariantsBulkCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductVariantsBulkCreateUserError`. */ +export type ProductVariantsBulkCreateUserErrorCode = + /** Variant price must be greater than or equal to zero. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Invalid input detected. */ + | "INVALID" + /** Input must be for this product. */ + | "MUST_BE_FOR_THIS_PRODUCT" + /** Variant options are not enough. */ + | "NEED_TO_ADD_OPTION_VALUES" + /** Price cannot take a negative value. */ + | "NEGATIVE_PRICE_VALUE" + /** Input is not defined for this shop. */ + | "NOT_DEFINED_FOR_SHOP" + /** On create, this key cannot be used. */ + | "NO_KEY_ON_CREATE" + /** Variant options are more than the product options. */ + | "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST" + /** You reached the limit of available SKUs in your current plan. */ + | "SUBSCRIPTION_VIOLATION" + /** Inventory locations cannot exceed the allowed resource limit or 10. */ + | "TOO_MANY_INVENTORY_LOCATIONS" + /** Quantity could not be set. The location was not found. */ + | "TRACKED_VARIANT_LOCATION_NOT_FOUND" + /** Variant already exists. */ + | "VARIANT_ALREADY_EXISTS" + /** Variant options already exist. Please change the variant option(s). */ + | "VARIANT_ALREADY_EXISTS_CHANGE_OPTION_VALUE"; + +/** Return type for `productVariantsBulkDelete` mutation. */ +export type ProductVariantsBulkDeletePayload = { + /** The updated product object. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed bulk variant delete mutations. */ +export type ProductVariantsBulkDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductVariantsBulkDeleteUserError`. */ +export type ProductVariantsBulkDeleteUserErrorCode = + /** The variant does not exist. */ + | "AT_LEAST_ONE_VARIANT_DOES_NOT_BELONG_TO_THE_PRODUCT" + /** Cannot delete default variant. */ + | "CANNOT_DELETE_LAST_VARIANT" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST"; + +/** The input fields for specifying a product variant to create as part of a variant bulk mutation. */ +export type ProductVariantsBulkInput = { + /** The value of the barcode associated with the product variant. */ + barcode?: InputMaybe; + /** The compare-at price of the variant. */ + compareAtPrice?: InputMaybe; + /** The Harmonized System code (or HS Tariff code) for the variant. */ + harmonizedSystemCode?: InputMaybe; + /** Specifies the product variant to update or delete. */ + id?: InputMaybe; + /** The inventory item associated with the variant, used for unit cost. */ + inventoryItem?: InputMaybe; + /** Whether customers are allowed to place an order for the variant when it's out of stock. */ + inventoryPolicy?: InputMaybe; + /** + * The inventory quantities at each location where the variant is stocked. The number of elements + * in the array of inventory quantities can't exceed the amount specified for the plan. + */ + inventoryQuantities?: InputMaybe>; + /** The ID of the media that's associated with the variant. */ + mediaId?: InputMaybe; + /** The URL of the media to associate with the variant. */ + mediaSrc?: InputMaybe>; + /** The additional customizable information about the product variant. */ + metafields?: InputMaybe>; + /** The custom properties that a shop owner uses to define product variants. */ + options?: InputMaybe>; + /** The price of the variant. */ + price?: InputMaybe; + /** Whether the variant requires shipping. */ + requiresShipping?: InputMaybe; + /** The SKU for the variant. */ + sku?: InputMaybe; + /** The tax code associated with the variant. */ + taxCode?: InputMaybe; + /** Whether the variant is taxable. */ + taxable?: InputMaybe; + /** The weight of the variant. */ + weight?: InputMaybe; + /** The unit of weight that's used to measure the variant. */ + weightUnit?: InputMaybe; +}; + +/** Return type for `productVariantsBulkReorder` mutation. */ +export type ProductVariantsBulkReorderPayload = { + /** The updated product. */ + product?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed bulk product variants reorder operation. */ +export type ProductVariantsBulkReorderUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductVariantsBulkReorderUserError`. */ +export type ProductVariantsBulkReorderUserErrorCode = + /** Product variant IDs must be unique. */ + | "DUPLICATED_VARIANT_ID" + /** Product variant position cannot be zero or negative number. */ + | "INVALID_POSITION" + /** Product variant does not exist. */ + | "MISSING_VARIANT" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST"; + +/** Return type for `productVariantsBulkUpdate` mutation. */ +export type ProductVariantsBulkUpdatePayload = { + /** The updated product object. */ + product?: Maybe; + /** The updated variants. */ + productVariants?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Error codes for failed variant bulk update mutations. */ +export type ProductVariantsBulkUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ProductVariantsBulkUpdateUserError`. */ +export type ProductVariantsBulkUpdateUserErrorCode = + /** The price of the variant must be greater than or equal to zero. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Variant options are not enough. */ + | "NEED_TO_ADD_OPTION_VALUES" + /** Price cannot take a negative value. */ + | "NEGATIVE_PRICE_VALUE" + /** Inventory quantities cannot be provided during update. */ + | "NO_INVENTORY_QUANTITES_DURING_UPDATE" + /** Inventory quantities cannot be updated with variants API. */ + | "NO_INVENTORY_QUANTITIES_ON_VARIANTS_UPDATE" + /** Variant options are more than the product options. */ + | "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST" + /** Product variant does not exist. */ + | "PRODUCT_VARIANT_DOES_NOT_EXIST" + /** Product variant is missing ID attribute. */ + | "PRODUCT_VARIANT_ID_MISSING" + /** You reached the limit of available SKUs in your current plan. */ + | "SUBSCRIPTION_VIOLATION" + /** The variant already exists. */ + | "VARIANT_ALREADY_EXISTS"; + +/** The set of valid sort keys for the ProfileItem query. */ +export type ProfileItemSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `inventory_total` value. */ + | "INVENTORY_TOTAL" + /** Sort by the `product_type` value. */ + | "PRODUCT_TYPE" + /** Sort by the `published_at` value. */ + | "PUBLISHED_AT" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `title` value. */ + | "TITLE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT" + /** Sort by the `vendor` value. */ + | "VENDOR"; + +/** Return type for `pubSubServerPixelUpdate` mutation. */ +export type PubSubServerPixelUpdatePayload = { + /** The server pixel as configured by the mutation. */ + serverPixel?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `pubSubWebhookSubscriptionCreate` mutation. */ +export type PubSubWebhookSubscriptionCreatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was created. */ + webhookSubscription?: Maybe; +}; + +/** An error that occurs during the execution of `PubSubWebhookSubscriptionCreate`. */ +export type PubSubWebhookSubscriptionCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PubSubWebhookSubscriptionCreateUserError`. */ +export type PubSubWebhookSubscriptionCreateUserErrorCode = + /** Invalid parameters provided. */ + "INVALID_PARAMETERS"; + +/** + * The input fields for a PubSub webhook subscription. + */ +export type PubSubWebhookSubscriptionInput = { + /** The format in which the webhook subscription should send the data. */ + format?: InputMaybe; + /** The list of fields to be included in the webhook subscription. */ + includeFields?: InputMaybe>; + /** The list of namespaces for any metafields that should be included in the webhook subscription. */ + metafieldNamespaces?: InputMaybe>; + /** The Pub/Sub project ID. */ + pubSubProject: Scalars["String"]["input"]; + /** The Pub/Sub topic ID. */ + pubSubTopic: Scalars["String"]["input"]; +}; + +/** Return type for `pubSubWebhookSubscriptionUpdate` mutation. */ +export type PubSubWebhookSubscriptionUpdatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was updated. */ + webhookSubscription?: Maybe; +}; + +/** An error that occurs during the execution of `PubSubWebhookSubscriptionUpdate`. */ +export type PubSubWebhookSubscriptionUpdateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PubSubWebhookSubscriptionUpdateUserError`. */ +export type PubSubWebhookSubscriptionUpdateUserErrorCode = + /** Invalid parameters provided. */ + "INVALID_PARAMETERS"; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type Publication = Node & { + /** + * The app associated with the publication. + * @deprecated Use [AppCatalog.apps](https://shopify.dev/api/admin-graphql/unstable/objects/AppCatalog#connection-appcatalog-apps) instead. + */ + app: App; + /** Whether new products are automatically published to this publication. */ + autoPublish: Scalars["Boolean"]["output"]; + /** The catalog associated with the publication. */ + catalog?: Maybe; + /** The collection publications for the list of collections published to the publication. */ + collectionPublicationsV3: ResourcePublicationConnection; + /** The list of collections published to the publication. */ + collections: CollectionConnection; + /** Whether the collection is available to the publication. */ + hasCollection: Scalars["Boolean"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * Name of the publication. + * @deprecated Use [Catalog.title](https://shopify.dev/api/admin-graphql/unstable/interfaces/Catalog#field-catalog-title) instead. + */ + name: Scalars["String"]["output"]; + /** A background operation associated with this publication. */ + operation?: Maybe; + /** The product publications for the list of products published to the publication. */ + productPublicationsV3: ResourcePublicationConnection; + /** The list of products published to the publication. */ + products: ProductConnection; + /** Whether the publication supports future publishing. */ + supportsFuturePublishing: Scalars["Boolean"]["output"]; +}; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type PublicationCollectionPublicationsV3Args = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type PublicationCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type PublicationHasCollectionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type PublicationProductPublicationsV3Args = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A publication is a group of products and collections that is published to an app. + */ +export type PublicationProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Publications. + */ +export type PublicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PublicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields for creating a publication. */ +export type PublicationCreateInput = { + /** Whether to automatically add newly created products to this publication. */ + autoPublish?: InputMaybe; + /** The ID of the catalog. */ + catalogId?: InputMaybe; + /** Whether to create an empty publication or prepopulate it with all products. */ + defaultState?: InputMaybe; +}; + +/** The input fields for the possible values for the default state of a publication. */ +export type PublicationCreateInputPublicationDefaultState = + /** The publication is populated with all products. */ + | "ALL_PRODUCTS" + /** The publication is empty. */ + | "EMPTY"; + +/** Return type for `publicationCreate` mutation. */ +export type PublicationCreatePayload = { + /** The publication that's been created. */ + publication?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `publicationDelete` mutation. */ +export type PublicationDeletePayload = { + /** The ID of the publication that was deleted. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Publication and a cursor during pagination. + */ +export type PublicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of PublicationEdge. */ + node: Publication; +}; + +/** The input fields required to publish a resource. */ +export type PublicationInput = { + /** ID of the publication. */ + publicationId?: InputMaybe; + /** + * The date and time that the resource was published. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing. This field has no effect if you include it in the `publishableUnpublish` mutation. + */ + publishDate?: InputMaybe; +}; + +/** The possible types of publication operations. */ +export type PublicationOperation = + | AddAllProductsOperation + | CatalogCsvOperation + | PublicationResourceOperation; + +/** A bulk update operation on a publication. */ +export type PublicationResourceOperation = Node & ResourceOperation & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The count of processed rows, summing imported, failed, and skipped rows. */ + processedRowCount?: Maybe; + /** Represents a rows objects within this background operation. */ + rowCount?: Maybe; + /** The status of this operation. */ + status: ResourceOperationStatus; +}; + +/** The input fields for updating a publication. */ +export type PublicationUpdateInput = { + /** Whether new products should be automatically published to the publication. */ + autoPublish?: InputMaybe; + /** A list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50. */ + publishablesToAdd?: InputMaybe>; + /** A list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50. */ + publishablesToRemove?: InputMaybe>; +}; + +/** Return type for `publicationUpdate` mutation. */ +export type PublicationUpdatePayload = { + /** The publication that's been updated. */ + publication?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Defines errors encountered while managing a publication. + */ +export type PublicationUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `PublicationUserError`. */ +export type PublicationUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Cannot modify a catalog for an app. */ + | "CANNOT_MODIFY_APP_CATALOG" + /** Can't modify a publication that belongs to an app catalog. */ + | "CANNOT_MODIFY_APP_CATALOG_PUBLICATION" + /** Cannot modify a catalog for a market. */ + | "CANNOT_MODIFY_MARKET_CATALOG" + /** Can't modify a publication that belongs to a market catalog. */ + | "CANNOT_MODIFY_MARKET_CATALOG_PUBLICATION" + /** Catalog does not exist. */ + | "CATALOG_NOT_FOUND" + /** The input value is invalid. */ + | "INVALID" + /** Publishable ID not found. */ + | "INVALID_PUBLISHABLE_ID" + /** Market does not exist. */ + | "MARKET_NOT_FOUND" + /** A product publication cannot be created because the catalog type associated with this publication does not permit publications of this product type. */ + | "PRODUCT_TYPE_INCOMPATIBLE_WITH_CATALOG_TYPE" + /** The publication is currently being modified. Please try again later. */ + | "PUBLICATION_LOCKED" + /** Publication not found. */ + | "PUBLICATION_NOT_FOUND" + /** The limit for simultaneous publication updates has been exceeded. */ + | "PUBLICATION_UPDATE_LIMIT_EXCEEDED" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** Can't perform this action on a publication. */ + | "UNSUPPORTED_PUBLICATION_ACTION" + /** A catalog publication can only contain products. */ + | "UNSUPPORTED_PUBLISHABLE_TYPE"; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type Publishable = { + /** The number of publications a resource is published to without feedback errors. */ + availablePublicationCount: Scalars["Int"]["output"]; + /** The number of publications a resource is published on. */ + publicationCount: Scalars["Int"]["output"]; + /** + * Check to see whether the resource is published to a given channel. + * @deprecated Use `publishedOnPublication` instead. + */ + publishedOnChannel: Scalars["Boolean"]["output"]; + /** + * Check to see whether the resource is published to the calling app's channel. + * @deprecated Use `publishedOnCurrentPublication` instead. + */ + publishedOnCurrentChannel: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to the calling app's publication. */ + publishedOnCurrentPublication: Scalars["Boolean"]["output"]; + /** Check to see whether the resource is published to a given publication. */ + publishedOnPublication: Scalars["Boolean"]["output"]; + /** The list of resources that are published to a publication. */ + resourcePublications: ResourcePublicationConnection; + /** The list of resources that are either published or staged to be published to a publication. */ + resourcePublicationsV2: ResourcePublicationV2Connection; + /** + * The list of channels that the resource is not published to. + * @deprecated Use `unpublishedPublications` instead. + */ + unpublishedChannels: ChannelConnection; + /** The list of publications that the resource is not published to. */ + unpublishedPublications: PublicationConnection; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishablePublicationCountArgs = { + onlyPublished?: InputMaybe; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishablePublishedOnChannelArgs = { + channelId: Scalars["ID"]["input"]; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishablePublishedOnPublicationArgs = { + publicationId: Scalars["ID"]["input"]; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishableResourcePublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishableResourcePublicationsV2Args = { + after?: InputMaybe; + before?: InputMaybe; + catalogType?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + onlyPublished?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishableUnpublishedChannelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a resource that can be published to a channel. + * A publishable resource can be either a Product or Collection. + */ +export type PublishableUnpublishedPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `publishablePublish` mutation. */ +export type PublishablePublishPayload = { + /** Resource that has been published. */ + publishable?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `publishablePublishToCurrentChannel` mutation. */ +export type PublishablePublishToCurrentChannelPayload = { + /** Resource that has been published. */ + publishable?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `publishableUnpublish` mutation. */ +export type PublishableUnpublishPayload = { + /** Resource that has been unpublished. */ + publishable?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `publishableUnpublishToCurrentChannel` mutation. */ +export type PublishableUnpublishToCurrentChannelPayload = { + /** Resource that has been unpublished. */ + publishable?: Maybe; + /** The user's shop. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents information about the purchasing company for the order or draft order. + */ +export type PurchasingCompany = { + /** The company associated to the order or draft order. */ + company: Company; + /** The company contact associated to the order or draft order. */ + contact?: Maybe; + /** The company location associated to the order or draft order. */ + location: CompanyLocation; +}; + +/** + * The input fields for a purchasing company, which is a combination of company, company contact, and company location. + */ +export type PurchasingCompanyInput = { + /** ID of the company contact. */ + companyContactId: Scalars["ID"]["input"]; + /** ID of the company. */ + companyId: Scalars["ID"]["input"]; + /** ID of the company location. */ + companyLocationId: Scalars["ID"]["input"]; +}; + +/** + * Represents information about the purchasing entity for the order or draft order. + */ +export type PurchasingEntity = Customer | PurchasingCompany; + +/** The input fields for a purchasing entity. Can either be a customer or a purchasing company. */ +export type PurchasingEntityInput = { + /** Represents a customer. Null if there's a purchasing company. */ + customerId?: InputMaybe; + /** Represents a purchasing company. Null if there's a customer. */ + purchasingCompany?: InputMaybe; +}; + +/** + * The quantity rule for the product variant in a given context. + */ +export type QuantityRule = { + /** + * The value that specifies the quantity increment between minimum and maximum of the rule. + * Only quantities divisible by this value will be considered valid. + * + * The increment must be lower than or equal to the minimum and the maximum, and both minimum and maximum + * must be divisible by this value. + */ + increment: Scalars["Int"]["output"]; + /** Whether the quantity rule fields match one increment, one minimum and no maximum. */ + isDefault: Scalars["Boolean"]["output"]; + /** + * An optional value that defines the highest allowed quantity purchased by the customer. + * If defined, maximum must be lower than or equal to the minimum and must be a multiple of the increment. + */ + maximum?: Maybe; + /** + * The value that defines the lowest allowed quantity purchased by the customer. + * The minimum must be a multiple of the quantity rule's increment. + */ + minimum: Scalars["Int"]["output"]; + /** Whether the values of the quantity rule were explicitly set. */ + originType: QuantityRuleOriginType; + /** The product variant for which the quantity rule is applied. */ + productVariant: ProductVariant; +}; + +/** + * An auto-generated type for paginating through multiple QuantityRules. + */ +export type QuantityRuleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in QuantityRuleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** The total count of QuantityRules. Note: The maximum count limit is 10000. */ + totalCount: Scalars["UnsignedInt64"]["output"]; +}; + +/** + * An auto-generated type which holds one QuantityRule and a cursor during pagination. + */ +export type QuantityRuleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of QuantityRuleEdge. */ + node: QuantityRule; +}; + +/** + * The input fields for the per-order quantity rule to be applied on the product variant. + */ +export type QuantityRuleInput = { + /** The quantity increment. */ + increment: Scalars["Int"]["input"]; + /** The maximum quantity. */ + maximum?: InputMaybe; + /** The minimum quantity. */ + minimum: Scalars["Int"]["input"]; + /** Product variant on which to apply the quantity rule. */ + variantId: Scalars["ID"]["input"]; +}; + +/** The origin of quantity rule on a price list. */ +export type QuantityRuleOriginType = + /** Quantity rule is explicitly defined. */ + | "FIXED" + /** Quantity rule falls back to the relative rule. */ + | "RELATIVE"; + +/** + * An error for a failed quantity rule operation. + */ +export type QuantityRuleUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `QuantityRuleUserError`. */ +export type QuantityRuleUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Quantity rules can be associated only with company location catalogs. */ + | "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES" + /** Something went wrong when trying to save the quantity rule. Please try again later. */ + | "GENERIC_ERROR" + /** Value must be greater than or equal to 1. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Increment must be lower than or equal to the minimum. */ + | "INCREMENT_IS_GREATER_THAN_MINIMUM" + /** The maximum must be a multiple of the increment. */ + | "MAXIMUM_NOT_MULTIPLE_OF_INCREMENT" + /** Minimum must be lower than or equal to the maximum. */ + | "MINIMUM_IS_GREATER_THAN_MAXIMUM" + /** The minimum must be a multiple of the increment. */ + | "MINIMUM_NOT_MULTIPLE_OF_INCREMENT" + /** Price list does not exist. */ + | "PRICE_LIST_DOES_NOT_EXIST" + /** Product variant ID does not exist. */ + | "PRODUCT_VARIANT_DOES_NOT_EXIST" + /** Quantity rule for variant associated with the price list provided does not exist. */ + | "VARIANT_QUANTITY_RULE_DOES_NOT_EXIST"; + +/** Return type for `quantityRulesAdd` mutation. */ +export type QuantityRulesAddPayload = { + /** The list of quantity rules that were added to or updated in the price list. */ + quantityRules?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `quantityRulesDelete` mutation. */ +export type QuantityRulesDeletePayload = { + /** + * A list of product variant IDs whose quantity rules were removed from the price list. + */ + deletedQuantityRulesVariantIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRoot = { + /** Returns an abandonment by ID. */ + abandonment?: Maybe; + /** Returns an Abandonment by the Abandoned Checkout ID. */ + abandonmentByAbandonedCheckoutId?: Maybe; + /** Lookup an App by ID or return the currently authenticated App. */ + app?: Maybe; + /** + * Fetches app by handle. + * Returns null if the app doesn't exist. + */ + appByHandle?: Maybe; + /** + * Fetches an app by its client ID. + * Returns null if the app doesn't exist. + */ + appByKey?: Maybe; + /** + * An app discount type. + */ + appDiscountType?: Maybe; + /** + * A list of app discount types installed by apps. + */ + appDiscountTypes: Array; + /** Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App. */ + appInstallation?: Maybe; + /** List of app installations. Requires the `read_apps` access scope. */ + appInstallations: AppInstallationConnection; + /** + * Returns an automatic discount resource by ID. + * @deprecated Use `automaticDiscountNode` instead. + */ + automaticDiscount?: Maybe; + /** Returns an automatic discount resource by ID. */ + automaticDiscountNode?: Maybe; + /** List of automatic discounts. */ + automaticDiscountNodes: DiscountAutomaticNodeConnection; + /** List of the shop's automatic discount saved searches. */ + automaticDiscountSavedSearches: SavedSearchConnection; + /** + * List of automatic discounts. + * @deprecated Use `automaticDiscountNodes` instead. + */ + automaticDiscounts: DiscountAutomaticConnection; + /** Returns a list of activated carrier services and associated shop locations that support them. */ + availableCarrierServices: Array; + /** A list of available locales. */ + availableLocales: Array; + /** Returns a `DeliveryCarrierService` object by ID. */ + carrierService?: Maybe; + /** List of Cart transform objects owned by the current API client. */ + cartTransforms: CartTransformConnection; + /** Returns a Catalog resource by ID. */ + catalog?: Maybe; + /** Returns the most recent catalog operations for the shop. */ + catalogOperations: Array; + /** The catalogs belonging to the shop. */ + catalogs: CatalogConnection; + /** + * Lookup a channel by ID. + * @deprecated Use `publication` instead. + */ + channel?: Maybe; + /** + * List of the active sales channels. + * @deprecated Use `publications` instead. + */ + channels: ChannelConnection; + /** A checkout profile on a shop. */ + checkoutProfile?: Maybe; + /** List of checkout profiles on a shop. */ + checkoutProfiles: CheckoutProfileConnection; + /** Returns a code discount resource by ID. */ + codeDiscountNode?: Maybe; + /** Returns a code discount identified by its discount code. */ + codeDiscountNodeByCode?: Maybe; + /** + * List of code discounts. Special fields for query params: + * * status: active, expired, scheduled + * * discount_type: bogo, fixed_amount, free_shipping, percentage. + */ + codeDiscountNodes: DiscountCodeNodeConnection; + /** List of the shop's code discount saved searches. */ + codeDiscountSavedSearches: SavedSearchConnection; + /** Returns a Collection resource by ID. */ + collection?: Maybe; + /** + * Return a collection by its handle. + */ + collectionByHandle?: Maybe; + /** Lists all rules that can be used to create smart collections. */ + collectionRulesConditions: Array; + /** Returns a list of the shop's collection saved searches. */ + collectionSavedSearches: SavedSearchConnection; + /** Returns a list of collections. */ + collections: CollectionConnection; + /** Returns the list of companies in the shop. */ + companies: CompanyConnection; + /** Returns a `Company` object by ID. */ + company?: Maybe; + /** Returns a `CompanyContact` object by ID. */ + companyContact?: Maybe; + /** Returns a `CompanyContactRole` object by ID. */ + companyContactRole?: Maybe; + /** The number of companies for a shop. */ + companyCount: Scalars["Int"]["output"]; + /** Returns a `CompanyLocation` object by ID. */ + companyLocation?: Maybe; + /** Returns the list of company locations in the shop. */ + companyLocations: CompanyLocationConnection; + /** Return the AppInstallation for the currently authenticated App. */ + currentAppInstallation: AppInstallation; + /** Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop. */ + currentBulkOperation?: Maybe; + /** Returns a Customer resource by ID. */ + customer?: Maybe; + /** Returns the status of a customer merge request job. */ + customerMergeJobStatus?: Maybe; + /** Returns a preview of a customer merge request. */ + customerMergePreview: CustomerMergePreview; + /** Returns a CustomerPaymentMethod resource by its ID. */ + customerPaymentMethod?: Maybe; + /** The list of members, such as customers, that's associated with an individual segment. */ + customerSegmentMembers: CustomerSegmentMemberConnection; + /** Returns a segment members query resource by ID. */ + customerSegmentMembersQuery?: Maybe; + /** Whether a member, which is a customer, belongs to a segment. */ + customerSegmentMembership: SegmentMembershipResponse; + /** List of customers. */ + customers: CustomerConnection; + /** The paginated list of deletion events. */ + deletionEvents: DeletionEventConnection; + /** The delivery customization. */ + deliveryCustomization?: Maybe; + /** The delivery customizations. */ + deliveryCustomizations: DeliveryCustomizationConnection; + /** Returns a Delivery Profile resource by ID. */ + deliveryProfile?: Maybe; + /** Returns a list of saved delivery profiles. */ + deliveryProfiles: DeliveryProfileConnection; + /** Returns the shop-wide shipping settings. */ + deliverySettings?: Maybe; + /** The total number of discount codes for the shop. */ + discountCodeCount: Scalars["Int"]["output"]; + /** Returns a discount resource by ID. */ + discountNode?: Maybe; + /** List of discounts. */ + discountNodes: DiscountNodeConnection; + /** Returns a bulk code creation resource by ID. */ + discountRedeemCodeBulkCreation?: Maybe; + /** List of the shop's redeemed discount code saved searches. */ + discountRedeemCodeSavedSearches: SavedSearchConnection; + /** Returns dispute details based on ID. */ + dispute?: Maybe; + /** Returns dispute evidence details based on ID. */ + disputeEvidence?: Maybe; + /** Lookup a Domain by ID. */ + domain?: Maybe; + /** Returns a DraftOrder resource by ID. */ + draftOrder?: Maybe; + /** List of the shop's draft order saved searches. */ + draftOrderSavedSearches: SavedSearchConnection; + /** Returns a DraftOrderTag resource by ID. */ + draftOrderTag?: Maybe; + /** List of saved draft orders. */ + draftOrders: DraftOrderConnection; + /** A list of the shop's file saved searches. */ + fileSavedSearches: SavedSearchConnection; + /** Returns a paginated list of files that have been uploaded to Shopify. */ + files: FileConnection; + /** Returns a Fulfillment resource by ID. */ + fulfillment?: Maybe; + /** Returns a Fulfillment order resource by ID. */ + fulfillmentOrder?: Maybe; + /** + * The paginated list of all fulfillment orders. + * The returned fulfillment orders are filtered according to the + * [fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes) + * granted to the app. + * + * Use this query to retrieve fulfillment orders assigned to merchant-managed locations, + * third-party fulfillment service locations, or all kinds of locations together. + * + * For fetching only the fulfillment orders assigned to the app's locations, use the + * [Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders) + * connection. + */ + fulfillmentOrders: FulfillmentOrderConnection; + /** Returns a FulfillmentService resource by ID. */ + fulfillmentService?: Maybe; + /** Returns a gift card resource by ID. */ + giftCard?: Maybe; + /** Returns a list of gift cards. */ + giftCards: GiftCardConnection; + /** The total number of gift cards issued for the shop. */ + giftCardsCount: Scalars["UnsignedInt64"]["output"]; + /** Returns an `InventoryItem` object by ID. */ + inventoryItem?: Maybe; + /** Returns a list of inventory items. */ + inventoryItems: InventoryItemConnection; + /** Returns an `InventoryLevel` object by ID. */ + inventoryLevel?: Maybe; + /** General inventory properties for the shop. */ + inventoryProperties: InventoryProperties; + /** + * Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes. + */ + job?: Maybe; + /** Returns an inventory Location resource by ID. */ + location?: Maybe; + /** Returns a list of active inventory locations. */ + locations: LocationConnection; + /** + * Returns a list of all origin locations available for a delivery profile. + * @deprecated Use `locationsAvailableForDeliveryProfilesConnection` instead. + */ + locationsAvailableForDeliveryProfiles?: Maybe>; + /** Returns a list of all origin locations available for a delivery profile. */ + locationsAvailableForDeliveryProfilesConnection: LocationConnection; + /** Returns a list of fulfillment orders that are on hold. */ + manualHoldsFulfillmentOrders: FulfillmentOrderConnection; + /** Returns a market resource by ID. */ + market?: Maybe; + /** Returns the applicable market for a customer based on where they are in the world. */ + marketByGeography?: Maybe; + /** A resource that can have localized values for different markets. */ + marketLocalizableResource?: Maybe; + /** Resources that can have localized values for different markets. */ + marketLocalizableResources: MarketLocalizableResourceConnection; + /** Resources that can have localized values for different markets. */ + marketLocalizableResourcesByIds: MarketLocalizableResourceConnection; + /** A list of marketing activities associated with the marketing app. */ + marketingActivities: MarketingActivityConnection; + /** Returns a MarketingActivity resource by ID. */ + marketingActivity?: Maybe; + /** Returns a MarketingEvent resource by ID. */ + marketingEvent?: Maybe; + /** A list of marketing events associated with the marketing app. */ + marketingEvents: MarketingEventConnection; + /** The markets configured for the shop. */ + markets: MarketConnection; + /** Returns a metafield by ID. */ + metafield?: Maybe; + /** Returns a metafield definition by ID. */ + metafieldDefinition?: Maybe; + /** + * Each metafield definition has a type, which defines the type of information that it can store. + * This type is enforced across every instance of the resource that owns the metafield definition. + * + * Refer to the [list of supported metafield types](https://shopify.dev/apps/metafields/types). + */ + metafieldDefinitionTypes: Array; + /** List of metafield definitions. */ + metafieldDefinitions: MetafieldDefinitionConnection; + /** List of the `MetafieldStorefrontVisibility` records. */ + metafieldStorefrontVisibilities: MetafieldStorefrontVisibilityConnection; + /** + * Returns a `MetafieldStorefrontVisibility` record by ID. A `MetafieldStorefrontVisibility` record lists the + * metafields to make visible in the Storefront API. + */ + metafieldStorefrontVisibility?: Maybe; + /** Retrieves a metaobject by ID. */ + metaobject?: Maybe; + /** Retrieves a metaobject by handle. */ + metaobjectByHandle?: Maybe; + /** Retrieves a metaobject definition by ID. */ + metaobjectDefinition?: Maybe; + /** Finds a metaobject definition by type. */ + metaobjectDefinitionByType?: Maybe; + /** All metaobject definitions. */ + metaobjectDefinitions: MetaobjectDefinitionConnection; + /** All metaobjects for the shop. */ + metaobjects: MetaobjectConnection; + /** + * Returns a specific node (any object that implements the + * [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) + * interface) by ID, in accordance with the + * [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification). + * This field is commonly used for refetching an object. + */ + node?: Maybe; + /** + * Returns the list of nodes (any objects that implement the + * [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) + * interface) with the given IDs, in accordance with the + * [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification). + */ + nodes: Array>; + /** Returns an Order resource by ID. */ + order?: Maybe; + /** Returns a payment status by payment reference ID. Used to check the status of a deferred payment. */ + orderPaymentStatus?: Maybe; + /** List of the shop's order saved searches. */ + orderSavedSearches: SavedSearchConnection; + /** Returns a list of orders placed. */ + orders: OrderConnection; + /** The payment customization. */ + paymentCustomization?: Maybe; + /** The payment customizations. */ + paymentCustomizations: PaymentCustomizationConnection; + /** The list of payment terms templates eligible for all shops and users. */ + paymentTermsTemplates: Array; + /** Returns a price list resource by ID. */ + priceList?: Maybe; + /** All price lists for a shop. */ + priceLists: PriceListConnection; + /** + * Returns a code price rule resource by ID. + * @deprecated Use `codeDiscountNode` instead. + */ + priceRule?: Maybe; + /** List of the shop's price rule saved searches. */ + priceRuleSavedSearches: SavedSearchConnection; + /** + * Returns a list of price rule resources that have at least one associated discount code. + * @deprecated Use `codeDiscountNodes` instead. + */ + priceRules: PriceRuleConnection; + /** The primary market of the shop. */ + primaryMarket: Market; + /** + * Returns a private metafield by ID. + * Private metafields are accessible only by the application that created them. + * + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * Returns a list of private metafields associated to a resource. + * + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** Returns a Product resource by ID. */ + product?: Maybe; + /** + * Return a product by its handle. + */ + productByHandle?: Maybe; + /** Returns the product duplicate job. */ + productDuplicateJob: ProductDuplicateJob; + /** Returns a ProductFeed resource by ID. */ + productFeed?: Maybe; + /** The product feeds for the shop. */ + productFeeds: ProductFeedConnection; + /** + * Returns the product resource feedback for the currently authenticated app. + */ + productResourceFeedback?: Maybe; + /** Returns a list of the shop's product saved searches. */ + productSavedSearches: SavedSearchConnection; + /** Returns a ProductVariant resource by ID. */ + productVariant?: Maybe; + /** List of the product variants. */ + productVariants: ProductVariantConnection; + /** List of products. */ + products: ProductConnection; + /** The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions. */ + publicApiVersions: Array; + /** + * Lookup a publication by ID. + */ + publication?: Maybe; + /** List of publications. */ + publications: PublicationConnection; + /** Returns a Refund resource by ID. */ + refund?: Maybe; + /** Returns a Return resource by ID. */ + return?: Maybe; + /** Lookup a returnable fulfillment by ID. */ + returnableFulfillment?: Maybe; + /** List of returnable fulfillments. */ + returnableFulfillments: ReturnableFulfillmentConnection; + /** Lookup a reverse delivery by ID. */ + reverseDelivery?: Maybe; + /** Lookup a reverse fulfillment order by ID. */ + reverseFulfillmentOrder?: Maybe; + /** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * Lookup a script tag resource by ID. + */ + scriptTag?: Maybe; + /** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * A list of script tags. + */ + scriptTags: ScriptTagConnection; + /** The Customer Segment. */ + segment?: Maybe; + /** The number of segments for a shop. */ + segmentCount: Scalars["Int"]["output"]; + /** A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria. */ + segmentFilterSuggestions: SegmentFilterConnection; + /** A list of filters. */ + segmentFilters: SegmentFilterConnection; + /** A list of a shop's segment migrations. */ + segmentMigrations: SegmentMigrationConnection; + /** The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria. */ + segmentValueSuggestions: SegmentValueConnection; + /** A list of a shop's segments. */ + segments: SegmentConnection; + /** Returns a Selling Plan Group resource by ID. */ + sellingPlanGroup?: Maybe; + /** List Selling Plan Groups. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** The server pixel configured by the app. */ + serverPixel?: Maybe; + /** + * Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains + * business and store management settings for the shop. + */ + shop: Shop; + /** The shop's billing preferences. */ + shopBillingPreferences: ShopBillingPreferences; + /** A list of locales available on a shop. */ + shopLocales: Array; + /** The Shopify Function. */ + shopifyFunction?: Maybe; + /** Returns the Shopify Functions for apps installed on the shop. */ + shopifyFunctions: ShopifyFunctionConnection; + /** Shopify Payments account information, including balances and payouts. */ + shopifyPaymentsAccount?: Maybe; + /** Returns the results of a ShopifyQL query. Refer to the [ShopifyQL documentation](https://shopify.dev/api/shopifyql) for more information. */ + shopifyqlQuery?: Maybe; + /** The StaffMember resource, by ID. */ + staffMember?: Maybe; + /** + * Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved. + * + * Refer to all available [`Standard Metafield Definition Templates`](https://shopify.dev/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate). + */ + standardMetafieldDefinitionTemplates: + StandardMetafieldDefinitionTemplateConnection; + /** Returns a SubscriptionBillingAttempt by ID. */ + subscriptionBillingAttempt?: Maybe; + /** Returns subscription billing attempts on a store. */ + subscriptionBillingAttempts: SubscriptionBillingAttemptConnection; + /** Returns a subscription billing cycle found either by cycle index or date. */ + subscriptionBillingCycle?: Maybe; + /** Returns subscription billing cycles for a contract ID. */ + subscriptionBillingCycles: SubscriptionBillingCycleConnection; + /** Returns a Subscription Contract resource by ID. */ + subscriptionContract?: Maybe; + /** List Subscription Contracts. */ + subscriptionContracts: SubscriptionContractConnection; + /** Returns a Subscription Draft resource by ID. */ + subscriptionDraft?: Maybe; + /** Returns a list of TenderTransactions associated with the shop. */ + tenderTransactions: TenderTransactionConnection; + /** A resource that can have localized values for different languages. */ + translatableResource?: Maybe; + /** Resources that can have localized values for different languages. */ + translatableResources: TranslatableResourceConnection; + /** Resources that can have localized values for different languages. */ + translatableResourcesByIds: TranslatableResourceConnection; + /** Returns a redirect resource by ID. */ + urlRedirect?: Maybe; + /** Returns a redirect import resource by ID. */ + urlRedirectImport?: Maybe; + /** A list of the shop's URL redirect saved searches. */ + urlRedirectSavedSearches: SavedSearchConnection; + /** A list of redirects for a shop. */ + urlRedirects: UrlRedirectConnection; + /** The web pixel configured by the app. */ + webPixel?: Maybe; + /** Returns a webhook subscription by ID. */ + webhookSubscription?: Maybe; + /** Returns a list of webhook subscriptions. */ + webhookSubscriptions: WebhookSubscriptionConnection; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAbandonmentArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAbandonmentByAbandonedCheckoutIdArgs = { + abandonedCheckoutId: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppArgs = { + id?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppByHandleArgs = { + handle: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppByKeyArgs = { + apiKey: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppDiscountTypeArgs = { + functionId: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppInstallationArgs = { + id?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAppInstallationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + category?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + privacy?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAutomaticDiscountArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAutomaticDiscountNodeArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAutomaticDiscountNodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAutomaticDiscountSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootAutomaticDiscountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCarrierServiceArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCartTransformsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCatalogArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCatalogsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootChannelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootChannelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCheckoutProfileArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCheckoutProfilesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCodeDiscountNodeArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCodeDiscountNodeByCodeArgs = { + code: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCodeDiscountNodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCodeDiscountSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionByHandleArgs = { + handle: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompaniesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompanyArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompanyContactArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompanyContactRoleArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompanyLocationArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCompanyLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCurrentBulkOperationArgs = { + type?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerMergeJobStatusArgs = { + jobId: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerMergePreviewArgs = { + customerOneId: Scalars["ID"]["input"]; + customerTwoId: Scalars["ID"]["input"]; + overrideFields?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerPaymentMethodArgs = { + id: Scalars["ID"]["input"]; + showRevoked?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerSegmentMembersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + queryId?: InputMaybe; + reverse?: InputMaybe; + segmentId?: InputMaybe; + sortKey?: InputMaybe; + timezone?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerSegmentMembersQueryArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerSegmentMembershipArgs = { + customerId: Scalars["ID"]["input"]; + segmentIds: Array; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDeletionEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + subjectTypes?: InputMaybe>; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDeliveryCustomizationArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDeliveryCustomizationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDeliveryProfileArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDeliveryProfilesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + merchantOwnedOnly?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDiscountCodeCountArgs = { + query?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDiscountNodeArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDiscountNodesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDiscountRedeemCodeBulkCreationArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDiscountRedeemCodeSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDisputeArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDisputeEvidenceArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDomainArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDraftOrderArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDraftOrderSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDraftOrderTagArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFileSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFilesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFulfillmentArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFulfillmentOrderArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + includeClosed?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootFulfillmentServiceArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootGiftCardArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootGiftCardsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootGiftCardsCountArgs = { + enabled?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootInventoryItemArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootInventoryItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootInventoryLevelArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootJobArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootLocationArgs = { + id?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + includeInactive?: InputMaybe; + includeLegacy?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootLocationsAvailableForDeliveryProfilesConnectionArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootManualHoldsFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketByGeographyArgs = { + countryCode: CountryCode; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketLocalizableResourceArgs = { + resourceId: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketLocalizableResourcesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + resourceType: MarketLocalizableResourceType; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketLocalizableResourcesByIdsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + resourceIds: Array; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketingActivitiesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + marketingActivityIds?: InputMaybe>; + query?: InputMaybe; + remoteIds?: InputMaybe>; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; + utm?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketingActivityArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketingEventArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketingEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMarketsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetafieldArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetafieldDefinitionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetafieldDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + key?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + ownerType: MetafieldOwnerType; + pinnedStatus?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetafieldStorefrontVisibilitiesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetafieldStorefrontVisibilityArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectByHandleArgs = { + handle: MetaobjectHandleInput; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectDefinitionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectDefinitionByTypeArgs = { + type: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectDefinitionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootNodeArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootNodesArgs = { + ids: Array; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootOrderArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootOrderPaymentStatusArgs = { + orderId: Scalars["ID"]["input"]; + paymentReferenceId: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootOrderSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPaymentCustomizationArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPaymentCustomizationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPaymentTermsTemplatesArgs = { + paymentTermsType?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPriceListArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPriceListsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPriceRuleArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPriceRuleSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPriceRulesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPrivateMetafieldArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + owner: Scalars["ID"]["input"]; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductByHandleArgs = { + handle: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductDuplicateJobArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductFeedArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductFeedsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductResourceFeedbackArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductVariantArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPublicationArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPublicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + catalogType?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootRefundArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootReturnArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootReturnableFulfillmentArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootReturnableFulfillmentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + orderId: Scalars["ID"]["input"]; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootReverseDeliveryArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootReverseFulfillmentOrderArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootScriptTagArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootScriptTagsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + src?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentFilterSuggestionsArgs = { + after?: InputMaybe; + first: Scalars["Int"]["input"]; + search: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentFiltersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentMigrationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + savedSearchId?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentValueSuggestionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filterQueryName?: InputMaybe; + first?: InputMaybe; + functionParameterQueryName?: InputMaybe; + last?: InputMaybe; + search: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSegmentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSellingPlanGroupArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSellingPlanGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootShopLocalesArgs = { + published?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootShopifyFunctionArgs = { + id: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootShopifyFunctionsArgs = { + after?: InputMaybe; + apiType?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + useCreationUi?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootShopifyqlQueryArgs = { + query: Scalars["String"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootStaffMemberArgs = { + id?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootStandardMetafieldDefinitionTemplatesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionBillingAttemptArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionBillingAttemptsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionBillingCycleArgs = { + billingCycleInput: SubscriptionBillingCycleInput; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionBillingCyclesArgs = { + after?: InputMaybe; + before?: InputMaybe; + billingCyclesDateRangeSelector?: InputMaybe< + SubscriptionBillingCyclesDateRangeSelector + >; + billingCyclesIndexRangeSelector?: InputMaybe< + SubscriptionBillingCyclesIndexRangeSelector + >; + contractId: Scalars["ID"]["input"]; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionContractArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionContractsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSubscriptionDraftArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootTenderTransactionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootTranslatableResourceArgs = { + resourceId: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootTranslatableResourcesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + resourceType: TranslatableResourceType; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootTranslatableResourcesByIdsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + resourceIds: Array; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectImportArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootWebPixelArgs = { + id?: InputMaybe; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootWebhookSubscriptionArgs = { + id: Scalars["ID"]["input"]; +}; + +/** The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootWebhookSubscriptionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + callbackUrl?: InputMaybe; + first?: InputMaybe; + format?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + topics?: InputMaybe>; +}; + +/** The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. */ +export type Refund = LegacyInteroperability & Node & { + /** The date and time when the refund was created. */ + createdAt?: Maybe; + /** A list of the refunded duties as part of this refund. */ + duties?: Maybe>; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The optional note associated with the refund. */ + note?: Maybe; + /** The order associated with the refund. */ + order: Order; + /** The `RefundLineItem` resources attached to the refund. */ + refundLineItems: RefundLineItemConnection; + /** The return associated with the refund. */ + return?: Maybe; + /** The staff member who created the refund. */ + staffMember?: Maybe; + /** + * The total amount across all transactions for the refund. + * @deprecated Use `totalRefundedSet` instead. + */ + totalRefunded: MoneyV2; + /** The total amount across all transactions for the refund, in shop and presentment currencies. */ + totalRefundedSet: MoneyBag; + /** The transactions associated with the refund. */ + transactions: OrderTransactionConnection; + /** The date and time when the refund was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. */ +export type RefundRefundLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items. */ +export type RefundTransactionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** An agreement between the merchant and customer to refund all or a portion of the order. */ +export type RefundAgreement = SalesAgreement & { + /** The application that created the agreement. */ + app?: Maybe; + /** The date and time at which the agreement occured. */ + happenedAt: Scalars["DateTime"]["output"]; + /** The unique ID for the agreement. */ + id: Scalars["ID"]["output"]; + /** The reason the agremeent was created. */ + reason: OrderActionType; + /** The refund associated with the agreement. */ + refund: Refund; + /** The sales associated with the agreement. */ + sales: SaleConnection; + /** The staff member associated with the agreement. */ + user?: Maybe; +}; + +/** An agreement between the merchant and customer to refund all or a portion of the order. */ +export type RefundAgreementSalesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Refunds. + */ +export type RefundConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in RefundEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `refundCreate` mutation. */ +export type RefundCreatePayload = { + /** The order associated with the created refund. */ + order?: Maybe; + /** The created refund. */ + refund?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a refunded duty. */ +export type RefundDuty = { + /** The amount of a refunded duty in shop and presentment currencies. */ + amountSet: MoneyBag; + /** The duty associated with this refunded duty. */ + originalDuty?: Maybe; +}; + +/** The input fields required to reimburse duties on a refund. */ +export type RefundDutyInput = { + /** The ID of the duty in the refund. */ + dutyId: Scalars["ID"]["input"]; + /** The type of refund for this duty. */ + refundType?: InputMaybe; +}; + +/** The type of refund to perform for a particular refund duty. */ +export type RefundDutyRefundType = + /** The duty is fully refunded. */ + | "FULL" + /** The duty is proportionally refunded based on the quantity of the refunded line item. */ + | "PROPORTIONAL"; + +/** + * An auto-generated type which holds one Refund and a cursor during pagination. + */ +export type RefundEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of RefundEdge. */ + node: Refund; +}; + +/** The input fields to create a refund. */ +export type RefundInput = { + /** The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ. */ + currency?: InputMaybe; + /** An optional note that's attached to the refund. */ + note?: InputMaybe; + /** Whether to send a refund notification to the customer. */ + notify?: InputMaybe; + /** The ID of the order that's being refunded. */ + orderId: Scalars["ID"]["input"]; + /** A list of duties to refund. */ + refundDuties?: InputMaybe>; + /** A list of line items to refund. */ + refundLineItems?: InputMaybe>; + /** The input fields that are required to reimburse shipping costs. */ + shipping?: InputMaybe; + /** A list of transactions involved in the refund. */ + transactions?: InputMaybe>; +}; + +/** A line item that's included in a refund. */ +export type RefundLineItem = { + /** The `LineItem` resource associated to the refunded line item. */ + lineItem: LineItem; + /** The inventory restock location. */ + location?: Maybe; + /** + * The price of a refunded line item. + * @deprecated Use `priceSet` instead. + */ + price: Scalars["Money"]["output"]; + /** The price of a refunded line item in shop and presentment currencies. */ + priceSet: MoneyBag; + /** The quantity of a refunded line item. */ + quantity: Scalars["Int"]["output"]; + /** The type of restock for the refunded line item. */ + restockType: RefundLineItemRestockType; + /** Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund. */ + restocked: Scalars["Boolean"]["output"]; + /** + * The subtotal price of a refunded line item. + * @deprecated Use `subtotalSet` instead. + */ + subtotal: Scalars["Money"]["output"]; + /** The subtotal price of a refunded line item in shop and presentment currencies. */ + subtotalSet: MoneyBag; + /** + * The total tax charged on a refunded line item. + * @deprecated Use `totalTaxSet` instead. + */ + totalTax: Scalars["Money"]["output"]; + /** The total tax charged on a refunded line item in shop and presentment currencies. */ + totalTaxSet: MoneyBag; +}; + +/** + * An auto-generated type for paginating through multiple RefundLineItems. + */ +export type RefundLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in RefundLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one RefundLineItem and a cursor during pagination. + */ +export type RefundLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of RefundLineItemEdge. */ + node: RefundLineItem; +}; + +/** The input fields required to reimburse line items on a refund. */ +export type RefundLineItemInput = { + /** The ID of the line item in the refund. */ + lineItemId: Scalars["ID"]["input"]; + /** The intended location for restocking. If the `restockType` is set to `NO_RESTOCK`, then this value is empty.` */ + locationId?: InputMaybe; + /** The quantity of the associated line item to be refunded. */ + quantity: Scalars["Int"]["input"]; + /** The type of restock for this line item. */ + restockType?: InputMaybe; +}; + +/** The type of restock performed for a particular refund line item. */ +export type RefundLineItemRestockType = + /** The refund line item was canceled. Use this when restocking unfulfilled line items. */ + | "CANCEL" + /** Deprecated. The refund line item was restocked, without specifically beingidentified as a return or cancelation. This value is not accepted when creating new refunds. */ + | "LEGACY_RESTOCK" + /** Refund line item was not restocked. */ + | "NO_RESTOCK" + /** The refund line item was returned. Use this when restocking line items that were fulfilled. */ + | "RETURN"; + +/** The input fields for the shipping cost to refund. */ +export type RefundShippingInput = { + /** Whether to refund the full shipping amount. */ + fullRefund?: InputMaybe; + /** + * The input fields required to refund shipping cost, in the presentment currency of the order. + * This overrides the `fullRefund` argument. + */ + shippingRefundAmount?: InputMaybe; +}; + +/** + * The input fields for a remote Authorize.net customer payment profile. + */ +export type RemoteAuthorizeNetCustomerPaymentProfileInput = { + /** + * The customerPaymentProfileId value from the Authorize.net API. + */ + customerPaymentProfileId?: InputMaybe; + /** + * The customerProfileId value from the Authorize.net API. + */ + customerProfileId: Scalars["String"]["input"]; +}; + +/** + * The input fields for a remote Braintree customer payment profile. + */ +export type RemoteBraintreePaymentMethodInput = { + /** + * The `customer_id` value from the Braintree API. + */ + customerId: Scalars["String"]["input"]; + /** + * The `payment_method_token` value from the Braintree API. + */ + paymentMethodToken?: InputMaybe; +}; + +/** + * The input fields for a remote stripe payment method. + */ +export type RemoteStripePaymentMethodInput = { + /** + * The customer_id value from the Stripe API. + */ + customerId: Scalars["String"]["input"]; + /** + * The payment_method_id value from the Stripe API. + */ + paymentMethodId?: InputMaybe; +}; + +/** + * An alert message that appears in the Shopify admin about a problem with a store resource, with 1 or more actions to take. For example, you could use an alert to indicate that you're not charging taxes on some product variants. + * They can optionally have a specific icon and be dismissed by merchants. + */ +export type ResourceAlert = { + /** + * Buttons in the alert that link to related information. + * For example, _Edit variants_. + */ + actions: Array; + /** + * The secondary text in the alert that includes further information or instructions about how to solve a problem. + */ + content: Scalars["HTML"]["output"]; + /** + * Unique identifier that appears when an alert is manually closed by the merchant. + * Most alerts can't be manually closed. + */ + dismissibleHandle?: Maybe; + /** An icon that's optionally displayed with the alert. */ + icon?: Maybe; + /** Indication of how important the alert is. */ + severity: ResourceAlertSeverity; + /** The primary text in the alert that includes information or describes the problem. */ + title: Scalars["String"]["output"]; +}; + +/** An action associated to a resource alert, such as editing variants. */ +export type ResourceAlertAction = { + /** Whether the action appears as a button or as a link. */ + primary: Scalars["Boolean"]["output"]; + /** Resource for the action to show. */ + show?: Maybe; + /** The text for the button in the alert. For example, _Edit variants_. */ + title: Scalars["String"]["output"]; + /** The target URL that the button links to. */ + url: Scalars["URL"]["output"]; +}; + +/** The available icons for resource alerts. */ +export type ResourceAlertIcon = + /** A checkmark inside a circle. */ + | "CHECKMARK_CIRCLE" + /** A lowercase `i` inside a circle. */ + | "INFORMATION_CIRCLE"; + +/** The possible severity levels for a resource alert. */ +export type ResourceAlertSeverity = + /** Indicates a critical alert. For example, a blocked app. */ + | "CRITICAL" + /** Indicates a neutral alert. For example, an accepted dispute. */ + | "DEFAULT" + | "ERROR" + /** Indicates an informative alert. For example, an escalated dispute. */ + | "INFO" + /** Indicates a success alert. For example, a winning a dispute. */ + | "SUCCESS" + /** Indicates an informative alert. For example, a new dispute. */ + | "WARNING"; + +/** + * Represents feedback from apps about a resource, and the steps required to set up the apps on the shop. + */ +export type ResourceFeedback = { + /** + * Feedback from an app about the steps a merchant needs to take to set up the app on their store. + * @deprecated Use `details` instead. + */ + appFeedback: Array; + /** List of AppFeedback detailing issues regarding a resource. */ + details: Array; + /** Summary of resource feedback pertaining to the resource. */ + summary: Scalars["String"]["output"]; +}; + +/** The input fields for a resource feedback object. */ +export type ResourceFeedbackCreateInput = { + /** + * The date and time when the feedback was generated. Used to help determine whether + * incoming feedback is outdated compared to existing feedback. + */ + feedbackGeneratedAt: Scalars["DateTime"]["input"]; + /** + * If the feedback state is `requires_action`, then you can send a string message that communicates the action to be taken by the merchant. + * The string must be a single message up to 100 characters long and must end with a period. + * You need to adhere to the message formatting rules or your requests will fail: + * - `[Explanation of the problem]. [Suggested action].` + * + * **Examples:** + * - `[Your app name]` isn't connected. Connect your account to use this sales channel. `[Learn more]` + * - `[Your app name]` isn't configured. Agree to the terms and conditions to use this app. `[Learn more]` + * Both `Your app name` and `Learn more` (a button which directs merchants to your app) are automatically populated in the Shopify admin. + */ + messages?: InputMaybe>; + /** The state of the feedback and whether it requires merchant action. */ + state: ResourceFeedbackState; +}; + +/** The state of the resource feedback. */ +export type ResourceFeedbackState = + /** No action required from merchant. */ + | "ACCEPTED" + /** The merchant needs to resolve an issue with the resource. */ + | "REQUIRES_ACTION"; + +/** A resource limit represents the limits that the resource has. */ +export type ResourceLimit = { + /** Whether the resource is available. */ + available: Scalars["Boolean"]["output"]; + /** Quantity available. If null the quantity available is unlimited. */ + quantityAvailable?: Maybe; + /** Quantity limit of the resource. If null the quantity is unlimited. */ + quantityLimit?: Maybe; + /** Quantity used of the resource. If null the quantity used can't be retrieved. */ + quantityUsed?: Maybe; +}; + +/** Represents a merchandising background operation interface. */ +export type ResourceOperation = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The count of processed rows, summing imported, failed, and skipped rows. */ + processedRowCount?: Maybe; + /** Represents a rows objects within this background operation. */ + rowCount?: Maybe; + /** The status of this operation. */ + status: ResourceOperationStatus; +}; + +/** Represents the state of this catalog operation. */ +export type ResourceOperationStatus = + /** Operation is currently running. */ + | "ACTIVE" + /** Operation is complete. */ + | "COMPLETE" + /** Operation has been created. */ + | "CREATED"; + +/** + * A resource publication represents information about the publication of a resource. + * An instance of `ResourcePublication`, unlike `ResourcePublicationV2`, can be neither published or scheduled to be published. + * + * See [ResourcePublicationV2](/api/admin-graphql/latest/objects/ResourcePublicationV2) for more context. + */ +export type ResourcePublication = { + /** + * The channel the resource publication is published to. + * @deprecated Use `publication` instead. + */ + channel: Channel; + /** + * Whether the resource publication is published. Also returns true if the resource publication is scheduled to be published. + * If false, then the resource publication is neither published nor scheduled to be published. + */ + isPublished: Scalars["Boolean"]["output"]; + /** The publication the resource publication is published to. */ + publication: Publication; + /** + * The date that the resource publication was or is going to be published to the publication. + * If the product isn't published, then this field returns an epoch timestamp. + */ + publishDate: Scalars["DateTime"]["output"]; + /** The resource published to the publication. */ + publishable: Publishable; +}; + +/** + * An auto-generated type for paginating through multiple ResourcePublications. + */ +export type ResourcePublicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ResourcePublicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ResourcePublication and a cursor during pagination. + */ +export type ResourcePublicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ResourcePublicationEdge. */ + node: ResourcePublication; +}; + +/** + * A resource publication represents information about the publication of a resource. + * Unlike `ResourcePublication`, an instance of `ResourcePublicationV2` can't be unpublished. It must either be published or scheduled to be published. + * + * See [ResourcePublication](/api/admin-graphql/latest/objects/ResourcePublication) for more context. + */ +export type ResourcePublicationV2 = { + /** + * Whether the resource publication is published. If true, then the resource publication is published to the publication. + * If false, then the resource publication is staged to be published to the publication. + */ + isPublished: Scalars["Boolean"]["output"]; + /** The publication the resource publication is published to. */ + publication: Publication; + /** The date that the resource publication was or is going to be published to the publication. */ + publishDate?: Maybe; + /** The resource published to the publication. */ + publishable: Publishable; +}; + +/** + * An auto-generated type for paginating through multiple ResourcePublicationV2s. + */ +export type ResourcePublicationV2Connection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ResourcePublicationV2Edge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination. + */ +export type ResourcePublicationV2Edge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ResourcePublicationV2Edge. */ + node: ResourcePublicationV2; +}; + +/** Represents a return. */ +export type Return = Node & { + /** Additional information about the declined return. */ + decline?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the return. */ + name: Scalars["String"]["output"]; + /** The order that the return belongs to. */ + order: Order; + /** The list of refunds associated with the return. */ + refunds: RefundConnection; + /** The return line items attached to the return. */ + returnLineItems: ReturnLineItemConnection; + /** The list of reverse fulfillment orders for the return. */ + reverseFulfillmentOrders: ReverseFulfillmentOrderConnection; + /** The status of the return. */ + status: ReturnStatus; + /** A suggested refund for the return. */ + suggestedRefund?: Maybe; + /** The sum of all line item quantities for the return. */ + totalQuantity: Scalars["Int"]["output"]; +}; + +/** Represents a return. */ +export type ReturnRefundsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a return. */ +export type ReturnReturnLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a return. */ +export type ReturnReverseFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a return. */ +export type ReturnSuggestedRefundArgs = { + refundDuties?: InputMaybe>; + refundShipping?: InputMaybe; + returnRefundLineItems: Array; +}; + +/** The input fields for approving a customer's return request. */ +export type ReturnApproveRequestInput = { + /** The ID of the return that's being approved. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `returnApproveRequest` mutation. */ +export type ReturnApproveRequestPayload = { + /** The approved return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `returnCancel` mutation. */ +export type ReturnCancelPayload = { + /** The canceled return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `returnClose` mutation. */ +export type ReturnClosePayload = { + /** The closed return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple Returns. + */ +export type ReturnConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReturnEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `returnCreate` mutation. */ +export type ReturnCreatePayload = { + /** The created return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Additional information about why a merchant declined the customer's return request. */ +export type ReturnDecline = { + /** + * The notification message sent to the customer about their declined return request. + * Maximum length: 500 characters. + */ + note?: Maybe; + /** The reason the customer's return request was declined. */ + reason: ReturnDeclineReason; +}; + +/** The reason why the merchant declined a customer's return request. */ +export type ReturnDeclineReason = + /** The return contains final sale items. */ + | "FINAL_SALE" + /** The return is declined for another reason. */ + | "OTHER" + /** The return period has ended. */ + | "RETURN_PERIOD_ENDED"; + +/** The input fields for declining a customer's return request. */ +export type ReturnDeclineRequestInput = { + /** The reason why the merchant declined the customer's return request. */ + declineReason: ReturnDeclineReason; + /** The ID of the return that's being declined. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `returnDeclineRequest` mutation. */ +export type ReturnDeclineRequestPayload = { + /** The declined return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Return and a cursor during pagination. + */ +export type ReturnEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReturnEdge. */ + node: Return; +}; + +/** Possible error codes that can be returned by `ReturnUserError`. */ +export type ReturnErrorCode = + /** The requested resource already exists. */ + | "ALREADY_EXISTS" + /** The input value is blank. */ + | "BLANK" + /** A requested resource could not be created. */ + | "CREATION_FAILED" + /** The input value should be equal to the value allowed. */ + | "EQUAL_TO" + /** A required feature is not enabled. */ + | "FEATURE_NOT_ENABLED" + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** The input value should be greater than or equal to the minimum value allowed. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** Unexpected internal error happened. */ + | "INTERNAL_ERROR" + /** The input value is invalid. */ + | "INVALID" + /** A resource was not in the correct state for the operation to succeed. */ + | "INVALID_STATE" + /** The input value should be less than the maximum value allowed. */ + | "LESS_THAN" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** A requested notification could not be sent. */ + | "NOTIFICATION_FAILED" + /** The input value is not a number. */ + | "NOT_A_NUMBER" + /** A requested item is not editable. */ + | "NOT_EDITABLE" + /** A requested item could not be found. */ + | "NOT_FOUND" + /** The input value needs to be blank. */ + | "PRESENT" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too big. */ + | "TOO_BIG" + /** The input value is too long. */ + | "TOO_LONG" + /** Too many arguments provided. */ + | "TOO_MANY_ARGUMENTS" + /** The input value is too short. */ + | "TOO_SHORT" + /** The input value is the wrong length. */ + | "WRONG_LENGTH"; + +/** The input fields for a return. */ +export type ReturnInput = { + /** When `true` the customer will receive a notification if there's an `Order.email` present. */ + notifyCustomer?: InputMaybe; + /** The ID of the order to be returned. */ + orderId: Scalars["ID"]["input"]; + /** The UTC date and time when the return was first solicited by the customer. */ + requestedAt?: InputMaybe; + /** The return line items list to be handled. */ + returnLineItems: Array; +}; + +/** A return line item. */ +export type ReturnLineItem = Node & { + /** A note from the customer that describes the item to be returned. Maximum length: 300 characters. */ + customerNote?: Maybe; + /** The fulfillment line item from which items are returned. */ + fulfillmentLineItem: FulfillmentLineItem; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The quantity being returned. */ + quantity: Scalars["Int"]["output"]; + /** The quantity that can be refunded. */ + refundableQuantity: Scalars["Int"]["output"]; + /** The quantity that was refunded. */ + refundedQuantity: Scalars["Int"]["output"]; + /** The reason for returning the item. */ + returnReason: ReturnReason; + /** Additional information about the reason for the return. Maximum length: 255 characters. */ + returnReasonNote: Scalars["String"]["output"]; + /** The total weight of the item. */ + totalWeight?: Maybe; + /** The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied. */ + withCodeDiscountedTotalPriceSet: MoneyBag; +}; + +/** + * An auto-generated type for paginating through multiple ReturnLineItems. + */ +export type ReturnLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReturnLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ReturnLineItem and a cursor during pagination. + */ +export type ReturnLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReturnLineItemEdge. */ + node: ReturnLineItem; +}; + +/** The input fields for a return line item. */ +export type ReturnLineItemInput = { + /** + * The ID of the fulfillment line item to be returned. + * Specifically, this field expects a `FulfillmentLineItem.id`. + */ + fulfillmentLineItemId: Scalars["ID"]["input"]; + /** The quantity of the item to be returned. */ + quantity: Scalars["Int"]["input"]; + /** The reason for the item to be returned. */ + returnReason: ReturnReason; + /** + * A note about the reason that the item is being returned. + * Maximum length: 255 characters. + */ + returnReasonNote?: InputMaybe; +}; + +/** The reason for returning the return line item. */ +export type ReturnReason = + /** The item is returned because the buyer did not like the color. */ + | "COLOR" + /** The item is returned because it is damaged or defective. */ + | "DEFECTIVE" + /** The item is returned because it was not as described. */ + | "NOT_AS_DESCRIBED" + /** The item is returned for another reason. For this value, a return reason note is also provided. */ + | "OTHER" + /** The item is returned because the size was too large. */ + | "SIZE_TOO_LARGE" + /** The item is returned because the size was too small. */ + | "SIZE_TOO_SMALL" + /** The item is returned because the buyer did not like the style. */ + | "STYLE" + /** The item is returned because of an unknown reason. */ + | "UNKNOWN" + /** The item is returned because the customer changed their mind. */ + | "UNWANTED" + /** The item is returned because the customer received the wrong one. */ + | "WRONG_ITEM"; + +/** The input fields to refund a return. */ +export type ReturnRefundInput = { + /** Whether to send a refund notification to the customer. */ + notifyCustomer?: InputMaybe; + /** A list of transactions involved in refunding the return. */ + orderTransactions?: InputMaybe>; + /** A list of duties to refund. */ + refundDuties?: InputMaybe>; + /** The shipping amount to refund. */ + refundShipping?: InputMaybe; + /** The ID of the return. */ + returnId: Scalars["ID"]["input"]; + /** A list of return line items to refund. */ + returnRefundLineItems: Array; +}; + +/** The input fields for a return refund line item. */ +export type ReturnRefundLineItemInput = { + /** The quantity of the return line item to be refunded. */ + quantity: Scalars["Int"]["input"]; + /** The ID of the return line item to be refunded. */ + returnLineItemId: Scalars["ID"]["input"]; +}; + +/** The input fields to create order transactions when refunding a return. */ +export type ReturnRefundOrderTransactionInput = { + /** The ID of the parent order transaction. The transaction must be of kind `CAPTURE` or a `SALE`. */ + parentId: Scalars["ID"]["input"]; + /** The amount of money for the transaction in the presentment currency of the order. */ + transactionAmount: MoneyInput; +}; + +/** Return type for `returnRefund` mutation. */ +export type ReturnRefundPayload = { + /** The created refund. */ + refund?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `returnReopen` mutation. */ +export type ReturnReopenPayload = { + /** The reopened return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for requesting a return. */ +export type ReturnRequestInput = { + /** The ID of the order that's being returned. */ + orderId: Scalars["ID"]["input"]; + /** The line items that are being handled in the return. */ + returnLineItems: Array; +}; + +/** The input fields for a return line item. */ +export type ReturnRequestLineItemInput = { + /** + * A note from the customer that describes the item to be returned. + * For example, the note can communicate issues with the item to the merchant. + * Maximum length: 300 characters. + */ + customerNote?: InputMaybe; + /** + * The ID of the fulfillment line item to be returned. + * Specifically, this field expects a `FulfillmentLineItem.id`. + */ + fulfillmentLineItemId: Scalars["ID"]["input"]; + /** The quantity of the item that's being returned. */ + quantity: Scalars["Int"]["input"]; + /** The reason why the line item is being returned. */ + returnReason: ReturnReason; +}; + +/** Return type for `returnRequest` mutation. */ +export type ReturnRequestPayload = { + /** The requested return. */ + return?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The status of a return. */ +export type ReturnStatus = + /** The return has been canceled. */ + | "CANCELED" + /** The return has been completed. */ + | "CLOSED" + /** The return was declined. */ + | "DECLINED" + /** The return is in progress. */ + | "OPEN" + /** The return was requested. */ + | "REQUESTED"; + +/** An error that occurs during the execution of a return mutation. */ +export type ReturnUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** + * A returnable fulfillment, which is an order that has been delivered + * and is eligible to be returned to the merchant. + */ +export type ReturnableFulfillment = Node & { + /** The fulfillment that the returnable fulfillment refers to. */ + fulfillment: Fulfillment; + /** The unique ID of the Returnable Fulfillment. */ + id: Scalars["ID"]["output"]; + /** The list of returnable fulfillment line items. */ + returnableFulfillmentLineItems: ReturnableFulfillmentLineItemConnection; +}; + +/** + * A returnable fulfillment, which is an order that has been delivered + * and is eligible to be returned to the merchant. + */ +export type ReturnableFulfillmentReturnableFulfillmentLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple ReturnableFulfillments. + */ +export type ReturnableFulfillmentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReturnableFulfillmentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ReturnableFulfillment and a cursor during pagination. + */ +export type ReturnableFulfillmentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReturnableFulfillmentEdge. */ + node: ReturnableFulfillment; +}; + +/** A returnable fulfillment line item. */ +export type ReturnableFulfillmentLineItem = { + /** The fulfillment line item that can be returned. */ + fulfillmentLineItem: FulfillmentLineItem; + /** The quantity available to be returned. */ + quantity: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ReturnableFulfillmentLineItems. + */ +export type ReturnableFulfillmentLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReturnableFulfillmentLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ReturnableFulfillmentLineItem and a cursor during pagination. + */ +export type ReturnableFulfillmentLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReturnableFulfillmentLineItemEdge. */ + node: ReturnableFulfillmentLineItem; +}; + +/** + * A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. + * For example, a buyer requests a return, and a merchant sends the buyer a shipping label. + * The reverse delivery contains the context of the items sent back, how they're being sent back + * (for example, a shipping label), and the current state of the delivery (tracking information). + */ +export type ReverseDelivery = Node & { + /** The deliverable associated with the reverse delivery. */ + deliverable?: Maybe; + /** The ID of the reverse delivery. */ + id: Scalars["ID"]["output"]; + /** The reverse delivery line items attached to the reverse delivery. */ + reverseDeliveryLineItems: ReverseDeliveryLineItemConnection; + /** The `ReverseFulfillmentOrder` associated with the reverse delivery. */ + reverseFulfillmentOrder: ReverseFulfillmentOrder; +}; + +/** + * A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. + * For example, a buyer requests a return, and a merchant sends the buyer a shipping label. + * The reverse delivery contains the context of the items sent back, how they're being sent back + * (for example, a shipping label), and the current state of the delivery (tracking information). + */ +export type ReverseDeliveryReverseDeliveryLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple ReverseDeliveries. + */ +export type ReverseDeliveryConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReverseDeliveryEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `reverseDeliveryCreateWithShipping` mutation. */ +export type ReverseDeliveryCreateWithShippingPayload = { + /** The created reverse delivery. */ + reverseDelivery?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The delivery method and artifacts associated with a reverse delivery. */ +export type ReverseDeliveryDeliverable = ReverseDeliveryShippingDeliverable; + +/** The input fields to dispose a reverse delivery line item. */ +export type ReverseDeliveryDisposeInput = { + /** The final arrangement for the reverse delivery line item. */ + dispositionType: ReverseFulfillmentOrderDispositionType; + /** + * The ID of the location where the reverse delivery line item is to be disposed. This is required + * when the disposition type is RESTOCKED. + */ + locationId?: InputMaybe; + /** The quantity of the reverse delivery line item to dispose. */ + quantity: Scalars["Int"]["input"]; + /** The ID of the reverse delivery line item. */ + reverseDeliveryLineItemId: Scalars["ID"]["input"]; +}; + +/** Return type for `reverseDeliveryDispose` mutation. */ +export type ReverseDeliveryDisposePayload = { + /** The disposed reverse delivery line items. */ + reverseDeliveryLineItems?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one ReverseDelivery and a cursor during pagination. + */ +export type ReverseDeliveryEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReverseDeliveryEdge. */ + node: ReverseDelivery; +}; + +/** The input fields for a reverse label. */ +export type ReverseDeliveryLabelInput = { + /** The URL of the label file. If a label file was uploaded to be attached to the delivery, then provide the temporary staged URL. */ + fileUrl: Scalars["URL"]["input"]; +}; + +/** The return label file information for a reverse delivery. */ +export type ReverseDeliveryLabelV2 = { + /** The date and time when the reverse delivery label was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A public link that can be used to download the label image. */ + publicFileUrl?: Maybe; + /** The date and time when the reverse delivery label was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** The details about a reverse delivery line item. */ +export type ReverseDeliveryLineItem = Node & { + /** The dispositions of the item. */ + dispositions: Array; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The expected number of units. */ + quantity: Scalars["Int"]["output"]; + /** The corresponding reverse fulfillment order line item. */ + reverseFulfillmentOrderLineItem: ReverseFulfillmentOrderLineItem; +}; + +/** + * An auto-generated type for paginating through multiple ReverseDeliveryLineItems. + */ +export type ReverseDeliveryLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReverseDeliveryLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ReverseDeliveryLineItem and a cursor during pagination. + */ +export type ReverseDeliveryLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReverseDeliveryLineItemEdge. */ + node: ReverseDeliveryLineItem; +}; + +/** The input fields for a reverse delivery line item. */ +export type ReverseDeliveryLineItemInput = { + /** The quantity of the item to be included in the delivery. */ + quantity: Scalars["Int"]["input"]; + /** The ID of the related reverse fulfillment order line item. */ + reverseFulfillmentOrderLineItemId: Scalars["ID"]["input"]; +}; + +/** A reverse shipping deliverable that may include a label and tracking information. */ +export type ReverseDeliveryShippingDeliverable = { + /** The return label attached to the reverse delivery. */ + label?: Maybe; + /** The information to track the reverse delivery. */ + tracking?: Maybe; +}; + +/** Return type for `reverseDeliveryShippingUpdate` mutation. */ +export type ReverseDeliveryShippingUpdatePayload = { + /** The updated reverse delivery. */ + reverseDelivery?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for tracking information about a return delivery. */ +export type ReverseDeliveryTrackingInput = { + /** The tracking number for the label. */ + number?: InputMaybe; + /** The tracking URL for the carrier. If the carrier isn't supported by Shopify, then provide the tracking URL of the delivery. */ + url?: InputMaybe; +}; + +/** Represents the information used to track a reverse delivery. */ +export type ReverseDeliveryTrackingV2 = { + /** The provider of the tracking information, in a human-readable format for display purposes. */ + carrierName?: Maybe; + /** The identifier used by the courier to identify the shipment. */ + number?: Maybe; + /** The URL to track a shipment. */ + url?: Maybe; +}; + +/** + * A group of one or more items in a return that will be processed at a fulfillment service. + * There can be more than one reverse fulfillment order for a return at a given location. + */ +export type ReverseFulfillmentOrder = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The list of reverse fulfillment order line items for the reverse fulfillment order. */ + lineItems: ReverseFulfillmentOrderLineItemConnection; + /** The order associated with the reverse fulfillment order. */ + order: Order; + /** The list of reverse deliveries for the reverse fulfillment order. */ + reverseDeliveries: ReverseDeliveryConnection; + /** The status of the reverse fulfillment order. */ + status: ReverseFulfillmentOrderStatus; + /** + * The current confirmation for the reverse fulfillment order from a third-party logistics service. + * If no third-party service is involved, then this value is `nil`. + */ + thirdPartyConfirmation?: Maybe; +}; + +/** + * A group of one or more items in a return that will be processed at a fulfillment service. + * There can be more than one reverse fulfillment order for a return at a given location. + */ +export type ReverseFulfillmentOrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * A group of one or more items in a return that will be processed at a fulfillment service. + * There can be more than one reverse fulfillment order for a return at a given location. + */ +export type ReverseFulfillmentOrderReverseDeliveriesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple ReverseFulfillmentOrders. + */ +export type ReverseFulfillmentOrderConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReverseFulfillmentOrderEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields to dispose a reverse fulfillment order line item. */ +export type ReverseFulfillmentOrderDisposeInput = { + /** The final arrangement for the reverse fulfillment order line item. */ + dispositionType: ReverseFulfillmentOrderDispositionType; + /** + * The ID of the location where the reverse fulfillment order line item is to be disposed. + * This is required when the disposition type is RESTOCKED. + */ + locationId?: InputMaybe; + /** The quantity of the reverse fulfillment order line item to dispose. */ + quantity: Scalars["Int"]["input"]; + /** The ID of the reverse fulfillment order line item. */ + reverseFulfillmentOrderLineItemId: Scalars["ID"]["input"]; +}; + +/** Return type for `reverseFulfillmentOrderDispose` mutation. */ +export type ReverseFulfillmentOrderDisposePayload = { + /** The disposed reverse fulfillment order line items. */ + reverseFulfillmentOrderLineItems?: Maybe< + Array + >; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The details of the arrangement of an item. */ +export type ReverseFulfillmentOrderDisposition = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The location where the disposition occurred. */ + location?: Maybe; + /** The number of disposed units. */ + quantity: Scalars["Int"]["output"]; + /** The final arrangement of an item. */ + type: ReverseFulfillmentOrderDispositionType; +}; + +/** The final arrangement of an item from a reverse fulfillment order. */ +export type ReverseFulfillmentOrderDispositionType = + /** An item that was expected but absent. */ + | "MISSING" + /** An item that wasn't restocked. */ + | "NOT_RESTOCKED" + /** An item that requires further processing before being restocked or discarded. */ + | "PROCESSING_REQUIRED" + /** An item that was restocked. */ + | "RESTOCKED"; + +/** + * An auto-generated type which holds one ReverseFulfillmentOrder and a cursor during pagination. + */ +export type ReverseFulfillmentOrderEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReverseFulfillmentOrderEdge. */ + node: ReverseFulfillmentOrder; +}; + +/** + * The details about a reverse fulfillment order line item. + */ +export type ReverseFulfillmentOrderLineItem = Node & { + /** The dispositions of the item. */ + dispositions: Array; + /** The corresponding fulfillment line item for a reverse fulfillment order line item. */ + fulfillmentLineItem: FulfillmentLineItem; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The total number of units to be processed. */ + totalQuantity: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ReverseFulfillmentOrderLineItems. + */ +export type ReverseFulfillmentOrderLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ReverseFulfillmentOrderLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ReverseFulfillmentOrderLineItem and a cursor during pagination. + */ +export type ReverseFulfillmentOrderLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ReverseFulfillmentOrderLineItemEdge. */ + node: ReverseFulfillmentOrderLineItem; +}; + +/** The status of a reverse fulfillment order. */ +export type ReverseFulfillmentOrderStatus = + /** The reverse fulfillment order has been canceled. */ + | "CANCELED" + /** The reverse fulfillment order has been completed. */ + | "CLOSED" + /** The reverse fulfillment order is in progress. */ + | "OPEN"; + +/** The third-party confirmation of a reverse fulfillment order. */ +export type ReverseFulfillmentOrderThirdPartyConfirmation = { + /** The status of the reverse fulfillment order third-party confirmation. */ + status: ReverseFulfillmentOrderThirdPartyConfirmationStatus; +}; + +/** The status of a reverse fulfillment order third-party confirmation. */ +export type ReverseFulfillmentOrderThirdPartyConfirmationStatus = + /** The reverse fulfillment order was accepted by the fulfillment service. */ + | "ACCEPTED" + /** The reverse fulfillment order cancelation was accepted by the fulfillment service. */ + | "CANCEL_ACCEPTED" + /** The reverse fulfillment order cancelation was rejected by the fulfillment service. */ + | "CANCEL_REJECTED" + /** The reverse fulfillment order is awaiting acceptance by the fulfillment service. */ + | "PENDING_ACCEPTANCE" + /** The reverse fulfillment order is awaiting cancelation by the fulfillment service. */ + | "PENDING_CANCELATION" + /** The reverse fulfillment order was rejected by the fulfillment service. */ + | "REJECTED"; + +/** A row count represents rows on background operation. */ +export type RowCount = { + /** Estimated number of rows contained within this background operation. */ + count: Scalars["Int"]["output"]; + /** Whether the operation exceeds max number of reportable rows. */ + exceedsMax: Scalars["Boolean"]["output"]; +}; + +/** SEO information. */ +export type Seo = { + /** SEO Description. */ + description?: Maybe; + /** SEO Title. */ + title?: Maybe; +}; + +/** The input fields for SEO information. */ +export type SeoInput = { + /** SEO description of the product. */ + description?: InputMaybe; + /** SEO title of the product. */ + title?: InputMaybe; +}; + +/** An individual sale record associated with a sales agreement. Every money value in an order's sales data is represented in the currency's smallest unit. When amounts are divided across multiple line items, such as taxes or order discounts, the amounts might not divide evenly across all of the line items on the order. To address this, the remaining currency units that couldn't be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for. In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts. This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items. */ +export type Sale = { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** The possible order action types for a sale. */ +export type SaleActionType = + /** A purchase or charge. */ + | "ORDER" + /** A removal or return. */ + | "RETURN" + /** An unknown order action. Represents new actions that may be added in future versions. */ + | "UNKNOWN" + /** A change to the price, taxes, or discounts for a prior purchase. */ + | "UPDATE"; + +/** The additional fee details for a line item. */ +export type SaleAdditionalFee = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The name of the additional fee. */ + name: Scalars["String"]["output"]; + /** The price of the additional fee. */ + price: MoneyBag; + /** A list of taxes charged on the additional fee. */ + taxLines: Array; +}; + +/** + * An auto-generated type for paginating through multiple Sales. + */ +export type SaleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SaleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Sale and a cursor during pagination. + */ +export type SaleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SaleEdge. */ + node: Sale; +}; + +/** The possible line types for a sale record. One of the possible order line types for a sale is an adjustment. Sales adjustments occur when a refund is issued for a line item that is either more or less than the total value of the line item. Examples are restocking fees and goodwill payments. When this happens, Shopify produces a sales agreement with sale records for each line item that is returned or refunded and an additional sale record for the adjustment (for example, a restocking fee). The sales records for the returned or refunded items represent the reversal of the original line item sale value. The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded. */ +export type SaleLineType = + /** An additional fee. */ + | "ADDITIONAL_FEE" + /** A sale adjustment. */ + | "ADJUSTMENT" + /** A duty charge. */ + | "DUTY" + /** A gift card. */ + | "GIFT_CARD" + /** A product purchased, returned or exchanged. */ + | "PRODUCT" + /** A shipping cost. */ + | "SHIPPING" + /** A tip added by the customer. */ + | "TIP" + /** An unknown sale line. Represents new types that may be added in future versions. */ + | "UNKNOWN"; + +/** The tax allocated to a sale from a single tax line. */ +export type SaleTax = { + /** The portion of the total tax amount on the related sale that comes from the associated tax line. */ + amount: MoneyBag; + /** The unique ID for the sale tax. */ + id: Scalars["ID"]["output"]; + /** The tax line associated with the sale. */ + taxLine: TaxLine; +}; + +/** A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. */ +export type SalesAgreement = { + /** The application that created the agreement. */ + app?: Maybe; + /** The date and time at which the agreement occured. */ + happenedAt: Scalars["DateTime"]["output"]; + /** The unique ID for the agreement. */ + id: Scalars["ID"]["output"]; + /** The reason the agremeent was created. */ + reason: OrderActionType; + /** The sales associated with the agreement. */ + sales: SaleConnection; + /** The staff member associated with the agreement. */ + user?: Maybe; +}; + +/** A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more. */ +export type SalesAgreementSalesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple SalesAgreements. + */ +export type SalesAgreementConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SalesAgreementEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SalesAgreement and a cursor during pagination. + */ +export type SalesAgreementEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SalesAgreementEdge. */ + node: SalesAgreement; +}; + +/** A saved search is a representation of a search query saved in the admin. */ +export type SavedSearch = LegacyInteroperability & Node & { + /** The filters of a saved search. */ + filters: Array; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The name of a saved search. */ + name: Scalars["String"]["output"]; + /** The query string of a saved search. This includes search terms and filters. */ + query: Scalars["String"]["output"]; + /** The type of resource this saved search is searching in. */ + resourceType: SearchResultType; + /** The search terms of a saved search. */ + searchTerms: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple SavedSearches. + */ +export type SavedSearchConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SavedSearchEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields to create a saved search. */ +export type SavedSearchCreateInput = { + /** A descriptive name of the saved search. */ + name: Scalars["String"]["input"]; + /** The query string of a saved search. This includes search terms and filters. */ + query: Scalars["String"]["input"]; + /** The type of resource this saved search is searching in. */ + resourceType: SearchResultType; +}; + +/** Return type for `savedSearchCreate` mutation. */ +export type SavedSearchCreatePayload = { + /** The saved search that was created. */ + savedSearch?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to delete a saved search. */ +export type SavedSearchDeleteInput = { + /** ID of the saved search to delete. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `savedSearchDelete` mutation. */ +export type SavedSearchDeletePayload = { + /** The ID of the saved search that was deleted. */ + deletedSavedSearchId?: Maybe; + /** The shop of the saved search that was deleted. */ + shop: Shop; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one SavedSearch and a cursor during pagination. + */ +export type SavedSearchEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SavedSearchEdge. */ + node: SavedSearch; +}; + +/** The input fields to update a saved search. */ +export type SavedSearchUpdateInput = { + /** ID of the saved search to update. */ + id: Scalars["ID"]["input"]; + /** A descriptive name of the saved search. */ + name?: InputMaybe; + /** The query string of a saved search. This included search terms and filters. */ + query?: InputMaybe; +}; + +/** Return type for `savedSearchUpdate` mutation. */ +export type SavedSearchUpdatePayload = { + /** The saved search that was updated. */ + savedSearch?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Script discount applications capture the intentions of a discount that + * was created by a Shopify Script for an order's line item or shipping line. + * + * Discount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object. + */ +export type ScriptDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is applied to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** + * The description of the application as defined by the Script. + * @deprecated Use `title` instead. + */ + description: Scalars["String"]["output"]; + /** + * An ordered index that can be used to identify the discount application and indicate the precedence + * of the discount application for calculations. + */ + index: Scalars["Int"]["output"]; + /** How the discount amount is distributed on the discounted lines. */ + targetSelection: DiscountApplicationTargetSelection; + /** Whether the discount is applied on line items or shipping lines. */ + targetType: DiscountApplicationTargetType; + /** The title of the application as defined by the Script. */ + title: Scalars["String"]["output"]; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** + *

Theme app extensions

+ *

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

+ * + * A script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the order status page of checkout. + */ +export type ScriptTag = LegacyInteroperability & Node & { + /** + * Whether the Shopify CDN can cache and serve the script tag. + * If `true`, then the script will be cached and served by the CDN. + * The cache expires 15 minutes after the script tag is successfully returned. + * If `false`, then the script will be served as is. + */ + cache: Scalars["Boolean"]["output"]; + /** The date and time when the script tag was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The page or pages on the online store that the script should be included. */ + displayScope: ScriptTagDisplayScope; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The URL to the remote script. */ + src: Scalars["URL"]["output"]; + /** The date and time when the script tag was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ScriptTags. + */ +export type ScriptTagConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ScriptTagEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `scriptTagCreate` mutation. */ +export type ScriptTagCreatePayload = { + /** The script tag that was created. */ + scriptTag?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `scriptTagDelete` mutation. */ +export type ScriptTagDeletePayload = { + /** The ID of the deleted script tag. */ + deletedScriptTagId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The page or pages on the online store where the script should be included. + */ +export type ScriptTagDisplayScope = + /** Include the script on both the web storefront and the order status page. */ + | "ALL" + /** Include the script only on the web storefront. */ + | "ONLINE_STORE" + /** Include the script only on the order status page. */ + | "ORDER_STATUS"; + +/** + * An auto-generated type which holds one ScriptTag and a cursor during pagination. + */ +export type ScriptTagEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ScriptTagEdge. */ + node: ScriptTag; +}; + +/** + * The input fields for a script tag. This input object is used when creating or updating + * a script tag to specify its URL, where it should be included, and how it will be cached. + */ +export type ScriptTagInput = { + /** + * Whether the Shopify CDN can cache and serve the script tag. + * If `true`, then the script will be cached and served by the CDN. + * The cache expires 15 minutes after the script tag is successfully returned. + * If `false`, then the script is served as is. + * The default value is `false`. + */ + cache?: InputMaybe; + /** The page or pages on the online store where the script should be included. */ + displayScope?: InputMaybe; + /** The URL of the remote script. For example: `https://example.com/path/to/script.js`. */ + src?: InputMaybe; +}; + +/** Return type for `scriptTagUpdate` mutation. */ +export type ScriptTagUpdatePayload = { + /** The script tag that was updated. */ + scriptTag?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A filter in a search query represented by a key value pair. */ +export type SearchFilter = { + /** The key of the search filter. */ + key: Scalars["String"]["output"]; + /** The value of the search filter. */ + value: Scalars["String"]["output"]; +}; + +/** A list of search filters along with their specific options in value and label pair for filtering. */ +export type SearchFilterOptions = { + /** A list of options that can be use to filter product availability. */ + productAvailability: Array; +}; + +/** Represents an individual result returned from a search. */ +export type SearchResult = { + /** Returns the search result description text. */ + description?: Maybe; + /** Returns the Image resource presented to accompany a search result. */ + image?: Maybe; + /** Returns the ID of the resource returned in the search result. */ + reference: Node; + /** Returns the resource title. */ + title: Scalars["String"]["output"]; + /** Returns the absolute URL to the resource in the search result. */ + url: Scalars["URL"]["output"]; +}; + +/** The connection type for SearchResult. */ +export type SearchResultConnection = { + /** A list of edges. */ + edges: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** + * Information to aid in pagination. + * @deprecated The provided information is not accurate. + */ + resultsAfterCount: Scalars["Int"]["output"]; +}; + +/** + * An auto-generated type which holds one SearchResult and a cursor during pagination. + */ +export type SearchResultEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SearchResultEdge. */ + node: SearchResult; +}; + +/** Specifies the type of resources to be returned from a search. */ +export type SearchResultType = + | "COLLECTION" + | "CUSTOMER" + /** A code discount redeem code. */ + | "DISCOUNT_REDEEM_CODE" + | "DRAFT_ORDER" + /** A file. */ + | "FILE" + | "ONLINE_STORE_ARTICLE" + | "ONLINE_STORE_BLOG" + | "ONLINE_STORE_PAGE" + | "ORDER" + | "PRICE_RULE" + | "PRODUCT" + /** A URL redirect. */ + | "URL_REDIRECT"; + +/** + * A dynamic collection of customers based on specific criteria. + */ +export type Segment = Node & { + /** The date and time when the segment was added to the store. */ + creationDate: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The date and time when the segment was last updated. */ + lastEditDate: Scalars["DateTime"]["output"]; + /** The name of the segment. */ + name: Scalars["String"]["output"]; + /** A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers. */ + query: Scalars["String"]["output"]; +}; + +/** A filter that takes a value that's associated with an object. For example, the `tags` field is associated with the [`Customer`](/api/admin-graphql/latest/objects/Customer) object. */ +export type SegmentAssociationFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** The statistics of a given attribute. */ +export type SegmentAttributeStatistics = { + /** The average of a given attribute. */ + average: Scalars["Float"]["output"]; + /** The sum of a given attribute. */ + sum: Scalars["Float"]["output"]; +}; + +/** A filter with a Boolean value that's been added to a segment query. */ +export type SegmentBooleanFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple Segments. + */ +export type SegmentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SegmentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `segmentCreate` mutation. */ +export type SegmentCreatePayload = { + /** The newly created segment. */ + segment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A filter with a date value that's been added to a segment query. */ +export type SegmentDateFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** Return type for `segmentDelete` mutation. */ +export type SegmentDeletePayload = { + /** ID of the deleted segment. */ + deletedSegmentId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one Segment and a cursor during pagination. + */ +export type SegmentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SegmentEdge. */ + node: Segment; +}; + +/** A filter with a set of possible values that's been added to a segment query. */ +export type SegmentEnumFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** A filter that's used to segment customers based on the date that an event occured. For example, the `product_bought` event filter allows you to segment customers based on what products they've bought. */ +export type SegmentEventFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The parameters for an event segment filter. */ + parameters: Array; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; + /** The return value type for an event segment filter. */ + returnValueType: Scalars["String"]["output"]; +}; + +/** The parameters for an event segment filter. */ +export type SegmentEventFilterParameter = { + /** Whether the parameter accepts a list of values. */ + acceptsMultipleValues: Scalars["Boolean"]["output"]; + /** The localized description of the parameter. */ + localizedDescription: Scalars["String"]["output"]; + /** The localized name of the parameter. */ + localizedName: Scalars["String"]["output"]; + /** Whether the parameter is optional. */ + optional: Scalars["Boolean"]["output"]; + /** The type of the parameter. */ + parameterType: Scalars["String"]["output"]; + /** The query name of the parameter. */ + queryName: Scalars["String"]["output"]; +}; + +/** The filters used in segment queries associated with a shop. */ +export type SegmentFilter = { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple SegmentFilters. + */ +export type SegmentFilterConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SegmentFilterEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SegmentFilter and a cursor during pagination. + */ +export type SegmentFilterEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SegmentFilterEdge. */ + node: SegmentFilter; +}; + +/** A filter with a double-precision, floating-point value that's been added to a segment query. */ +export type SegmentFloatFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** A filter with an integer that's been added to a segment query. */ +export type SegmentIntegerFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** + * The response type for the `segmentMembership` object. + */ +export type SegmentMembership = { + /** A Boolean that indicates whether or not the customer in the query is a member of the segment, which is identified using the `segmentId`. */ + isMember: Scalars["Boolean"]["output"]; + /** A `segmentId` that's used for testing membership. */ + segmentId: Scalars["ID"]["output"]; +}; + +/** + * A list of maps that contain `segmentId` IDs and `isMember` Booleans. The maps represent segment memberships. + */ +export type SegmentMembershipResponse = { + /** The membership status for the given list of segments. */ + memberships: Array; +}; + +/** + * A segment and its corresponding saved search. + * For example, you can use `SegmentMigration` to retrieve the segment ID that corresponds to a saved search ID. + */ +export type SegmentMigration = { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The ID of the saved search. */ + savedSearchId: Scalars["ID"]["output"]; + /** The ID of the segment. */ + segmentId?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple SegmentMigrations. + */ +export type SegmentMigrationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SegmentMigrationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SegmentMigration and a cursor during pagination. + */ +export type SegmentMigrationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SegmentMigrationEdge. */ + node: SegmentMigration; +}; + +/** The set of valid sort keys for the Segment query. */ +export type SegmentSortKeys = + /** Sort by the `creation_date` value. */ + | "CREATION_DATE" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `last_edit_date` value. */ + | "LAST_EDIT_DATE" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** The statistics of a given segment. */ +export type SegmentStatistics = { + /** The statistics of a given attribute. */ + attributeStatistics: SegmentAttributeStatistics; +}; + +/** The statistics of a given segment. */ +export type SegmentStatisticsAttributeStatisticsArgs = { + attributeName: Scalars["String"]["input"]; +}; + +/** A filter with a string that's been added to a segment query. */ +export type SegmentStringFilter = SegmentFilter & { + /** The localized name of the filter. */ + localizedName: Scalars["String"]["output"]; + /** Whether a file can have multiple values for a single customer. */ + multiValue: Scalars["Boolean"]["output"]; + /** The query name of the filter. */ + queryName: Scalars["String"]["output"]; +}; + +/** Return type for `segmentUpdate` mutation. */ +export type SegmentUpdatePayload = { + /** The updated segment. */ + segment?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * A list of suggested values associated with an individual segment. A + * segment is a group of members, such as customers, that meet specific + * criteria. + */ +export type SegmentValue = { + /** The localized version of the value's name. This name is displayed to the merchant. */ + localizedValue: Scalars["String"]["output"]; + /** The name of the query associated with the suggestion. */ + queryName: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple SegmentValues. + */ +export type SegmentValueConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SegmentValueEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SegmentValue and a cursor during pagination. + */ +export type SegmentValueEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SegmentValueEdge. */ + node: SegmentValue; +}; + +/** + * Properties used by customers to select a product variant. + * Products can have multiple options, like different sizes or colors. + */ +export type SelectedOption = { + /** The product option’s name. */ + name: Scalars["String"]["output"]; + /** The product option’s value. */ + value: Scalars["String"]["output"]; +}; + +/** + * Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups + * and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing + * up these records if you need to restore them later. + * + * For more information on selling plans, refer to + * [*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans). + */ +export type SellingPlan = HasPublishedTranslations & Node & { + /** A selling plan policy which describes the recurring billing details. */ + billingPolicy: SellingPlanBillingPolicy; + /** The category used to classify the selling plan for reporting purposes. */ + category?: Maybe; + /** The date and time when the selling plan was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A selling plan policy which describes the delivery details. */ + deliveryPolicy: SellingPlanDeliveryPolicy; + /** Buyer facing string which describes the selling plan commitment. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** When to reserve inventory for a selling plan. */ + inventoryPolicy?: Maybe; + /** + * A customer-facing description of the selling plan. + * + * If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies. + */ + name: Scalars["String"]["output"]; + /** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ + options: Array; + /** Relative position of the selling plan for display. A lower position will be displayed before a higher position. */ + position?: Maybe; + /** Selling plan pricing details. */ + pricingPolicies: Array; + /** The translations associated with the resource. */ + translations: Array; +}; + +/** + * Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups + * and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing + * up these records if you need to restore them later. + * + * For more information on selling plans, refer to + * [*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans). + */ +export type SellingPlanTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** Represents a selling plan policy anchor. */ +export type SellingPlanAnchor = { + /** + * The cutoff day for the anchor. + * + * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets + * the days of the week according to ISO 8601, where 1 is Monday. + * + * If `type` is MONTHDAY, then the value must be between 1-31. + * + * If `type` is YEARDAY, then the value must be `null`. + */ + cutoffDay?: Maybe; + /** + * The day of the anchor. + * + * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets + * the days of the week according to ISO 8601, where 1 is Monday. + * + * If `type` isn't WEEKDAY, then the value must be between 1-31. + */ + day: Scalars["Int"]["output"]; + /** + * The month of the anchor. If type is different than YEARDAY, then the value must + * be `null` or between 1-12. + */ + month?: Maybe; + /** + * Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY. + */ + type: SellingPlanAnchorType; +}; + +/** The input fields required to create or update a selling plan anchor. */ +export type SellingPlanAnchorInput = { + /** + * The cutoff day of the anchor. + * + * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets + * the days of the week according to ISO 8601, where 1 is Monday. + * + * If `type` is MONTHDAY, then the value must be between 1-31. + * + * If `type` is YEARDAY, then the value must be `null`. + * + * This field should only be set if the cutoff field for the delivery policy is `null`. + */ + cutoffDay?: InputMaybe; + /** + * The day of the anchor. + * + * If `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets + * the days of the week according to ISO 8601, where 1 is Monday. + * + * If `type` isn't WEEKDAY, then the value must be between 1-31. + */ + day?: InputMaybe; + /** + * The month of the anchor. If type is different than YEARDAY, then the value must + * be `null` or between 1-12. + */ + month?: InputMaybe; + /** + * Represents the anchor type, must be one of WEEKDAY, MONTHDAY, YEARDAY. + */ + type?: InputMaybe; +}; + +/** Represents the anchor type. */ +export type SellingPlanAnchorType = + /** Which day of the month, between 1-31. */ + | "MONTHDAY" + /** Which day of the week, between 1-7. */ + | "WEEKDAY" + /** Which days of the month and year, month between 1-12, and day between 1-31. */ + | "YEARDAY"; + +/** + * Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every + * three months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing + * policies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. + * We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanBillingPolicy = + | SellingPlanFixedBillingPolicy + | SellingPlanRecurringBillingPolicy; + +/** The input fields that are required to create or update a billing policy type. */ +export type SellingPlanBillingPolicyInput = { + /** The fixed billing policy details. */ + fixed?: InputMaybe; + /** The recurring billing policy details. */ + recurring?: InputMaybe; +}; + +/** + * The category of the selling plan. For the `OTHER` category, + * you must fill out our [request form](https://docs.google.com/forms/d/e/1FAIpQLSeU18Xmw0Q61V8wdH-dfGafFqIBfRchQKUO8WAF3yJTvgyyZQ/viewform), + * where we'll review your request for a new purchase option. + */ +export type SellingPlanCategory = + /** The selling plan is for anything not in one of the other categories. */ + | "OTHER" + /** The selling plan is for pre-orders. */ + | "PRE_ORDER" + /** The selling plan is for subscriptions. */ + | "SUBSCRIPTION" + /** The selling plan is for try before you buy purchases. */ + | "TRY_BEFORE_YOU_BUY"; + +/** The amount charged at checkout when the full amount isn't charged at checkout. */ +export type SellingPlanCheckoutCharge = { + /** The charge type for the checkout charge. */ + type: SellingPlanCheckoutChargeType; + /** The charge value for the checkout charge. */ + value: SellingPlanCheckoutChargeValue; +}; + +/** The input fields that are required to create or update a checkout charge. */ +export type SellingPlanCheckoutChargeInput = { + /** The checkout charge type defined by the policy. */ + type?: InputMaybe; + /** The checkout charge value defined by the policy. */ + value?: InputMaybe; +}; + +/** The percentage value of the price used for checkout charge. */ +export type SellingPlanCheckoutChargePercentageValue = { + /** The percentage value of the price used for checkout charge. */ + percentage: Scalars["Float"]["output"]; +}; + +/** The checkout charge when the full amount isn't charged at checkout. */ +export type SellingPlanCheckoutChargeType = + /** The checkout charge is a percentage of the product or variant price. */ + | "PERCENTAGE" + /** The checkout charge is a fixed price amount. */ + | "PRICE"; + +/** The portion of the price to be charged at checkout. */ +export type SellingPlanCheckoutChargeValue = + | MoneyV2 + | SellingPlanCheckoutChargePercentageValue; + +/** The input fields required to create or update an checkout charge value. */ +export type SellingPlanCheckoutChargeValueInput = { + /** The fixed value for an checkout charge. */ + fixedValue?: InputMaybe; + /** The percentage value. */ + percentage?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple SellingPlans. + */ +export type SellingPlanConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SellingPlanEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver + * every other week). The selling plan delivery policy and associated records (selling plan groups, selling plans, + * pricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app. + * We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanDeliveryPolicy = + | SellingPlanFixedDeliveryPolicy + | SellingPlanRecurringDeliveryPolicy; + +/** The input fields that are required to create or update a delivery policy. */ +export type SellingPlanDeliveryPolicyInput = { + /** The fixed delivery policy details. */ + fixed?: InputMaybe; + /** The recurring delivery policy details. */ + recurring?: InputMaybe; +}; + +/** + * An auto-generated type which holds one SellingPlan and a cursor during pagination. + */ +export type SellingPlanEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SellingPlanEdge. */ + node: SellingPlan; +}; + +/** The fixed selling plan billing policy. */ +export type SellingPlanFixedBillingPolicy = { + /** The checkout charge when the full amount isn't charged at checkout. */ + checkoutCharge: SellingPlanCheckoutCharge; + /** The exact time when to capture the full payment. */ + remainingBalanceChargeExactTime?: Maybe; + /** + * The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration. + */ + remainingBalanceChargeTimeAfterCheckout?: Maybe; + /** When to capture payment for amount due. */ + remainingBalanceChargeTrigger: SellingPlanRemainingBalanceChargeTrigger; +}; + +/** The input fields required to create or update a fixed billing policy. */ +export type SellingPlanFixedBillingPolicyInput = { + /** The checkout charge policy for the selling plan. */ + checkoutCharge?: InputMaybe; + /** The date and time to capture the full payment. */ + remainingBalanceChargeExactTime?: InputMaybe; + /** The period after capturing the payment for the amount due (`remainingBalanceChargeTrigger`), and before capturing the full payment. Expressed as an ISO8601 duration. */ + remainingBalanceChargeTimeAfterCheckout?: InputMaybe< + Scalars["String"]["input"] + >; + /** When to capture the payment for the amount due. */ + remainingBalanceChargeTrigger?: InputMaybe< + SellingPlanRemainingBalanceChargeTrigger + >; +}; + +/** Represents a fixed selling plan delivery policy. */ +export type SellingPlanFixedDeliveryPolicy = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors: Array; + /** A buffer period for orders to be included in next fulfillment anchor. */ + cutoff?: Maybe; + /** The date and time when the fulfillment should trigger. */ + fulfillmentExactTime?: Maybe; + /** What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN. */ + fulfillmentTrigger: SellingPlanFulfillmentTrigger; + /** + * Whether the delivery policy is merchant or buyer-centric. + * Buyer-centric delivery policies state the time when the buyer will receive the goods. + * Merchant-centric delivery policies state the time when the fulfillment should be started. + * Currently, only merchant-centric delivery policies are supported. + */ + intent: SellingPlanFixedDeliveryPolicyIntent; + /** The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`. */ + preAnchorBehavior: SellingPlanFixedDeliveryPolicyPreAnchorBehavior; +}; + +/** The input fields required to create or update a fixed delivery policy. */ +export type SellingPlanFixedDeliveryPolicyInput = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors?: InputMaybe>; + /** A buffer period for orders to be included in a cycle. */ + cutoff?: InputMaybe; + /** The date and time when the fulfillment should trigger. */ + fulfillmentExactTime?: InputMaybe; + /** What triggers the fulfillment. */ + fulfillmentTrigger?: InputMaybe; + /** Whether the delivery policy is merchant or buyer-centric. */ + intent?: InputMaybe; + /** The pre-anchor behavior. */ + preAnchorBehavior?: InputMaybe< + SellingPlanFixedDeliveryPolicyPreAnchorBehavior + >; +}; + +/** Possible intentions of a Delivery Policy. */ +export type SellingPlanFixedDeliveryPolicyIntent = /** + * A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment. + */ + "FULFILLMENT_BEGIN"; + +/** The fulfillment or delivery behavior of the first fulfillment when the orderis placed before the anchor. */ +export type SellingPlanFixedDeliveryPolicyPreAnchorBehavior = + /** + * Orders placed can be fulfilled / delivered immediately. Orders placed inside a cutoff can be fulfilled / delivered at the next anchor. + */ + | "ASAP" + /** + * Orders placed can be fulfilled / delivered at the next anchor date. + * Orders placed inside a cutoff will skip the next anchor and can be fulfilled / + * delivered at the following anchor. + */ + | "NEXT"; + +/** + * Represents the pricing policy of a subscription or deferred purchase option selling plan. + * The selling plan fixed pricing policy works with the billing and delivery policy + * to determine the final price. Discounts are divided among fulfillments. + * For example, a subscription with a $10 discount and two deliveries will have a $5 + * discount applied to each delivery. + */ +export type SellingPlanFixedPricingPolicy = SellingPlanPricingPolicyBase & { + /** The price adjustment type. */ + adjustmentType: SellingPlanPricingPolicyAdjustmentType; + /** The price adjustment value. */ + adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; + /** The date and time when the fixed selling plan pricing policy was created. */ + createdAt: Scalars["DateTime"]["output"]; +}; + +/** The input fields required to create or update a fixed selling plan pricing policy. */ +export type SellingPlanFixedPricingPolicyInput = { + /** Price adjustment type defined by the policy. */ + adjustmentType?: InputMaybe; + /** Price adjustment value defined by the policy. */ + adjustmentValue?: InputMaybe; + /** ID of the pricing policy. */ + id?: InputMaybe; +}; + +/** Describes what triggers fulfillment. */ +export type SellingPlanFulfillmentTrigger = + /** Use the anchor values to calculate fulfillment date. */ + | "ANCHOR" + /** As soon as possible. */ + | "ASAP" + /** At an exact time defined by the fulfillment_exact_time field. */ + | "EXACT_TIME" + /** Unknown. Usually to be determined in the future. */ + | "UNKNOWN"; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroup = HasPublishedTranslations & Node & { + /** The ID for app, exposed in Liquid and product JSON. */ + appId?: Maybe; + /** Whether the given product is directly associated to the selling plan group. */ + appliesToProduct: Scalars["Boolean"]["output"]; + /** Whether the given product variant is directly associated to the selling plan group. */ + appliesToProductVariant: Scalars["Boolean"]["output"]; + /** + * Whether any of the product variants of the given product are associated to the selling plan group. + */ + appliesToProductVariants: Scalars["Boolean"]["output"]; + /** The date and time when the selling plan group was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The merchant-facing description of the selling plan group. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The merchant-facing label of the selling plan group. */ + merchantCode: Scalars["String"]["output"]; + /** The buyer-facing label of the selling plan group. */ + name: Scalars["String"]["output"]; + /** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ + options: Array; + /** The relative position of the selling plan group for display. */ + position?: Maybe; + /** A count of products associated to the selling plan group. */ + productCount: Scalars["Int"]["output"]; + /** A count of product variants associated to the selling plan group. */ + productVariantCount: Scalars["Int"]["output"]; + /** Product variants associated to the selling plan group. */ + productVariants: ProductVariantConnection; + /** Products associated to the selling plan group. */ + products: ProductConnection; + /** Selling plans associated to the selling plan group. */ + sellingPlans: SellingPlanConnection; + /** A summary of the policies associated to the selling plan group. */ + summary?: Maybe; + /** The translations associated with the resource. */ + translations: Array; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupAppliesToProductArgs = { + productId: Scalars["ID"]["input"]; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupAppliesToProductVariantArgs = { + productVariantId: Scalars["ID"]["input"]; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupAppliesToProductVariantsArgs = { + productId: Scalars["ID"]["input"]; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupProductVariantCountArgs = { + productId?: InputMaybe; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + productId?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupSellingPlansArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups + * and associated records (selling plans and policies) are deleted 48 hours after a merchant + * uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later. + */ +export type SellingPlanGroupTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** Return type for `sellingPlanGroupAddProductVariants` mutation. */ +export type SellingPlanGroupAddProductVariantsPayload = { + /** The updated selling plan group. */ + sellingPlanGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `sellingPlanGroupAddProducts` mutation. */ +export type SellingPlanGroupAddProductsPayload = { + /** The updated selling plan group. */ + sellingPlanGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type for paginating through multiple SellingPlanGroups. + */ +export type SellingPlanGroupConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SellingPlanGroupEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `sellingPlanGroupCreate` mutation. */ +export type SellingPlanGroupCreatePayload = { + /** The created selling plan group object. */ + sellingPlanGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `sellingPlanGroupDelete` mutation. */ +export type SellingPlanGroupDeletePayload = { + /** The ID of the deleted selling plan group object. */ + deletedSellingPlanGroupId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. + */ +export type SellingPlanGroupEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SellingPlanGroupEdge. */ + node: SellingPlanGroup; +}; + +/** The input fields required to create or update a selling plan group. */ +export type SellingPlanGroupInput = { + /** ID for app, exposed in Liquid and product JSON. */ + appId?: InputMaybe; + /** Merchant facing description of the selling plan group. */ + description?: InputMaybe; + /** Merchant facing label of the selling plan group. */ + merchantCode?: InputMaybe; + /** Buyer facing label of the selling plan group. */ + name?: InputMaybe; + /** The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ + options?: InputMaybe>; + /** Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one. */ + position?: InputMaybe; + /** List of selling plans to create. */ + sellingPlansToCreate?: InputMaybe>; + /** List of selling plans ids to delete. */ + sellingPlansToDelete?: InputMaybe>; + /** List of selling plans to update. */ + sellingPlansToUpdate?: InputMaybe>; +}; + +/** Return type for `sellingPlanGroupRemoveProductVariants` mutation. */ +export type SellingPlanGroupRemoveProductVariantsPayload = { + /** The removed product variant ids. */ + removedProductVariantIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `sellingPlanGroupRemoveProducts` mutation. */ +export type SellingPlanGroupRemoveProductsPayload = { + /** The removed product ids. */ + removedProductIds?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for resource association with a Selling Plan Group. */ +export type SellingPlanGroupResourceInput = { + /** The IDs of the Products to add to the Selling Plan Group. */ + productIds?: InputMaybe>; + /** The IDs of the Variants to add to the Selling Plan Group. */ + productVariantIds?: InputMaybe>; +}; + +/** The set of valid sort keys for the SellingPlanGroup query. */ +export type SellingPlanGroupSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `name` value. */ + | "NAME" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE" + /** Sort by the `updated_at` value. */ + | "UPDATED_AT"; + +/** Return type for `sellingPlanGroupUpdate` mutation. */ +export type SellingPlanGroupUpdatePayload = { + /** The IDs of the deleted Subscription Plans. */ + deletedSellingPlanIds?: Maybe>; + /** The updated Selling Plan Group. */ + sellingPlanGroup?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents a selling plan group custom error. + */ +export type SellingPlanGroupUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `SellingPlanGroupUserError`. */ +export type SellingPlanGroupUserErrorCode = + /** Billing and delivery policy types must be the same. */ + | "BILLING_AND_DELIVERY_POLICY_TYPES_MUST_BE_THE_SAME" + /** The input value is blank. */ + | "BLANK" + /** A fixed billing policy's checkout charge value and type must match. */ + | "CHECKOUT_CHARGE_VALUE_AND_TYPE_MUST_MATCH" + /** The input value should be equal to the value allowed. */ + | "EQUAL_TO" + /** Could not add the resource to the selling plan group. */ + | "ERROR_ADDING_RESOURCE_TO_GROUP" + /** A fixed billing policy's fulfillment_exact_time must not be present when the fulfillment_trigger isn't EXACT_TIME. */ + | "FULFILLMENT_EXACT_TIME_NOT_ALLOWED" + /** A fixed billing policy's fulfillment_exact_time can't be blank when the fulfillment_trigger is EXACT_TIME. */ + | "FULFILLMENT_EXACT_TIME_REQUIRED" + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** The input value should be greater than or equal to the minimum value allowed. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Selling plan group could not be deleted. */ + | "GROUP_COULD_NOT_BE_DELETED" + /** Selling plan group does not exist. */ + | "GROUP_DOES_NOT_EXIST" + /** The input value isn't included in the list. */ + | "INCLUSION" + /** The input value is invalid. */ + | "INVALID" + /** The input value should be less than the maximum value allowed. */ + | "LESS_THAN" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** The input value is not a number. */ + | "NOT_A_NUMBER" + /** The record with the ID used as the input value couldn't be found. */ + | "NOT_FOUND" + /** Only one billing policy type can be defined. */ + | "ONLY_NEED_ONE_BILLING_POLICY_TYPE" + /** A fixed billing policy's checkout charge can have at most one value. */ + | "ONLY_NEED_ONE_CHECKOUT_CHARGE_VALUE" + /** Only one delivery policy type can be defined. */ + | "ONLY_NEED_ONE_DELIVERY_POLICY_TYPE" + /** Only one pricing policy type can be defined. */ + | "ONLY_NEED_ONE_PRICING_POLICY_TYPE" + /** Only one pricing policy adjustment value type can be defined. */ + | "ONLY_NEED_ONE_PRICING_POLICY_VALUE" + /** A selling plan can't have both fixed and recurring billing policies. */ + | "ONLY_ONE_OF_FIXED_OR_RECURRING_BILLING" + /** A selling plan can't have both fixed and recurring delivery policies. */ + | "ONLY_ONE_OF_FIXED_OR_RECURRING_DELIVERY" + /** Selling plan does not exist. */ + | "PLAN_DOES_NOT_EXIST" + /** Selling plan ID must be specified to update. */ + | "PLAN_ID_MUST_BE_SPECIFIED_TO_UPDATE" + /** The input value needs to be blank. */ + | "PRESENT" + /** Pricing policy's adjustment value and adjustment type must match. */ + | "PRICING_POLICY_ADJUSTMENT_VALUE_AND_TYPE_MUST_MATCH" + /** Product does not exist. */ + | "PRODUCT_DOES_NOT_EXIST" + /** Product variant does not exist. */ + | "PRODUCT_VARIANT_DOES_NOT_EXIST" + /** A fixed billing policy's remaining_balance_charge_exact_time must not be present when the remaining_balance_charge_trigger isn't EXACT_TIME. */ + | "REMAINING_BALANCE_CHARGE_EXACT_TIME_NOT_ALLOWED" + /** A fixed billing policy's remaining_balance_charge_exact_time can't be blank when the remaining_balance_charge_trigger is EXACT_TIME. */ + | "REMAINING_BALANCE_CHARGE_EXACT_TIME_REQUIRED" + /** A fixed billing policy's remaining_balance_charge_time_after_checkout must be present and greater than zero when the remaining_balance_charge_trigger is TIME_AFTER_CHECKOUT. */ + | "REMAINING_BALANCE_CHARGE_TIME_AFTER_CHECKOUT_MUST_BE_GREATER_THAN_ZERO" + /** A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is less than 100. */ + | "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PARTIAL_PERCENTAGE_CHECKOUT_CHARGE" + /** A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PRICE. */ + | "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PRICE_CHECKOUT_CHARGE" + /** A fixed billing policy's remaining_balance_charge_trigger must be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is 100. */ + | "REMAINING_BALANCE_CHARGE_TRIGGER_ON_FULL_CHECKOUT" + /** The selling plan list provided contains 1 or more invalid IDs. */ + | "RESOURCE_LIST_CONTAINS_INVALID_IDS" + /** A fixed delivery policy's anchors must not be present when the fulfillment_trigger isn't ANCHOR. */ + | "SELLING_PLAN_ANCHORS_NOT_ALLOWED" + /** A fixed delivery policy's anchors must be present when the fulfillment_trigger is ANCHOR. */ + | "SELLING_PLAN_ANCHORS_REQUIRED" + /** Selling plan's billing and delivery policies anchors must be equal. */ + | "SELLING_PLAN_BILLING_AND_DELIVERY_POLICY_ANCHORS_MUST_BE_EQUAL" + /** Selling plan's billing cycle must be a multiple of delivery cycle. */ + | "SELLING_PLAN_BILLING_CYCLE_MUST_BE_A_MULTIPLE_OF_DELIVERY_CYCLE" + /** Missing billing policy. */ + | "SELLING_PLAN_BILLING_POLICY_MISSING" + /** Must include at least one selling plan. */ + | "SELLING_PLAN_COUNT_LOWER_BOUND" + /** Exceeded the selling plan limit (31). */ + | "SELLING_PLAN_COUNT_UPPER_BOUND" + /** Missing delivery policy. */ + | "SELLING_PLAN_DELIVERY_POLICY_MISSING" + /** Cannot have multiple selling plans with the same name. */ + | "SELLING_PLAN_DUPLICATE_NAME" + /** Cannot have multiple selling plans with the same options. */ + | "SELLING_PLAN_DUPLICATE_OPTIONS" + /** A fixed selling plan can have at most one pricing policy. */ + | "SELLING_PLAN_FIXED_PRICING_POLICIES_LIMIT" + /** Selling plan's billing policy max cycles must be greater than min cycles. */ + | "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES" + /** Cannot define option2 on this selling plan as there's no label on the parent selling plan group. */ + | "SELLING_PLAN_MISSING_OPTION2_LABEL_ON_PARENT_GROUP" + /** Cannot define option3 on this selling plan as there's no label on the parent selling plan group. */ + | "SELLING_PLAN_MISSING_OPTION3_LABEL_ON_PARENT_GROUP" + /** Selling plan's option2 is required because option2 exists. */ + | "SELLING_PLAN_OPTION2_REQUIRED_AS_DEFINED_ON_PARENT_GROUP" + /** Selling plan's option3 is required because option3 exists. */ + | "SELLING_PLAN_OPTION3_REQUIRED_AS_DEFINED_ON_PARENT_GROUP" + /** Selling plans can't have more than 2 pricing policies. */ + | "SELLING_PLAN_PRICING_POLICIES_LIMIT" + /** Selling plan's pricing policies must contain one fixed pricing policy. */ + | "SELLING_PLAN_PRICING_POLICIES_MUST_CONTAIN_A_FIXED_PRICING_POLICY" + /** The input value is already taken. */ + | "TAKEN" + /** The input value is too big. */ + | "TOO_BIG" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** The input value is the wrong length. */ + | "WRONG_LENGTH"; + +/** The input fields to create or update a selling plan. */ +export type SellingPlanInput = { + /** Selling plan policy which describes the billing details. */ + billingPolicy?: InputMaybe; + /** The category used to classify this selling plan for reporting purposes. */ + category?: InputMaybe; + /** A selling plan policy which describes the delivery details. */ + deliveryPolicy?: InputMaybe; + /** Buyer facing string which describes the selling plan commitment. */ + description?: InputMaybe; + /** ID of the selling plan. */ + id?: InputMaybe; + /** A selling plan policy which describes the inventory details. */ + inventoryPolicy?: InputMaybe; + /** Buyer facing string which describes the selling plan content. */ + name?: InputMaybe; + /** The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values. */ + options?: InputMaybe>; + /** Relative value for display purposes of this plan. A lower position will be displayed before a higher one. */ + position?: InputMaybe; + /** + * The pricing policies which describe the pricing details. Each selling plan + * can only contain a maximum of 2 pricing policies. + */ + pricingPolicies?: InputMaybe>; +}; + +/** Represents valid selling plan interval. */ +export type SellingPlanInterval = + /** Day interval. */ + | "DAY" + /** Month interval. */ + | "MONTH" + /** Week interval. */ + | "WEEK" + /** Year interval. */ + | "YEAR"; + +/** The selling plan inventory policy. */ +export type SellingPlanInventoryPolicy = { + /** When to reserve inventory for the order. */ + reserve: SellingPlanReserve; +}; + +/** The input fields required to create or update an inventory policy. */ +export type SellingPlanInventoryPolicyInput = { + /** When to reserve inventory for the order. The value must be ON_FULFILLMENT or ON_SALE. */ + reserve?: InputMaybe; +}; + +/** + * Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set + * for a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and + * associated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48 + * hours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need + * to restore them later. + */ +export type SellingPlanPricingPolicy = + | SellingPlanFixedPricingPolicy + | SellingPlanRecurringPricingPolicy; + +/** Represents a selling plan pricing policy adjustment type. */ +export type SellingPlanPricingPolicyAdjustmentType = + /** Fixed amount off adjustment. */ + | "FIXED_AMOUNT" + /** Percentage off adjustment. */ + | "PERCENTAGE" + /** Price of the policy. */ + | "PRICE"; + +/** Represents a selling plan pricing policy adjustment value type. */ +export type SellingPlanPricingPolicyAdjustmentValue = + | MoneyV2 + | SellingPlanPricingPolicyPercentageValue; + +/** Represents selling plan pricing policy common fields. */ +export type SellingPlanPricingPolicyBase = { + /** The price adjustment type. */ + adjustmentType: SellingPlanPricingPolicyAdjustmentType; + /** The price adjustment value. */ + adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; +}; + +/** The input fields required to create or update a selling plan pricing policy. */ +export type SellingPlanPricingPolicyInput = { + /** Fixed pricing policy details. */ + fixed?: InputMaybe; + /** Recurring pricing policy details. */ + recurring?: InputMaybe; +}; + +/** The percentage value of a selling plan pricing policy percentage type. */ +export type SellingPlanPricingPolicyPercentageValue = { + /** The percentage value. */ + percentage: Scalars["Float"]["output"]; +}; + +/** The input fields required to create or update a pricing policy adjustment value. */ +export type SellingPlanPricingPolicyValueInput = { + /** The fixed value for an fixed amount off or a new policy price. */ + fixedValue?: InputMaybe; + /** The percentage value. */ + percentage?: InputMaybe; +}; + +/** Represents a recurring selling plan billing policy. */ +export type SellingPlanRecurringBillingPolicy = { + /** Specific anchor dates upon which the billing interval calculations should be made. */ + anchors: Array; + /** The date and time when the selling plan billing policy was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The billing frequency, it can be either: day, week, month or year. */ + interval: SellingPlanInterval; + /** The number of intervals between billings. */ + intervalCount: Scalars["Int"]["output"]; + /** Maximum number of billing iterations. */ + maxCycles?: Maybe; + /** Minimum number of billing iterations. */ + minCycles?: Maybe; +}; + +/** The input fields required to create or update a recurring billing policy. */ +export type SellingPlanRecurringBillingPolicyInput = { + /** Specific anchor dates upon which the billing interval calculations should be made. */ + anchors?: InputMaybe>; + /** The billing frequency, it can be either: day, week, month or year. */ + interval?: InputMaybe; + /** The number of intervals between billings. */ + intervalCount?: InputMaybe; + /** Maximum number of billing iterations. */ + maxCycles?: InputMaybe; + /** Minimum number of billing iterations. */ + minCycles?: InputMaybe; +}; + +/** Represents a recurring selling plan delivery policy. */ +export type SellingPlanRecurringDeliveryPolicy = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors: Array; + /** The date and time when the selling plan delivery policy was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Number of days which represent a buffer period for orders to be included in a cycle. */ + cutoff?: Maybe; + /** + * Whether the delivery policy is merchant or buyer-centric. + * Buyer-centric delivery policies state the time when the buyer will receive the goods. + * Merchant-centric delivery policies state the time when the fulfillment should be started. + * Currently, only merchant-centric delivery policies are supported. + */ + intent: SellingPlanRecurringDeliveryPolicyIntent; + /** The delivery frequency, it can be either: day, week, month or year. */ + interval: SellingPlanInterval; + /** The number of intervals between deliveries. */ + intervalCount: Scalars["Int"]["output"]; + /** The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`. */ + preAnchorBehavior: SellingPlanRecurringDeliveryPolicyPreAnchorBehavior; +}; + +/** The input fields to create or update a recurring delivery policy. */ +export type SellingPlanRecurringDeliveryPolicyInput = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors?: InputMaybe>; + /** A buffer period for orders to be included in a cycle. */ + cutoff?: InputMaybe; + /** Intention of this delivery policy, it can be either: delivery or fulfillment. */ + intent?: InputMaybe; + /** The delivery frequency, it can be either: day, week, month or year. */ + interval?: InputMaybe; + /** The number of intervals between deliveries. */ + intervalCount?: InputMaybe; + /** The pre-anchor behavior. It can be either: asap or next. */ + preAnchorBehavior?: InputMaybe< + SellingPlanRecurringDeliveryPolicyPreAnchorBehavior + >; +}; + +/** Whether the delivery policy is merchant or buyer-centric. */ +export type SellingPlanRecurringDeliveryPolicyIntent = /** + * A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment. + */ + "FULFILLMENT_BEGIN"; + +/** The fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor. */ +export type SellingPlanRecurringDeliveryPolicyPreAnchorBehavior = + /** + * The orders placed can be fulfilled or delivered immediately. The orders placed inside a cutoff can be fulfilled or delivered at the next anchor. + */ + | "ASAP" + /** + * The orders placed can be fulfilled or delivered at the next anchor date. + * The orders placed inside a cutoff will skip the next anchor and can be fulfilled or + * delivered at the following anchor. + */ + | "NEXT"; + +/** Represents a recurring selling plan pricing policy. */ +export type SellingPlanRecurringPricingPolicy = SellingPlanPricingPolicyBase & { + /** The price adjustment type. */ + adjustmentType: SellingPlanPricingPolicyAdjustmentType; + /** The price adjustment value. */ + adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; + /** Cycle after which this pricing policy applies. */ + afterCycle?: Maybe; + /** The date and time when the recurring selling plan pricing policy was created. */ + createdAt: Scalars["DateTime"]["output"]; +}; + +/** The input fields required to create or update a recurring selling plan pricing policy. */ +export type SellingPlanRecurringPricingPolicyInput = { + /** Price adjustment type defined by the policy. */ + adjustmentType?: InputMaybe; + /** Price adjustment value defined by the policy. */ + adjustmentValue?: InputMaybe; + /** Cycle after which the pricing policy applies. */ + afterCycle: Scalars["Int"]["input"]; + /** ID of the pricing policy. */ + id?: InputMaybe; +}; + +/** When to capture the payment for the remaining amount due. */ +export type SellingPlanRemainingBalanceChargeTrigger = + /** At an exact time defined by the remaining_balance_charge_exact_time field. */ + | "EXACT_TIME" + /** When there's no remaining balance to be charged after checkout. */ + | "NO_REMAINING_BALANCE" + /** After the duration defined by the remaining_balance_charge_time_after_checkout field. */ + | "TIME_AFTER_CHECKOUT"; + +/** When to reserve inventory for a selling plan. */ +export type SellingPlanReserve = + /** Reserve inventory when order is fulfilled. */ + | "ON_FULFILLMENT" + /** Reserve inventory at time of sale. */ + | "ON_SALE"; + +/** A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint. */ +export type ServerPixel = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The current state of this server pixel. */ + status?: Maybe; + /** Address of the EventBridge or PubSub endpoint. */ + webhookEndpointAddress?: Maybe; +}; + +/** Return type for `serverPixelCreate` mutation. */ +export type ServerPixelCreatePayload = { + /** The new server pixel. */ + serverPixel?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `serverPixelDelete` mutation. */ +export type ServerPixelDeletePayload = { + /** The ID of the server pixel that was deleted, if one was deleted. */ + deletedServerPixelId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The current state of a server pixel. */ +export type ServerPixelStatus = + /** This server pixel is connected: it will stream customer events to the endpoint if it is configured properly. */ + | "CONNECTED" + /** This server pixel is disconnected: it does not stream events to the endpoint and an endpoint address has been added to the server pixel. */ + | "DISCONNECTED_CONFIGURED" + /** This server pixel is disconnected and unconfigured: it does not stream events to the endpoint and no endpoint address had been added to the server pixel. */ + | "DISCONNECTED_UNCONFIGURED"; + +/** The class of the discount for combining purposes. */ +export type ShippingDiscountClass = /** Combined as a shipping discount. */ + "SHIPPING"; + +/** Represents the shipping details that the customer chose for their order. */ +export type ShippingLine = { + /** + * A reference to the carrier service that provided the rate. + * Present when the rate was computed by a third-party carrier service. + */ + carrierIdentifier?: Maybe; + /** A reference to the shipping method. */ + code?: Maybe; + /** Whether the shipping line is custom or not. */ + custom: Scalars["Boolean"]["output"]; + /** The general classification of the delivery method. */ + deliveryCategory?: Maybe; + /** + * The discounts that have been allocated to the shipping line. + */ + discountAllocations: Array; + /** + * The pre-tax shipping price with discounts applied. + * @deprecated Use `discountedPriceSet` instead. + */ + discountedPrice: MoneyV2; + /** The pre-tax shipping price with discounts applied. */ + discountedPriceSet: MoneyBag; + /** A globally-unique ID. */ + id?: Maybe; + /** + * The pre-tax shipping price without any discounts applied. + * @deprecated Use `originalPriceSet` instead. + */ + originalPrice: MoneyV2; + /** The pre-tax shipping price without any discounts applied. */ + originalPriceSet: MoneyBag; + /** The phone number at the shipping address. */ + phone?: Maybe; + /** + * Returns the price of the shipping line. + * @deprecated Use `originalPriceSet` instead. + */ + price: Scalars["Money"]["output"]; + /** + * The fulfillment service requested for the shipping method. + * Present if the shipping method requires processing by a third party fulfillment service. + */ + requestedFulfillmentService?: Maybe; + /** A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users. */ + shippingRateHandle?: Maybe; + /** Returns the rate source for the shipping line. */ + source?: Maybe; + /** The TaxLine objects connected to this shipping line. */ + taxLines: Array; + /** Returns the title of the shipping line. */ + title: Scalars["String"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ShippingLines. + */ +export type ShippingLineConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ShippingLineEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ShippingLine and a cursor during pagination. + */ +export type ShippingLineEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ShippingLineEdge. */ + node: ShippingLine; +}; + +/** The input fields for specifying the shipping details for the order. */ +export type ShippingLineInput = { + /** Price of the shipping rate. */ + price?: InputMaybe; + /** A unique identifier for the shipping rate. */ + shippingRateHandle?: InputMaybe; + /** Title of the shipping rate. */ + title?: InputMaybe; +}; + +/** A sale associated with a shipping charge. */ +export type ShippingLineSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** The shipping line item for the associated sale. `shippingLine` is not available if the `SaleActionType` is a return. */ + shippingLine?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** + * The shipping method for the delivery. Customers will see applicable shipping methods in the shipping section of checkout. + */ +export type ShippingMethod = { + /** A unique code associated with the rate. For example: `expedited_mail` */ + code: Scalars["String"]["output"]; + /** + * A description of the rate, which customers will see at checkout. + * For example: `Local delivery`, `Free Express Worldwide`, `Includes tracking and insurance`. + */ + label: Scalars["String"]["output"]; +}; + +/** Return type for `shippingPackageDelete` mutation. */ +export type ShippingPackageDeletePayload = { + /** The ID of the deleted shipping package. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `shippingPackageMakeDefault` mutation. */ +export type ShippingPackageMakeDefaultPayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Type of a shipping package. */ +export type ShippingPackageType = + /** A shipping box. */ + | "BOX" + /** An envelope. */ + | "ENVELOPE" + /** A flat rate packaging supplied by a carrier. */ + | "FLAT_RATE" + /** A soft-pack, bubble-wrap or vinyl envelope. */ + | "SOFT_PACK"; + +/** Return type for `shippingPackageUpdate` mutation. */ +export type ShippingPackageUpdatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** A shipping rate is an additional cost added to the cost of the products that were ordered. */ +export type ShippingRate = { + /** Human-readable unique identifier for this shipping rate. */ + handle: Scalars["String"]["output"]; + /** The cost associated with the shipping rate. */ + price: MoneyV2; + /** The name of the shipping rate. */ + title: Scalars["String"]["output"]; +}; + +/** Represents the shipping costs refunded on the Refund. */ +export type ShippingRefund = { + /** + * The monetary value of the shipping fees to be refunded. + * @deprecated Use `amountSet` instead. + */ + amount: Scalars["Money"]["output"]; + /** The monetary value of the shipping fees to be refunded in shop and presentment currencies. */ + amountSet: MoneyBag; + /** + * The maximum amount of shipping fees currently refundable. + * @deprecated Use `maximumRefundableSet` instead. + */ + maximumRefundable: Scalars["Money"]["output"]; + /** The maximum amount of shipping fees currently refundable in shop and presentment currencies. */ + maximumRefundableSet: MoneyBag; + /** + * The monetary value of the tax allocated to shipping fees to be refunded. + * @deprecated Use `taxSet` instead. + */ + tax: Scalars["Money"]["output"]; + /** The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies. */ + taxSet: MoneyBag; +}; + +/** The input fields that are required to reimburse shipping costs. */ +export type ShippingRefundInput = { + /** The monetary value of the shipping fees to be reimbursed. */ + amount?: InputMaybe; + /** Whether a full refund is provided. */ + fullRefund?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type Shop = HasMetafields & HasPublishedTranslations & Node & { + /** A list of the shop's active alert messages that appear in the Shopify admin. */ + alerts: Array; + /** A list of the shop's product categories. Limit: 1000 product categories. */ + allProductCategories: Array; + /** + * The token required to query the shop's reports or dashboards. + * @deprecated Not supported anymore. + */ + analyticsToken: Scalars["String"]["output"]; + /** + * The paginated list of fulfillment orders assigned to the shop locations owned by the app. + * + * Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations + * managed by + * [fulfillment services](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) + * that are registered by the app. + * One app (api_client) can host multiple fulfillment services on a shop. + * Each fulfillment service manages a dedicated location on a shop. + * Assigned fulfillment orders can have associated + * [fulfillment requests](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus), + * or might currently not be requested to be fulfilled. + * + * The app must have `read_assigned_fulfillment_orders` + * [access scope](https://shopify.dev/docs/api/usage/access-scopes) + * to be able to retrieve fulfillment orders assigned to its locations. + * + * All assigned fulfillment orders (except those with the `CLOSED` status) will be returned by default. + * Perform filtering with the `assignmentStatus` argument + * to receive only fulfillment orders that have been requested to be fulfilled. + */ + assignedFulfillmentOrders: FulfillmentOrderConnection; + /** The list of sales channels not currently installed on the shop. */ + availableChannelApps: AppConnection; + /** The shop's billing address information. */ + billingAddress: ShopAddress; + /** + * Exposes the number of channels. + * @deprecated Use `publicationCount` instead. + */ + channelCount: Scalars["Int"]["output"]; + /** List of all channel definitions associated with a shop. */ + channelDefinitionsForInstalledChannels: Array< + AvailableChannelDefinitionsByChannel + >; + /** + * List of the shop's active sales channels. + * @deprecated Use `QueryRoot.channels` instead. + */ + channels: ChannelConnection; + /** Specifies whether the shop supports checkouts via Checkout API. */ + checkoutApiSupported: Scalars["Boolean"]["output"]; + /** + * Return a collection by its handle. + * @deprecated Use `QueryRoot.collectionByHandle` instead. + */ + collectionByHandle?: Maybe; + /** + * List of the shop's collection saved searches. + * @deprecated Use `QueryRoot.collectionSavedSearches` instead. + */ + collectionSavedSearches: SavedSearchConnection; + /** + * List of the shop's collections. + * @deprecated Use `QueryRoot.collections` instead. + */ + collections: CollectionConnection; + /** + * The public-facing contact email address for the shop. + * Customers will use this email to communicate with the shop owner. + */ + contactEmail: Scalars["String"]["output"]; + /** Countries that have been defined in shipping zones for the shop. */ + countriesInShippingZones: CountriesInShippingZones; + /** The three letter code for the currency that the shop sells in. */ + currencyCode: CurrencyCode; + /** How currencies are displayed on your store. */ + currencyFormats: CurrencyFormats; + /** The presentment currency settings for the shop excluding the shop's own currency. */ + currencySettings: CurrencySettingConnection; + /** Whether customer accounts are required, optional, or disabled for the shop. */ + customerAccounts: ShopCustomerAccountsSetting; + /** + * List of the shop's customer saved searches. + * @deprecated Use `QueryRoot.customerSavedSearches` instead. + */ + customerSavedSearches: SavedSearchConnection; + /** A list of tags that have been added to customer accounts. */ + customerTags: StringConnection; + /** + * Customer accounts associated to the shop. + * @deprecated Use `QueryRoot.customers` instead. + */ + customers: CustomerConnection; + /** The shop's meta description used in search engine results. */ + description?: Maybe; + /** + * The domains configured for the shop. + * @deprecated Use `domainsPaginated` instead. + */ + domains: Array; + /** + * List of the shop's draft order saved searches. + * @deprecated Use `QueryRoot.draftOrderSavedSearches` instead. + */ + draftOrderSavedSearches: SavedSearchConnection; + /** A list of tags that have been added to draft orders. */ + draftOrderTags: StringConnection; + /** + * List of saved draft orders on the shop. + * @deprecated Use `QueryRoot.draftOrders` instead. + */ + draftOrders: DraftOrderConnection; + /** + * The shop owner's email address. + * Shopify will use this email address to communicate with the shop owner. + */ + email: Scalars["String"]["output"]; + /** The presentment currencies enabled for the shop. */ + enabledPresentmentCurrencies: Array; + /** The set of features enabled for the shop. */ + features: ShopFeatures; + /** + * The paginated list of merchant-managed and third-party fulfillment orders. + * @deprecated Use `QueryRoot.fulfillmentOrders` instead. + */ + fulfillmentOrders: FulfillmentOrderConnection; + /** List of the shop's installed fulfillment services. */ + fulfillmentServices: Array; + /** The shop's time zone as defined by the IANA. */ + ianaTimezone: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * List of the shop's inventory items. + * @deprecated Use `QueryRoot.inventoryItems` instead. + */ + inventoryItems: InventoryItemConnection; + /** + * The number of pendings orders on the shop. + * Limited to a maximum of 10000. + */ + limitedPendingOrderCount: LimitedPendingOrderCount; + /** + * List of active locations of the shop. + * @deprecated Use `QueryRoot.locations` instead. + */ + locations: LocationConnection; + /** + * List of a shop's marketing events. + * @deprecated Use `QueryRoot.marketingEvents` instead. + */ + marketingEvents: MarketingEventConnection; + /** The approval signals for a shop to support onboarding to channel apps. */ + merchantApprovalSignals?: Maybe; + /** Returns a metafield by namespace and key that belongs to the resource. */ + metafield?: Maybe; + /** List of metafields that belong to the resource. */ + metafields: MetafieldConnection; + /** The shop's .myshopify.com domain name. */ + myshopifyDomain: Scalars["String"]["output"]; + /** The shop's name. */ + name: Scalars["String"]["output"]; + /** The shop's settings related to navigation. */ + navigationSettings: Array; + /** The prefix that appears before order numbers. */ + orderNumberFormatPrefix: Scalars["String"]["output"]; + /** The suffix that appears after order numbers. */ + orderNumberFormatSuffix: Scalars["String"]["output"]; + /** + * List of the shop's order saved searches. + * @deprecated Use `QueryRoot.orderSavedSearches` instead. + */ + orderSavedSearches: SavedSearchConnection; + /** A list of tags that have been added to orders. */ + orderTags: StringConnection; + /** + * A list of the shop's orders. + * @deprecated Use `QueryRoot.orders` instead. + */ + orders: OrderConnection; + /** The shop's settings related to payments. */ + paymentSettings: PaymentSettings; + /** + * Number of pending orders on the shop. + * @deprecated Use `limitedPendingOrderCount` instead. + */ + pendingOrderCount: Scalars["Int"]["output"]; + /** The shop's billing plan. */ + plan: ShopPlan; + /** + * List of the shop's price rule saved searches. + * @deprecated Use `QueryRoot.priceRuleSavedSearches` instead. + */ + priceRuleSavedSearches: SavedSearchConnection; + /** + * List of the shop’s price rules. + * @deprecated Use `QueryRoot.priceRules` instead. + */ + priceRules: PriceRuleConnection; + /** The primary domain of the shop's online store. */ + primaryDomain: Domain; + /** + * Returns a private metafield by namespace and key that belongs to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafield?: Maybe; + /** + * List of private metafields that belong to the resource. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafields: PrivateMetafieldConnection; + /** + * Return a product by its handle. + * @deprecated Use `QueryRoot.productByHandle` instead. + */ + productByHandle?: Maybe; + /** The list of all images of all products for the shop. */ + productImages: ImageConnection; + /** + * List of the shop's product saved searches. + * @deprecated Use `QueryRoot.productSavedSearches` instead. + */ + productSavedSearches: SavedSearchConnection; + /** A list of tags that have been added to products. */ + productTags: StringConnection; + /** The list of types added to products. */ + productTypes: StringConnection; + /** + * List of the shop's product variants. + * @deprecated Use `QueryRoot.productVariants` instead. + */ + productVariants: ProductVariantConnection; + /** The list of vendors added to products. */ + productVendors: StringConnection; + /** + * List of the shop's products. + * @deprecated Use `QueryRoot.products`. + */ + products: ProductConnection; + /** The number of publications for the shop. */ + publicationCount: Scalars["Int"]["output"]; + /** The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed. */ + resourceLimits: ShopResourceLimits; + /** The URL of the rich text editor that can be used for mobile devices. */ + richTextEditorUrl: Scalars["URL"]["output"]; + /** Fetches a list of admin search results by a specified query. */ + search: SearchResultConnection; + /** The list of search filter options for the shop. These can be used to filter productvisibility for the shop. */ + searchFilters: SearchFilterOptions; + /** Whether the shop has outstanding setup steps. */ + setupRequired: Scalars["Boolean"]["output"]; + /** The list of countries that the shop ships to. */ + shipsToCountries: Array; + /** The list of all legal policies associated with a shop. */ + shopPolicies: Array; + /** + * Shopify Payments account information, including balances and payouts. + * @deprecated Use `QueryRoot.shopifyPaymentsAccount` instead. + */ + shopifyPaymentsAccount?: Maybe; + /** The paginated list of the shop's staff members. */ + staffMembers: StaffMemberConnection; + /** The storefront access token of a private application. These are scoped per-application. */ + storefrontAccessTokens: StorefrontAccessTokenConnection; + /** + * The URL of the shop's storefront. + * @deprecated Use `url` instead. + */ + storefrontUrl: Scalars["URL"]["output"]; + /** Whether the shop charges taxes for shipping. */ + taxShipping: Scalars["Boolean"]["output"]; + /** Whether applicable taxes are included in the shop's product prices. */ + taxesIncluded: Scalars["Boolean"]["output"]; + /** The shop's time zone abbreviation. */ + timezoneAbbreviation: Scalars["String"]["output"]; + /** The shop's time zone offset. */ + timezoneOffset: Scalars["String"]["output"]; + /** The shop's time zone offset expressed as a number of minutes. */ + timezoneOffsetMinutes: Scalars["Int"]["output"]; + /** Whether transactional SMS sent by Shopify have been disabled for a shop. */ + transactionalSmsDisabled: Scalars["Boolean"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** The shop's unit system for weights and measures. */ + unitSystem: UnitSystem; + /** Fetches a list of images uploaded to the shop by their IDs. */ + uploadedImagesByIds: Array; + /** The URL of the shop's online store. */ + url: Scalars["URL"]["output"]; + /** The shop's primary unit of weight for products and shipping. */ + weightUnit: WeightUnit; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopAssignedFulfillmentOrdersArgs = { + after?: InputMaybe; + assignmentStatus?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + locationIds?: InputMaybe>; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopAvailableChannelAppsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopChannelsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCollectionByHandleArgs = { + handle: Scalars["String"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCollectionSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCurrencySettingsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCustomerSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCustomerTagsArgs = { + first: Scalars["Int"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopCustomersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopDraftOrderSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopDraftOrderTagsArgs = { + first: Scalars["Int"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopDraftOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopFulfillmentOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + includeClosed?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopInventoryItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + includeInactive?: InputMaybe; + includeLegacy?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopMarketingEventsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + keys?: InputMaybe>; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopOrderSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopOrderTagsArgs = { + first: Scalars["Int"]["input"]; + sort?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopPriceRuleSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopPriceRulesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopPrivateMetafieldArgs = { + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopPrivateMetafieldsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + namespace?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductByHandleArgs = { + handle: Scalars["String"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductImagesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductSavedSearchesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductTagsArgs = { + first: Scalars["Int"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductTypesArgs = { + first: Scalars["Int"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductVendorsArgs = { + first: Scalars["Int"]["input"]; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + savedSearchId?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopSearchArgs = { + after?: InputMaybe; + first: Scalars["Int"]["input"]; + query: Scalars["String"]["input"]; + types?: InputMaybe>; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopStaffMembersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopStorefrontAccessTokensArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** + * Represents a collection of general settings and information about the shop. + */ +export type ShopUploadedImagesByIdsArgs = { + imageIds: Array; +}; + +/** The shop's billing address. */ +export type ShopAddress = Node & { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + */ + address2?: Maybe; + /** + * The name of the city, district, village, or town. + */ + city?: Maybe; + /** The name of the company or organization. */ + company?: Maybe; + /** Whether the address coordinates are valid. */ + coordinatesValidated: Scalars["Boolean"]["output"]; + /** + * The name of the country. + */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + * + * @deprecated Use `countryCodeV2` instead. + */ + countryCode?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + */ + countryCodeV2?: Maybe; + /** + * The first name. + * @deprecated Always null in this context. + */ + firstName?: Maybe; + /** A formatted version of the address, customized by the provided arguments. */ + formatted: Array; + /** A comma-separated list of the values for city, province, and country. */ + formattedArea?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The last name. + * @deprecated Always null in this context. + */ + lastName?: Maybe; + /** The latitude coordinate of the address. */ + latitude?: Maybe; + /** The longitude coordinate of the address. */ + longitude?: Maybe; + /** + * The full name, based on firstName and lastName. + * + * @deprecated Always null in this context. + */ + name?: Maybe; + /** + * A phone number associated with the address. + * + * Formatted using E.164 standard. For example, _+16135551111_. + */ + phone?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * + * For example, ON. + */ + provinceCode?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + +/** The shop's billing address. */ +export type ShopAddressFormattedArgs = { + withCompany?: InputMaybe; +}; + +/** + * An alert message that appears in the Shopify admin about a problem with a store setting, with an action to take. For example, you could show an alert to ask the merchant to enter their billing information to activate Shopify Plus. + */ +export type ShopAlert = { + /** + * The text for the button in the alert that links to related information. For example, _Add credit card_. + */ + action: ShopAlertAction; + /** A description of the alert and further information, such as whether the merchant will be charged. */ + description: Scalars["String"]["output"]; +}; + +/** An action associated to a shop alert, such as adding a credit card. */ +export type ShopAlertAction = { + /** The text for the button in the alert. For example, _Add credit card_. */ + title: Scalars["String"]["output"]; + /** The target URL that the button links to. */ + url: Scalars["URL"]["output"]; +}; + +/** Billing preferences for the shop. */ +export type ShopBillingPreferences = { + /** The currency the shop uses to pay for apps and services. */ + currency: CurrencyCode; +}; + +/** + * Possible branding of a shop. + * Branding can be used to define the look of a shop including its styling and logo in the Shopify Admin. + */ +export type ShopBranding = + /** Shop has Rogers branding. */ + | "ROGERS" + /** Shop has Shopify branding. */ + | "SHOPIFY" + /** Shop has Shopify Gold branding. */ + | "SHOPIFY_GOLD" + /** Shop has Shopify Plus branding. */ + | "SHOPIFY_PLUS"; + +/** + * Represents the shop's customer account requirement preference. + */ +export type ShopCustomerAccountsSetting = + | "DISABLED" + | "OPTIONAL" + | "REQUIRED"; + +/** + * Represents the feature set available to the shop. + * Most fields specify whether a feature is enabled for a shop, and some fields return information + * related to specific features. + */ +export type ShopFeatures = { + /** Whether a shop has access to Avalara AvaTax. */ + avalaraAvatax: Scalars["Boolean"]["output"]; + /** The branding of the shop, which influences its look and feel in the Shopify admin. */ + branding: ShopBranding; + /** Represents the Bundles feature configuration for the shop. */ + bundles: BundlesFeature; + /** Whether a shop's online store can have CAPTCHA protection. */ + captcha: Scalars["Boolean"]["output"]; + /** Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify. */ + captchaExternalDomains: Scalars["Boolean"]["output"]; + /** + * Whether the delivery profiles functionality is enabled for this shop. + * @deprecated Delivery profiles are now 100% enabled across Shopify. + */ + deliveryProfiles: Scalars["Boolean"]["output"]; + /** Whether a shop has access to the Google Analytics dynamic remarketing feature. */ + dynamicRemarketing: Scalars["Boolean"]["output"]; + /** Whether a shop can be migrated to use Shopify subscriptions. */ + eligibleForSubscriptionMigration: Scalars["Boolean"]["output"]; + /** Whether a shop is configured properly to sell subscriptions. */ + eligibleForSubscriptions: Scalars["Boolean"]["output"]; + /** Whether a shop can create gift cards. */ + giftCards: Scalars["Boolean"]["output"]; + /** + * Whether a shop displays Harmonized System codes on products. This is used for customs when shipping + * internationally. + */ + harmonizedSystemCode: Scalars["Boolean"]["output"]; + /** Whether a shop can enable international domains. */ + internationalDomains: Scalars["Boolean"]["output"]; + /** Whether a shop can enable international price overrides. */ + internationalPriceOverrides: Scalars["Boolean"]["output"]; + /** Whether a shop can enable international price rules. */ + internationalPriceRules: Scalars["Boolean"]["output"]; + /** Whether a shop has enabled a legacy subscription gateway to handle older subscriptions. */ + legacySubscriptionGatewayEnabled: Scalars["Boolean"]["output"]; + /** + * Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial + * or don't have a storefront. + */ + liveView: Scalars["Boolean"]["output"]; + /** + * Whether a shop has multi-location functionality. + * @deprecated All shops support multi-location inventory. Use `QueryRoot.locations` to determine whether shop has more than one location. + */ + multiLocation: Scalars["Boolean"]["output"]; + /** Whether a shop has access to the onboarding visual. */ + onboardingVisual: Scalars["Boolean"]["output"]; + /** Whether a shop is configured to sell subscriptions with PayPal Express. */ + paypalExpressSubscriptionGatewayStatus: + PaypalExpressSubscriptionsGatewayStatus; + /** Whether a shop has access to all reporting features. */ + reports: Scalars["Boolean"]["output"]; + /** Whether a shop has ever had subscription products. */ + sellsSubscriptions: Scalars["Boolean"]["output"]; + /** + * Whether the shop has a Shopify Plus subscription. + * @deprecated Use Shop.plan.shopifyPlus instead. + */ + shopifyPlus: Scalars["Boolean"]["output"]; + /** + * Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful. + */ + showMetrics: Scalars["Boolean"]["output"]; + /** Whether a shop has an online store. */ + storefront: Scalars["Boolean"]["output"]; + /** Whether a shop is using Shopify Balance. */ + usingShopifyBalance: Scalars["Boolean"]["output"]; +}; + +/** A locale that's been enabled on a shop. */ +export type ShopLocale = { + /** The locale ISO code. */ + locale: Scalars["String"]["output"]; + /** The market web presences that use the locale. */ + marketWebPresences: Array; + /** The human-readable locale name. */ + name: Scalars["String"]["output"]; + /** Whether the locale is the default locale for the shop. */ + primary: Scalars["Boolean"]["output"]; + /** Whether the locale is visible to buyers. */ + published: Scalars["Boolean"]["output"]; +}; + +/** Return type for `shopLocaleDisable` mutation. */ +export type ShopLocaleDisablePayload = { + /** ISO code of the locale that was deleted. */ + locale?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `shopLocaleEnable` mutation. */ +export type ShopLocaleEnablePayload = { + /** ISO code of the locale that was enabled. */ + shopLocale?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for a shop locale. + */ +export type ShopLocaleInput = { + /** The market web presences on which the locale should be enabled. Pass in an empty array to remove the locale across all market web presences. */ + marketWebPresenceIds?: InputMaybe>; + /** Whether the locale is published. Only published locales are visible to the buyer. */ + published?: InputMaybe; +}; + +/** Return type for `shopLocaleUpdate` mutation. */ +export type ShopLocaleUpdatePayload = { + /** The locale that was updated. */ + shopLocale?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The billing plan of the shop. + */ +export type ShopPlan = { + /** The name of the shop's billing plan. */ + displayName: Scalars["String"]["output"]; + /** Whether the shop is a partner development shop for testing purposes. */ + partnerDevelopment: Scalars["Boolean"]["output"]; + /** Whether the shop has a Shopify Plus subscription. */ + shopifyPlus: Scalars["Boolean"]["output"]; +}; + +/** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ +export type ShopPolicy = HasPublishedTranslations & Node & { + /** The text of the policy. The maximum size is 512kb. */ + body: Scalars["HTML"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The translations associated with the resource. */ + translations: Array; + /** The shop policy type. */ + type: ShopPolicyType; + /** The public URL of the policy. */ + url: Scalars["URL"]["output"]; +}; + +/** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ +export type ShopPolicyTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; +}; + +/** Possible error codes that can be returned by `ShopPolicyUserError`. */ +export type ShopPolicyErrorCode = /** The input value is too big. */ + "TOO_BIG"; + +/** The input fields required to update a policy. */ +export type ShopPolicyInput = { + /** Policy text, maximum size of 512kb. */ + body: Scalars["String"]["input"]; + /** The shop policy type. */ + type: ShopPolicyType; +}; + +/** Available shop policy types. */ +export type ShopPolicyType = + /** The contact information. */ + | "CONTACT_INFORMATION" + /** The legal notice. */ + | "LEGAL_NOTICE" + /** The privacy policy. */ + | "PRIVACY_POLICY" + /** The refund policy. */ + | "REFUND_POLICY" + /** The shipping policy. */ + | "SHIPPING_POLICY" + /** The purchase options cancellation policy. */ + | "SUBSCRIPTION_POLICY" + /** The terms of sale. */ + | "TERMS_OF_SALE" + /** The terms of service. */ + | "TERMS_OF_SERVICE"; + +/** Return type for `shopPolicyUpdate` mutation. */ +export type ShopPolicyUpdatePayload = { + /** The shop policy that has been updated. */ + shopPolicy?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of a shop policy mutation. */ +export type ShopPolicyUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Return type for `shopResourceFeedbackCreate` mutation. */ +export type ShopResourceFeedbackCreatePayload = { + /** The shop feedback that's created. */ + feedback?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `ShopResourceFeedbackCreate`. */ +export type ShopResourceFeedbackCreateUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `ShopResourceFeedbackCreateUserError`. */ +export type ShopResourceFeedbackCreateUserErrorCode = + /** The input value is blank. */ + | "BLANK" + /** The input value is invalid. */ + | "INVALID" + /** The feedback for a later version of the resource was already accepted. */ + | "OUTDATED_FEEDBACK" + /** The input value needs to be blank. */ + | "PRESENT"; + +/** Resource limits of a shop. */ +export type ShopResourceLimits = { + /** Maximum number of locations allowed. */ + locationLimit: Scalars["Int"]["output"]; + /** Maximum number of product options allowed. */ + maxProductOptions: Scalars["Int"]["output"]; + /** The maximum number of variants allowed per product. */ + maxProductVariants: Scalars["Int"]["output"]; + /** Whether the shop has reached the limit of the number of URL redirects it can make for resources. */ + redirectLimitReached: Scalars["Boolean"]["output"]; + /** + * The maximum number of variants allowed per shop. If the shop has unlimited SKUs, then the quantity used can't be retrieved. + * @deprecated This field is deprecated. After the 2023-10 version, we no longer set limits on number of SKUs per shop. Use `maxProductVariants` instead. + */ + skuResourceLimits: ResourceLimit; +}; + +/** Possible sort of tags. */ +export type ShopTagSort = + /** Alphabetical sort. */ + | "ALPHABETICAL" + /** Popularity sort. */ + | "POPULAR"; + +/** A Shopify Function. */ +export type ShopifyFunction = { + /** The API type of the Shopify Function. */ + apiType: Scalars["String"]["output"]; + /** The API version of the Shopify Function. */ + apiVersion: Scalars["String"]["output"]; + /** The app that owns the Shopify Function. */ + app: App; + /** The App Bridge information for the Shopify Function. */ + appBridge: FunctionsAppBridge; + /** The client ID of the app that owns the Shopify Function. */ + appKey: Scalars["String"]["output"]; + /** The description of the Shopify Function. */ + description?: Maybe; + /** The ID of the Shopify Function. */ + id: Scalars["String"]["output"]; + /** The input query of the Shopify Function. */ + inputQuery?: Maybe; + /** The title of the Shopify Function. */ + title: Scalars["String"]["output"]; + /** If the Shopify Function uses the creation UI in the Admin. */ + useCreationUi: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple ShopifyFunctions. + */ +export type ShopifyFunctionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ShopifyFunctionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ShopifyFunction and a cursor during pagination. + */ +export type ShopifyFunctionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ShopifyFunctionEdge. */ + node: ShopifyFunction; +}; + +/** + * Balance and payout information for a + * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) + * account. Balance includes all balances for the currencies supported by the shop. + * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. + */ +export type ShopifyPaymentsAccount = Node & { + /** Whether the Shopify Payments setup is completed. */ + activated: Scalars["Boolean"]["output"]; + /** Current balances in all currencies for the account. */ + balance: Array; + /** All bank accounts configured for the Shopify Payments account. */ + bankAccounts: ShopifyPaymentsBankAccountConnection; + /** + * The statement descriptor used for charges. + * + * The statement descriptor appears on a customer's credit card or bank statement when they make a purchase. + * + * @deprecated Use `chargeStatementDescriptors` instead. + */ + chargeStatementDescriptor?: Maybe; + /** + * The statement descriptors used for charges. + * + * These descriptors appear on a customer's credit card or bank statement when they make a purchase. + */ + chargeStatementDescriptors?: Maybe; + /** The Shopify Payments account country. */ + country: Scalars["String"]["output"]; + /** The default payout currency for the Shopify Payments account. */ + defaultCurrency: CurrencyCode; + /** All disputes related to the Shopify Payments account. */ + disputes: ShopifyPaymentsDisputeConnection; + /** The fraud settings of the Shopify Payments account. */ + fraudSettings: ShopifyPaymentsFraudSettings; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The notifications settings for the account. */ + notificationSettings: ShopifyPaymentsNotificationSettings; + /** Whether the Shopify Payments account can be onboarded. */ + onboardable: Scalars["Boolean"]["output"]; + /** The payout schedule for the account. */ + payoutSchedule: ShopifyPaymentsPayoutSchedule; + /** + * The descriptor used for payouts. + * + * The descriptor appears on a merchant's bank statement when they receive a payout. + */ + payoutStatementDescriptor?: Maybe; + /** All current and previous payouts made between the account and the bank account. */ + payouts: ShopifyPaymentsPayoutConnection; + /** The permitted documents for identity verification. */ + permittedVerificationDocuments: Array; + /** The verifications necessary for this account. */ + verifications: Array; +}; + +/** + * Balance and payout information for a + * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) + * account. Balance includes all balances for the currencies supported by the shop. + * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. + */ +export type ShopifyPaymentsAccountBankAccountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Balance and payout information for a + * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) + * account. Balance includes all balances for the currencies supported by the shop. + * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. + */ +export type ShopifyPaymentsAccountDisputesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * Balance and payout information for a + * [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) + * account. Balance includes all balances for the currencies supported by the shop. + * You can also query for a list of payouts, where each payout includes the corresponding currencyCode field. + */ +export type ShopifyPaymentsAccountPayoutsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + transactionType?: InputMaybe; +}; + +/** + * A bank account that can receive payouts. + */ +export type ShopifyPaymentsBankAccount = Node & { + /** The account number of the bank account. */ + accountNumber: Scalars["String"]["output"]; + /** The last digits of the account number (the rest is redacted). */ + accountNumberLastDigits: Scalars["String"]["output"]; + /** + * The name of the bank. + */ + bankName?: Maybe; + /** + * The country of the bank. + */ + country: CountryCode; + /** The date that the bank account was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** + * The currency of the bank account. + */ + currency: CurrencyCode; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** All current and previous payouts made between the account and the bank account. */ + payouts: ShopifyPaymentsPayoutConnection; + /** The routing number of the bank account. */ + routingNumber: Scalars["String"]["output"]; + /** + * The status of the bank account. + */ + status: ShopifyPaymentsBankAccountStatus; +}; + +/** + * A bank account that can receive payouts. + */ +export type ShopifyPaymentsBankAccountPayoutsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + transactionType?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts. + */ +export type ShopifyPaymentsBankAccountConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ShopifyPaymentsBankAccountEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination. + */ +export type ShopifyPaymentsBankAccountEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ShopifyPaymentsBankAccountEdge. */ + node: ShopifyPaymentsBankAccount; +}; + +/** The bank account status. */ +export type ShopifyPaymentsBankAccountStatus = + /** A payout to the bank account failed. */ + | "ERRORED" + /** A bank account that hasn't had any activity and that's not validated. */ + | "NEW" + /** It was determined that the bank account exists. */ + | "VALIDATED" + /** Bank account validation was successful. */ + | "VERIFIED"; + +/** The charge descriptors for a payments account. */ +export type ShopifyPaymentsChargeStatementDescriptor = { + /** The default charge statement descriptor. */ + default?: Maybe; + /** The prefix of the statement descriptor. */ + prefix: Scalars["String"]["output"]; +}; + +/** The charge descriptors for a payments account. */ +export type ShopifyPaymentsDefaultChargeStatementDescriptor = + & ShopifyPaymentsChargeStatementDescriptor + & { + /** The default charge statement descriptor. */ + default?: Maybe; + /** The prefix of the statement descriptor. */ + prefix: Scalars["String"]["output"]; + }; + +/** A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution. */ +export type ShopifyPaymentsDispute = LegacyInteroperability & Node & { + /** The total amount disputed by the cardholder. */ + amount: MoneyV2; + /** The deadline for evidence submission. */ + evidenceDueBy?: Maybe; + /** The date when evidence was sent. Returns null if evidence hasn't yet been sent. */ + evidenceSentOn?: Maybe; + /** The date when this dispute was resolved. Returns null if the dispute isn't yet resolved. */ + finalizedOn?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The date when this dispute was initiated. */ + initiatedAt: Scalars["DateTime"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The order that contains the charge that's under dispute. */ + order?: Maybe; + /** The reason of the dispute. */ + reasonDetails: ShopifyPaymentsDisputeReasonDetails; + /** The current state of the dispute. */ + status: DisputeStatus; + /** Indicates if this dispute is still in the inquiry phase or has turned into a chargeback. */ + type: DisputeType; +}; + +/** + * An auto-generated type for paginating through multiple ShopifyPaymentsDisputes. + */ +export type ShopifyPaymentsDisputeConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ShopifyPaymentsDisputeEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination. + */ +export type ShopifyPaymentsDisputeEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ShopifyPaymentsDisputeEdge. */ + node: ShopifyPaymentsDispute; +}; + +/** The evidence associated with the dispute. */ +export type ShopifyPaymentsDisputeEvidence = Node & { + /** The activity logs associated with the dispute evidence. */ + accessActivityLog?: Maybe; + /** The billing address that's provided by the customer. */ + billingAddress?: Maybe; + /** The cancellation policy disclosure associated with the dispute evidence. */ + cancellationPolicyDisclosure?: Maybe; + /** The cancellation policy file associated with the dispute evidence. */ + cancellationPolicyFile?: Maybe; + /** The cancellation rebuttal associated with the dispute evidence. */ + cancellationRebuttal?: Maybe; + /** The customer communication file associated with the dispute evidence. */ + customerCommunicationFile?: Maybe; + /** The customer's email address. */ + customerEmailAddress?: Maybe; + /** The customer's first name. */ + customerFirstName?: Maybe; + /** The customer's last name. */ + customerLastName?: Maybe; + /** The customer purchase ip for this dispute evidence. */ + customerPurchaseIp?: Maybe; + /** The dispute associated with the evidence. */ + dispute: ShopifyPaymentsDispute; + /** The file uploads associated with the dispute evidence. */ + disputeFileUploads: Array; + /** The fulfillments associated with the dispute evidence. */ + fulfillments: Array; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The product description for this dispute evidence. */ + productDescription?: Maybe; + /** The refund policy disclosure associated with the dispute evidence. */ + refundPolicyDisclosure?: Maybe; + /** The refund policy file associated with the dispute evidence. */ + refundPolicyFile?: Maybe; + /** The refund refusal explanation associated with dispute evidence. */ + refundRefusalExplanation?: Maybe; + /** The service documentation file associated with the dispute evidence. */ + serviceDocumentationFile?: Maybe; + /** The mailing address for shipping that's provided by the customer. */ + shippingAddress?: Maybe; + /** The shipping documentation file associated with the dispute evidence. */ + shippingDocumentationFile?: Maybe; + /** Whether the dispute evidence is submitted. */ + submitted: Scalars["Boolean"]["output"]; + /** The uncategorized file associated with the dispute evidence. */ + uncategorizedFile?: Maybe; + /** The uncategorized text for the dispute evidence. */ + uncategorizedText?: Maybe; +}; + +/** The possible dispute evidence file types. */ +export type ShopifyPaymentsDisputeEvidenceFileType = + /** Cancellation Policy File. */ + | "CANCELLATION_POLICY_FILE" + /** Customer Communication File. */ + | "CUSTOMER_COMMUNICATION_FILE" + /** Refund Policy File. */ + | "REFUND_POLICY_FILE" + /** Service Documentation File. */ + | "SERVICE_DOCUMENTATION_FILE" + /** Shipping Documentation File. */ + | "SHIPPING_DOCUMENTATION_FILE" + /** Uncategorized File. */ + | "UNCATEGORIZED_FILE"; + +/** The input fields required to update a dispute evidence object. */ +export type ShopifyPaymentsDisputeEvidenceUpdateInput = { + /** Activity logs. */ + accessActivityLog?: InputMaybe; + /** Cancellation policy disclosure. */ + cancellationPolicyDisclosure?: InputMaybe; + /** Cancellation policy file. */ + cancellationPolicyFile?: InputMaybe< + ShopifyPaymentsDisputeFileUploadUpdateInput + >; + /** Cancellation rebuttal. */ + cancellationRebuttal?: InputMaybe; + /** Customer communication file. */ + customerCommunicationFile?: InputMaybe< + ShopifyPaymentsDisputeFileUploadUpdateInput + >; + /** Customer email address. */ + customerEmailAddress?: InputMaybe; + /** Customer first name. */ + customerFirstName?: InputMaybe; + /** Customer last name. */ + customerLastName?: InputMaybe; + /** Refund policy disclosure. */ + refundPolicyDisclosure?: InputMaybe; + /** Refund policy file. */ + refundPolicyFile?: InputMaybe; + /** Refund refusal explanation. */ + refundRefusalExplanation?: InputMaybe; + /** Service documentation file. */ + serviceDocumentationFile?: InputMaybe< + ShopifyPaymentsDisputeFileUploadUpdateInput + >; + /** The shipping address associated with the dispute evidence. */ + shippingAddress?: InputMaybe; + /** Shipping documentation file. */ + shippingDocumentationFile?: InputMaybe< + ShopifyPaymentsDisputeFileUploadUpdateInput + >; + /** Whether to submit the evidence. */ + submitEvidence?: InputMaybe; + /** Uncategorized file. */ + uncategorizedFile?: InputMaybe; + /** Uncategorized text. */ + uncategorizedText?: InputMaybe; +}; + +/** The file upload associated with the dispute evidence. */ +export type ShopifyPaymentsDisputeFileUpload = Node & { + /** The type of the file for the dispute evidence. */ + disputeEvidenceType?: Maybe; + /** The file size. */ + fileSize: Scalars["Int"]["output"]; + /** The file type. */ + fileType: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The original file name. */ + originalFileName?: Maybe; + /** The URL for accessing the file. */ + url: Scalars["URL"]["output"]; +}; + +/** The input fields required to update a dispute file upload object. */ +export type ShopifyPaymentsDisputeFileUploadUpdateInput = { + /** Whether to delete this file upload. */ + destroy?: InputMaybe; + /** The ID of the file upload to be updated. */ + id: Scalars["ID"]["input"]; +}; + +/** The fulfillment associated with dispute evidence. */ +export type ShopifyPaymentsDisputeFulfillment = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The shipping carrier for this fulfillment. */ + shippingCarrier?: Maybe; + /** The shipping date for this fulfillment. */ + shippingDate?: Maybe; + /** The shipping tracking number for this fulfillment. */ + shippingTrackingNumber?: Maybe; +}; + +/** The reason for the dispute provided by the cardholder's bank. */ +export type ShopifyPaymentsDisputeReason = + /** The customer's bank can't process the charge. */ + | "BANK_CANNOT_PROCESS" + /** The customer claims that the purchased product was returned or the transaction was otherwise canceled, but you haven't yet provided a refund or credit. */ + | "CREDIT_NOT_PROCESSED" + /** The customer initiated the dispute. Contact the customer for additional details on why the payment was disputed. */ + | "CUSTOMER_INITIATED" + /** The customer's bank can't proceed with the debit since it hasn't been authorized. */ + | "DEBIT_NOT_AUTHORIZED" + /** The customer claims they were charged multiple times for the same product or service. */ + | "DUPLICATE" + /** The cardholder claims that they didn’t authorize the payment. */ + | "FRAUDULENT" + /** The dispute is uncategorized, so you should contact the customer for additional details to find out why the payment was disputed. */ + | "GENERAL" + /** The customer account associated with the purchase is incorrect. */ + | "INCORRECT_ACCOUNT_DETAILS" + /** The customer's bank account has insufficient funds. */ + | "INSUFFICIENT_FUNDS" + /** The customer claims they did not receive the products or services purchased. */ + | "PRODUCT_NOT_RECEIVED" + /** The product or service was received but was defective, damaged, or not as described. */ + | "PRODUCT_UNACCEPTABLE" + /** The customer claims that you continued to charge them after a subscription was canceled. */ + | "SUBSCRIPTION_CANCELLED" + /** The customer doesn’t recognize the payment appearing on their card statement. */ + | "UNRECOGNIZED"; + +/** Details regarding a dispute reason. */ +export type ShopifyPaymentsDisputeReasonDetails = { + /** The raw code provided by the payment network. */ + networkReasonCode?: Maybe; + /** The reason for the dispute provided by the cardholder's banks. */ + reason: ShopifyPaymentsDisputeReason; +}; + +/** Presents all Shopify Payments information related to an extended authorization. */ +export type ShopifyPaymentsExtendedAuthorization = { + /** + * The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment. + */ + extendedAuthorizationExpiresAt: Scalars["DateTime"]["output"]; + /** + * The time after which capture will incur an additional fee. + */ + standardAuthorizationExpiresAt: Scalars["DateTime"]["output"]; +}; + +/** The fraud settings of a payments account. */ +export type ShopifyPaymentsFraudSettings = { + /** Decline a charge if there's an AVS failure. */ + declineChargeOnAvsFailure: Scalars["Boolean"]["output"]; + /** Decline a charge if there's an CVC failure. */ + declineChargeOnCvcFailure: Scalars["Boolean"]["output"]; +}; + +/** The charge descriptors for a Japanese payments account. */ +export type ShopifyPaymentsJpChargeStatementDescriptor = + & ShopifyPaymentsChargeStatementDescriptor + & { + /** The default charge statement descriptor. */ + default?: Maybe; + /** The charge statement descriptor in kana. */ + kana?: Maybe; + /** The charge statement descriptor in kanji. */ + kanji?: Maybe; + /** The prefix of the statement descriptor. */ + prefix: Scalars["String"]["output"]; + }; + +/** The notification settings for the account. */ +export type ShopifyPaymentsNotificationSettings = { + /** Receive email notifications when new payouts are sent or payouts fail. */ + payouts: Scalars["Boolean"]["output"]; +}; + +/** + * Payouts represent the movement of money between a merchant's Shopify + * Payments balance and their bank account. + */ +export type ShopifyPaymentsPayout = LegacyInteroperability & Node & { + /** The bank account for the payout. */ + bankAccount?: Maybe; + /** + * The total amount and currency of the payout. + * @deprecated Use `net` instead. + */ + gross: MoneyV2; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** + * The exact time when the payout was issued. The payout only contains + * balance transactions that were available at this time. + */ + issuedAt: Scalars["DateTime"]["output"]; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The total amount and currency of the payout. */ + net: MoneyV2; + /** The transfer status of the payout. */ + status: ShopifyPaymentsPayoutStatus; + /** The summary of the payout. */ + summary: ShopifyPaymentsPayoutSummary; + /** The direction of the payout. */ + transactionType: ShopifyPaymentsPayoutTransactionType; +}; + +/** + * An auto-generated type for paginating through multiple ShopifyPaymentsPayouts. + */ +export type ShopifyPaymentsPayoutConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ShopifyPaymentsPayoutEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination. + */ +export type ShopifyPaymentsPayoutEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of ShopifyPaymentsPayoutEdge. */ + node: ShopifyPaymentsPayout; +}; + +/** The interval at which payouts are sent to the connected bank account. */ +export type ShopifyPaymentsPayoutInterval = + /** Each business day. */ + | "DAILY" + /** Payouts will not be automatically made. */ + | "MANUAL" + /** Each month, on the day of month specified by monthlyAnchor. */ + | "MONTHLY" + /** Each week, on the day of week specified by weeklyAnchor. */ + | "WEEKLY"; + +/** The payment schedule for a payments account. */ +export type ShopifyPaymentsPayoutSchedule = { + /** The interval at which payouts are sent to the connected bank account. */ + interval: ShopifyPaymentsPayoutInterval; + /** + * The day of the month funds will be paid out. + * + * The value can be any day of the month from the 1st to the 31st. + * If the payment interval is set to monthly, this value will be used. + * Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. + */ + monthlyAnchor?: Maybe; + /** + * The day of the week funds will be paid out. + * + * The value can be any weekday from Monday to Friday. + * If the payment interval is set to weekly, this value will be used. + */ + weeklyAnchor?: Maybe; +}; + +/** The transfer status of the payout. */ +export type ShopifyPaymentsPayoutStatus = + /** The payout has been canceled by Shopify. */ + | "CANCELED" + /** The payout has been declined by the bank. */ + | "FAILED" + /** The payout has been submitted to the bank. */ + | "IN_TRANSIT" + /** The payout has been successfully deposited into the bank. */ + | "PAID" + /** + * The payout has been created and had transactions assigned to it, but + * it has not yet been submitted to the bank. + */ + | "SCHEDULED"; + +/** + * Breakdown of the total fees and gross of each of the different types of transactions associated + * with the payout. + */ +export type ShopifyPaymentsPayoutSummary = { + /** Total fees for all adjustments including disputes. */ + adjustmentsFee: MoneyV2; + /** Total gross amount for all adjustments including disputes. */ + adjustmentsGross: MoneyV2; + /** Total fees for all charges. */ + chargesFee: MoneyV2; + /** Total gross amount for all charges. */ + chargesGross: MoneyV2; + /** Total fees for all refunds. */ + refundsFee: MoneyV2; + /** Total gross amount for all refunds. */ + refundsFeeGross: MoneyV2; + /** Total fees for all reserved funds. */ + reservedFundsFee: MoneyV2; + /** Total gross amount for all reserved funds. */ + reservedFundsGross: MoneyV2; + /** Total fees for all retried payouts. */ + retriedPayoutsFee: MoneyV2; + /** Total gross amount for all retried payouts. */ + retriedPayoutsGross: MoneyV2; +}; + +/** The possible transaction types for a payout. */ +export type ShopifyPaymentsPayoutTransactionType = + /** The payout is a deposit. */ + | "DEPOSIT" + /** The payout is a withdrawal. */ + | "WITHDRAWAL"; + +/** Presents all Shopify Payments specific information related to an order refund. */ +export type ShopifyPaymentsRefundSet = { + /** + * The acquirer reference number (ARN) code generated for Visa/Mastercard transactions. + */ + acquirerReferenceNumber?: Maybe; +}; + +/** Presents all Shopify Payments specific information related to an order transaction. */ +export type ShopifyPaymentsTransactionSet = { + /** + * Contains all fields related to an extended authorization. + */ + extendedAuthorizationSet?: Maybe; + /** + * Contains all fields related to a refund. + */ + refundSet?: Maybe; +}; + +/** + * Each subject (individual) of an account has a verification object giving + * information about the verification state. + */ +export type ShopifyPaymentsVerification = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The status of the verification. */ + status: ShopifyPaymentsVerificationStatus; + /** The subject/individual who has to be verified. */ + subject: ShopifyPaymentsVerificationSubject; +}; + +/** A document which can be used to verify an individual. */ +export type ShopifyPaymentsVerificationDocument = { + /** True if the back side of the document is required. */ + backRequired: Scalars["Boolean"]["output"]; + /** True if the front side of the document is required. */ + frontRequired: Scalars["Boolean"]["output"]; + /** The type of the document which can be used for verification. */ + type: ShopifyPaymentsVerificationDocumentType; +}; + +/** The types of possible verification documents. */ +export type ShopifyPaymentsVerificationDocumentType = + /** The subject's driver's license. */ + | "DRIVERS_LICENSE" + /** A government's identification document of the subject. */ + | "GOVERNMENT_IDENTIFICATION" + /** The subject's passport. */ + | "PASSPORT"; + +/** The status of a verification. */ +export type ShopifyPaymentsVerificationStatus = + /** The verification request has been submitted but a response has not yet been given. */ + | "PENDING" + /** The verification has not yet been verified. */ + | "UNVERIFIED" + /** The verification has been verified. */ + | "VERIFIED"; + +/** The verification subject represents an individual that has to be verified. */ +export type ShopifyPaymentsVerificationSubject = { + /** The family name of the individual to verify. */ + familyName: Scalars["String"]["output"]; + /** The given name of the individual to verify. */ + givenName: Scalars["String"]["output"]; +}; + +/** A response to a ShopifyQL query. */ +export type ShopifyqlResponse = { + /** A list of parse errors, if parsing fails. */ + parseErrors?: Maybe>; + /** + * The result in a tabular format with schema and row data. + * To be used as a raw 2-dimensional response of the query. + * It's always present even if query has a `VISUALIZE` keyword. + */ + tableData?: Maybe; +}; + +/** + * Represents the data about a staff member's Shopify account. Merchants can use staff member data to get more information about the staff members in their store. + */ +export type StaffMember = Node & { + /** Whether the staff member is active. */ + active: Scalars["Boolean"]["output"]; + /** The image used as the staff member's avatar in the Shopify admin. */ + avatar: Image; + /** The staff member's email address. */ + email: Scalars["String"]["output"]; + /** Whether the staff member's account exists. */ + exists: Scalars["Boolean"]["output"]; + /** The staff member's first name. */ + firstName?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The staff member's initials, if available. */ + initials?: Maybe>; + /** Whether the staff member is the shop owner. */ + isShopOwner: Scalars["Boolean"]["output"]; + /** The staff member's last name. */ + lastName?: Maybe; + /** The staff member's preferred locale. Locale values use the format `language` or `language-COUNTRY`, where `language` is a two-letter language code, and `COUNTRY` is a two-letter country code. For example: `en` or `en-US` */ + locale: Scalars["String"]["output"]; + /** The staff member's full name. */ + name: Scalars["String"]["output"]; + /** The staff member's phone number. */ + phone?: Maybe; + /** The data used to customize the Shopify admin experience for the staff member. */ + privateData: StaffMemberPrivateData; +}; + +/** + * Represents the data about a staff member's Shopify account. Merchants can use staff member data to get more information about the staff members in their store. + */ +export type StaffMemberAvatarArgs = { + fallback?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple StaffMembers. + */ +export type StaffMemberConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in StaffMemberEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Represents the fallback avatar image for a staff member. This is used only if the staff member has no avatar image. */ +export type StaffMemberDefaultImage = + /** Returns a default avatar image for the staff member. */ + | "DEFAULT" + /** Returns a URL that returns a 404 error if the image is not present. */ + | "NOT_FOUND" + /** Returns a transparent avatar image for the staff member. */ + | "TRANSPARENT"; + +/** + * An auto-generated type which holds one StaffMember and a cursor during pagination. + */ +export type StaffMemberEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of StaffMemberEdge. */ + node: StaffMember; +}; + +/** Represents access permissions for a staff member. */ +export type StaffMemberPermission = + /** The staff member can manage and install apps and channels. */ + | "APPLICATIONS" + /** The staff member can manage and install sales channels. */ + | "CHANNELS" + /** The staff member can view, create, update, and delete customers, and respond to customer messages in the Shopify Messaging API. */ + | "CUSTOMERS" + /** The staff member can view the Shopify Home page, which includes sales information and other shop data. */ + | "DASHBOARD" + /** The staff member can view, buy, and manage domains. */ + | "DOMAINS" + /** The staff member can create, update, and delete draft orders. */ + | "DRAFT_ORDERS" + /** The staff member can update orders. */ + | "EDIT_ORDERS" + /** The staff has the same permissions as the [store owner](https://shopify.dev/en/manual/your-account/staff-accounts/staff-permissions#store-owner-permissions) with some exceptions, such as modifying the account billing or deleting staff accounts. */ + | "FULL" + /** The staff member can view, create, issue, and export gift cards to a CSV file. */ + | "GIFT_CARDS" + /** The staff member can view and modify links and navigation menus. */ + | "LINKS" + /** The staff member can create, update, and delete locations where inventory is stocked or managed. */ + | "LOCATIONS" + /** The staff member can view and create discount codes and automatic discounts, and export discounts to a CSV file. */ + | "MARKETING" + /** The staff member can view, create, and automate marketing campaigns. */ + | "MARKETING_SECTION" + /** The staff member can view, create, update, delete, and cancel orders, and receive order notifications. The staff member can still create draft orders without this permission. */ + | "ORDERS" + /** The staff member can view the Overview and Live view pages, which include sales information, and other shop and sales channels data. */ + | "OVERVIEWS" + /** The staff member can view, create, update, publish, and delete blog posts and pages. */ + | "PAGES" + /** The staff member can pay for an order by using a vaulted card. */ + | "PAY_ORDERS_BY_VAULTED_CARD" + /** The staff member can view the preferences and configuration of a shop. */ + | "PREFERENCES" + /** The staff member can view, create, import, and update products, collections, and inventory. */ + | "PRODUCTS" + /** The staff member can view and create all reports, which includes sales information and other shop data. */ + | "REPORTS" + /** The staff member can view, update, and publish themes. */ + | "THEMES" + /** The staff member can view and create translations. */ + | "TRANSLATIONS"; + +/** Represents the data used to customize the Shopify admin experience for a logged-in staff member. */ +export type StaffMemberPrivateData = { + /** The URL to the staff member's account settings page. */ + accountSettingsUrl: Scalars["URL"]["output"]; + /** The date and time when the staff member was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** + * Access permissions for the staff member. + * @deprecated Use StaffMember.permissions.userPermissions instead + */ + permissions: Array; +}; + +/** + * An image to be uploaded. + * + * Deprecated in favor of + * [StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput), + * which is used by the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate). + */ +export type StageImageInput = { + /** The image filename. */ + filename: Scalars["String"]["input"]; + /** HTTP method to be used by the staged upload. */ + httpMethod?: InputMaybe; + /** The image MIME type. */ + mimeType: Scalars["String"]["input"]; + /** The image resource. */ + resource: StagedUploadTargetGenerateUploadResource; +}; + +/** + * Information about a staged upload target, which should be used to send a request to upload + * the file. + * + * For more information on the upload process, refer to + * [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify). + */ +export type StagedMediaUploadTarget = { + /** Parameters needed to authenticate a request to upload the file. */ + parameters: Array; + /** + * The URL to be passed as `originalSource` in + * [CreateMediaInput](https://shopify.dev/api/admin-graphql/latest/input-objects/CreateMediaInput) + * and [FileCreateInput](https://shopify.dev/api/admin-graphql/2022-04/input-objects/FileCreateInput) + * for the [productCreateMedia](https://shopify.dev/api/admin-graphql/2022-04/mutations/productCreateMedia) + * and [fileCreate](https://shopify.dev/api/admin-graphql/2022-04/mutations/fileCreate) + * mutations. + */ + resourceUrl?: Maybe; + /** + * The URL to use when sending an request to upload the file. Should be used in conjunction with + * the parameters field. + */ + url?: Maybe; +}; + +/** + * The possible HTTP methods that can be used when sending a request to upload a file using information from a + * [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget). + */ +export type StagedUploadHttpMethodType = + /** The POST HTTP method. */ + | "POST" + /** The PUT HTTP method. */ + | "PUT"; + +/** The input fields for generating staged upload targets. */ +export type StagedUploadInput = { + /** + * The size of the file to upload, in bytes. This is required when the request's resource property is set to + * [VIDEO](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-video) + * or [MODEL_3D](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-model3d). + */ + fileSize?: InputMaybe; + /** The file's name and extension. */ + filename: Scalars["String"]["input"]; + /** + * The HTTP method to be used when sending a request to upload the file using the returned staged + * upload target. + */ + httpMethod?: InputMaybe; + /** The file's MIME type. */ + mimeType: Scalars["String"]["input"]; + /** The file's intended Shopify resource type. */ + resource: StagedUploadTargetGenerateUploadResource; +}; + +/** + * The parameters required to authenticate a file upload request using a + * [StagedMediaUploadTarget's url field](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-stagedmediauploadtarget-url). + * + * For more information on the upload process, refer to + * [Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify). + */ +export type StagedUploadParameter = { + /** The parameter's name. */ + name: Scalars["String"]["output"]; + /** The parameter's value. */ + value: Scalars["String"]["output"]; +}; + +/** + * Information about the staged target. + * + * Deprecated in favor of + * [StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget), + * which is returned by the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate). + */ +export type StagedUploadTarget = { + /** The parameters of an image to be uploaded. */ + parameters: Array; + /** The image URL. */ + url: Scalars["String"]["output"]; +}; + +/** + * The required fields and parameters to generate the URL upload an" + * asset to Shopify. + * + * Deprecated in favor of + * [StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput), + * which is used by the + * [stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate). + */ +export type StagedUploadTargetGenerateInput = { + /** The size of the file to upload, in bytes. */ + fileSize?: InputMaybe; + /** The filename of the asset being uploaded. */ + filename: Scalars["String"]["input"]; + /** The HTTP method to be used by the staged upload. */ + httpMethod?: InputMaybe; + /** The MIME type of the asset being uploaded. */ + mimeType: Scalars["String"]["input"]; + /** The resource type being uploaded. */ + resource: StagedUploadTargetGenerateUploadResource; +}; + +/** Return type for `stagedUploadTargetGenerate` mutation. */ +export type StagedUploadTargetGeneratePayload = { + /** The signed parameters that can be used to upload the asset. */ + parameters: Array; + /** The signed URL where the asset can be uploaded. */ + url: Scalars["String"]["output"]; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The resource type to receive. */ +export type StagedUploadTargetGenerateUploadResource = + /** + * Represents bulk mutation variables. + * + * For example, bulk mutation variables can be used for bulk operations using the + * [bulkOperationRunMutation mutation](https://shopify.dev/api/admin-graphql/latest/mutations/bulkOperationRunMutation). + */ + | "BULK_MUTATION_VARIABLES" + /** + * An image associated with a collection. + * + * For example, after uploading an image, you can use the + * [collectionUpdate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/collectionUpdate) + * to add the image to a collection. + */ + | "COLLECTION_IMAGE" + /** + * Represents any file other than HTML. + * + * For example, after uploading the file, you can add the file to the + * [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the + * [fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate). + */ + | "FILE" + /** + * An image. + * + * For example, after uploading an image, you can add the image to a product using the + * [productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia) + * or to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the + * [fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate). + */ + | "IMAGE" + /** + * A Shopify hosted 3d model. + * + * For example, after uploading the 3d model, you can add the 3d model to a product using the + * [productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia). + */ + | "MODEL_3D" + /** + * An image that's associated with a product. + * + * For example, after uploading the image, you can add the image to a product using the + * [productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia). + */ + | "PRODUCT_IMAGE" + /** + * Represents a label associated with a return. + * + * For example, once uploaded, this resource can be used to [create a + * ReverseDelivery](https://shopify.dev/api/admin-graphql/unstable/mutations/reverseDeliveryCreateWithShipping). + */ + | "RETURN_LABEL" + /** + * An image. + * + * For example, after uploading the image, you can add the image to the + * [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the + * [fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate). + */ + | "SHOP_IMAGE" + /** + * Represents a redirect CSV file. + * + * Example usage: This resource can be used for creating a + * [UrlRedirectImport](https://shopify.dev/api/admin-graphql/2022-04/objects/UrlRedirectImport) + * object for use in the + * [urlRedirectImportCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate). + */ + | "URL_REDIRECT_IMPORT" + /** + * A Shopify-hosted video. + * + * For example, after uploading the video, you can add the video to a product using the + * [productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia) + * or to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the + * [fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate). + */ + | "VIDEO"; + +/** Return type for `stagedUploadTargetsGenerate` mutation. */ +export type StagedUploadTargetsGeneratePayload = { + /** The staged upload targets that were generated. */ + urls?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `stagedUploadsCreate` mutation. */ +export type StagedUploadsCreatePayload = { + /** The staged upload targets that were generated. */ + stagedTargets?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `standardMetafieldDefinitionEnable` mutation. */ +export type StandardMetafieldDefinitionEnablePayload = { + /** The metafield definition that was created. */ + createdDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `StandardMetafieldDefinitionEnable`. */ +export type StandardMetafieldDefinitionEnableUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `StandardMetafieldDefinitionEnableUserError`. */ +export type StandardMetafieldDefinitionEnableUserErrorCode = + /** The input value is invalid. */ + | "INVALID" + /** The maximum number of definitions per owner type has been exceeded. */ + | "LIMIT_EXCEEDED" + /** The input value is already taken. */ + | "TAKEN" + /** The standard metafield definition template was not found. */ + | "TEMPLATE_NOT_FOUND" + /** The definition type is not eligible to be used as collection condition. */ + | "TYPE_NOT_ALLOWED_FOR_CONDITIONS" + /** The namespace and key is already in use for a set of your metafields. */ + | "UNSTRUCTURED_ALREADY_EXISTS"; + +/** + * Standard metafield definition templates provide preset configurations to create metafield definitions. + * Each template has a specific namespace and key that we've reserved to have specific meanings for common use cases. + * + * Refer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions). + */ +export type StandardMetafieldDefinitionTemplate = Node & { + /** The description of the standard metafield definition. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The key owned by the definition after the definition has been activated. */ + key: Scalars["String"]["output"]; + /** The human-readable name for the standard metafield definition. */ + name: Scalars["String"]["output"]; + /** The namespace owned by the definition after the definition has been activated. */ + namespace: Scalars["String"]["output"]; + /** The list of resource types that the standard metafield definition can be applied to. */ + ownerTypes: Array; + /** The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores. */ + type: MetafieldDefinitionType; + /** The configured validations for the standard metafield definition. */ + validations: Array; + /** + * Whether metafields for the definition are by default visible using the Storefront API. + */ + visibleToStorefrontApi: Scalars["Boolean"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple StandardMetafieldDefinitionTemplates. + */ +export type StandardMetafieldDefinitionTemplateConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in StandardMetafieldDefinitionTemplateEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one StandardMetafieldDefinitionTemplate and a cursor during pagination. + */ +export type StandardMetafieldDefinitionTemplateEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of StandardMetafieldDefinitionTemplateEdge. */ + node: StandardMetafieldDefinitionTemplate; +}; + +/** Return type for `standardMetaobjectDefinitionEnable` mutation. */ +export type StandardMetaobjectDefinitionEnablePayload = { + /** The metaobject definition that was enabled using the standard template. */ + metaobjectDefinition?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents the details of a specific type of product within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt). */ +export type StandardizedProductType = { + /** The product taxonomy node associated with the standardized product type. */ + productTaxonomyNode?: Maybe; +}; + +/** Provides the fields and values to use when adding a standard product type to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values. */ +export type StandardizedProductTypeInput = { + /** The ID of the node in the Shopify taxonomy that represents the product type. */ + productTaxonomyNodeId: Scalars["ID"]["input"]; +}; + +/** + * A token that's used to delegate unauthenticated access scopes to clients that need to access + * the unauthenticated Storefront API. An app can have a maximum of 100 active storefront access + * tokens for each shop. + */ +export type StorefrontAccessToken = Node & { + /** List of permissions associated with the token. */ + accessScopes: Array; + /** The issued public access token. */ + accessToken: Scalars["String"]["output"]; + /** The date and time when the public access token was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** An arbitrary title for each token determined by the developer, used for reference purposes. */ + title: Scalars["String"]["output"]; + /** The date and time when the storefront access token was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple StorefrontAccessTokens. + */ +export type StorefrontAccessTokenConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in StorefrontAccessTokenEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `storefrontAccessTokenCreate` mutation. */ +export type StorefrontAccessTokenCreatePayload = { + /** The user's shop. */ + shop: Shop; + /** The storefront access token. */ + storefrontAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to delete a storefront access token. */ +export type StorefrontAccessTokenDeleteInput = { + /** The ID of the storefront access token to delete. */ + id: Scalars["ID"]["input"]; +}; + +/** Return type for `storefrontAccessTokenDelete` mutation. */ +export type StorefrontAccessTokenDeletePayload = { + /** The ID of the deleted storefront access token. */ + deletedStorefrontAccessTokenId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination. + */ +export type StorefrontAccessTokenEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of StorefrontAccessTokenEdge. */ + node: StorefrontAccessToken; +}; + +/** The input fields for a storefront access token. */ +export type StorefrontAccessTokenInput = { + /** A title for the storefront access token. */ + title: Scalars["String"]["input"]; +}; + +/** + * An auto-generated type for paginating through a list of Strings. + */ +export type StringConnection = { + /** A list of edges. */ + edges: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one String and a cursor during pagination. + */ +export type StringEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of StringEdge. */ + node: Scalars["String"]["output"]; +}; + +/** Represents an applied code discount. */ +export type SubscriptionAppliedCodeDiscount = { + /** The unique ID. */ + id: Scalars["ID"]["output"]; + /** The redeem code of the discount that applies on the subscription. */ + redeemCode: Scalars["String"]["output"]; + /** The reason that the discount on the subscription draft is rejected. */ + rejectionReason?: Maybe; +}; + +/** The input fields for mapping a subscription line to a discount. */ +export type SubscriptionAtomicLineInput = { + /** The discount to be added to the subscription line. */ + discounts?: InputMaybe>; + /** The new subscription line. */ + line: SubscriptionLineInput; +}; + +/** The input fields for mapping a subscription line to a discount. */ +export type SubscriptionAtomicManualDiscountInput = { + /** The maximum number of times the subscription discount will be applied on orders. */ + recurringCycleLimit?: InputMaybe; + /** The title associated with the subscription discount. */ + title?: InputMaybe; + /** Percentage or fixed amount value of the discount. */ + value?: InputMaybe; +}; + +/** + * A record of an execution of the subscription billing process. Billing attempts use + * idempotency keys to avoid duplicate order creation. A successful billing attempt + * will create an order. + */ +export type SubscriptionBillingAttempt = Node & { + /** The date and time when the billing attempt was completed. */ + completedAt?: Maybe; + /** The date and time when the billing attempt was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** A code corresponding to a payment error during processing. */ + errorCode?: Maybe; + /** A message describing a payment error during processing. */ + errorMessage?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** A unique key generated by the client to avoid duplicate payments. */ + idempotencyKey: Scalars["String"]["output"]; + /** + * The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. + */ + nextActionUrl?: Maybe; + /** The result of this billing attempt if completed successfully. */ + order?: Maybe; + /** + * The date and time used to calculate fulfillment intervals for a billing attempt that + * successfully completed after the current anchor date. To prevent fulfillment from being + * pushed to the next anchor date, this field can override the billing attempt date. + */ + originTime?: Maybe; + /** Whether the billing attempt is still processing. */ + ready: Scalars["Boolean"]["output"]; + /** The subscription contract. */ + subscriptionContract: SubscriptionContract; +}; + +/** + * An auto-generated type for paginating through multiple SubscriptionBillingAttempts. + */ +export type SubscriptionBillingAttemptConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionBillingAttemptEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `subscriptionBillingAttemptCreate` mutation. */ +export type SubscriptionBillingAttemptCreatePayload = { + /** The subscription billing attempt. */ + subscriptionBillingAttempt?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination. + */ +export type SubscriptionBillingAttemptEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionBillingAttemptEdge. */ + node: SubscriptionBillingAttempt; +}; + +/** + * The possible error codes associated with making billing attempts. The error codes supplement the + * `error_message` to provide consistent results and help with dunning management. + */ +export type SubscriptionBillingAttemptErrorCode = + /** The amount is too small. */ + | "AMOUNT_TOO_SMALL" + /** + * There was an error during the authentication. + */ + | "AUTHENTICATION_ERROR" + /** Payment method was canceled by buyer. */ + | "BUYER_CANCELED_PAYMENT_METHOD" + /** Customer is invalid. */ + | "CUSTOMER_INVALID" + /** Customer was not found. */ + | "CUSTOMER_NOT_FOUND" + /** + * Payment method is expired. + */ + | "EXPIRED_PAYMENT_METHOD" + /** The billing agreement ID or the transaction ID for the customer's payment method is invalid. */ + | "INVALID_CUSTOMER_BILLING_AGREEMENT" + /** + * Payment method is invalid. Please update or create a new payment method. + */ + | "INVALID_PAYMENT_METHOD" + /** The shipping address is either missing or invalid. */ + | "INVALID_SHIPPING_ADDRESS" + /** No inventory location found or enabled. */ + | "INVENTORY_ALLOCATIONS_NOT_FOUND" + /** A payment has already been made for this invoice. */ + | "INVOICE_ALREADY_PAID" + /** + * Payment method was declined by processor. + */ + | "PAYMENT_METHOD_DECLINED" + /** Payment method cannot be used with the current payment gateway test mode configuration. */ + | "PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG" + /** + * Payment method was not found. + */ + | "PAYMENT_METHOD_NOT_FOUND" + /** + * Payment provider is not enabled. + */ + | "PAYMENT_PROVIDER_IS_NOT_ENABLED" + /** + * Gateway is in test mode and attempted to bill a live payment method. + */ + | "TEST_MODE" + /** Transient error, try again later. */ + | "TRANSIENT_ERROR" + /** + * There was an unexpected error during the billing attempt. + */ + | "UNEXPECTED_ERROR"; + +/** The input fields required to complete a subscription billing attempt. */ +export type SubscriptionBillingAttemptInput = { + /** + * Select the specific billing cycle to be billed. + * Default to bill the current billing cycle if not specified. + */ + billingCycleSelector?: InputMaybe; + /** A unique key generated by the client to avoid duplicate payments. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ + idempotencyKey: Scalars["String"]["input"]; + /** + * The date and time used to calculate fulfillment intervals for a billing attempt that + * successfully completed after the current anchor date. To prevent fulfillment from being + * pushed to the next anchor date, this field can override the billing attempt date. + */ + originTime?: InputMaybe; +}; + +/** The set of valid sort keys for the SubscriptionBillingAttempts query. */ +export type SubscriptionBillingAttemptsSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** A subscription billing cycle. */ +export type SubscriptionBillingCycle = { + /** The date on which the billing attempt is expected to be made. */ + billingAttemptExpectedDate: Scalars["DateTime"]["output"]; + /** The list of billing attempts associated with the billing cycle. */ + billingAttempts: SubscriptionBillingAttemptConnection; + /** The end date of the billing cycle. */ + cycleEndAt: Scalars["DateTime"]["output"]; + /** The index of the billing cycle. */ + cycleIndex: Scalars["Int"]["output"]; + /** The start date of the billing cycle. */ + cycleStartAt: Scalars["DateTime"]["output"]; + /** Whether this billing cycle was edited. */ + edited: Scalars["Boolean"]["output"]; + /** The active edited contract for the billing cycle. */ + editedContract?: Maybe; + /** Whether this billing cycle was skipped. */ + skipped: Scalars["Boolean"]["output"]; + /** The subscription contract that the billing cycle belongs to. */ + sourceContract: SubscriptionContract; + /** The status of the billing cycle. */ + status: SubscriptionBillingCycleBillingCycleStatus; +}; + +/** A subscription billing cycle. */ +export type SubscriptionBillingCycleBillingAttemptsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The possible status values of a subscription billing cycle. */ +export type SubscriptionBillingCycleBillingCycleStatus = + /** The billing cycle is billed. */ + | "BILLED" + /** The billing cycle hasn't been billed. */ + | "UNBILLED"; + +/** + * An auto-generated type for paginating through multiple SubscriptionBillingCycles. + */ +export type SubscriptionBillingCycleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionBillingCycleEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `subscriptionBillingCycleContractDraftCommit` mutation. */ +export type SubscriptionBillingCycleContractDraftCommitPayload = { + /** The committed Subscription Billing Cycle Edited Contract object. */ + contract?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionBillingCycleContractDraftConcatenate` mutation. */ +export type SubscriptionBillingCycleContractDraftConcatenatePayload = { + /** The Subscription Draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionBillingCycleContractEdit` mutation. */ +export type SubscriptionBillingCycleContractEditPayload = { + /** The draft subscription contract object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination. + */ +export type SubscriptionBillingCycleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionBillingCycleEdge. */ + node: SubscriptionBillingCycle; +}; + +/** Return type for `subscriptionBillingCycleEditDelete` mutation. */ +export type SubscriptionBillingCycleEditDeletePayload = { + /** The list of updated billing cycles. */ + billingCycles?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContract = + & SubscriptionContractBase + & { + /** The subscription app that the subscription contract is registered to. */ + app?: Maybe; + /** The URL of the subscription contract page on the subscription app. */ + appAdminUrl?: Maybe; + /** The billing cycles that the edited contract belongs to. */ + billingCycles: SubscriptionBillingCycleConnection; + /** The date and time when the subscription contract was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The currency that's used for the subscription contract. */ + currencyCode: CurrencyCode; + /** A list of the custom attributes to be added to the generated orders. */ + customAttributes: Array; + /** The customer to whom the subscription contract belongs. */ + customer?: Maybe; + /** The customer payment method that's used for the subscription contract. */ + customerPaymentMethod?: Maybe; + /** The delivery method for each billing of the subscription contract. */ + deliveryMethod?: Maybe; + /** The delivery price for each billing of the subscription contract. */ + deliveryPrice: MoneyV2; + /** The list of subscription discounts associated with the subscription contract. */ + discounts: SubscriptionManualDiscountConnection; + /** The number of lines associated with the subscription contract. */ + lineCount: Scalars["Int"]["output"]; + /** The list of subscription lines associated with the subscription contract. */ + lines: SubscriptionLineConnection; + /** The note field that will be applied to the generated orders. */ + note?: Maybe; + /** A list of the subscription contract's orders. */ + orders: OrderConnection; + /** The date and time when the subscription contract was updated. */ + updatedAt: Scalars["DateTime"]["output"]; + }; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContractBillingCyclesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContractCustomerPaymentMethodArgs = { + showRevoked?: InputMaybe; +}; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContractDiscountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContractLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a subscription contract with billing cycles. */ +export type SubscriptionBillingCycleEditedContractOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Return type for `subscriptionBillingCycleEditsDelete` mutation. */ +export type SubscriptionBillingCycleEditsDeletePayload = { + /** The list of updated billing cycles. */ + billingCycles?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `SubscriptionBillingCycleUserError`. */ +export type SubscriptionBillingCycleErrorCode = + /** Billing date cannot be set on skipped billing cycle. */ + | "BILLING_DATE_SET_ON_SKIPPED" + /** Billing cycle selector cannot select billing cycle outside of index range. */ + | "CYCLE_INDEX_OUT_OF_RANGE" + /** Can't find the billing cycle. */ + | "CYCLE_NOT_FOUND" + /** Billing cycle selector cannot select billing cycle outside of start date range. */ + | "CYCLE_START_DATE_OUT_OF_RANGE" + /** Billing cycle schedule edit input provided is empty. Must take in parameters to modify schedule. */ + | "EMPTY_BILLING_CYCLE_EDIT_SCHEDULE_INPUT" + /** Billing cycle has incomplete billing attempts in progress. */ + | "INCOMPLETE_BILLING_ATTEMPTS" + /** The input value is invalid. */ + | "INVALID" + /** The index selector is invalid. */ + | "INVALID_CYCLE_INDEX" + /** The date selector is invalid. */ + | "INVALID_DATE" + /** There's no contract or schedule edit associated with the targeted billing cycle(s). */ + | "NO_CYCLE_EDITS" + /** Billing date of a cycle cannot be set to a value outside of its billing date range. */ + | "OUT_OF_BOUNDS" + /** Billing cycle selector cannot select upcoming billing cycle past limit. */ + | "UPCOMING_CYCLE_LIMIT_EXCEEDED"; + +/** + * The input fields for specifying the subscription contract and selecting the associated billing cycle. + */ +export type SubscriptionBillingCycleInput = { + /** The ID of the subscription contract associated with the billing cycle. */ + contractId: Scalars["ID"]["input"]; + /** Selects the billing cycle by date or index. */ + selector: SubscriptionBillingCycleSelector; +}; + +/** The input fields for parameters to modify the schedule of a specific billing cycle. */ +export type SubscriptionBillingCycleScheduleEditInput = { + /** Sets the expected billing date for the billing cycle. */ + billingDate?: InputMaybe; + /** The reason for editing. */ + reason: SubscriptionBillingCycleScheduleEditInputScheduleEditReason; + /** Sets the skip status for the billing cycle. */ + skip?: InputMaybe; +}; + +/** The input fields for possible reasons for editing the billing cycle's schedule. */ +export type SubscriptionBillingCycleScheduleEditInputScheduleEditReason = + /** Buyer initiated the schedule edit. */ + | "BUYER_INITIATED" + /** Developer initiated the schedule edit. */ + | "DEV_INITIATED" + /** Merchant initiated the schedule edit. */ + | "MERCHANT_INITIATED"; + +/** Return type for `subscriptionBillingCycleScheduleEdit` mutation. */ +export type SubscriptionBillingCycleScheduleEditPayload = { + /** The updated billing cycle. */ + billingCycle?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to select SubscriptionBillingCycle by either date or index. */ +export type SubscriptionBillingCycleSelector = { + /** Returns a billing cycle by date. */ + date?: InputMaybe; + /** Returns a billing cycle by index. */ + index?: InputMaybe; +}; + +/** The possible errors for a subscription billing cycle. */ +export type SubscriptionBillingCycleUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** The input fields to select a subset of subscription billing cycles within a date range. */ +export type SubscriptionBillingCyclesDateRangeSelector = { + /** The end date and time for the range. */ + endDate: Scalars["DateTime"]["input"]; + /** The start date and time for the range. */ + startDate: Scalars["DateTime"]["input"]; +}; + +/** The input fields to select a subset of subscription billing cycles within an index range. */ +export type SubscriptionBillingCyclesIndexRangeSelector = { + /** The end index for the range. */ + endIndex: Scalars["Int"]["input"]; + /** The start index for the range. */ + startIndex: Scalars["Int"]["input"]; +}; + +/** The set of valid sort keys for the SubscriptionBillingCycles query. */ +export type SubscriptionBillingCyclesSortKeys = + /** Sort by the `cycle_index` value. */ + | "CYCLE_INDEX" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** Select subscription billing cycles to be targeted. */ +export type SubscriptionBillingCyclesTargetSelection = + /** Target all current and upcoming subscription billing cycles. */ + "ALL"; + +/** Represents a Subscription Billing Policy. */ +export type SubscriptionBillingPolicy = { + /** Specific anchor dates upon which the billing interval calculations should be made. */ + anchors: Array; + /** The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc). */ + interval: SellingPlanInterval; + /** The number of billing intervals between invoices. */ + intervalCount: Scalars["Int"]["output"]; + /** Maximum amount of cycles after which the subscription ends. */ + maxCycles?: Maybe; + /** Minimum amount of cycles required in the subscription. */ + minCycles?: Maybe; +}; + +/** The input fields for a Subscription Billing Policy. */ +export type SubscriptionBillingPolicyInput = { + /** Specific anchor dates upon which the billing interval calculations should be made. */ + anchors?: InputMaybe>; + /** The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc). */ + interval: SellingPlanInterval; + /** The number of billing intervals between invoices. */ + intervalCount: Scalars["Int"]["input"]; + /** Maximum amount of cycles required in the subscription. */ + maxCycles?: InputMaybe; + /** Minimum amount of cycles required in the subscription. */ + minCycles?: InputMaybe; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContract = Node & SubscriptionContractBase & { + /** The subscription app that the subscription contract is registered to. */ + app?: Maybe; + /** The URL of the subscription contract page on the subscription app. */ + appAdminUrl?: Maybe; + /** The list of billing attempts associated with the subscription contract. */ + billingAttempts: SubscriptionBillingAttemptConnection; + /** The billing policy associated with the subscription contract. */ + billingPolicy: SubscriptionBillingPolicy; + /** The date and time when the subscription contract was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The currency that's used for the subscription contract. */ + currencyCode: CurrencyCode; + /** A list of the custom attributes to be added to the generated orders. */ + customAttributes: Array; + /** The customer to whom the subscription contract belongs. */ + customer?: Maybe; + /** The customer payment method that's used for the subscription contract. */ + customerPaymentMethod?: Maybe; + /** The delivery method for each billing of the subscription contract. */ + deliveryMethod?: Maybe; + /** The delivery policy associated with the subscription contract. */ + deliveryPolicy: SubscriptionDeliveryPolicy; + /** The delivery price for each billing of the subscription contract. */ + deliveryPrice: MoneyV2; + /** The list of subscription discounts associated with the subscription contract. */ + discounts: SubscriptionManualDiscountConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The current status of the last payment. */ + lastPaymentStatus?: Maybe; + /** The number of lines associated with the subscription contract. */ + lineCount: Scalars["Int"]["output"]; + /** The list of subscription lines associated with the subscription contract. */ + lines: SubscriptionLineConnection; + /** The next billing date for the subscription contract. */ + nextBillingDate?: Maybe; + /** The note field that will be applied to the generated orders. */ + note?: Maybe; + /** A list of the subscription contract's orders. */ + orders: OrderConnection; + /** The order from which this contract originated. */ + originOrder?: Maybe; + /** The revision id of the contract. */ + revisionId: Scalars["UnsignedInt64"]["output"]; + /** The current status of the subscription contract. */ + status: SubscriptionContractSubscriptionStatus; + /** The date and time when the subscription contract was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContractBillingAttemptsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContractCustomerPaymentMethodArgs = { + showRevoked?: InputMaybe; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContractDiscountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContractLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Contract. */ +export type SubscriptionContractOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields required to create a Subscription Contract. */ +export type SubscriptionContractAtomicCreateInput = { + /** The attributes used as input for the Subscription Draft. */ + contract: SubscriptionDraftInput; + /** The currency used for the subscription contract. */ + currencyCode: CurrencyCode; + /** The ID of the customer to associate with the subscription contract. */ + customerId: Scalars["ID"]["input"]; + /** A list of discount redeem codes to apply to the subscription contract. */ + discountCodes?: InputMaybe>; + /** A list of new Subscription Lines. */ + lines: Array; + /** The next billing date for the subscription contract. */ + nextBillingDate: Scalars["DateTime"]["input"]; +}; + +/** Return type for `subscriptionContractAtomicCreate` mutation. */ +export type SubscriptionContractAtomicCreatePayload = { + /** The new Subscription Contract object. */ + contract?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents subscription contract common fields. */ +export type SubscriptionContractBase = { + /** The subscription app that the subscription contract is registered to. */ + app?: Maybe; + /** The URL of the subscription contract page on the subscription app. */ + appAdminUrl?: Maybe; + /** The currency that's used for the subscription contract. */ + currencyCode: CurrencyCode; + /** A list of the custom attributes to be added to the generated orders. */ + customAttributes: Array; + /** The customer to whom the subscription contract belongs. */ + customer?: Maybe; + /** The customer payment method that's used for the subscription contract. */ + customerPaymentMethod?: Maybe; + /** The delivery method for each billing of the subscription contract. */ + deliveryMethod?: Maybe; + /** The delivery price for each billing of the subscription contract. */ + deliveryPrice: MoneyV2; + /** The list of subscription discounts associated with the subscription contract. */ + discounts: SubscriptionManualDiscountConnection; + /** The number of lines associated with the subscription contract. */ + lineCount: Scalars["Int"]["output"]; + /** The list of subscription lines associated with the subscription contract. */ + lines: SubscriptionLineConnection; + /** The note field that will be applied to the generated orders. */ + note?: Maybe; + /** A list of the subscription contract's orders. */ + orders: OrderConnection; + /** The date and time when the subscription contract was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** Represents subscription contract common fields. */ +export type SubscriptionContractBaseCustomerPaymentMethodArgs = { + showRevoked?: InputMaybe; +}; + +/** Represents subscription contract common fields. */ +export type SubscriptionContractBaseDiscountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents subscription contract common fields. */ +export type SubscriptionContractBaseLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents subscription contract common fields. */ +export type SubscriptionContractBaseOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple SubscriptionContracts. + */ +export type SubscriptionContractConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionContractEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The input fields required to create a Subscription Contract. */ +export type SubscriptionContractCreateInput = { + /** The attributes used as input for the Subscription Draft. */ + contract: SubscriptionDraftInput; + /** The currency used for the subscription contract. */ + currencyCode: CurrencyCode; + /** The ID of the customer to associate with the subscription contract. */ + customerId: Scalars["ID"]["input"]; + /** The next billing date for the subscription contract. */ + nextBillingDate: Scalars["DateTime"]["input"]; +}; + +/** Return type for `subscriptionContractCreate` mutation. */ +export type SubscriptionContractCreatePayload = { + /** The Subscription Contract object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one SubscriptionContract and a cursor during pagination. + */ +export type SubscriptionContractEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionContractEdge. */ + node: SubscriptionContract; +}; + +/** Possible error codes that can be returned by `SubscriptionContractUserError`. */ +export type SubscriptionContractErrorCode = /** The input value is invalid. */ + "INVALID"; + +/** The possible status values of the last payment on a subscription contract. */ +export type SubscriptionContractLastPaymentStatus = + /** Failed subscription billing attempt. */ + | "FAILED" + /** Successful subscription billing attempt. */ + | "SUCCEEDED"; + +/** The input fields required to create a Subscription Contract. */ +export type SubscriptionContractProductChangeInput = { + /** The price of the product. */ + currentPrice?: InputMaybe; + /** The ID of the product variant the subscription line refers to. */ + productVariantId?: InputMaybe; +}; + +/** Return type for `subscriptionContractProductChange` mutation. */ +export type SubscriptionContractProductChangePayload = { + /** The new Subscription Contract object. */ + contract?: Maybe; + /** The updated Subscription Line. */ + lineUpdated?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionContractSetNextBillingDate` mutation. */ +export type SubscriptionContractSetNextBillingDatePayload = { + /** The updated Subscription Contract object. */ + contract?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The possible status values of a subscription. */ +export type SubscriptionContractSubscriptionStatus = + /** The contract is active and continuing per its policies. */ + | "ACTIVE" + /** The contract was ended by an unplanned customer action. */ + | "CANCELLED" + /** The contract has ended per the expected circumstances. All billing and deliverycycles of the subscriptions were executed. */ + | "EXPIRED" + /** The contract ended because billing failed and no further billing attempts are expected. */ + | "FAILED" + /** The contract is temporarily paused and is expected to resume in the future. */ + | "PAUSED" + /** The contract has expired due to inactivity. */ + | "STALE"; + +/** Return type for `subscriptionContractUpdate` mutation. */ +export type SubscriptionContractUpdatePayload = { + /** The Subscription Contract object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a Subscription Contract error. */ +export type SubscriptionContractUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Represents a Subscription Line Pricing Cycle Adjustment. */ +export type SubscriptionCyclePriceAdjustment = { + /** Price adjustment type. */ + adjustmentType: SellingPlanPricingPolicyAdjustmentType; + /** Price adjustment value. */ + adjustmentValue: SellingPlanPricingPolicyAdjustmentValue; + /** The number of cycles required before this pricing policy applies. */ + afterCycle: Scalars["Int"]["output"]; + /** The computed price after the adjustments applied. */ + computedPrice: MoneyV2; +}; + +/** Describes the delivery method to use to get the physical goods to the customer. */ +export type SubscriptionDeliveryMethod = + | SubscriptionDeliveryMethodLocalDelivery + | SubscriptionDeliveryMethodPickup + | SubscriptionDeliveryMethodShipping; + +/** + * Specifies delivery method fields for a subscription draft. + * This is an input union: one, and only one, field can be provided. + * The field provided will determine which delivery method is to be used. + */ +export type SubscriptionDeliveryMethodInput = { + /** The input fields for the local delivery method. */ + localDelivery?: InputMaybe; + /** The input fields for the pickup delivery method. */ + pickup?: InputMaybe; + /** The input fields for the shipping delivery method. */ + shipping?: InputMaybe; +}; + +/** A local delivery method, which includes a mailing address and a local delivery option. */ +export type SubscriptionDeliveryMethodLocalDelivery = { + /** The address to deliver to. */ + address: SubscriptionMailingAddress; + /** The details of the local delivery method to use. */ + localDeliveryOption: SubscriptionDeliveryMethodLocalDeliveryOption; +}; + +/** + * The input fields for a local delivery method. + * + * This input accepts partial input. When a field is not provided, + * its prior value is left unchanged. + */ +export type SubscriptionDeliveryMethodLocalDeliveryInput = { + /** The address to deliver to. */ + address?: InputMaybe; + /** The details of the local delivery method to use. */ + localDeliveryOption?: InputMaybe< + SubscriptionDeliveryMethodLocalDeliveryOptionInput + >; +}; + +/** The selected delivery option on a subscription contract. */ +export type SubscriptionDeliveryMethodLocalDeliveryOption = { + /** A custom reference to the delivery method for use with automations. */ + code?: Maybe; + /** The details displayed to the customer to describe the local delivery option. */ + description?: Maybe; + /** The delivery instructions that the customer can provide to the merchant. */ + instructions?: Maybe; + /** + * The phone number that the customer provided to the merchant. + * Formatted using E.164 standard. For example, `+16135551111`. + */ + phone: Scalars["String"]["output"]; + /** The presentment title of the local delivery option. */ + presentmentTitle?: Maybe; + /** The title of the local delivery option. */ + title?: Maybe; +}; + +/** The input fields for local delivery option. */ +export type SubscriptionDeliveryMethodLocalDeliveryOptionInput = { + /** A custom reference to the delivery method for use with automations. */ + code?: InputMaybe; + /** The details displayed to the customer to describe the local delivery option. */ + description?: InputMaybe; + /** The delivery instructions that the customer can provide to the merchant. */ + instructions?: InputMaybe; + /** + * The phone number that the customer must provide to the merchant. + * Formatted using E.164 standard. For example, `+16135551111`. + */ + phone: Scalars["String"]["input"]; + /** The presentment title of the local delivery option. */ + presentmentTitle?: InputMaybe; + /** The title of the local delivery option. */ + title?: InputMaybe; +}; + +/** A delivery method with a pickup option. */ +export type SubscriptionDeliveryMethodPickup = { + /** The details of the pickup delivery method to use. */ + pickupOption: SubscriptionDeliveryMethodPickupOption; +}; + +/** + * The input fields for a pickup delivery method. + * + * This input accepts partial input. When a field is not provided, + * its prior value is left unchanged. + */ +export type SubscriptionDeliveryMethodPickupInput = { + /** The details of the pickup method to use. */ + pickupOption?: InputMaybe; +}; + +/** Represents the selected pickup option on a subscription contract. */ +export type SubscriptionDeliveryMethodPickupOption = { + /** A custom reference to the delivery method for use with automations. */ + code?: Maybe; + /** The details displayed to the customer to describe the pickup option. */ + description?: Maybe; + /** The location where the customer will pickup the merchandise. */ + location: Location; + /** The presentment title of the pickup option. */ + presentmentTitle?: Maybe; + /** The title of the pickup option. */ + title?: Maybe; +}; + +/** The input fields for pickup option. */ +export type SubscriptionDeliveryMethodPickupOptionInput = { + /** A custom reference to the delivery method for use with automations. */ + code?: InputMaybe; + /** The details displayed to the customer to describe the pickup option. */ + description?: InputMaybe; + /** The ID of the pickup location. */ + locationId: Scalars["ID"]["input"]; + /** The presentment title of the pickup option. */ + presentmentTitle?: InputMaybe; + /** The title of the pickup option. */ + title?: InputMaybe; +}; + +/** Represents a shipping delivery method: a mailing address and a shipping option. */ +export type SubscriptionDeliveryMethodShipping = { + /** The address to ship to. */ + address: SubscriptionMailingAddress; + /** The details of the shipping method to use. */ + shippingOption: SubscriptionDeliveryMethodShippingOption; +}; + +/** + * Specifies shipping delivery method fields. + * + * This input accepts partial input. When a field is not provided, + * its prior value is left unchanged. + */ +export type SubscriptionDeliveryMethodShippingInput = { + /** The address to ship to. */ + address?: InputMaybe; + /** The details of the shipping method to use. */ + shippingOption?: InputMaybe; +}; + +/** Represents the selected shipping option on a subscription contract. */ +export type SubscriptionDeliveryMethodShippingOption = { + /** + * The carrier service that's providing this shipping option. + * This field isn't currently supported and returns null. + * + * @deprecated This field has never been implemented. + */ + carrierService?: Maybe; + /** The code of the shipping option. */ + code?: Maybe; + /** The description of the shipping option. */ + description?: Maybe; + /** The presentment title of the shipping option. */ + presentmentTitle?: Maybe; + /** The title of the shipping option. */ + title?: Maybe; +}; + +/** The input fields for shipping option. */ +export type SubscriptionDeliveryMethodShippingOptionInput = { + /** The carrier service ID of the shipping option. */ + carrierServiceId?: InputMaybe; + /** The code of the shipping option. */ + code?: InputMaybe; + /** The description of the shipping option. */ + description?: InputMaybe; + /** The presentment title of the shipping option. */ + presentmentTitle?: InputMaybe; + /** The title of the shipping option. */ + title?: InputMaybe; +}; + +/** The delivery option for a subscription contract. */ +export type SubscriptionDeliveryOption = + | SubscriptionLocalDeliveryOption + | SubscriptionPickupOption + | SubscriptionShippingOption; + +/** The result of the query to fetch delivery options for the subscription contract. */ +export type SubscriptionDeliveryOptionResult = + | SubscriptionDeliveryOptionResultFailure + | SubscriptionDeliveryOptionResultSuccess; + +/** A failure to find the available delivery options for a subscription contract. */ +export type SubscriptionDeliveryOptionResultFailure = { + /** The reason for the failure. */ + message?: Maybe; +}; + +/** The delivery option for a subscription contract. */ +export type SubscriptionDeliveryOptionResultSuccess = { + /** The available delivery options. */ + deliveryOptions: Array; +}; + +/** Represents a Subscription Delivery Policy. */ +export type SubscriptionDeliveryPolicy = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors: Array; + /** The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc). */ + interval: SellingPlanInterval; + /** The number of delivery intervals between deliveries. */ + intervalCount: Scalars["Int"]["output"]; +}; + +/** The input fields for a Subscription Delivery Policy. */ +export type SubscriptionDeliveryPolicyInput = { + /** The specific anchor dates upon which the delivery interval calculations should be made. */ + anchors?: InputMaybe>; + /** The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc). */ + interval: SellingPlanInterval; + /** The number of billing intervals between invoices. */ + intervalCount: Scalars["Int"]["input"]; +}; + +/** Subscription draft discount types. */ +export type SubscriptionDiscount = + | SubscriptionAppliedCodeDiscount + | SubscriptionManualDiscount; + +/** Represents what a particular discount reduces from a line price. */ +export type SubscriptionDiscountAllocation = { + /** Allocation amount. */ + amount: MoneyV2; + /** Discount that created the allocation. */ + discount: SubscriptionDiscount; +}; + +/** + * An auto-generated type for paginating through multiple SubscriptionDiscounts. + */ +export type SubscriptionDiscountConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionDiscountEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination. + */ +export type SubscriptionDiscountEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionDiscountEdge. */ + node: SubscriptionDiscount; +}; + +/** Represents the subscription lines the discount applies on. */ +export type SubscriptionDiscountEntitledLines = { + /** Specify whether the subscription discount will apply on all subscription lines. */ + all: Scalars["Boolean"]["output"]; + /** The list of subscription lines associated with the subscription discount. */ + lines: SubscriptionLineConnection; +}; + +/** Represents the subscription lines the discount applies on. */ +export type SubscriptionDiscountEntitledLinesLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The value of the discount and how it will be applied. */ +export type SubscriptionDiscountFixedAmountValue = { + /** The fixed amount value of the discount. */ + amount: MoneyV2; + /** Whether the amount is applied per item. */ + appliesOnEachItem: Scalars["Boolean"]["output"]; +}; + +/** The percentage value of the discount. */ +export type SubscriptionDiscountPercentageValue = { + /** The percentage value of the discount. */ + percentage: Scalars["Int"]["output"]; +}; + +/** The reason a discount on a subscription draft was rejected. */ +export type SubscriptionDiscountRejectionReason = + /** Discount is inactive. */ + | "CURRENTLY_INACTIVE" + /** Given customer does not qualify for the discount. */ + | "CUSTOMER_NOT_ELIGIBLE" + /** Customer usage limit has been reached. */ + | "CUSTOMER_USAGE_LIMIT_REACHED" + /** Purchase type does not qualify for the discount. */ + | "INCOMPATIBLE_PURCHASE_TYPE" + /** Internal error during discount code validation. */ + | "INTERNAL_ERROR" + /** Discount code is not found. */ + | "NOT_FOUND" + /** Discount does not apply to any of the given line items. */ + | "NO_ENTITLED_LINE_ITEMS" + /** No applicable shipping lines. */ + | "NO_ENTITLED_SHIPPING_LINES" + /** Purchase amount of items does not qualify for the discount. */ + | "PURCHASE_NOT_IN_RANGE" + /** Quantity of items does not qualify for the discount. */ + | "QUANTITY_NOT_IN_RANGE" + /** Discount usage limit has been reached. */ + | "USAGE_LIMIT_REACHED"; + +/** The value of the discount and how it will be applied. */ +export type SubscriptionDiscountValue = + | SubscriptionDiscountFixedAmountValue + | SubscriptionDiscountPercentageValue; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraft = Node & { + /** The billing cycle that the subscription contract will be associated with. */ + billingCycle?: Maybe; + /** The billing policy for the subscription contract. */ + billingPolicy: SubscriptionBillingPolicy; + /** The billing cycles of the contracts that will be concatenated to the subscription contract. */ + concatenatedBillingCycles: SubscriptionBillingCycleConnection; + /** The currency used for the subscription contract. */ + currencyCode: CurrencyCode; + /** A list of the custom attributes to be added to the generated orders. */ + customAttributes: Array; + /** The customer to whom the subscription contract belongs. */ + customer: Customer; + /** The customer payment method used for the subscription contract. */ + customerPaymentMethod?: Maybe; + /** The delivery method for each billing of the subscription contract. */ + deliveryMethod?: Maybe; + /** + * The available delivery options for a given delivery address. Returns `null` for pending requests. + */ + deliveryOptions?: Maybe; + /** The delivery policy for the subscription contract. */ + deliveryPolicy: SubscriptionDeliveryPolicy; + /** The delivery price for each billing the subscription contract. */ + deliveryPrice?: Maybe; + /** The list of subscription discounts which will be associated with the subscription contract. */ + discounts: SubscriptionDiscountConnection; + /** The list of subscription discounts to be added to the subscription contract. */ + discountsAdded: SubscriptionDiscountConnection; + /** The list of subscription discounts to be removed from the subscription contract. */ + discountsRemoved: SubscriptionDiscountConnection; + /** The list of subscription discounts to be updated on the subscription contract. */ + discountsUpdated: SubscriptionDiscountConnection; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The list of subscription lines which will be associated with the subscription contract. */ + lines: SubscriptionLineConnection; + /** The list of subscription lines to be added to the subscription contract. */ + linesAdded: SubscriptionLineConnection; + /** The list of subscription lines to be removed from the subscription contract. */ + linesRemoved: SubscriptionLineConnection; + /** The next billing date for the subscription contract. */ + nextBillingDate?: Maybe; + /** The note field that will be applied to the generated orders. */ + note?: Maybe; + /** The original subscription contract. */ + originalContract?: Maybe; + /** + * Available Shipping Options for a given delivery address. Returns NULL for pending requests. + * + * @deprecated Use `deliveryOptions` instead. + */ + shippingOptions?: Maybe; + /** The current status of the subscription contract. */ + status?: Maybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftConcatenatedBillingCyclesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftCustomerPaymentMethodArgs = { + showRevoked?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftDeliveryOptionsArgs = { + deliveryAddress?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftDiscountsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftDiscountsAddedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftDiscountsRemovedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftDiscountsUpdatedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftLinesAddedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftLinesRemovedArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** Represents a Subscription Draft. */ +export type SubscriptionDraftShippingOptionsArgs = { + deliveryAddress?: InputMaybe; +}; + +/** Return type for `subscriptionDraftCommit` mutation. */ +export type SubscriptionDraftCommitPayload = { + /** The updated Subscription Contract object. */ + contract?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftDiscountAdd` mutation. */ +export type SubscriptionDraftDiscountAddPayload = { + /** The added Subscription Discount. */ + discountAdded?: Maybe; + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftDiscountCodeApply` mutation. */ +export type SubscriptionDraftDiscountCodeApplyPayload = { + /** The added subscription discount. */ + appliedDiscount?: Maybe; + /** The subscription contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftDiscountRemove` mutation. */ +export type SubscriptionDraftDiscountRemovePayload = { + /** The removed subscription draft discount. */ + discountRemoved?: Maybe; + /** The subscription contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftDiscountUpdate` mutation. */ +export type SubscriptionDraftDiscountUpdatePayload = { + /** The updated Subscription Discount. */ + discountUpdated?: Maybe; + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `SubscriptionDraftUserError`. */ +export type SubscriptionDraftErrorCode = + /** This line has already been removed. */ + | "ALREADY_REMOVED" + /** Cannot commit a contract draft with this mutation. Please use SubscriptionDraftCommit. */ + | "BILLING_CYCLE_ABSENT" + /** Billing policy cannot be updated for billing cycle contract drafts. */ + | "BILLING_CYCLE_CONTRACT_DRAFT_BILLING_POLICY_INVALID" + /** Delivery policy cannot be updated for billing cycle contract drafts. */ + | "BILLING_CYCLE_CONTRACT_DRAFT_DELIVERY_POLICY_INVALID" + /** Cannot commit a billing cycle contract draft with this mutation. Please use SubscriptionBillingCycleContractDraftCommit. */ + | "BILLING_CYCLE_PRESENT" + /** The input value is blank. */ + | "BLANK" + /** Subscription draft has been already committed. */ + | "COMMITTED" + /** Contract draft must be a billing cycle contract draft for contract concatenation. */ + | "CONCATENATION_BILLING_CYCLE_CONTRACT_DRAFT_REQUIRED" + /** Currency is not enabled. */ + | "CURRENCY_NOT_ENABLED" + /** The customer doesn't exist. */ + | "CUSTOMER_DOES_NOT_EXIST" + /** The payment method customer must be the same as the contract customer. */ + | "CUSTOMER_MISMATCH" + /** The after cycle attribute must be unique between cycle discounts. */ + | "CYCLE_DISCOUNTS_UNIQUE_AFTER_CYCLE" + /** Billing cycle selector cannot select billing cycle outside of index range. */ + | "CYCLE_INDEX_OUT_OF_RANGE" + /** Billing cycle selector requires exactly one of index or date to be provided. */ + | "CYCLE_SELECTOR_VALIDATE_ONE_OF" + /** Billing cycle selector cannot select billing cycle outside of start date range. */ + | "CYCLE_START_DATE_OUT_OF_RANGE" + /** The delivery method can't be blank if any lines require shipping. */ + | "DELIVERY_METHOD_REQUIRED" + /** The delivery policy interval must be a multiple of the billing policy interval. */ + | "DELIVERY_MUST_BE_MULTIPLE_OF_BILLING" + /** Concatenated contracts cannot contain duplicate subscription contracts. */ + | "DUPLICATE_CONCATENATED_CONTRACTS" + /** Maximum number of concatenated contracts on a billing cycle contract draft exceeded. */ + | "EXCEEDED_MAX_CONCATENATED_CONTRACTS" + /** The input value should be greater than the minimum allowed value. */ + | "GREATER_THAN" + /** The input value should be greater than or equal to the minimum value allowed. */ + | "GREATER_THAN_OR_EQUAL_TO" + /** Cannot update a subscription contract with a current or upcoming billing cycle contract edit. */ + | "HAS_FUTURE_EDITS" + /** The input value is invalid. */ + | "INVALID" + /** The adjustment value must the same type as the adjustment type. */ + | "INVALID_ADJUSTMENT_TYPE" + /** The adjustment value must be either fixed_value or percentage. */ + | "INVALID_ADJUSTMENT_VALUE" + /** Next billing date is invalid. */ + | "INVALID_BILLING_DATE" + /** Must have at least one line. */ + | "INVALID_LINES" + /** Note length is too long. */ + | "INVALID_NOTE_LENGTH" + /** The input value should be less than the maximum value allowed. */ + | "LESS_THAN" + /** The input value should be less than or equal to the maximum value allowed. */ + | "LESS_THAN_OR_EQUAL_TO" + /** The local delivery options must be set for local delivery. */ + | "MISSING_LOCAL_DELIVERY_OPTIONS" + /** The value is not an integer. */ + | "NOT_AN_INTEGER" + /** Value is not in range. */ + | "NOT_IN_RANGE" + /** Discount must have at least one entitled line. */ + | "NO_ENTITLED_LINES" + /** Input value is not present. */ + | "PRESENCE" + /** The maximum number of cycles must be greater than the minimum. */ + | "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES" + /** Another operation updated the contract concurrently as the commit was in progress. */ + | "STALE_CONTRACT" + /** The input value is too long. */ + | "TOO_LONG" + /** The input value is too short. */ + | "TOO_SHORT" + /** Billing cycle selector cannot select upcoming billing cycle past limit. */ + | "UPCOMING_CYCLE_LIMIT_EXCEEDED"; + +/** Return type for `subscriptionDraftFreeShippingDiscountAdd` mutation. */ +export type SubscriptionDraftFreeShippingDiscountAddPayload = { + /** The added subscription free shipping discount. */ + discountAdded?: Maybe; + /** The subscription contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftFreeShippingDiscountUpdate` mutation. */ +export type SubscriptionDraftFreeShippingDiscountUpdatePayload = { + /** The updated Subscription Discount. */ + discountUpdated?: Maybe; + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields required to create a Subscription Draft. */ +export type SubscriptionDraftInput = { + /** The billing policy for the subscription contract. */ + billingPolicy?: InputMaybe; + /** A list of the custom attributes added to the subscription contract. */ + customAttributes?: InputMaybe>; + /** The delivery method for the subscription contract. */ + deliveryMethod?: InputMaybe; + /** The delivery policy for the subscription contract. */ + deliveryPolicy?: InputMaybe; + /** The shipping price for each renewal the subscription contract. */ + deliveryPrice?: InputMaybe; + /** The next billing date for the subscription contract. */ + nextBillingDate?: InputMaybe; + /** The note field that will be applied to the generated orders. */ + note?: InputMaybe; + /** The ID of the payment method to be used for the subscription contract. */ + paymentMethodId?: InputMaybe; + /** The current status of the subscription contract. */ + status?: InputMaybe; +}; + +/** Return type for `subscriptionDraftLineAdd` mutation. */ +export type SubscriptionDraftLineAddPayload = { + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The added Subscription Line. */ + lineAdded?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftLineRemove` mutation. */ +export type SubscriptionDraftLineRemovePayload = { + /** The list of updated subscription discounts impacted by the removed line. */ + discountsUpdated?: Maybe>; + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The removed Subscription Line. */ + lineRemoved?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftLineUpdate` mutation. */ +export type SubscriptionDraftLineUpdatePayload = { + /** The Subscription Contract draft object. */ + draft?: Maybe; + /** The updated Subscription Line. */ + lineUpdated?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `subscriptionDraftUpdate` mutation. */ +export type SubscriptionDraftUpdatePayload = { + /** The Subscription Draft object. */ + draft?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a Subscription Draft error. */ +export type SubscriptionDraftUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** The input fields for a subscription free shipping discount on a contract. */ +export type SubscriptionFreeShippingDiscountInput = { + /** The maximum number of times the subscription free shipping discount will be applied on orders. */ + recurringCycleLimit?: InputMaybe; + /** The title associated with the subscription free shipping discount. */ + title?: InputMaybe; +}; + +/** Represents a Subscription Line. */ +export type SubscriptionLine = { + /** The price per unit for the subscription line in the contract's currency. */ + currentPrice: MoneyV2; + /** List of custom attributes associated to the line item. */ + customAttributes: Array; + /** Discount allocations. */ + discountAllocations: Array; + /** The unique ID. */ + id: Scalars["ID"]["output"]; + /** Total line price including all discounts. */ + lineDiscountedPrice: MoneyV2; + /** Describe the price changes of the line over time. */ + pricingPolicy?: Maybe; + /** The product ID associated with the subscription line. */ + productId?: Maybe; + /** The quantity of the unit selected for the subscription line. */ + quantity: Scalars["Int"]["output"]; + /** Whether physical shipping is required for the variant. */ + requiresShipping: Scalars["Boolean"]["output"]; + /** + * The selling plan ID associated to the line. + * + * Indicates which selling plan was used to create this + * contract line initially. The selling plan ID is also used to + * find the associated delivery profile. + * + * The subscription contract, subscription line, or selling plan might have + * changed. As a result, the selling plan's attributes might not + * match the information on the contract. + */ + sellingPlanId?: Maybe; + /** + * The selling plan name associated to the line. This name describes + * the order line items created from this subscription line + * for both merchants and customers. + * + * The value can be different from the selling plan's name, because both + * the selling plan's name and the subscription line's selling_plan_name + * attribute can be updated independently. + */ + sellingPlanName?: Maybe; + /** Variant SKU number of the item associated with the subscription line. */ + sku?: Maybe; + /** Whether the variant is taxable. */ + taxable: Scalars["Boolean"]["output"]; + /** Product title of the item associated with the subscription line. */ + title: Scalars["String"]["output"]; + /** The product variant ID associated with the subscription line. */ + variantId?: Maybe; + /** The image associated with the line item's variant or product. */ + variantImage?: Maybe; + /** Product variant title of the item associated with the subscription line. */ + variantTitle?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple SubscriptionLines. + */ +export type SubscriptionLineConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionLineEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SubscriptionLine and a cursor during pagination. + */ +export type SubscriptionLineEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionLineEdge. */ + node: SubscriptionLine; +}; + +/** The input fields required to add a new subscription line to a contract. */ +export type SubscriptionLineInput = { + /** The price of the product. */ + currentPrice: Scalars["Decimal"]["input"]; + /** The custom attributes for this subscription line. */ + customAttributes?: InputMaybe>; + /** Describes expected price changes of the subscription line over time. */ + pricingPolicy?: InputMaybe; + /** The ID of the product variant the subscription line refers to. */ + productVariantId: Scalars["ID"]["input"]; + /** The quantity of the product. */ + quantity: Scalars["Int"]["input"]; + /** The selling plan for the subscription line. */ + sellingPlanId?: InputMaybe; + /** + * The selling plan name for the subscription line. + * + * Defaults to using the selling plan's current name when not specified. + */ + sellingPlanName?: InputMaybe; +}; + +/** The input fields required to update a subscription line on a contract. */ +export type SubscriptionLineUpdateInput = { + /** The price of the product. */ + currentPrice?: InputMaybe; + /** The custom attributes for this subscription line. */ + customAttributes?: InputMaybe>; + /** Describes expected price changes of the subscription line over time. */ + pricingPolicy?: InputMaybe; + /** The ID of the product variant the subscription line refers to. */ + productVariantId?: InputMaybe; + /** The quantity of the product. */ + quantity?: InputMaybe; + /** The selling plan for the subscription line. */ + sellingPlanId?: InputMaybe; + /** The selling plan name for the subscription line. */ + sellingPlanName?: InputMaybe; +}; + +/** A local delivery option for a subscription contract. */ +export type SubscriptionLocalDeliveryOption = { + /** The code of the local delivery option. */ + code: Scalars["String"]["output"]; + /** The description of the local delivery option. */ + description?: Maybe; + /** Whether a phone number is required for the local delivery option. */ + phoneRequired: Scalars["Boolean"]["output"]; + /** The presentment title of the local delivery option. */ + presentmentTitle?: Maybe; + /** The price of the local delivery option. */ + price?: Maybe; + /** The title of the local delivery option. */ + title: Scalars["String"]["output"]; +}; + +/** Represents a Mailing Address on a Subscription. */ +export type SubscriptionMailingAddress = { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** The second line of the address. Typically the number of the apartment, suite, or unit. */ + address2?: Maybe; + /** The name of the city, district, village, or town. */ + city?: Maybe; + /** The name of the customer's company or organization. */ + company?: Maybe; + /** The name of the country. */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + */ + countryCode?: Maybe; + /** The first name of the customer. */ + firstName?: Maybe; + /** The last name of the customer. */ + lastName?: Maybe; + /** The full name of the customer, based on firstName and lastName. */ + name?: Maybe; + /** A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_. */ + phone?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * + * For example, ON. + */ + provinceCode?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + +/** Custom subscription discount. */ +export type SubscriptionManualDiscount = { + /** Entitled line items used to apply the subscription discount on. */ + entitledLines: SubscriptionDiscountEntitledLines; + /** The unique ID. */ + id: Scalars["ID"]["output"]; + /** The maximum number of times the subscription discount will be applied on orders. */ + recurringCycleLimit?: Maybe; + /** The reason that the discount on the subscription draft is rejected. */ + rejectionReason?: Maybe; + /** Type of line the discount applies on. */ + targetType: DiscountTargetType; + /** The title associated with the subscription discount. */ + title?: Maybe; + /** The type of the subscription discount. */ + type: DiscountType; + /** The number of times the discount was applied. */ + usageCount: Scalars["Int"]["output"]; + /** The value of the subscription discount. */ + value: SubscriptionDiscountValue; +}; + +/** + * An auto-generated type for paginating through multiple SubscriptionManualDiscounts. + */ +export type SubscriptionManualDiscountConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SubscriptionManualDiscountEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination. + */ +export type SubscriptionManualDiscountEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of SubscriptionManualDiscountEdge. */ + node: SubscriptionManualDiscount; +}; + +/** The input fields for the subscription lines the discount applies on. */ +export type SubscriptionManualDiscountEntitledLinesInput = { + /** Specify whether the subscription discount will apply on all subscription lines. */ + all?: InputMaybe; + /** The ID of the lines to add to or remove from the subscription discount. */ + lines?: InputMaybe; +}; + +/** The input fields for the fixed amount value of the discount and distribution on the lines. */ +export type SubscriptionManualDiscountFixedAmountInput = { + /** Fixed amount value. */ + amount?: InputMaybe; + /** Whether the amount is intended per line item or once per subscription. */ + appliesOnEachItem?: InputMaybe; +}; + +/** The input fields for a subscription discount on a contract. */ +export type SubscriptionManualDiscountInput = { + /** Entitled line items used to apply the subscription discount on. */ + entitledLines?: InputMaybe; + /** The maximum number of times the subscription discount will be applied on orders. */ + recurringCycleLimit?: InputMaybe; + /** The title associated with the subscription discount. */ + title?: InputMaybe; + /** Percentage or fixed amount value of the discount. */ + value?: InputMaybe; +}; + +/** The input fields for line items that the discount refers to. */ +export type SubscriptionManualDiscountLinesInput = { + /** The ID of the lines to add to the subscription discount. */ + add?: InputMaybe>; + /** The ID of the lines to remove from the subscription discount. */ + remove?: InputMaybe>; +}; + +/** The input fields for the discount value and its distribution. */ +export type SubscriptionManualDiscountValueInput = { + /** Fixed amount input in the currency defined by the subscription. */ + fixedAmount?: InputMaybe; + /** The percentage value of the discount. Value must be between 0 - 100. */ + percentage?: InputMaybe; +}; + +/** A pickup option to deliver a subscription contract. */ +export type SubscriptionPickupOption = { + /** The code of the pickup option. */ + code: Scalars["String"]["output"]; + /** The description of the pickup option. */ + description?: Maybe; + /** The pickup location. */ + location: Location; + /** Whether a phone number is required for the pickup option. */ + phoneRequired: Scalars["Boolean"]["output"]; + /** The estimated amount of time it takes for the pickup to be ready. For example, "Usually ready in 24 hours".). */ + pickupTime: Scalars["String"]["output"]; + /** The presentment title of the pickup option. */ + presentmentTitle?: Maybe; + /** The price of the pickup option. */ + price?: Maybe; + /** The title of the pickup option. */ + title: Scalars["String"]["output"]; +}; + +/** Represents a Subscription Line Pricing Policy. */ +export type SubscriptionPricingPolicy = { + /** The base price per unit for the subscription line in the contract's currency. */ + basePrice: MoneyV2; + /** The adjustments per cycle for the subscription line. */ + cycleDiscounts: Array; +}; + +/** The input fields for an array containing all pricing changes for each billing cycle. */ +export type SubscriptionPricingPolicyCycleDiscountsInput = { + /** The price adjustment type. */ + adjustmentType: SellingPlanPricingPolicyAdjustmentType; + /** The price adjustment value. */ + adjustmentValue: SellingPlanPricingPolicyValueInput; + /** The cycle after which the pricing policy applies. */ + afterCycle: Scalars["Int"]["input"]; + /** The computed price after the adjustments are applied. */ + computedPrice: Scalars["Decimal"]["input"]; +}; + +/** The input fields for expected price changes of the subscription line over time. */ +export type SubscriptionPricingPolicyInput = { + /** The base price per unit for the subscription line in the contract's currency. */ + basePrice: Scalars["Decimal"]["input"]; + /** An array containing all pricing changes for each billing cycle. */ + cycleDiscounts: Array; +}; + +/** A shipping option to deliver a subscription contract. */ +export type SubscriptionShippingOption = { + /** + * The carrier service that's providing this shipping option. + * This field isn't currently supported and returns null. + * + * @deprecated This field has never been implemented. + */ + carrierService?: Maybe; + /** The code of the shipping option. */ + code: Scalars["String"]["output"]; + /** The description of the shipping option. */ + description?: Maybe; + /** If a phone number is required for the shipping option. */ + phoneRequired?: Maybe; + /** The presentment title of the shipping option. */ + presentmentTitle?: Maybe; + /** The price of the shipping option. */ + price?: Maybe; + /** The title of the shipping option. */ + title: Scalars["String"]["output"]; +}; + +/** The result of the query to fetch shipping options for the subscription contract. */ +export type SubscriptionShippingOptionResult = + | SubscriptionShippingOptionResultFailure + | SubscriptionShippingOptionResultSuccess; + +/** Failure determining available shipping options for delivery of a subscription contract. */ +export type SubscriptionShippingOptionResultFailure = { + /** Failure reason. */ + message?: Maybe; +}; + +/** A shipping option for delivery of a subscription contract. */ +export type SubscriptionShippingOptionResultSuccess = { + /** Available shipping options. */ + shippingOptions: Array; +}; + +/** + * A suggested transaction. Suggested transaction are usually used in the context of refunds + * and exchanges. + */ +export type SuggestedOrderTransaction = { + /** The masked account number associated with the payment method. */ + accountNumber?: Maybe; + /** + * The amount of the transaction. + * @deprecated Use `amountSet` instead. + */ + amount: Scalars["Money"]["output"]; + /** The amount and currency of the suggested order transaction in shop and presentment currencies. */ + amountSet: MoneyBag; + /** The human-readable payment gateway name suggested to process the transaction. */ + formattedGateway?: Maybe; + /** The suggested payment gateway used to process the transaction. */ + gateway?: Maybe; + /** Specifies the kind of the suggested order transaction. */ + kind: SuggestedOrderTransactionKind; + /** + * Specifies the available amount to refund on the gateway. Only available within SuggestedRefund. + * @deprecated Use `maximumRefundableSet` instead. + */ + maximumRefundable?: Maybe; + /** Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund. */ + maximumRefundableSet?: Maybe; + /** The associated parent transaction, for example the authorization of a capture. */ + parentTransaction?: Maybe; +}; + +/** Specifies the kind of the suggested order transaction. */ +export type SuggestedOrderTransactionKind = + /** A suggested refund transaction for an order. */ + "SUGGESTED_REFUND"; + +/** Represents a refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund. */ +export type SuggestedRefund = { + /** + * The total monetary value to be refunded. + * @deprecated Use `amountSet` instead. + */ + amount: Scalars["Money"]["output"]; + /** The total monetary value to be refunded in shop and presentment currencies. */ + amountSet: MoneyBag; + /** The sum of all the discounted prices of the line items being refunded. */ + discountedSubtotalSet: MoneyBag; + /** + * The total monetary value available to refund. + * @deprecated Use `maximumRefundableSet` instead. + */ + maximumRefundable: Scalars["Money"]["output"]; + /** The total monetary value available to refund in shop and presentment currencies. */ + maximumRefundableSet: MoneyBag; + /** A list of duties to be refunded from the order. */ + refundDuties: Array; + /** A list of line items to be refunded, along with restock instructions. */ + refundLineItems: Array; + /** The shipping costs to be refunded from the order. */ + shipping: ShippingRefund; + /** + * The sum of all the prices of the line items being refunded. + * @deprecated Use `subtotalSet` instead. + */ + subtotal: Scalars["Money"]["output"]; + /** The sum of all the prices of the line items being refunded in shop and presentment currencies. */ + subtotalSet: MoneyBag; + /** A list of suggested order transactions. */ + suggestedTransactions: Array; + /** The total cart discount amount that was applied to all line items in this refund. */ + totalCartDiscountAmountSet: MoneyBag; + /** The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive. */ + totalDutiesSet: MoneyBag; + /** The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive. */ + totalTaxSet: MoneyBag; + /** + * The sum of the taxes being refunded from the order. The value must be positive. + * @deprecated Use `totalTaxSet` instead. + */ + totalTaxes: Scalars["Money"]["output"]; +}; + +/** Represents a return refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund for the return. */ +export type SuggestedReturnRefund = { + /** The total monetary value to be refunded in shop and presentment currencies. */ + amount: MoneyBag; + /** The sum of all the discounted prices of the line items being refunded. */ + discountedSubtotal: MoneyBag; + /** The total monetary value available to refund in shop and presentment currencies. */ + maximumRefundable: MoneyBag; + /** A list of duties to be refunded from the order. */ + refundDuties: Array; + /** The shipping costs to be refunded from the order. */ + shipping: ShippingRefund; + /** The sum of all the prices of the line items being refunded in shop and presentment currencies. */ + subtotal: MoneyBag; + /** A list of suggested order transactions. */ + suggestedTransactions: Array; + /** The total cart discount amount that was applied to all line items in this refund. */ + totalCartDiscountAmount: MoneyBag; + /** The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive. */ + totalDuties: MoneyBag; + /** The sum of the taxes being refunded in shop and presentment currencies. The value must be positive. */ + totalTax: MoneyBag; +}; + +/** The result in a tabular format with schema information and formatted and unformatted row data. */ +export type TableData = { + /** The data table columns. */ + columns: Array; + /** The formatted data values. */ + rowData: Array>; + /** The unformatted data values. */ + unformattedData: Scalars["JSON"]["output"]; +}; + +/** A nested array representation of the data. An index in an array represents a row number. */ +export type TableDataColumn = { + /** For comparison columns, indicates the column to compare to. */ + comparedTo: Scalars["String"]["output"]; + /** The data type of the column value. */ + dataType: Scalars["String"]["output"]; + /** The display name of the column in the data model. */ + displayName: Scalars["String"]["output"]; + /** The name of the column in the data model. */ + name: Scalars["String"]["output"]; +}; + +/** The default table response structure for a ShopifyQL query. */ +export type TableResponse = ShopifyqlResponse & { + /** A list of parse errors, if parsing fails. */ + parseErrors?: Maybe>; + /** The result in a tabular format with schema and row data. */ + tableData?: Maybe; +}; + +/** Return type for `tagsAdd` mutation. */ +export type TagsAddPayload = { + /** The object that was updated. */ + node?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `tagsRemove` mutation. */ +export type TagsRemovePayload = { + /** The object that was updated. */ + node?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Tax app configuration of a merchant. */ +export type TaxAppConfiguration = { + /** State of the tax app configuration. */ + state: TaxPartnerState; +}; + +/** Return type for `taxAppConfigure` mutation. */ +export type TaxAppConfigurePayload = { + /** The updated tax app configuration. */ + taxAppConfiguration?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `TaxAppConfigure`. */ +export type TaxAppConfigureUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `TaxAppConfigureUserError`. */ +export type TaxAppConfigureUserErrorCode = + /** Unable to update already active tax partner. */ + | "TAX_PARTNER_ALREADY_ACTIVE" + /** Unable to find the tax partner record. */ + | "TAX_PARTNER_NOT_FOUND" + /** Unable to update tax partner state. */ + | "TAX_PARTNER_STATE_UPDATE_FAILED"; + +/** Available customer tax exemptions. */ +export type TaxExemption = + /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia. */ + | "CA_BC_COMMERCIAL_FISHERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia. */ + | "CA_BC_CONTRACTOR_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia. */ + | "CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia. */ + | "CA_BC_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia. */ + | "CA_BC_SUB_CONTRACTOR_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada. */ + | "CA_DIPLOMAT_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba. */ + | "CA_MB_COMMERCIAL_FISHERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba. */ + | "CA_MB_FARMER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba. */ + | "CA_MB_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia. */ + | "CA_NS_COMMERCIAL_FISHERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia. */ + | "CA_NS_FARMER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario. */ + | "CA_ON_PURCHASE_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island. */ + | "CA_PE_COMMERCIAL_FISHERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan. */ + | "CA_SK_COMMERCIAL_FISHERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan. */ + | "CA_SK_CONTRACTOR_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan. */ + | "CA_SK_FARMER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan. */ + | "CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan. */ + | "CA_SK_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan. */ + | "CA_SK_SUB_CONTRACTOR_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada. */ + | "CA_STATUS_CARD_EXEMPTION" + /** This customer is exempt from VAT for purchases within the EU that is shipping from outside of customer's country. */ + | "EU_REVERSE_CHARGE_EXEMPTION_RULE" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alaska. */ + | "US_AK_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alabama. */ + | "US_AL_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arkansas. */ + | "US_AR_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arizona. */ + | "US_AZ_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in California. */ + | "US_CA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Colorado. */ + | "US_CO_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Connecticut. */ + | "US_CT_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington DC. */ + | "US_DC_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Delaware. */ + | "US_DE_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Florida. */ + | "US_FL_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Georgia. */ + | "US_GA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Hawaii. */ + | "US_HI_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Iowa. */ + | "US_IA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Idaho. */ + | "US_ID_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Illinois. */ + | "US_IL_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Indiana. */ + | "US_IN_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kansas. */ + | "US_KS_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kentucky. */ + | "US_KY_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Louisiana. */ + | "US_LA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Massachusetts. */ + | "US_MA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maryland. */ + | "US_MD_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maine. */ + | "US_ME_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Michigan. */ + | "US_MI_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Minnesota. */ + | "US_MN_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Missouri. */ + | "US_MO_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Mississippi. */ + | "US_MS_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Montana. */ + | "US_MT_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Carolina. */ + | "US_NC_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Dakota. */ + | "US_ND_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nebraska. */ + | "US_NE_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Hampshire. */ + | "US_NH_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Jersey. */ + | "US_NJ_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Mexico. */ + | "US_NM_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nevada. */ + | "US_NV_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New York. */ + | "US_NY_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Ohio. */ + | "US_OH_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oklahoma. */ + | "US_OK_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oregon. */ + | "US_OR_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Pennsylvania. */ + | "US_PA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Rhode Island. */ + | "US_RI_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Carolina. */ + | "US_SC_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Dakota. */ + | "US_SD_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Tennessee. */ + | "US_TN_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Texas. */ + | "US_TX_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Utah. */ + | "US_UT_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Virginia. */ + | "US_VA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Vermont. */ + | "US_VT_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington. */ + | "US_WA_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wisconsin. */ + | "US_WI_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in West Virginia. */ + | "US_WV_RESELLER_EXEMPTION" + /** This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wyoming. */ + | "US_WY_RESELLER_EXEMPTION"; + +/** Represents a single tax applied to the associated line item. */ +export type TaxLine = { + /** Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line. */ + channelLiable?: Maybe; + /** + * The amount of tax, in shop currency, after discounts and before returns. + * @deprecated Use `priceSet` instead. + */ + price: Scalars["Money"]["output"]; + /** The amount of tax, in shop and presentment currencies, after discounts and before returns. */ + priceSet: MoneyBag; + /** The proportion of the line item price that the tax represents as a decimal. */ + rate?: Maybe; + /** The proportion of the line item price that the tax represents as a percentage. */ + ratePercentage?: Maybe; + /** The name of the tax. */ + title: Scalars["String"]["output"]; +}; + +/** State of the tax app configuration. */ +export type TaxPartnerState = + /** App is configured and to be used for tax calculations. */ + | "ACTIVE" + /** App is not configured. */ + | "PENDING" + /** App is configured, but not used for tax calculations. */ + | "READY"; + +/** + * A TenderTransaction represents a transaction with financial impact on a shop's balance sheet. A tender transaction always + * represents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions + * for reconciling a shop's cash flow. A TenderTransaction is immutable once created. + */ +export type TenderTransaction = Node & { + /** The amount and currency of the tender transaction. */ + amount: MoneyV2; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Information about the payment method used for the transaction. */ + paymentMethod?: Maybe; + /** Date and time when the transaction was processed. */ + processedAt?: Maybe; + /** The remote gateway reference associated with the tender transaction. */ + remoteReference?: Maybe; + /** Whether the transaction is a test transaction. */ + test: Scalars["Boolean"]["output"]; + /** Information about the payment instrument used for the transaction. */ + transactionDetails?: Maybe; + /** The staff member who performed the transaction. */ + user?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple TenderTransactions. + */ +export type TenderTransactionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in TenderTransactionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Information about the credit card used for this transaction. */ +export type TenderTransactionCreditCardDetails = { + /** The name of the company that issued the customer's credit card. Example: `Visa`. */ + creditCardCompany?: Maybe; + /** The customer's credit card number, with all digits except the last 4 redacted. Example: `•••• •••• •••• 1234` */ + creditCardNumber?: Maybe; +}; + +/** Information about the payment instrument used for this transaction. */ +export type TenderTransactionDetails = TenderTransactionCreditCardDetails; + +/** + * An auto-generated type which holds one TenderTransaction and a cursor during pagination. + */ +export type TenderTransactionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of TenderTransactionEdge. */ + node: TenderTransaction; +}; + +/** A sale associated with a tip. */ +export type TipSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line item for the associated sale. */ + lineItem: LineItem; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** Transaction fee related to an order transaction. */ +export type TransactionFee = Node & { + /** Amount of the fee. */ + amount: MoneyV2; + /** Flat rate charge for a transaction. */ + flatFee: MoneyV2; + /** Name of the credit card flat fee. */ + flatFeeName?: Maybe; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Percentage charge. */ + rate: Scalars["Decimal"]["output"]; + /** Name of the credit card rate. */ + rateName?: Maybe; + /** Tax amount charged on the fee. */ + taxAmount: MoneyV2; + /** Name of the type of fee. */ + type: Scalars["String"]["output"]; +}; + +/** Translatable content of a resource's field. */ +export type TranslatableContent = { + /** Hash digest representation of the content value. */ + digest?: Maybe; + /** The resource field that's being translated. */ + key: Scalars["String"]["output"]; + /** Locale of the content. */ + locale: Scalars["String"]["output"]; + /** Type of the translatable content. */ + type: LocalizableContentType; + /** Content value. */ + value?: Maybe; +}; + +/** A resource that has translatable fields. */ +export type TranslatableResource = { + /** GID of the resource. */ + resourceId: Scalars["ID"]["output"]; + /** Translatable content. */ + translatableContent: Array; + /** Translatable content translations. */ + translations: Array; +}; + +/** A resource that has translatable fields. */ +export type TranslatableResourceTranslationsArgs = { + locale: Scalars["String"]["input"]; + marketId?: InputMaybe; + outdated?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple TranslatableResources. + */ +export type TranslatableResourceConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in TranslatableResourceEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one TranslatableResource and a cursor during pagination. + */ +export type TranslatableResourceEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of TranslatableResourceEdge. */ + node: TranslatableResource; +}; + +/** Specifies the type of resources that are translatable. */ +export type TranslatableResourceType = + /** A product collection. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`. */ + | "COLLECTION" + /** + * The delivery method definition. For example, "Standard", or "Expedited". + * Translatable fields: `name`. + */ + | "DELIVERY_METHOD_DEFINITION" + /** An email template. Translatable fields: `title`, `body_html`. */ + | "EMAIL_TEMPLATE" + /** A filter. Translatable fields: `label`. */ + | "FILTER" + /** A link to direct users. Translatable fields: `title`. */ + | "LINK" + /** A Metafield. Translatable fields: `value`. */ + | "METAFIELD" + /** A Metaobject. Translatable fields are determined by the Metaobject type. */ + | "METAOBJECT" + /** An online store article. Translatable fields: `title`, `body_html`, `summary_html`, `handle`, `meta_title`, `meta_description`. */ + | "ONLINE_STORE_ARTICLE" + /** An online store blog. Translatable fields: `title`, `handle`, `meta_title`, `meta_description`. */ + | "ONLINE_STORE_BLOG" + /** A category of links. Translatable fields: `title`. */ + | "ONLINE_STORE_MENU" + /** An online store page. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`. */ + | "ONLINE_STORE_PAGE" + /** An online store theme. Translatable fields: `dynamic keys based on theme data`. */ + | "ONLINE_STORE_THEME" + /** A packing slip template. Translatable fields: `body`. */ + | "PACKING_SLIP_TEMPLATE" + /** A payment gateway. Translatable fields: `name`. */ + | "PAYMENT_GATEWAY" + /** An online store product. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`. */ + | "PRODUCT" + /** + * An online store custom product property name. For example, "Size", "Color", or "Material". + * Translatable fields: `name`. + */ + | "PRODUCT_OPTION" + /** An online store product variant. Translatable fields: `title`, `option1`, `option2`, `option3`. The field `title` has been deprecated. */ + | "PRODUCT_VARIANT" + /** A selling plan. Translatable fields:`name`, `option1`, `option2`, `option3`, `description`. */ + | "SELLING_PLAN" + /** A selling plan group. Translatable fields: `name`, `option1`, `option2`, `option3`. */ + | "SELLING_PLAN_GROUP" + /** A shop. Translatable fields: `meta_title`, `meta_description`. */ + | "SHOP" + /** A shop policy. Translatable fields: `body`. */ + | "SHOP_POLICY"; + +/** Translation of a field of a resource. */ +export type Translation = { + /** On the resource that this translation belongs to, the reference to the value being translated. */ + key: Scalars["String"]["output"]; + /** ISO code of the translation locale. */ + locale: Scalars["String"]["output"]; + /** The market that the translation is specific to. Null value means the translation is available in all markets. */ + market?: Maybe; + /** Whether the original content has changed since this translation was updated. */ + outdated: Scalars["Boolean"]["output"]; + /** The date and time when the translation was updated. */ + updatedAt?: Maybe; + /** Translation value. */ + value?: Maybe; +}; + +/** Possible error codes that can be returned by `TranslationUserError`. */ +export type TranslationErrorCode = + /** The input value is blank. */ + | "BLANK" + /** Translation value is invalid. */ + | "FAILS_RESOURCE_VALIDATION" + /** The input value is invalid. */ + | "INVALID" + /** Locale language code is invalid. */ + | "INVALID_CODE" + /** Locale code format is invalid. */ + | "INVALID_FORMAT" + /** Translation key is invalid. */ + | "INVALID_KEY_FOR_MODEL" + /** The locale is missing on the market corresponding to the `marketId` argument. */ + | "INVALID_LOCALE_FOR_MARKET" + /** Locale is invalid for the shop. */ + | "INVALID_LOCALE_FOR_SHOP" + /** Market localizable content is invalid. */ + | "INVALID_MARKET_LOCALIZABLE_CONTENT" + /** Translatable content is invalid. */ + | "INVALID_TRANSLATABLE_CONTENT" + /** The handle is already taken for this resource. */ + | "INVALID_VALUE_FOR_HANDLE_TRANSLATION" + /** The shop isn't allowed to operate on market custom content. */ + | "MARKET_CUSTOM_CONTENT_NOT_ALLOWED" + /** The market corresponding to the `marketId` argument doesn't exist. */ + | "MARKET_DOES_NOT_EXIST" + /** The market override locale creation failed. */ + | "MARKET_LOCALE_CREATION_FAILED" + /** Resource does not exist. */ + | "RESOURCE_NOT_FOUND" + /** The specified resource can't be customized for a market. */ + | "RESOURCE_NOT_MARKET_CUSTOMIZABLE" + /** Resource is not translatable. */ + | "RESOURCE_NOT_TRANSLATABLE" + /** Too many translation keys for the resource. */ + | "TOO_MANY_KEYS_FOR_RESOURCE"; + +/** The input fields and values for creating or updating a translation. */ +export type TranslationInput = { + /** On the resource that this translation belongs to, the reference to the value being translated. */ + key: Scalars["String"]["input"]; + /** ISO code of the locale being translated into. Only locales returned in `shopLocales` are valid. */ + locale: Scalars["String"]["input"]; + /** The ID of the market that the translation is specific to. Not specifying this field means that the translation will be available in all markets. */ + marketId?: InputMaybe; + /** Hash digest representation of the content being translated. */ + translatableContentDigest: Scalars["String"]["input"]; + /** The value of the translation. */ + value: Scalars["String"]["input"]; +}; + +/** Represents an error that happens during the execution of a translation mutation. */ +export type TranslationUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Return type for `translationsRegister` mutation. */ +export type TranslationsRegisterPayload = { + /** The translations that were created or updated. */ + translations?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `translationsRemove` mutation. */ +export type TranslationsRemovePayload = { + /** The translations that were deleted. */ + translations?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents a typed custom attribute. */ +export type TypedAttribute = { + /** Key or name of the attribute. */ + key: Scalars["String"]["output"]; + /** Value of the attribute. */ + value: Scalars["String"]["output"]; +}; + +/** + * Specifies the + * [Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters) + * that are associated with a related marketing campaign. + */ +export type UtmInput = { + /** The name of the UTM campaign. */ + campaign: Scalars["String"]["input"]; + /** The UTM campaign medium. */ + medium: Scalars["String"]["input"]; + /** The name of the website or application where the referral link exists. */ + source: Scalars["String"]["input"]; +}; + +/** Represents a set of UTM parameters. */ +export type UtmParameters = { + /** The name of a marketing campaign. */ + campaign?: Maybe; + /** Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective. */ + content?: Maybe; + /** The medium of a marketing campaign, such as a banner or email newsletter. */ + medium?: Maybe; + /** The source of traffic to the merchant's store, such as Google or an email newsletter. */ + source?: Maybe; + /** Paid search terms used by a marketing campaign. */ + term?: Maybe; +}; + +/** Systems of weights and measures. */ +export type UnitSystem = + /** Imperial system of weights and measures. */ + | "IMPERIAL_SYSTEM" + /** Metric system of weights and measures. */ + | "METRIC_SYSTEM"; + +/** This is represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale. */ +export type UnknownSale = Sale & { + /** The type of order action that the sale represents. */ + actionType: SaleActionType; + /** The unique ID for the sale. */ + id: Scalars["ID"]["output"]; + /** The line type assocated with the sale. */ + lineType: SaleLineType; + /** The number of units either ordered or intended to be returned. */ + quantity?: Maybe; + /** All individual taxes associated with the sale. */ + taxes: Array; + /** The total sale amount after taxes and discounts. */ + totalAmount: MoneyBag; + /** The total discounts allocated to the sale after taxes. */ + totalDiscountAmountAfterTaxes: MoneyBag; + /** The total discounts allocated to the sale before taxes. */ + totalDiscountAmountBeforeTaxes: MoneyBag; + /** The total amount of taxes for the sale. */ + totalTaxAmount: MoneyBag; +}; + +/** The input fields required to update a media object. */ +export type UpdateMediaInput = { + /** The alt text associated to the media. */ + alt?: InputMaybe; + /** Specifies the media to update. */ + id: Scalars["ID"]["input"]; + /** The source from which to update the media preview image. May be an external URL or staged upload URL. */ + previewImageSource?: InputMaybe; +}; + +/** The URL redirect for the online store. */ +export type UrlRedirect = Node & { + /** The ID of the URL redirect. */ + id: Scalars["ID"]["output"]; + /** The old path to be redirected from. When the user visits this path, they will be redirected to the target location. */ + path: Scalars["String"]["output"]; + /** The target location where the user will be redirected to. */ + target: Scalars["String"]["output"]; +}; + +/** Return type for `urlRedirectBulkDeleteAll` mutation. */ +export type UrlRedirectBulkDeleteAllPayload = { + /** The asynchronous job removing the redirects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `urlRedirectBulkDeleteByIds` mutation. */ +export type UrlRedirectBulkDeleteByIdsPayload = { + /** The asynchronous job removing the redirects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `UrlRedirectBulkDeleteByIds`. */ +export type UrlRedirectBulkDeleteByIdsUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `UrlRedirectBulkDeleteByIdsUserError`. */ +export type UrlRedirectBulkDeleteByIdsUserErrorCode = /** + * You must pass one or more [`URLRedirect`]( + * https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect + * ) object IDs. + */ + "IDS_EMPTY"; + +/** Return type for `urlRedirectBulkDeleteBySavedSearch` mutation. */ +export type UrlRedirectBulkDeleteBySavedSearchPayload = { + /** The asynchronous job removing the redirects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `UrlRedirectBulkDeleteBySavedSearch`. */ +export type UrlRedirectBulkDeleteBySavedSearchUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `UrlRedirectBulkDeleteBySavedSearchUserError`. */ +export type UrlRedirectBulkDeleteBySavedSearchUserErrorCode = + /** The saved search's query cannot match all entries or be empty. */ + | "INVALID_SAVED_SEARCH_QUERY" + /** Saved search not found. */ + | "SAVED_SEARCH_NOT_FOUND"; + +/** Return type for `urlRedirectBulkDeleteBySearch` mutation. */ +export type UrlRedirectBulkDeleteBySearchPayload = { + /** The asynchronous job removing the redirects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** An error that occurs during the execution of `UrlRedirectBulkDeleteBySearch`. */ +export type UrlRedirectBulkDeleteBySearchUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Possible error codes that can be returned by `UrlRedirectBulkDeleteBySearchUserError`. */ +export type UrlRedirectBulkDeleteBySearchUserErrorCode = + /** Invalid search string. */ + "INVALID_SEARCH_ARGUMENT"; + +/** + * An auto-generated type for paginating through multiple UrlRedirects. + */ +export type UrlRedirectConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in UrlRedirectEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `urlRedirectCreate` mutation. */ +export type UrlRedirectCreatePayload = { + /** The created redirect. */ + urlRedirect?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `urlRedirectDelete` mutation. */ +export type UrlRedirectDeletePayload = { + /** The ID of the deleted redirect. */ + deletedUrlRedirectId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one UrlRedirect and a cursor during pagination. + */ +export type UrlRedirectEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of UrlRedirectEdge. */ + node: UrlRedirect; +}; + +/** Possible error codes that can be returned by `UrlRedirectUserError`. */ +export type UrlRedirectErrorCode = + /** Redirect could not be created. */ + | "CREATE_FAILED" + /** Redirect could not be deleted. */ + | "DELETE_FAILED" + /** Redirect does not exist. */ + | "DOES_NOT_EXIST" + /** Redirect could not be updated. */ + | "UPDATE_FAILED"; + +/** + * A request to import a [`URLRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object + * into the Online Store channel. Apps can use this to query the state of an `UrlRedirectImport` request. + * + * For more information, see [`url-redirect`](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect)s. + */ +export type UrlRedirectImport = Node & { + /** The number of rows in the file. */ + count?: Maybe; + /** The number of redirects created from the import. */ + createdCount?: Maybe; + /** The number of redirects that failed to be imported. */ + failedCount?: Maybe; + /** Whether the import is finished. */ + finished: Scalars["Boolean"]["output"]; + /** The date and time when the import finished. */ + finishedAt?: Maybe; + /** The ID of the `UrlRedirectImport` object. */ + id: Scalars["ID"]["output"]; + /** A list of up to three previews of the URL redirects to be imported. */ + previewRedirects: Array; + /** The number of redirects updated during the import. */ + updatedCount?: Maybe; +}; + +/** Return type for `urlRedirectImportCreate` mutation. */ +export type UrlRedirectImportCreatePayload = { + /** The created `URLRedirectImport` object. */ + urlRedirectImport?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `UrlRedirectImportUserError`. */ +export type UrlRedirectImportErrorCode = + /** The import has already completed. */ + | "ALREADY_IMPORTED" + /** CSV file does not exist at given URL. */ + | "FILE_DOES_NOT_EXIST" + /** The import is already in progress. */ + | "IN_PROGRESS" + /** URL redirect import not found. */ + | "NOT_FOUND"; + +/** A preview of a URL redirect import row. */ +export type UrlRedirectImportPreview = { + /** The old path to be redirected from. When the user visits this path, they will be redirected to the target location. */ + path: Scalars["String"]["output"]; + /** The target location where the user will be redirected to. */ + target: Scalars["String"]["output"]; +}; + +/** Return type for `urlRedirectImportSubmit` mutation. */ +export type UrlRedirectImportSubmitPayload = { + /** The asynchronous job importing the redirects. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents an error that happens during execution of a redirect import mutation. */ +export type UrlRedirectImportUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** The input fields to create or update a URL redirect. */ +export type UrlRedirectInput = { + /** The old path to be redirected from. When the user visits this path, they will be redirected to the target location. */ + path?: InputMaybe; + /** The target location where the user will be redirected to. */ + target?: InputMaybe; +}; + +/** The set of valid sort keys for the UrlRedirect query. */ +export type UrlRedirectSortKeys = + /** Sort by the `id` value. */ + | "ID" + /** Sort by the `path` value. */ + | "PATH" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** Return type for `urlRedirectUpdate` mutation. */ +export type UrlRedirectUpdatePayload = { + /** Returns the updated URL redirect. */ + urlRedirect?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Represents an error that happens during execution of a redirect mutation. */ +export type UrlRedirectUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Represents an error in the input of a mutation. */ +export type UserError = DisplayableError & { + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars["String"]["output"]; +}; + +/** Represents a credit card payment instrument. */ +export type VaultCreditCard = { + /** The billing address of the card. */ + billingAddress?: Maybe; + /** The brand for the card. */ + brand: Scalars["String"]["output"]; + /** Whether the card has been expired. */ + expired: Scalars["Boolean"]["output"]; + /** The expiry month of the card. */ + expiryMonth: Scalars["Int"]["output"]; + /** The expiry year of the card. */ + expiryYear: Scalars["Int"]["output"]; + /** The last four digits for the card. */ + lastDigits: Scalars["String"]["output"]; + /** The name of the card holder. */ + name: Scalars["String"]["output"]; +}; + +/** Represents a paypal billing agreement payment instrument. */ +export type VaultPaypalBillingAgreement = { + /** Whether the paypal billing agreement is inactive. */ + inactive: Scalars["Boolean"]["output"]; + /** The paypal account name. */ + name: Scalars["String"]["output"]; + /** The paypal account email address. */ + paypalAccountEmail: Scalars["String"]["output"]; +}; + +/** + * Representation of 3d vectors and points. It can represent + * either the coordinates of a point in space, a direction, or + * size. Presented as an object with three floating-point values. + */ +export type Vector3 = { + /** The x coordinate of Vector3. */ + x: Scalars["Float"]["output"]; + /** The y coordinate of Vector3. */ + y: Scalars["Float"]["output"]; + /** The z coordinate of Vector3. */ + z: Scalars["Float"]["output"]; +}; + +/** + * Represents a Shopify hosted video. + */ +export type Video = File & Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** + * The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created. + */ + createdAt: Scalars["DateTime"]["output"]; + /** + * The video's duration in milliseconds. This value is `null` unless the video's status field is + * [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). + */ + duration?: Maybe; + /** Any errors that have occurred on the file. */ + fileErrors: Array; + /** The status of the file. */ + fileStatus: FileStatus; + /** The video's filename. */ + filename: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The media content type. */ + mediaContentType: MediaContentType; + /** Any errors which have occurred on the media. */ + mediaErrors: Array; + /** The warnings attached to the media. */ + mediaWarnings: Array; + /** + * The video's original source. This value is `null` unless the video's status field is + * [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). + */ + originalSource?: Maybe; + /** The preview image for the media. */ + preview?: Maybe; + /** + * The video's sources. This value is empty unless the video's status field is + * [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready). + */ + sources: Array; + /** Current status of the media. */ + status: MediaStatus; + /** The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * Represents a source for a Shopify hosted video. + * + * Types of sources include the original video, lower resolution versions of the original video, + * and an m3u8 playlist file. + * + * Only [videos](https://shopify.dev/api/admin-graphql/latest/objects/video) with a status field + * of [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready) have sources. + */ +export type VideoSource = { + /** The video source's file size in bytes. */ + fileSize?: Maybe; + /** The video source's file format extension. */ + format: Scalars["String"]["output"]; + /** The video source's height. */ + height: Scalars["Int"]["output"]; + /** The video source's MIME type. */ + mimeType: Scalars["String"]["output"]; + /** The video source's URL. */ + url: Scalars["String"]["output"]; + /** The video source's width. */ + width: Scalars["Int"]["output"]; +}; + +/** A type of visualization. */ +export type VisualizationType = + /** Bar Chart. */ + | "BAR" + /** Line Chart. */ + | "LINE"; + +/** A web pixel settings. */ +export type WebPixel = Node & { + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The settings JSON object for the web pixel. */ + settings: Scalars["JSON"]["output"]; +}; + +/** Return type for `webPixelCreate` mutation. */ +export type WebPixelCreatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The created web pixel settings. */ + webPixel?: Maybe; +}; + +/** Return type for `webPixelDelete` mutation. */ +export type WebPixelDeletePayload = { + /** The ID of the web pixel settings that was deleted. */ + deletedWebPixelId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to use to update a web pixel. */ +export type WebPixelInput = { + /** The web pixel settings in JSON format. */ + settings: Scalars["JSON"]["input"]; +}; + +/** Return type for `webPixelUpdate` mutation. */ +export type WebPixelUpdatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The updated web pixel settings. */ + webPixel?: Maybe; +}; + +/** An Amazon EventBridge partner event source to which webhook subscriptions publish events. */ +export type WebhookEventBridgeEndpoint = { + /** The ARN of this EventBridge partner event source. */ + arn: Scalars["ARN"]["output"]; +}; + +/** An HTTPS endpoint to which webhook subscriptions send POST requests. */ +export type WebhookHttpEndpoint = { + /** The URL to which the webhooks events are sent. */ + callbackUrl: Scalars["URL"]["output"]; +}; + +/** A Google Cloud Pub/Sub topic to which webhook subscriptions publish events. */ +export type WebhookPubSubEndpoint = { + /** The Google Cloud Pub/Sub project ID. */ + pubSubProject: Scalars["String"]["output"]; + /** The Google Cloud Pub/Sub topic ID. */ + pubSubTopic: Scalars["String"]["output"]; +}; + +/** + * A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API. + * It describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic. + * When an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination. + * Learn more about the [webhooks system](https://shopify.dev/apps/webhooks). + */ +export type WebhookSubscription = LegacyInteroperability & Node & { + /** The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription. */ + apiVersion: ApiVersion; + /** + * The destination URI to which the webhook subscription will send a message when an event occurs. + * @deprecated Use `endpoint` instead. + */ + callbackUrl: Scalars["URL"]["output"]; + /** The date and time when the webhook subscription was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** The endpoint to which the webhook subscription will send events. */ + endpoint: WebhookSubscriptionEndpoint; + /** The format in which the webhook subscription should send the data. */ + format: WebhookSubscriptionFormat; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** An optional array of top-level resource fields that should be serialized and sent in the webhook message. If null, then all fields will be sent. */ + includeFields: Array; + /** The ID of the corresponding resource in the REST Admin API. */ + legacyResourceId: Scalars["UnsignedInt64"]["output"]; + /** The list of namespaces for any metafields that should be included in the webhook subscription. */ + metafieldNamespaces: Array; + /** + * The list of namespaces for private metafields that should be included in the webhook subscription. + * @deprecated Metafields created using a reserved namespace are private by default. See our guide for + * [migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields). + */ + privateMetafieldNamespaces: Array; + /** The type of event that triggers the webhook. The topic determines when the webhook subscription sends a webhook, as well as what class of data object that webhook contains. */ + topic: WebhookSubscriptionTopic; + /** The date and time when the webhook subscription was updated. */ + updatedAt: Scalars["DateTime"]["output"]; +}; + +/** + * An auto-generated type for paginating through multiple WebhookSubscriptions. + */ +export type WebhookSubscriptionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in WebhookSubscriptionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** Return type for `webhookSubscriptionCreate` mutation. */ +export type WebhookSubscriptionCreatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was created. */ + webhookSubscription?: Maybe; +}; + +/** Return type for `webhookSubscriptionDelete` mutation. */ +export type WebhookSubscriptionDeletePayload = { + /** The ID of the deleted webhook subscription. */ + deletedWebhookSubscriptionId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * An auto-generated type which holds one WebhookSubscription and a cursor during pagination. + */ +export type WebhookSubscriptionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars["String"]["output"]; + /** The item at the end of WebhookSubscriptionEdge. */ + node: WebhookSubscription; +}; + +/** An endpoint to which webhook subscriptions send webhooks events. */ +export type WebhookSubscriptionEndpoint = + | WebhookEventBridgeEndpoint + | WebhookHttpEndpoint + | WebhookPubSubEndpoint; + +/** The supported formats for webhook subscriptions. */ +export type WebhookSubscriptionFormat = + | "JSON" + | "XML"; + +/** + * The input fields for a webhook subscription. + */ +export type WebhookSubscriptionInput = { + /** URL where the webhook subscription should send the POST request when the event occurs. */ + callbackUrl?: InputMaybe; + /** The format in which the webhook subscription should send the data. */ + format?: InputMaybe; + /** The list of fields to be included in the webhook subscription. */ + includeFields?: InputMaybe>; + /** The list of namespaces for any metafields that should be included in the webhook subscription. */ + metafieldNamespaces?: InputMaybe>; +}; + +/** The set of valid sort keys for the WebhookSubscription query. */ +export type WebhookSubscriptionSortKeys = + /** Sort by the `created_at` value. */ + | "CREATED_AT" + /** Sort by the `id` value. */ + | "ID" + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + */ + | "RELEVANCE"; + +/** + * The supported topics for webhook subscriptions. You can use webhook subscriptions to receive + * notifications about particular events in a shop. + * + * You don't create webhook subscriptions to + * [mandatory webhooks](https://shopify.dev/apps/webhooks/configuration/mandatory-webhooks). + * Instead, you configure mandatory webhooks in your Partner Dashboard as part of your app setup. + */ +export type WebhookSubscriptionTopic = + /** The webhook topic for `app_purchases_one_time/update` events. Occurs whenever a one-time app charge is updated. */ + | "APP_PURCHASES_ONE_TIME_UPDATE" + /** The webhook topic for `app_subscriptions/approaching_capped_amount` events. Occurs when the balance used on an app subscription crosses 90% of the capped amount. */ + | "APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT" + /** The webhook topic for `app_subscriptions/update` events. Occurs whenever an app subscription is updated. */ + | "APP_SUBSCRIPTIONS_UPDATE" + /** The webhook topic for `app/uninstalled` events. Occurs whenever a shop has uninstalled the app. */ + | "APP_UNINSTALLED" + /** The webhook topic for `attributed_sessions/first` events. Occurs whenever an order with a "first" attributed session is attributed. Requires the `read_marketing_events` scope. */ + | "ATTRIBUTED_SESSIONS_FIRST" + /** The webhook topic for `attributed_sessions/last` events. Occurs whenever an order with a "last" attributed session is attributed. Requires the `read_marketing_events` scope. */ + | "ATTRIBUTED_SESSIONS_LAST" + /** The webhook topic for `audit_events/admin_api_activity` events. Triggers for each auditable Admin API request. This topic is limited to one active subscription per Plus store and requires the use of Google Cloud Pub/Sub or AWS EventBridge. Requires the `read_audit_events` scope. */ + | "AUDIT_EVENTS_ADMIN_API_ACTIVITY" + /** The webhook topic for `bulk_operations/finish` events. Notifies when a Bulk Operation finishes. */ + | "BULK_OPERATIONS_FINISH" + /** The webhook topic for `carts/create` events. Occurs when a cart is created in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are created in a custom storefront. Requires the `read_orders` scope. */ + | "CARTS_CREATE" + /** The webhook topic for `carts/update` events. Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront. Requires the `read_orders` scope. */ + | "CARTS_UPDATE" + /** The webhook topic for `channels/delete` events. Occurs whenever a channel is deleted. Requires the `read_publications` scope. */ + | "CHANNELS_DELETE" + /** The webhook topic for `checkouts/create` events. Occurs whenever a checkout is created. Requires the `read_orders` scope. */ + | "CHECKOUTS_CREATE" + /** The webhook topic for `checkouts/delete` events. Occurs whenever a checkout is deleted. Requires the `read_orders` scope. */ + | "CHECKOUTS_DELETE" + /** The webhook topic for `checkouts/update` events. Occurs whenever a checkout is updated. Requires the `read_orders` scope. */ + | "CHECKOUTS_UPDATE" + /** The webhook topic for `collections/create` events. Occurs whenever a collection is created. Requires the `read_products` scope. */ + | "COLLECTIONS_CREATE" + /** The webhook topic for `collections/delete` events. Occurs whenever a collection is deleted. Requires the `read_products` scope. */ + | "COLLECTIONS_DELETE" + /** The webhook topic for `collections/update` events. Occurs whenever a collection is updated, including whenever products are added or removed from the collection. Occurs once if multiple products are added or removed from a collection at the same time. Requires the `read_products` scope. */ + | "COLLECTIONS_UPDATE" + /** The webhook topic for `collection_listings/add` events. Occurs whenever a collection listing is added. Requires the `read_product_listings` scope. */ + | "COLLECTION_LISTINGS_ADD" + /** The webhook topic for `collection_listings/remove` events. Occurs whenever a collection listing is removed. Requires the `read_product_listings` scope. */ + | "COLLECTION_LISTINGS_REMOVE" + /** The webhook topic for `collection_listings/update` events. Occurs whenever a collection listing is updated. Requires the `read_product_listings` scope. */ + | "COLLECTION_LISTINGS_UPDATE" + /** The webhook topic for `collection_publications/create` events. Occurs whenever a collection publication listing is created. Requires the `read_publications` scope. */ + | "COLLECTION_PUBLICATIONS_CREATE" + /** The webhook topic for `collection_publications/delete` events. Occurs whenever a collection publication listing is deleted. Requires the `read_publications` scope. */ + | "COLLECTION_PUBLICATIONS_DELETE" + /** The webhook topic for `collection_publications/update` events. Occurs whenever a collection publication listing is updated. Requires the `read_publications` scope. */ + | "COLLECTION_PUBLICATIONS_UPDATE" + /** The webhook topic for `companies/create` events. Occurs whenever a company is created. Requires the `read_customers` scope. */ + | "COMPANIES_CREATE" + /** The webhook topic for `companies/delete` events. Occurs whenever a company is deleted. Requires the `read_customers` scope. */ + | "COMPANIES_DELETE" + /** The webhook topic for `companies/update` events. Occurs whenever a company is updated. Requires the `read_customers` scope. */ + | "COMPANIES_UPDATE" + /** The webhook topic for `company_contacts/create` events. Occurs whenever a company contact is created. Requires the `read_customers` scope. */ + | "COMPANY_CONTACTS_CREATE" + /** The webhook topic for `company_contacts/delete` events. Occurs whenever a company contact is deleted. Requires the `read_customers` scope. */ + | "COMPANY_CONTACTS_DELETE" + /** The webhook topic for `company_contacts/update` events. Occurs whenever a company contact is updated. Requires the `read_customers` scope. */ + | "COMPANY_CONTACTS_UPDATE" + /** The webhook topic for `company_contact_roles/assign` events. Occurs whenever a role is assigned to a contact at a location. Requires the `read_customers` scope. */ + | "COMPANY_CONTACT_ROLES_ASSIGN" + /** The webhook topic for `company_contact_roles/revoke` events. Occurs whenever a role is revoked from a contact at a location. Requires the `read_customers` scope. */ + | "COMPANY_CONTACT_ROLES_REVOKE" + /** The webhook topic for `company_locations/create` events. Occurs whenever a company location is created. Requires the `read_customers` scope. */ + | "COMPANY_LOCATIONS_CREATE" + /** The webhook topic for `company_locations/delete` events. Occurs whenever a company location is deleted. Requires the `read_customers` scope. */ + | "COMPANY_LOCATIONS_DELETE" + /** The webhook topic for `company_locations/update` events. Occurs whenever a company location is updated. Requires the `read_customers` scope. */ + | "COMPANY_LOCATIONS_UPDATE" + /** The webhook topic for `customers/create` events. Occurs whenever a customer is created. Requires the `read_customers` scope. */ + | "CUSTOMERS_CREATE" + /** The webhook topic for `customers/delete` events. Occurs whenever a customer is deleted. Requires the `read_customers` scope. */ + | "CUSTOMERS_DELETE" + /** The webhook topic for `customers/disable` events. Occurs whenever a customer account is disabled. Requires the `read_customers` scope. */ + | "CUSTOMERS_DISABLE" + /** The webhook topic for `customers_email_marketing_consent/update` events. Occurs whenever a customer's email marketing consent is updated. Requires the `read_customers` scope. */ + | "CUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE" + /** The webhook topic for `customers/enable` events. Occurs whenever a customer account is enabled. Requires the `read_customers` scope. */ + | "CUSTOMERS_ENABLE" + /** The webhook topic for `customers_marketing_consent/update` events. Occurs whenever a customer's SMS marketing consent is updated. Requires the `read_customers` scope. */ + | "CUSTOMERS_MARKETING_CONSENT_UPDATE" + /** The webhook topic for `customers/merge` events. Triggers when two customers are merged Requires the `read_customer_merge` scope. */ + | "CUSTOMERS_MERGE" + /** The webhook topic for `customers/update` events. Occurs whenever a customer is updated. Requires the `read_customers` scope. */ + | "CUSTOMERS_UPDATE" + /** The webhook topic for `customer_groups/create` events. Occurs whenever a customer saved search is created. Requires the `read_customers` scope. */ + | "CUSTOMER_GROUPS_CREATE" + /** The webhook topic for `customer_groups/delete` events. Occurs whenever a customer saved search is deleted. Requires the `read_customers` scope. */ + | "CUSTOMER_GROUPS_DELETE" + /** The webhook topic for `customer_groups/update` events. Occurs whenever a customer saved search is updated. Requires the `read_customers` scope. */ + | "CUSTOMER_GROUPS_UPDATE" + /** The webhook topic for `customer_payment_methods/create` events. Occurs whenever a customer payment method is created. Requires the `read_customer_payment_methods` scope. */ + | "CUSTOMER_PAYMENT_METHODS_CREATE" + /** The webhook topic for `customer_payment_methods/revoke` events. Occurs whenever a customer payment method is revoked. Requires the `read_customer_payment_methods` scope. */ + | "CUSTOMER_PAYMENT_METHODS_REVOKE" + /** The webhook topic for `customer_payment_methods/update` events. Occurs whenever a customer payment method is updated. Requires the `read_customer_payment_methods` scope. */ + | "CUSTOMER_PAYMENT_METHODS_UPDATE" + /** The webhook topic for `customer.tags_added` events. Triggers when tags are added to a customer. Requires the `read_customers` scope. */ + | "CUSTOMER_TAGS_ADDED" + /** The webhook topic for `customer.tags_removed` events. Triggers when tags are removed from a customer. Requires the `read_customers` scope. */ + | "CUSTOMER_TAGS_REMOVED" + /** The webhook topic for `disputes/create` events. Occurs whenever a dispute is created. Requires the `read_shopify_payments_disputes` scope. */ + | "DISPUTES_CREATE" + /** The webhook topic for `disputes/update` events. Occurs whenever a dispute is updated. Requires the `read_shopify_payments_disputes` scope. */ + | "DISPUTES_UPDATE" + /** The webhook topic for `domains/create` events. Occurs whenever a domain is created. */ + | "DOMAINS_CREATE" + /** The webhook topic for `domains/destroy` events. Occurs whenever a domain is destroyed. */ + | "DOMAINS_DESTROY" + /** The webhook topic for `domains/update` events. Occurs whenever a domain is updated. */ + | "DOMAINS_UPDATE" + /** The webhook topic for `draft_orders/create` events. Occurs whenever a draft order is created. Requires the `read_draft_orders` scope. */ + | "DRAFT_ORDERS_CREATE" + /** The webhook topic for `draft_orders/delete` events. Occurs whenever a draft order is deleted. Requires the `read_draft_orders` scope. */ + | "DRAFT_ORDERS_DELETE" + /** The webhook topic for `draft_orders/update` events. Occurs whenever a draft order is updated. Requires the `read_draft_orders` scope. */ + | "DRAFT_ORDERS_UPDATE" + /** The webhook topic for `fulfillments/create` events. Occurs whenever a fulfillment is created. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders. */ + | "FULFILLMENTS_CREATE" + /** The webhook topic for `fulfillments/update` events. Occurs whenever a fulfillment is updated. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders. */ + | "FULFILLMENTS_UPDATE" + /** The webhook topic for `fulfillment_events/create` events. Occurs whenever a fulfillment event is created. Requires the `read_fulfillments` scope. */ + | "FULFILLMENT_EVENTS_CREATE" + /** The webhook topic for `fulfillment_events/delete` events. Occurs whenever a fulfillment event is deleted. Requires the `read_fulfillments` scope. */ + | "FULFILLMENT_EVENTS_DELETE" + /** The webhook topic for `fulfillment_orders/cancellation_request_accepted` events. Occurs when a 3PL accepts a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_ACCEPTED" + /** The webhook topic for `fulfillment_orders/cancellation_request_rejected` events. Occurs when a 3PL rejects a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED" + /** The webhook topic for `fulfillment_orders/cancellation_request_submitted` events. Occurs when a merchant requests a fulfillment request to be cancelled after that request was approved by a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_SUBMITTED" + /** The webhook topic for `fulfillment_orders/cancelled` events. Occurs when a fulfillment order is cancelled. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_CANCELLED" + /** The webhook topic for `fulfillment_orders/fulfillment_request_accepted` events. Occurs when a fulfillment service accepts a request to fulfill a fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTED" + /** The webhook topic for `fulfillment_orders/fulfillment_request_rejected` events. Occurs when a 3PL rejects a fulfillment request that was sent by a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED" + /** The webhook topic for `fulfillment_orders/fulfillment_request_submitted` events. Occurs when a merchant submits a fulfillment request to a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders. */ + | "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED" + /** The webhook topic for `fulfillment_orders/fulfillment_service_failed_to_complete` events. Occurs when a fulfillment service intends to close an in_progress fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_FULFILLMENT_SERVICE_FAILED_TO_COMPLETE" + /** The webhook topic for `fulfillment_orders/hold_released` events. Occurs whenever a fulfillment order hold is released. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_HOLD_RELEASED" + /** The webhook topic for `fulfillment_orders/line_items_prepared_for_local_delivery` events. Occurs whenever a fulfillment order's line items are prepared for local delivery. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_LOCAL_DELIVERY" + /** The webhook topic for `fulfillment_orders/line_items_prepared_for_pickup` events. Triggers when one or more of the line items for a fulfillment order are prepared for pickup Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_PICKUP" + /** + * The webhook topic for `fulfillment_orders/moved` events. Occurs whenever the location which is assigned to fulfill one or more fulfillment order line items is changed. + * + * * `original_fulfillment_order` - The final state of the original fulfillment order. + * * `moved_fulfillment_order` - The fulfillment order which now contains the re-assigned line items. + * * `source_location` - The original location which was assigned to fulfill the line items (available as of the `2023-04` API version). + * * `destination_location_id` - The ID of the location which is now responsible for fulfilling the line items. + * + * **Note:** The [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation) + * of the `original_fulfillment_order` might be changed by the move operation. + * If you need to determine the originally assigned location, then you should refer to the `source_location`. + * + * [Learn more about moving line items](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentOrderMove). + * Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. + */ + | "FULFILLMENT_ORDERS_MOVED" + /** The webhook topic for `fulfillment_orders/order_routing_complete` events. Occurs when an order has finished being routed and it's fulfillment orders assigned to a fulfillment service's location. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders. */ + | "FULFILLMENT_ORDERS_ORDER_ROUTING_COMPLETE" + /** The webhook topic for `fulfillment_orders/placed_on_hold` events. Occurs when a fulfillment order is placed on hold. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_PLACED_ON_HOLD" + /** The webhook topic for `fulfillment_orders/rescheduled` events. Triggers when a fulfillment order is rescheduled Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_RESCHEDULED" + /** The webhook topic for `fulfillment_orders/scheduled_fulfillment_order_ready` events. Occurs whenever a fulfillment order which was scheduled becomes due. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders. */ + | "FULFILLMENT_ORDERS_SCHEDULED_FULFILLMENT_ORDER_READY" + /** The webhook topic for `inventory_items/create` events. Occurs whenever an inventory item is created. Requires the `read_inventory` scope. */ + | "INVENTORY_ITEMS_CREATE" + /** The webhook topic for `inventory_items/delete` events. Occurs whenever an inventory item is deleted. Requires the `read_inventory` scope. */ + | "INVENTORY_ITEMS_DELETE" + /** The webhook topic for `inventory_items/update` events. Occurs whenever an inventory item is updated. Requires the `read_inventory` scope. */ + | "INVENTORY_ITEMS_UPDATE" + /** The webhook topic for `inventory_levels/connect` events. Occurs whenever an inventory level is connected. Requires the `read_inventory` scope. */ + | "INVENTORY_LEVELS_CONNECT" + /** The webhook topic for `inventory_levels/disconnect` events. Occurs whenever an inventory level is disconnected. Requires the `read_inventory` scope. */ + | "INVENTORY_LEVELS_DISCONNECT" + /** The webhook topic for `inventory_levels/update` events. Occurs whenever an inventory level is updated. Requires the `read_inventory` scope. */ + | "INVENTORY_LEVELS_UPDATE" + /** The webhook topic for `locales/create` events. Occurs whenever a shop locale is created Requires the `read_locales` scope. */ + | "LOCALES_CREATE" + /** The webhook topic for `locales/update` events. Occurs whenever a shop locale is updated, such as published or unpublished Requires the `read_locales` scope. */ + | "LOCALES_UPDATE" + /** The webhook topic for `locations/activate` events. Occurs whenever a deactivated location is re-activated. Requires the `read_locations` scope. */ + | "LOCATIONS_ACTIVATE" + /** The webhook topic for `locations/create` events. Occurs whenever a location is created. Requires the `read_locations` scope. */ + | "LOCATIONS_CREATE" + /** The webhook topic for `locations/deactivate` events. Occurs whenever a location is deactivated. Requires the `read_locations` scope. */ + | "LOCATIONS_DEACTIVATE" + /** The webhook topic for `locations/delete` events. Occurs whenever a location is deleted. Requires the `read_locations` scope. */ + | "LOCATIONS_DELETE" + /** The webhook topic for `locations/update` events. Occurs whenever a location is updated. Requires the `read_locations` scope. */ + | "LOCATIONS_UPDATE" + /** The webhook topic for `markets/create` events. Occurs when a new market is created. Requires the `read_markets` scope. */ + | "MARKETS_CREATE" + /** The webhook topic for `markets/delete` events. Occurs when a market is deleted. Requires the `read_markets` scope. */ + | "MARKETS_DELETE" + /** The webhook topic for `markets/update` events. Occurs when a market is updated. Requires the `read_markets` scope. */ + | "MARKETS_UPDATE" + /** The webhook topic for `orders/cancelled` events. Occurs whenever an order is cancelled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders. */ + | "ORDERS_CANCELLED" + /** The webhook topic for `orders/create` events. Occurs whenever an order is created. Requires at least one of the following scopes: read_orders, read_marketplace_orders. */ + | "ORDERS_CREATE" + /** The webhook topic for `orders/delete` events. Occurs whenever an order is deleted. Requires the `read_orders` scope. */ + | "ORDERS_DELETE" + /** The webhook topic for `orders/edited` events. Occurs whenever an order is edited. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders. */ + | "ORDERS_EDITED" + /** The webhook topic for `orders/fulfilled` events. Occurs whenever an order is fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders. */ + | "ORDERS_FULFILLED" + /** The webhook topic for `orders/paid` events. Occurs whenever an order is paid. Requires at least one of the following scopes: read_orders, read_marketplace_orders. */ + | "ORDERS_PAID" + /** The webhook topic for `orders/partially_fulfilled` events. Occurs whenever an order is partially fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders. */ + | "ORDERS_PARTIALLY_FULFILLED" + /** The webhook topic for `orders/updated` events. Occurs whenever an order is updated. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders. */ + | "ORDERS_UPDATED" + /** The webhook topic for `order_transactions/create` events. Occurs when a order transaction is created or when it's status is updated. Only occurs for transactions with a status of success, failure or error. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders. */ + | "ORDER_TRANSACTIONS_CREATE" + /** The webhook topic for `payment_schedules/due` events. Occurs whenever payment schedules are due. Requires the `read_payment_terms` scope. */ + | "PAYMENT_SCHEDULES_DUE" + /** The webhook topic for `payment_terms/create` events. Occurs whenever payment terms are created. Requires the `read_payment_terms` scope. */ + | "PAYMENT_TERMS_CREATE" + /** The webhook topic for `payment_terms/delete` events. Occurs whenever payment terms are deleted. Requires the `read_payment_terms` scope. */ + | "PAYMENT_TERMS_DELETE" + /** The webhook topic for `payment_terms/update` events. Occurs whenever payment terms are updated. Requires the `read_payment_terms` scope. */ + | "PAYMENT_TERMS_UPDATE" + /** The webhook topic for `products/create` events. Occurs whenever a product is created. Requires the `read_products` scope. */ + | "PRODUCTS_CREATE" + /** The webhook topic for `products/delete` events. Occurs whenever a product is deleted. Requires the `read_products` scope. */ + | "PRODUCTS_DELETE" + /** The webhook topic for `products/update` events. Occurs whenever a product is updated, or whenever a product is ordered, or whenever a variant is added, removed, or updated. Requires the `read_products` scope. */ + | "PRODUCTS_UPDATE" + /** The webhook topic for `product_feeds/create` events. Triggers when product feed is created Requires the `read_product_listings` scope. */ + | "PRODUCT_FEEDS_CREATE" + /** The webhook topic for `product_feeds/full_sync` events. Triggers when a full sync for a product feed is performed Requires the `read_product_listings` scope. */ + | "PRODUCT_FEEDS_FULL_SYNC" + /** The webhook topic for `product_feeds/incremental_sync` events. Occurs whenever a product publication is created, updated or removed for a product feed Requires the `read_product_listings` scope. */ + | "PRODUCT_FEEDS_INCREMENTAL_SYNC" + /** The webhook topic for `product_feeds/update` events. Triggers when product feed is updated Requires the `read_product_listings` scope. */ + | "PRODUCT_FEEDS_UPDATE" + /** The webhook topic for `product_listings/add` events. Occurs whenever an active product is listed on a channel. Requires the `read_product_listings` scope. */ + | "PRODUCT_LISTINGS_ADD" + /** The webhook topic for `product_listings/remove` events. Occurs whenever a product listing is removed from the channel. Requires the `read_product_listings` scope. */ + | "PRODUCT_LISTINGS_REMOVE" + /** The webhook topic for `product_listings/update` events. Occurs whenever a product publication is updated. Requires the `read_product_listings` scope. */ + | "PRODUCT_LISTINGS_UPDATE" + /** The webhook topic for `product_publications/create` events. Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published. Requires the `read_publications` scope. */ + | "PRODUCT_PUBLICATIONS_CREATE" + /** The webhook topic for `product_publications/delete` events. Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished. Requires the `read_publications` scope. */ + | "PRODUCT_PUBLICATIONS_DELETE" + /** The webhook topic for `product_publications/update` events. Occurs whenever a product publication is updated. Requires the `read_publications` scope. */ + | "PRODUCT_PUBLICATIONS_UPDATE" + /** The webhook topic for `profiles/create` events. Occurs whenever a delivery profile is created Requires at least one of the following scopes: read_shipping, read_assigned_shipping. */ + | "PROFILES_CREATE" + /** The webhook topic for `profiles/delete` events. Occurs whenever a delivery profile is deleted Requires at least one of the following scopes: read_shipping, read_assigned_shipping. */ + | "PROFILES_DELETE" + /** The webhook topic for `profiles/update` events. Occurs whenever a delivery profile is updated Requires at least one of the following scopes: read_shipping, read_assigned_shipping. */ + | "PROFILES_UPDATE" + /** The webhook topic for `refunds/create` events. Occurs whenever a new refund is created without errors on an order, independent from the movement of money. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders. */ + | "REFUNDS_CREATE" + /** The webhook topic for `returns/approve` events. Occurs whenever a return is approved. This means `Return.status` is `OPEN`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_APPROVE" + /** The webhook topic for `returns/cancel` events. Occurs whenever a return is canceled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_CANCEL" + /** The webhook topic for `returns/close` events. Occurs whenever a return is closed. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_CLOSE" + /** The webhook topic for `returns/decline` events. Occurs whenever a return is declined. This means `Return.status` is `DECLINED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_DECLINE" + /** The webhook topic for `returns/reopen` events. Occurs whenever a closed return is reopened. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_REOPEN" + /** The webhook topic for `returns/request` events. Occurs whenever a return is requested. This means `Return.status` is `REQUESTED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders. */ + | "RETURNS_REQUEST" + /** + * The webhook topic for `reverse_deliveries/attach_deliverable` events. Occurs whenever a deliverable is attached to a reverse delivery. + * This occurs when a reverse delivery is created or updated with delivery metadata. + * Metadata includes the delivery method, label, and tracking information associated with a reverse delivery. + * Requires at least one of the following scopes: read_returns, read_marketplace_returns. + */ + | "REVERSE_DELIVERIES_ATTACH_DELIVERABLE" + /** + * The webhook topic for `reverse_fulfillment_orders/dispose` events. Occurs whenever a disposition is made on a reverse fulfillment order. + * This includes dispositions made on reverse deliveries that are associated with the reverse fulfillment order. + * Requires at least one of the following scopes: read_returns, read_marketplace_returns. + */ + | "REVERSE_FULFILLMENT_ORDERS_DISPOSE" + /** The webhook topic for `scheduled_product_listings/add` events. Occurs whenever a product is scheduled to be published. Requires the `read_product_listings` scope. */ + | "SCHEDULED_PRODUCT_LISTINGS_ADD" + /** The webhook topic for `scheduled_product_listings/remove` events. Occurs whenever a product is no longer scheduled to be published. Requires the `read_product_listings` scope. */ + | "SCHEDULED_PRODUCT_LISTINGS_REMOVE" + /** The webhook topic for `scheduled_product_listings/update` events. Occurs whenever a product's scheduled availability date changes. Requires the `read_product_listings` scope. */ + | "SCHEDULED_PRODUCT_LISTINGS_UPDATE" + /** The webhook topic for `segments/create` events. Occurs whenever a segment is created. Requires the `read_customers` scope. */ + | "SEGMENTS_CREATE" + /** The webhook topic for `segments/delete` events. Occurs whenever a segment is deleted. Requires the `read_customers` scope. */ + | "SEGMENTS_DELETE" + /** The webhook topic for `segments/update` events. Occurs whenever a segment is updated. Requires the `read_customers` scope. */ + | "SEGMENTS_UPDATE" + /** The webhook topic for `selling_plan_groups/create` events. Notifies when a SellingPlanGroup is created. Requires the `read_products` scope. */ + | "SELLING_PLAN_GROUPS_CREATE" + /** The webhook topic for `selling_plan_groups/delete` events. Notifies when a SellingPlanGroup is deleted. Requires the `read_products` scope. */ + | "SELLING_PLAN_GROUPS_DELETE" + /** The webhook topic for `selling_plan_groups/update` events. Notifies when a SellingPlanGroup is updated. Requires the `read_products` scope. */ + | "SELLING_PLAN_GROUPS_UPDATE" + /** The webhook topic for `shipping_addresses/create` events. Occurs whenever a shipping address is created. Requires the `read_shipping` scope. */ + | "SHIPPING_ADDRESSES_CREATE" + /** The webhook topic for `shipping_addresses/update` events. Occurs whenever a shipping address is updated. Requires the `read_shipping` scope. */ + | "SHIPPING_ADDRESSES_UPDATE" + /** The webhook topic for `shop/update` events. Occurs whenever a shop is updated. */ + | "SHOP_UPDATE" + /** The webhook topic for `subscription_billing_attempts/challenged` events. Occurs when the financial instutition challenges the subscripttion billing attempt charge as per 3D Secure. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_ATTEMPTS_CHALLENGED" + /** The webhook topic for `subscription_billing_attempts/failure` events. Occurs whenever a subscription billing attempt fails. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE" + /** The webhook topic for `subscription_billing_attempts/success` events. Occurs whenever a subscription billing attempt succeeds. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS" + /** The webhook topic for `subscription_billing_cycle_edits/create` events. Occurs whenever a subscription contract billing cycle is edited. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_CYCLE_EDITS_CREATE" + /** The webhook topic for `subscription_billing_cycle_edits/delete` events. Occurs whenever a subscription contract billing cycle edit is deleted. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_CYCLE_EDITS_DELETE" + /** The webhook topic for `subscription_billing_cycle_edits/update` events. Occurs whenever a subscription contract billing cycle edit is updated. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_BILLING_CYCLE_EDITS_UPDATE" + /** The webhook topic for `subscription_contracts/create` events. Occurs whenever a subscription contract is created. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_CONTRACTS_CREATE" + /** The webhook topic for `subscription_contracts/update` events. Occurs whenever a subscription contract is updated. Requires the `read_own_subscription_contracts` scope. */ + | "SUBSCRIPTION_CONTRACTS_UPDATE" + /** The webhook topic for `tax_partners/update` events. Occurs whenever a tax partner is created or updated. Requires the `read_taxes` scope. */ + | "TAX_PARTNERS_UPDATE" + /** The webhook topic for `tax_services/create` events. Occurs whenever a tax service is created. Requires the `read_taxes` scope. */ + | "TAX_SERVICES_CREATE" + /** The webhook topic for `tax_services/update` events. Occurs whenver a tax service is updated. Requires the `read_taxes` scope. */ + | "TAX_SERVICES_UPDATE" + /** The webhook topic for `tender_transactions/create` events. Occurs when a tender transaction is created. Requires the `read_orders` scope. */ + | "TENDER_TRANSACTIONS_CREATE" + /** The webhook topic for `themes/create` events. Occurs whenever a theme is created. Does not occur when theme files are created. Requires the `read_themes` scope. */ + | "THEMES_CREATE" + /** The webhook topic for `themes/delete` events. Occurs whenever a theme is deleted. Does not occur when theme files are deleted. Requires the `read_themes` scope. */ + | "THEMES_DELETE" + /** The webhook topic for `themes/publish` events. Occurs whenever a theme with the main or mobile (deprecated) role is published. Requires the `read_themes` scope. */ + | "THEMES_PUBLISH" + /** The webhook topic for `themes/update` events. Occurs whenever a theme is updated. Does not occur when theme files are updated. Requires the `read_themes` scope. */ + | "THEMES_UPDATE" + /** The webhook topic for `variants/in_stock` events. Occurs whenever a variant becomes in stock. Requires the `read_products` scope. */ + | "VARIANTS_IN_STOCK" + /** The webhook topic for `variants/out_of_stock` events. Occurs whenever a variant becomes out of stock. Requires the `read_products` scope. */ + | "VARIANTS_OUT_OF_STOCK"; + +/** Return type for `webhookSubscriptionUpdate` mutation. */ +export type WebhookSubscriptionUpdatePayload = { + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; + /** The webhook subscription that was updated. */ + webhookSubscription?: Maybe; +}; + +/** A weight, which includes a numeric value and a unit of measurement. */ +export type Weight = { + /** The unit of measurement for `value`. */ + unit: WeightUnit; + /** The weight value using the unit system specified with `unit`. */ + value: Scalars["Float"]["output"]; +}; + +/** + * The input fields for the weight unit and value inputs. + */ +export type WeightInput = { + /** Unit of measurement for `value`. */ + unit: WeightUnit; + /** The weight value using the unit system specified with `weight_unit`. */ + value: Scalars["Float"]["input"]; +}; + +/** Units of measurement for weight. */ +export type WeightUnit = + /** Metric system unit of mass. */ + | "GRAMS" + /** 1 kilogram equals 1000 grams. */ + | "KILOGRAMS" + /** Imperial system unit of mass. */ + | "OUNCES" + /** 1 pound equals 16 ounces. */ + | "POUNDS"; + +/** Return type for `deliveryProfileCreate` mutation. */ +export type DeliveryProfileCreatePayload = { + /** The delivery profile that was created. */ + profile?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `deliveryProfileRemove` mutation. */ +export type DeliveryProfileRemovePayload = { + /** The delivery profile deletion job triggered by the mutation. */ + job?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `deliveryProfileUpdate` mutation. */ +export type DeliveryProfileUpdatePayload = { + /** The delivery profile that was updated. */ + profile?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +export type NoopQueryVariables = Exact<{ [key: string]: never }>; + +export type NoopQuery = { app?: { description?: string | null } | null }; diff --git a/shopify/utils/admin/admin.graphql.json b/shopify/utils/admin/admin.graphql.json new file mode 100644 index 000000000..8e6a5d584 --- /dev/null +++ b/shopify/utils/admin/admin.graphql.json @@ -0,0 +1,194416 @@ +{ + "data": { + "__schema": { + "queryType": { + "name": "QueryRoot" + }, + "mutationType": { + "name": "Mutation" + }, + "subscriptionType": null, + "types": [ + { + "kind": "SCALAR", + "name": "ARN", + "description": "An Amazon Web Services Amazon Resource Name (ARN), including the Region and account ID.\nFor more information, refer to [Amazon Resource Names](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AbandonedCheckout", + "description": "A checkout that was abandoned by the customer.", + "fields": [ + { + "name": "abandonedCheckoutUrl", + "description": "The URL for the buyer to recover their checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemsQuantity", + "description": "The number of products in the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "The sum of all items in the checkout, including discounts, shipping, taxes, and tips.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Abandonment", + "description": "A browse, cart, or checkout that was abandoned by a customer.", + "fields": [ + { + "name": "abandonedCheckoutPayload", + "description": "The abandonment payload for the abandoned checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AbandonedCheckout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "abandonmentType", + "description": "The abandonment type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AbandonmentAbandonmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "The app associated with an abandoned checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartUrl", + "description": "Permalink to the cart page.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the abandonment was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer who abandoned this event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerHasNoOrderSinceAbandonment", + "description": "Whether the customer has completed an order since this checkout has been abandoned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "daysSinceLastAbandonmentEmail", + "description": "The number of days since the last abandonment email was sent to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "emailSentAt", + "description": "When the email was sent, if that's the case.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "emailState", + "description": "The email state (e.g., sent or not sent).", + "args": [], + "type": { + "kind": "ENUM", + "name": "AbandonmentEmailState", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hoursSinceLastAbandonedCheckout", + "description": "The number of hours since the customer has last abandoned a checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryAvailable", + "description": "Whether the products in abandonment are available.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isFromOnlineStore", + "description": "Whether the abandonment event comes from the Online Store sales channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isFromShopApp", + "description": "Whether the abandonment event comes from the Shop app sales channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isFromShopPay", + "description": "Whether the abandonment event comes from Shop Pay.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isMostSignificantAbandonment", + "description": "Whether the customer didn't complete another most significant step since this abandonment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastBrowseAbandonmentDate", + "description": "The date for the latest browse abandonment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastCartAbandonmentDate", + "description": "The date for the latest cart abandonment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastCheckoutAbandonmentDate", + "description": "The date for the latest checkout abandonment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mostRecentStep", + "description": "The most recent step type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AbandonmentAbandonmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productsAddedToCart", + "description": "The products added to the cart during the customer abandoned visit.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisitProductInfoConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productsViewed", + "description": "The products viewed during the customer abandoned visit.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisitProductInfoConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visitStartedAt", + "description": "The date and time when the visit started.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AbandonmentAbandonmentType", + "description": "Specifies the abandonment type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BROWSE", + "description": "The abandonment event is an abandoned browse.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART", + "description": "The abandonment event is an abandoned cart.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUT", + "description": "The abandonment event is an abandoned checkout.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AbandonmentDeliveryState", + "description": "Specifies the delivery state of a marketing activity.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_SENT", + "description": "The marketing activity action has not yet been sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SENT", + "description": "The marketing activity action has been sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "The marketing activity action has been scheduled for later delivery.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AbandonmentEmailState", + "description": "Specifies the email state.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_SENT", + "description": "The email has not yet been sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SENT", + "description": "The email has been sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "The email has been scheduled for later delivery.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AbandonmentEmailStateUpdatePayload", + "description": "Return type for `abandonmentEmailStateUpdate` mutation.", + "fields": [ + { + "name": "abandonment", + "description": "The updated abandonment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Abandonment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AbandonmentEmailStateUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AbandonmentEmailStateUpdateUserError", + "description": "An error that occurs during the execution of `AbandonmentEmailStateUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AbandonmentEmailStateUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AbandonmentEmailStateUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `AbandonmentEmailStateUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ABANDONMENT_NOT_FOUND", + "description": "Unable to find an Abandonment for the provided ID.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesPayload", + "description": "Return type for `abandonmentUpdateActivitiesDeliveryStatuses` mutation.", + "fields": [ + { + "name": "abandonment", + "description": "The updated abandonment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Abandonment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", + "description": "An error that occurs during the execution of `AbandonmentUpdateActivitiesDeliveryStatuses`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserErrorCode", + "description": "Possible error codes that can be returned by `AbandonmentUpdateActivitiesDeliveryStatusesUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ABANDONMENT_NOT_FOUND", + "description": "Unable to find an Abandonment for the provided ID.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETING_ACTIVITY_NOT_FOUND", + "description": "Unable to find a marketing activity for the provided ID.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_STATUS_INFO_NOT_FOUND", + "description": "Unable to find delivery status info for the provided ID.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AccessScope", + "description": "The permission required to access a Shopify Admin API or Storefront API resource for a shop. Merchants grant access scopes that are requested by applications.\n", + "fields": [ + { + "name": "description", + "description": "A description of the actions that the access scope allows an app to perform.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A readable string that represents the access scope. The string usually follows the format `{action}_{resource}`. `{action}` is `read` or `write`, and `{resource}` is the resource that the action can be performed on. `{action}` and `{resource}` are separated by an underscore. For example, `read_orders` or `write_products`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddAllProductsOperation", + "description": "Represents an operation publishing all products to a publication.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedRowCount", + "description": "The count of processed rows, summing imported, failed, and skipped rows.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rowCount", + "description": "Represents a rows objects within this background operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RowCount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceOperationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AdditionalFee", + "description": "The additional fees that have been applied to the order.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "A list of taxes charged on the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AdditionalFeeSale", + "description": "A sale associated with an additional fee charge.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "additionalFee", + "description": "The additional fees for the associated sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleAdditionalFee", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AdjustmentSale", + "description": "A sale associated with an order price adjustment.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AllDiscountItems", + "description": "Targets all items the cart for a specified discount.", + "fields": [ + { + "name": "allItems", + "description": "Whether all items are eligible for the discount. This value always returns `true`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApiVersion", + "description": "A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).\nVersions are commonly referred to by their handle (for example, `2021-10`).\n", + "fields": [ + { + "name": "displayName", + "description": "The human-readable name of the version.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supported", + "description": "Whether the version is actively supported by Shopify. Supported API versions are guaranteed to be stable. Unsupported API versions include unstable, release candidate, and end-of-life versions that are marked as unsupported. For more information, refer to [Versioning](https://shopify.dev/api/usage/versioning).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "App", + "description": "A Shopify application.", + "fields": [ + { + "name": "apiKey", + "description": "A unique application API identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appStoreAppUrl", + "description": "App store page URL of the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appStoreDeveloperUrl", + "description": "App store page URL of the developer who created the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableAccessScopes", + "description": "The access scopes available to the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AccessScope", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "banner", + "description": "Banner image for the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Description of the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "developerName", + "description": "The name of the app developer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "developerType", + "description": "The type of app developer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppDeveloperType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "developerUrl", + "description": "Website of the developer who created the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `appStoreDeveloperUrl` instead." + }, + { + "name": "embedded", + "description": "Whether the app uses the Embedded App SDK.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "failedRequirements", + "description": "Requirements that must be met before the app can be installed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FailedRequirement", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "features", + "description": "A list of app features that are shown in the Shopify App Store listing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "feedback", + "description": "Feedback from this app about the store.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppFeedback", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "Handle of the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "icon", + "description": "Icon that represents the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installUrl", + "description": "Webpage where you can install the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installation", + "description": "Corresponding AppInstallation for this shop and App.\nReturns null if the App is not installed.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPostPurchaseAppInUse", + "description": "Whether the app is the [post purchase](https://shopify.dev/apps/checkout/post-purchase) app in use.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "launchUrl", + "description": "Webpage that the app starts in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use AppInstallation.launchUrl instead" + }, + { + "name": "navigationItems", + "description": "Menu items for the app, which also appear as submenu items in left navigation sidebar in the Shopify admin.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NavigationItem", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use AppInstallation.navigationItems instead" + }, + { + "name": "previouslyInstalled", + "description": "Whether the app was previously installed on the current shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricingDetails", + "description": "Detailed information about the app pricing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricingDetailsSummary", + "description": "Summary of the app pricing details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privacyPolicyUrl", + "description": "Link to app privacy policy.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicCategory", + "description": "The public category for the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppPublicCategory", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "published", + "description": "Whether the app is published to the Shopify App Store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestedAccessScopes", + "description": "The access scopes requested by the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AccessScope", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "screenshots", + "description": "Screenshots of the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyDeveloped", + "description": "Whether the app was developed by Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Name of the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uninstallMessage", + "description": "Message that appears when the app is uninstalled. For example:\nBy removing this app, you will no longer be able to publish products to MySocialSite or view this app in your Shopify admin. You can re-enable this channel at any time.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uninstallUrl", + "description": "Webpage where you can uninstall the app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use AppInstallation.uninstallUrl instead" + }, + { + "name": "webhookApiVersion", + "description": "The webhook API version for the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppCatalog", + "description": "A catalog that defines the publication associated with an app.\n", + "fields": [ + { + "name": "apps", + "description": "The apps associated with the catalog.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operations", + "description": "Most recent catalog operations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The price list associated with the catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "A group of products and collections that's published to a catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppConnection", + "description": "An auto-generated type for paginating through multiple Apps.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppCredit", + "description": "App credits can be applied by the merchant towards future app purchases, subscriptions, or usage records in Shopify.", + "fields": [ + { + "name": "amount", + "description": "The amount that can be used towards future app purchases in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the app credit was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the app credit.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the app credit is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppCreditConnection", + "description": "An auto-generated type for paginating through multiple AppCredits.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppCreditEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppCreditEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppCredit", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppCreditEdge", + "description": "An auto-generated type which holds one AppCredit and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppCreditEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppCredit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppDeveloperType", + "description": "Possible types of app developer.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHOPIFY", + "description": "Indicates the app developer is Shopify.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTNER", + "description": "Indicates the app developer is a Partner.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT", + "description": "Indicates the app developer works directly for a Merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "Indicates the app developer is unknown. It is not categorized as any of the other developer types.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppDiscountType", + "description": "A script that defines a discount type.", + "fields": [ + { + "name": "app", + "description": "The app providing the app discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appBridge", + "description": "The App Bridge details for discount type configuration.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FunctionsAppBridge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appKey", + "description": "The client ID of the app providing the app discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A description of the app discount type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the app discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "functionId", + "description": "The ID of the function providing the app discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The target type of the app discount type. Possible values: `SHIPPING_LINE` and `LINE_ITEM`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the app discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppEdge", + "description": "An auto-generated type which holds one App and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppFeedback", + "description": "Reports the status of shops and their resources and displays this information\nwithin Shopify admin. AppFeedback is used to notify merchants about steps they need to take\nto set up an app on their store.\n", + "fields": [ + { + "name": "app", + "description": "The application associated to the feedback.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "link", + "description": "A link to where merchants can resolve errors.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Link", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "messages", + "description": "The feedback message presented to the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppInstallation", + "description": "Represents an installed application on a shop.", + "fields": [ + { + "name": "accessScopes", + "description": "The access scopes granted to the application by a merchant during installation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AccessScope", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "activeSubscriptions", + "description": "The active application subscriptions billed to the shop on a recurring basis.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allSubscriptions", + "description": "All subscriptions created for a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppSubscriptionSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscriptionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "Application which is installed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channel", + "description": "Channel associated with the installed application.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publication` instead." + }, + { + "name": "credits", + "description": "Credits that can be used towards future app purchases.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppTransactionSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppCreditConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "launchUrl", + "description": "The URL to launch the application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "oneTimePurchases", + "description": "One-time purchases to a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppTransactionSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "publication", + "description": "The publication associated with the installed application.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "revenueAttributionRecords", + "description": "The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptions", + "description": "Subscriptions charge to a shop on a recurring basis.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `activeSubscriptions` instead." + }, + { + "name": "uninstallUrl", + "description": "The URL to uninstall the application.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppInstallationCategory", + "description": "The possible categories of an app installation, based on their purpose\nor the environment they can run in.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CHANNEL", + "description": "Apps that serve as channels through which sales are made, such as the online store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POS_EMBEDDED", + "description": "Apps that can be used in the POS mobile client.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppInstallationConnection", + "description": "An auto-generated type for paginating through multiple AppInstallations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppInstallationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppInstallationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppInstallationEdge", + "description": "An auto-generated type which holds one AppInstallation and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppInstallationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppInstallationPrivacy", + "description": "The levels of privacy of an app installation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PUBLIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIVATE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppInstallationSortKeys", + "description": "The set of valid sort keys for the AppInstallation query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INSTALLED_AT", + "description": "Sort by the `installed_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_TITLE", + "description": "Sort by the `app_title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppPlanInput", + "description": "The pricing model for the app subscription.\nThe pricing model input can be either `appRecurringPricingDetails` or `appUsagePricingDetails`.\n", + "fields": null, + "inputFields": [ + { + "name": "appUsagePricingDetails", + "description": "The pricing details for usage-based billing.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AppUsagePricingInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appRecurringPricingDetails", + "description": "The pricing details for recurring billing.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AppRecurringPricingInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppPlanV2", + "description": "The app plan that the merchant is subscribed to.", + "fields": [ + { + "name": "pricingDetails", + "description": "The plan billed to a shop on a recurring basis.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "AppPricingDetails", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "AppPricingDetails", + "description": "The information about the price that's charged to a shop every plan period.\nThe concrete type can be `AppRecurringPricing` for recurring billing or `AppUsagePricing` for usage-based billing.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppRecurringPricing", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppUsagePricing", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "AppPricingInterval", + "description": "The frequency at which the shop is billed for an app subscription.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ANNUAL", + "description": "The app subscription bills the shop annually.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EVERY_30_DAYS", + "description": "The app subscription bills the shop every 30 days.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppPublicCategory", + "description": "The public-facing category for an app.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRIVATE", + "description": "The app's public category is [private](https://shopify.dev/apps/distribution#deprecated-app-types).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC", + "description": "The app's public category is [public](https://shopify.dev/apps/distribution#capabilities-and-requirements).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM", + "description": "The app's public category is [custom](https://shopify.dev/apps/distribution#capabilities-and-requirements).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The app's public category is other. An app is in this category if it's not classified under any of the other app types (private, public, or custom).", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "AppPurchase", + "description": "Services and features purchased once by the store.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the app purchase occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The amount to be charged to the store for the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppPurchaseStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the app purchase is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "description": "Services and features purchased once by a store.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the app purchase occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The amount to be charged to the store for the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the app purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppPurchaseStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the app purchase is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "AppPurchase", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeConnection", + "description": "An auto-generated type for paginating through multiple AppPurchaseOneTimes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppPurchaseOneTimeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeCreatePayload", + "description": "Return type for `appPurchaseOneTimeCreate` mutation.", + "fields": [ + { + "name": "appPurchaseOneTime", + "description": "The newly created app one-time purchase.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmationUrl", + "description": "The URL that the merchant can access to approve or decline the newly created app one-time purchase.\n\nIf the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined.\nIf the merchant approves and they're successfully invoiced, then the state of the charge changes from `pending` to `active`.\n\nYou get paid after the charge is activated.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeEdge", + "description": "An auto-generated type which holds one AppPurchaseOneTime and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppPurchaseOneTimeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppPurchaseStatus", + "description": "The approval status of the app purchase.\n\nThe merchant is charged for the purchase immediately after approval, and the status changes to `active`.\nIf the payment fails, then the app purchase remains `pending`.\n\nPurchases start as `pending` and can change to: `active`, `declined`, `expired`. After a purchase changes, it\nremains in that final state.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCEPTED", + "description": "The app purchase has been approved by the merchant and is ready to be activated by the app. App purchases created through the GraphQL Admin API are activated upon approval.", + "isDeprecated": true, + "deprecationReason": "As of API version 2021-01, when a merchant accepts an app purchase, the status immediately changes from `pending` to `active`." + }, + { + "name": "ACTIVE", + "description": "The app purchase was approved by the merchant and has been activated by the app. Active app purchases are charged to the merchant and are paid out to the partner.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "The app purchase was declined by the merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The app purchase was not accepted within two days of being created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The app purchase is pending approval by the merchant.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRecurringPricing", + "description": "The pricing information about a subscription app.\nThe object contains an interval (the frequency at which the shop is billed for an app subscription) and\na price (the amount to be charged to the subscribing shop at each interval).\n", + "fields": [ + { + "name": "discount", + "description": "The discount applied to the subscription for a given number of billing intervals.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppSubscriptionDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The frequency at which the subscribing shop is billed for an app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppPricingInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The amount and currency to be charged to the subscribing shop every billing interval.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppRecurringPricingInput", + "description": "Instructs the app subscription to generate a fixed charge on a recurring basis. The frequency is specified by the billing interval.", + "fields": null, + "inputFields": [ + { + "name": "interval", + "description": "How often the app subscription generates a charge.", + "type": { + "kind": "ENUM", + "name": "AppPricingInterval", + "ofType": null + }, + "defaultValue": "EVERY_30_DAYS" + }, + { + "name": "price", + "description": "The amount to be charged to the store every billing interval.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discount", + "description": "The discount applied to the subscription for a given number of billing intervals.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionDiscountInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecord", + "description": "Represents app revenue that was captured externally by the partner.", + "fields": [ + { + "name": "amount", + "description": "The financial amount captured in this attribution.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "capturedAt", + "description": "The timestamp when the financial amount was captured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The timestamp at which this revenue attribution was issued.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "idempotencyKey", + "description": "The unique value submitted during the creation of the app revenue attribution record.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Indicates whether this is a test submission.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of revenue attribution.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppRevenueAttributionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordConnection", + "description": "An auto-generated type for paginating through multiple AppRevenueAttributionRecords.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppRevenueAttributionRecordEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecord", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordCreatePayload", + "description": "Return type for `appRevenueAttributionRecordCreate` mutation.", + "fields": [ + { + "name": "appRevenueAttributionRecord", + "description": "The created app revenue attribution record.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecord", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordCreateUserError", + "description": "An error that occurs during the execution of `AppRevenueAttributionRecordCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordCreateUserErrorCode", + "description": "Possible error codes that can be returned by `AppRevenueAttributionRecordCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordDeletePayload", + "description": "Return type for `appRevenueAttributionRecordDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the revenue attribution that was deleted, if one was.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordDeleteUserError", + "description": "An error that occurs during the execution of `AppRevenueAttributionRecordDelete`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `AppRevenueAttributionRecordDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordEdge", + "description": "An auto-generated type which holds one AppRevenueAttributionRecord and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppRevenueAttributionRecordEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecord", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppRevenueAttributionRecordInput", + "description": "The input fields to supply an app revenue attribution record.", + "fields": null, + "inputFields": [ + { + "name": "idempotencyKey", + "description": "The unique value submitted during creation.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "capturedAt", + "description": "The timestamp when the financial amount was captured.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "amount", + "description": "The financial amount captured in this attribution.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of revenue attribution.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppRevenueAttributionType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "test", + "description": "Indicates whether this is a test submission.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppRevenueAttributionRecordSortKeys", + "description": "The set of valid sort keys for the AppRevenueAttributionRecord query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppRevenueAttributionType", + "description": "Represents the billing types of revenue attribution.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLICATION_PURCHASE", + "description": "App purchase related revenue collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPLICATION_SUBSCRIPTION", + "description": "App subscription revenue collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPLICATION_USAGE", + "description": "App usage-based revenue collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "Other app revenue collection type.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscription", + "description": "Provides users access to services and/or features for a duration of time.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the app subscription was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentPeriodEnd", + "description": "The date and time when the current app subscription period ends. Returns `null` if the subscription isn't active.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "The plans attached to the app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscriptionLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnUrl", + "description": "The URL that the merchant is redirected to after approving the app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppSubscriptionStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Specifies whether the app subscription is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trialDays", + "description": "The number of free trial days, starting at the subscription's creation date, by which billing is delayed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionCancelPayload", + "description": "Return type for `appSubscriptionCancel` mutation.", + "fields": [ + { + "name": "appSubscription", + "description": "The cancelled app subscription.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionConnection", + "description": "An auto-generated type for paginating through multiple AppSubscriptions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscriptionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppSubscriptionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionCreatePayload", + "description": "Return type for `appSubscriptionCreate` mutation.", + "fields": [ + { + "name": "appSubscription", + "description": "The newly-created app subscription.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmationUrl", + "description": "The URL pointing to the page where the merchant approves or declines the charges for an app subscription.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionDiscount", + "description": "Discount applied to the recurring pricing portion of a subscription.", + "fields": [ + { + "name": "durationLimitInIntervals", + "description": "The total number of billing intervals to which the discount will be applied.\nThe discount will be applied to an indefinite number of billing intervals if this value is blank.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceAfterDiscount", + "description": "The price of the subscription after the discount is applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingDurationInIntervals", + "description": "The remaining number of billing intervals to which the discount will be applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount applied every billing interval.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "AppSubscriptionDiscountValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionDiscountAmount", + "description": "The fixed amount value of a discount.", + "fields": [ + { + "name": "amount", + "description": "The fixed amount value of a discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionDiscountInput", + "description": "The input fields to specify a discount to the recurring pricing portion of a subscription over a number of billing intervals.\n", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The value to be discounted every billing interval.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionDiscountValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "durationLimitInIntervals", + "description": "The total number of billing intervals to which the discount will be applied.\nThe discount will be applied to an indefinite number of billing intervals if this value is left blank.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionDiscountPercentage", + "description": "The percentage value of a discount.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of a discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "AppSubscriptionDiscountValue", + "description": "The value of the discount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppSubscriptionDiscountAmount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionDiscountPercentage", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionDiscountValueInput", + "description": "The input fields to specify the value discounted every billing interval.", + "fields": null, + "inputFields": [ + { + "name": "percentage", + "description": "The percentage value of a discount.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "amount", + "description": "The monetary value of a discount.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionEdge", + "description": "An auto-generated type which holds one AppSubscription and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppSubscriptionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionLineItem", + "description": "The plan attached to an app subscription.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "plan", + "description": "The pricing model for the app subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppPlanV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageRecords", + "description": "A list of the store's usage records for a usage pricing plan.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppUsageRecordSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppUsageRecordConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionLineItemInput", + "description": "The input fields to add more than one pricing plan to an app subscription.", + "fields": null, + "inputFields": [ + { + "name": "plan", + "description": "The pricing model for the app subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AppPlanInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionLineItemUpdatePayload", + "description": "Return type for `appSubscriptionLineItemUpdate` mutation.", + "fields": [ + { + "name": "appSubscription", + "description": "The updated app subscription.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmationUrl", + "description": "The URL where the merchant approves or declines the updated app subscription line item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppSubscriptionReplacementBehavior", + "description": "The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLY_IMMEDIATELY", + "description": "Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPLY_ON_NEXT_BILLING_CYCLE", + "description": "Defers canceling the merchant's current app subscription and applying the newly created app subscription until the start of the next billing cycle. This value is ignored if the new app subscription is using a different currency than the current app subscription, in which case the new app subscription is applied immediately.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STANDARD", + "description": "Cancels the merchant's current app subscription immediately and replaces it with the newly created app subscription, with the exception of\nthe following scenarios where replacing the current app subscription will be deferred until the start of the next billing cycle.\n1) The current app subscription is annual and the newly created app subscription is annual, using the same currency, but is of a lesser value.\n2) The current app subscription is annual and the newly created app subscription is monthly and using the same currency.\n3) The current app subscription and the newly created app subscription are identical except for the `discount` value.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppSubscriptionSortKeys", + "description": "The set of valid sort keys for the AppSubscription query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppSubscriptionStatus", + "description": "The status of the app subscription.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "The app subscription is pending approval by the merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCEPTED", + "description": "The app subscription has been approved by the merchant and is ready to be activated by the app.", + "isDeprecated": true, + "deprecationReason": "As of API version 2021-01, when a merchant approves an app subscription, the status immediately transitions from `pending` to `active`." + }, + { + "name": "ACTIVE", + "description": "The app subscription has been approved by the merchant. Active app subscriptions are billed to the shop. After payment, partners receive payouts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "The app subscription was declined by the merchant. This is a terminal state.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The app subscription wasn't approved by the merchant within two days of being created. This is a terminal state.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FROZEN", + "description": "The app subscription is on hold due to non-payment. The subscription re-activates after payments resume.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "The app subscription was cancelled by the app. This could be caused by the app being uninstalled, a new app subscription being activated, or a direct cancellation by the app. This is a terminal state.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionTrialExtendPayload", + "description": "Return type for `appSubscriptionTrialExtend` mutation.", + "fields": [ + { + "name": "appSubscription", + "description": "The app subscription that had its trial extended.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscriptionTrialExtendUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionTrialExtendUserError", + "description": "An error that occurs during the execution of `AppSubscriptionTrialExtend`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "AppSubscriptionTrialExtendUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppSubscriptionTrialExtendUserErrorCode", + "description": "Possible error codes that can be returned by `AppSubscriptionTrialExtendUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUBSCRIPTION_NOT_FOUND", + "description": "The app subscription wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRIAL_NOT_ACTIVE", + "description": "The trial isn't active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_NOT_ACTIVE", + "description": "The app subscription isn't active.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppTransactionSortKeys", + "description": "The set of valid sort keys for the AppTransaction query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppUsagePricing", + "description": "Defines a usage pricing model for the app subscription.\nThese charges are variable based on how much the merchant uses the app.\n", + "fields": [ + { + "name": "balanceUsed", + "description": "The total usage records for interval.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cappedAmount", + "description": "The capped amount prevents the merchant from being charged for any usage over that amount during a billing period.\nThis prevents billing from exceeding a maximum threshold over the duration of the billing period.\nFor the merchant to continue using the app after exceeding a capped amount, they would need to agree to a new usage charge.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The frequency with which the app usage records are billed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AppPricingInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "terms", + "description": "The terms and conditions for app usage pricing.\nMust be present in order to create usage charges.\nThe terms are presented to the merchant when they approve an app's usage charges.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AppUsagePricingInput", + "description": "The input fields to issue arbitrary charges for app usage associated with a subscription.", + "fields": null, + "inputFields": [ + { + "name": "cappedAmount", + "description": "The maximum amount of usage charges that can be incurred within a subscription billing interval.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "terms", + "description": "The terms and conditions for app usage. These terms stipulate the pricing model for the charges that an app creates.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppUsageRecord", + "description": "Store usage for app subscriptions with usage pricing.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the usage record was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the app usage record.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "idempotencyKey", + "description": "A unique key generated by the client to avoid duplicate charges.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the usage record.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionLineItem", + "description": "Defines the usage pricing plan the merchant is subscribed to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppSubscriptionLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppUsageRecordConnection", + "description": "An auto-generated type for paginating through multiple AppUsageRecords.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppUsageRecordEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in AppUsageRecordEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppUsageRecord", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppUsageRecordCreatePayload", + "description": "Return type for `appUsageRecordCreate` mutation.", + "fields": [ + { + "name": "appUsageRecord", + "description": "The newly created app usage record.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppUsageRecord", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppUsageRecordEdge", + "description": "An auto-generated type which holds one AppUsageRecord and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of AppUsageRecordEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppUsageRecord", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AppUsageRecordSortKeys", + "description": "The set of valid sort keys for the AppUsageRecord query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Attribute", + "description": "Represents a generic custom attribute.", + "fields": [ + { + "name": "key", + "description": "Key or name of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "description": "The input fields for an attribute.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "Key or name of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Value of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AutomaticDiscountApplication", + "description": "Automatic discount applications capture the intentions of a discount that was automatically applied.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is applied to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "index", + "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "AutomaticDiscountSortKeys", + "description": "The set of valid sort keys for the AutomaticDiscount query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AvailableChannelDefinitionsByChannel", + "description": "Represents an object containing all information for channels available to a shop.\n", + "fields": [ + { + "name": "channelDefinitions", + "description": "The channel definitions for channels installed on a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelDefinition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channelName", + "description": "The name of the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BadgeType", + "description": "The possible types for a badge.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEFAULT", + "description": "This badge has type `default`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUCCESS", + "description": "This badge has type `success`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTENTION", + "description": "This badge has type `attention`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WARNING", + "description": "This badge has type `warning`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INFO", + "description": "This badge has type `info`.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BasicEvent", + "description": "Basic events chronicle resource activities such as the creation of an article, the fulfillment of an order, or\nthe addition of a product.\n", + "fields": [ + { + "name": "appTitle", + "description": "The name of the app that created the event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToApp", + "description": "Whether the event was created by an app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToUser", + "description": "Whether the event was caused by an admin user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the event was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "criticalAlert", + "description": "Whether the event is critical.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human readable text that describes the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Event", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BillingAttemptUserError", + "description": "Represents an error that happens during the execution of a billing attempt mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BillingAttemptUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BillingAttemptUserErrorCode", + "description": "Possible error codes that can be returned by `BillingAttemptUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTRACT_NOT_FOUND", + "description": "Subscription contract does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORIGIN_TIME_BEFORE_CONTRACT_CREATION", + "description": "Origin time cannot be before the contract creation time.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", + "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_INDEX_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of index range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_START_DATE_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of start date range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORIGIN_TIME_OUT_OF_RANGE", + "description": "Origin time needs to be within the selected billing cycle's start and end at date.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Boolean", + "description": "Represents `true` or `false` values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BulkMutationErrorCode", + "description": "Possible error codes that can be returned by `BulkMutationUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OPERATION_IN_PROGRESS", + "description": "The operation did not run because another bulk mutation is already running. [Wait for the operation to finish](https://shopify.dev/api/usage/bulk-operations/imports#wait-for-the-operation-to-finish) before retrying this operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_MUTATION", + "description": "The operation did not run because the mutation is invalid. Check your mutation syntax and try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_STAGED_UPLOAD_FILE", + "description": "The JSONL file submitted via the `stagedUploadsCreate` mutation is invalid. Update the file and try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_SUCH_FILE", + "description": "The JSONL file could not be found. Try [uploading the file](https://shopify.dev/api/usage/bulk-operations/imports#generate-the-uploaded-url-and-parameters) again, and check that you've entered the URL correctly for the `stagedUploadPath` mutation argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_FILE_SERVER_ERROR", + "description": "There was a problem reading the JSONL file. This error might be intermittent, so you can try performing the same query again.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkMutationUserError", + "description": "Represents an error that happens during execution of a bulk mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BulkMutationErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkOperation", + "description": "An asynchronous long-running operation to fetch data in bulk or to bulk import data.\n\nBulk operations are created using the `bulkOperationRunQuery` or `bulkOperationRunMutation` mutation. After\nthey are created, clients should poll the `status` field for updates. When `COMPLETED`, the `url` field contains\na link to the data in [JSONL](http://jsonlines.org/) format.\n\nRefer to the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.\n", + "fields": [ + { + "name": "completedAt", + "description": "When the bulk operation was successfully completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "When the bulk operation was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorCode", + "description": "Error code for failed operations.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BulkOperationErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileSize", + "description": "File size in bytes of the file in the `url` field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "objectCount", + "description": "A running count of all the objects processed.\nFor example, when fetching all the products and their variants, this field counts both products and variants.\nThis field can be used to track operation progress.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partialDataUrl", + "description": "The URL that points to the partial or incomplete response data (in [JSONL](http://jsonlines.org/) format) that was returned by a failed operation.\nThe URL expires 7 days after the operation fails. Returns `null` when there's no data available.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "query", + "description": "GraphQL query document specified in `bulkOperationRunQuery`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rootObjectCount", + "description": "A running count of all the objects that are processed at the root of the query.\nFor example, when fetching all the products and their variants, this field only counts products.\nThis field can be used to track operation progress.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Status of the bulk operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BulkOperationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The bulk operation's type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BulkOperationType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL that points to the response data in [JSONL](http://jsonlines.org/) format.\nThe URL expires 7 days after the operation completes.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkOperationCancelPayload", + "description": "Return type for `bulkOperationCancel` mutation.", + "fields": [ + { + "name": "bulkOperation", + "description": "The bulk operation to be canceled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BulkOperation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BulkOperationErrorCode", + "description": "Error codes for failed bulk operations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCESS_DENIED", + "description": "The provided operation `query` returned access denied due to missing\n[access scopes](https://shopify.dev/api/usage/access-scopes).\nReview the requested object permissions and execute the query as a normal non-bulk GraphQL request to see more details.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_SERVER_ERROR", + "description": "The operation resulted in partial or incomplete data due to internal server errors during execution.\nThese errors might be intermittent, so you can try performing the same query again.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TIMEOUT", + "description": "The operation resulted in partial or incomplete data due to query timeouts during execution.\nIn some cases, timeouts can be avoided by modifying your `query` to select fewer fields.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkOperationRunMutationPayload", + "description": "Return type for `bulkOperationRunMutation` mutation.", + "fields": [ + { + "name": "bulkOperation", + "description": "The newly created bulk operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BulkOperation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BulkMutationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkOperationRunQueryPayload", + "description": "Return type for `bulkOperationRunQuery` mutation.", + "fields": [ + { + "name": "bulkOperation", + "description": "The newly created bulk operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BulkOperation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BulkOperationStatus", + "description": "The valid values for the status of a bulk operation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CANCELED", + "description": "The bulk operation has been canceled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELING", + "description": "Cancelation has been initiated on the bulk operation. There may be a short delay from when a cancelation\nstarts until the operation is actually canceled.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPLETED", + "description": "The bulk operation has successfully completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED", + "description": "The bulk operation has been created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The bulk operation URL has expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "The bulk operation has failed. For information on why the operation failed, use\n[BulkOperation.errorCode](https://shopify.dev/api/admin-graphql/latest/enums/bulkoperationerrorcode).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RUNNING", + "description": "The bulk operation is runnning.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BulkOperationType", + "description": "The valid values for the bulk operation's type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUERY", + "description": "The bulk operation is a query.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUTATION", + "description": "The bulk operation is a mutation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkProductResourceFeedbackCreatePayload", + "description": "Return type for `bulkProductResourceFeedbackCreate` mutation.", + "fields": [ + { + "name": "feedback", + "description": "The feedback that's created.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductResourceFeedback", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BulkProductResourceFeedbackCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BulkProductResourceFeedbackCreateUserError", + "description": "An error that occurs during the execution of `BulkProductResourceFeedbackCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BulkProductResourceFeedbackCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BulkProductResourceFeedbackCreateUserErrorCode", + "description": "Possible error codes that can be returned by `BulkProductResourceFeedbackCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MAXIMUM_FEEDBACK_LIMIT_EXCEEDED", + "description": "The operation was attempted on too many feedback objects. The maximum number of feedback objects that you can operate on is 50.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUTDATED_FEEDBACK", + "description": "The feedback for a later version of this resource was already accepted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_NOT_FOUND", + "description": "The product wasn't found or isn't available to the channel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BundlesFeature", + "description": "Represents the Bundles feature configuration for the shop.\n", + "fields": [ + { + "name": "eligibleForBundles", + "description": "Whether a shop is configured properly to sell bundles.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ineligibilityReason", + "description": "The reason why a shop is not eligible for bundles.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellsBundles", + "description": "Whether a shop has any fixed bundle products or has a cartTransform function installed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BusinessCustomerErrorCode", + "description": "Possible error codes that can be returned by `BusinessCustomerUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_NOT_FOUND", + "description": "The resource wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_DELETE", + "description": "Deleting the resource failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED", + "description": "Missing a required field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_INPUT", + "description": "The input is empty.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INPUT", + "description": "The input is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNEXPECTED_TYPE", + "description": "Unexpected type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The field value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIMIT_REACHED", + "description": "The number of resources exceeded the limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "description": "An error that happens during the execution of a business customer mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BusinessCustomerErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BuyerExperienceConfiguration", + "description": "Settings describing the behavior of checkout for a B2B buyer.", + "fields": [ + { + "name": "checkoutToDraft", + "description": "Whether to checkout to draft order for merchant review.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editableShippingAddress", + "description": "Whether to allow customers to use editable shipping addresses.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payNowOnly", + "description": "Whether a buyer must pay at checkout or they can also choose to pay\nlater using net terms.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsTemplate", + "description": "Represents the merchant configured payment terms.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentTermsTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BuyerExperienceConfigurationInput", + "description": "The input fields specifying the behavior of checkout for a B2B buyer.", + "fields": null, + "inputFields": [ + { + "name": "checkoutToDraft", + "description": "Whether to checkout to draft order for merchant review.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentTermsTemplateId", + "description": "Represents the merchant configured payment terms.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "editableShippingAddress", + "description": "Whether to allow customers to edit their shipping address at checkout.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedAutomaticDiscountApplication", + "description": "A discount that is automatically applied to an order that is being edited.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliedTo", + "description": "The level at which the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of discount application. Indicates the reason why the discount was applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDiscountAllocation", + "description": "An amount discounting the line that has been allocated by an associated discount application.\n", + "fields": [ + { + "name": "allocatedAmountSet", + "description": "The money amount that's allocated by the discount application in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplication", + "description": "The discount that the allocated amount originated from.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "description": "A [discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/discountapplication) involved in order editing that might be newly added or have new changes applied.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliedTo", + "description": "The level at which the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of discount application. Indicates the reason why the discount was applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CalculatedAutomaticDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDiscountCodeApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CalculatedManualDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CalculatedScriptDiscountApplication", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CalculatedDiscountApplicationConnection", + "description": "An auto-generated type for paginating through multiple CalculatedDiscountApplications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedDiscountApplicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CalculatedDiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDiscountApplicationEdge", + "description": "An auto-generated type which holds one CalculatedDiscountApplication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CalculatedDiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDiscountCodeApplication", + "description": "A discount code that is applied to an order that is being edited.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliedTo", + "description": "The level at which the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The string identifying the discount code that was used at the time of application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of discount application. Indicates the reason why the discount was applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDraftOrder", + "description": "The computed properties for a draft order.", + "fields": [ + { + "name": "appliedDiscount", + "description": "Order-level discount applied to the draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrderAppliedDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableShippingRates", + "description": "The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingRate", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddressMatchesShippingAddress", + "description": "Whether the billing address matches the shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency of the store for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "Customer who will be sent an invoice for the draft order, if there's one.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "Line items in the draft order with their computed properties.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedDraftOrderLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemsSubtotalPrice", + "description": "A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketName", + "description": "The name of the selected market.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketRegionCountryCode", + "description": "The selected market region country code for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "Phone number assigned to draft order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentCurrencyCode", + "description": "The payment currency of the customer for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchasingEntity", + "description": "The purchasing entity for the draft order.", + "args": [], + "type": { + "kind": "UNION", + "name": "PurchasingEntity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLine", + "description": "Line item that contains the shipping costs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPrice", + "description": "Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceSet", + "description": "Subtotal of the line items and their discounts (doesn't contain shipping charges or shipping discounts, or taxes).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "Total amount of taxes charged for each line item and shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountsSet", + "description": "Total discounts for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalLineItemsPriceSet", + "description": "Total price of line items for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPrice", + "description": "Total amount of the draft order (includes taxes, shipping charges, and discounts).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "Total amount of the draft order(includes taxes, shipping charges, and discounts).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPrice", + "description": "Total shipping charge for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPriceSet", + "description": "Total shipping charge for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTax", + "description": "Total amount of taxes for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxSet", + "description": "Total amount of taxes for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedDraftOrderLineItem", + "description": "The computed line items for a draft order.", + "fields": [ + { + "name": "appliedDiscount", + "description": "The discount applied to the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrderAppliedDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom", + "description": "Whether the line item is a custom line item (`true`) or a product variant line item (`false`).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributesV2", + "description": "Additional information (metafields) about the line item with the associated types.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TypedAttribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotal", + "description": "Total price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotalSet", + "description": "The total price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPrice", + "description": "The unit price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPriceSet", + "description": "Unit price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated with the draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isGiftCard", + "description": "Whether the line item represents the purchase of a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotal", + "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalSet", + "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPrice", + "description": "The variant price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPriceSet", + "description": "The variant price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product associated with the draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of variant items requested in the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The SKU number of the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product or variant. This field only applies to custom line items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscount", + "description": "The total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountSet", + "description": "The total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The variant associated with the draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The name of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who created the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The weight unit and value for a draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Weight", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "description": "A line item involved in order editing that may be newly added or have new changes applied.\n", + "fields": [ + { + "name": "calculatedDiscountAllocations", + "description": "The discounts that have been allocated onto the line item by discount applications.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated onto the line item by discount applications.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `calculatedDiscountAllocations` instead." + }, + { + "name": "discountedUnitPriceSet", + "description": "The price of a single quantity of the line item with line item discounts applied, in shop and presentment currencies. Discounts applied to the entire order aren't included in this price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editableQuantity", + "description": "The total number of items that can be edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editableQuantityBeforeChanges", + "description": "The editable quantity prior to any changes made in the current edit.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editableSubtotalSet", + "description": "The total price of editable lines in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasStagedLineItemDiscount", + "description": "Whether the calculated line item has a staged discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image object associated to the line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPriceSet", + "description": "The variant unit price in shop and presentment currencies, without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The total number of items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restockable", + "description": "Whether the line item can be restocked or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restocking", + "description": "Whether the changes on the line item will result in a restock.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The variant SKU number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stagedChanges", + "description": "A list of changes that affect this line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "OrderStagedChange", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uneditableSubtotalSet", + "description": "The total price of uneditable lines in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant associated with this line item. The value is null for custom line items and items where\nthe variant has been deleted.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The title of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedLineItemConnection", + "description": "An auto-generated type for paginating through multiple CalculatedLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CalculatedLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedLineItemEdge", + "description": "An auto-generated type which holds one CalculatedLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CalculatedLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedManualDiscountApplication", + "description": "Represents a discount that was manually created for an order that is being edited.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliedTo", + "description": "The level at which the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of discount application. Indicates the reason why the discount was applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedOrder", + "description": "An order with edits applied but not saved.\n", + "fields": [ + { + "name": "addedDiscountApplications", + "description": "Returns only the new discount applications being added to the order in the current edit.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedDiscountApplicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addedLineItems", + "description": "Returns only the new line items being added to the order during the current edit.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartDiscountAmountSet", + "description": "Amount of the order-level discount (doesn't contain any line item discounts) in shop and presentment currencies.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "committed", + "description": "Whether the changes have been applied and saved to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "Returns all items on the order that existed before starting the edit.\nWill include any changes that have been made.\nWill not include line items added during the current edit.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `editable`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CalculatedLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notificationPreviewHtml", + "description": "The HTML of the customer notification for the order edit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notificationPreviewTitle", + "description": "The customer notification title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order without any changes applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalOrder` instead." + }, + { + "name": "originalOrder", + "description": "The order without any changes applied.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stagedChanges", + "description": "List of changes made to the order during the current edit.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderStagedChangeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalLineItemsQuantity", + "description": "The sum of the quantities for the line items that contribute to the order's subtotal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceSet", + "description": "The subtotal of the line items, in shop and presentment currencies, after all the discounts are applied. The subtotal doesn't include shipping. The subtotal includes taxes for taxes-included orders and excludes taxes for taxes-excluded orders.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "Taxes charged for the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalOutstandingSet", + "description": "Total price of the order less the total amount received from the customer in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "Total amount of the order (includes taxes and discounts) in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CalculatedScriptDiscountApplication", + "description": "A discount created by a Shopify script for an order that is being edited.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliedTo", + "description": "The level at which the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of discount application. Indicates the reason why the discount was applied.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CalculatedDiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CardPaymentDetails", + "description": "Card payment details related to a transaction.", + "fields": [ + { + "name": "avsResultCode", + "description": "The response code from the address verification system (AVS). The code is always a single letter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bin", + "description": "The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The name of the company that issued the customer's credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cvvResultCode", + "description": "The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expirationMonth", + "description": "The month in which the used credit card expires.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expirationYear", + "description": "The year in which the used credit card expires.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The holder of the credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The customer's credit card number, with most of the leading digits redacted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wallet", + "description": "Digital wallet used for the payment.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DigitalWallet", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransform", + "description": "A Cart Transform Function to create [Customized Bundles.](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle).\n", + "fields": [ + { + "name": "functionId", + "description": "The ID for the Cart Transform function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformConnection", + "description": "An auto-generated type for paginating through multiple CartTransforms.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransformEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CartTransformEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransform", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformCreatePayload", + "description": "Return type for `cartTransformCreate` mutation.", + "fields": [ + { + "name": "cartTransform", + "description": "The newly created cart transform function.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartTransform", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransformCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformCreateUserError", + "description": "An error that occurs during the execution of `CartTransformCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CartTransformCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartTransformCreateUserErrorCode", + "description": "Possible error codes that can be returned by `CartTransformCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INPUT_INVALID", + "description": "Failed to create cart transform due to invalid input.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_NOT_FOUND", + "description": "No Shopify Function found for provided function_id.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_ALREADY_REGISTERED", + "description": "A cart transform function already exists for the provided function_id.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_DOES_NOT_IMPLEMENT", + "description": "Function does not implement the required interface for this cart_transform function.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformDeletePayload", + "description": "Return type for `cartTransformDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The globally-unique ID for the deleted cart transform.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransformDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformDeleteUserError", + "description": "An error that occurs during the execution of `CartTransformDelete`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CartTransformDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartTransformDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `CartTransformDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "Could not find cart transform for provided id.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAUTHORIZED_APP_SCOPE", + "description": "Unauthorized app scope.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartTransformEdge", + "description": "An auto-generated type which holds one CartTransform and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CartTransformEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransform", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Catalog", + "description": "A list of products with publishing and pricing information.\nA catalog can be associated with a specific context, such as a [`Market`](https://shopify.dev/api/admin-graphql/current/objects/market), [`CompanyLocation`](https://shopify.dev/api/admin-graphql/current/objects/companylocation), or [`App`](https://shopify.dev/api/admin-graphql/current/objects/app).\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operations", + "description": "Most recent catalog operations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The price list associated with the catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "A group of products and collections that's published to a catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppCatalog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationCatalog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketCatalog", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CatalogConnection", + "description": "An auto-generated type for paginating through multiple Catalogs.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CatalogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total count of Catalogs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CatalogContextInput", + "description": "The input fields for the context in which the catalog's publishing and pricing rules apply.", + "fields": null, + "inputFields": [ + { + "name": "companyLocationIds", + "description": "The IDs of the company locations to associate to the catalog.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogContextUpdatePayload", + "description": "Return type for `catalogContextUpdate` mutation.", + "fields": [ + { + "name": "catalog", + "description": "The updated catalog.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CatalogCreateInput", + "description": "The input fields required to create a catalog.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The name of the catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "context", + "description": "The context associated with the catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CatalogContextInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "priceListId", + "description": "The ID of the price list to associate to the catalog.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "publicationId", + "description": "The ID of the publication to associate to the catalog.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogCreatePayload", + "description": "Return type for `catalogCreate` mutation.", + "fields": [ + { + "name": "catalog", + "description": "The newly created catalog.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogCsvOperation", + "description": "A catalog csv operation represents a CSV file import.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedRowCount", + "description": "The count of processed rows, summing imported, failed, and skipped rows.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rowCount", + "description": "Represents a rows objects within this background operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RowCount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceOperationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogDeletePayload", + "description": "Return type for `catalogDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted catalog.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogEdge", + "description": "An auto-generated type which holds one Catalog and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CatalogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogSortKeys", + "description": "The set of valid sort keys for the Catalog query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogStatus", + "description": "The state of a catalog.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The catalog is active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARCHIVED", + "description": "The catalog is archived.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT", + "description": "The catalog is in draft.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogType", + "description": "The associated catalog's type.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NONE", + "description": "Not associated to a catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP", + "description": "Catalogs belonging to apps.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATION", + "description": "Catalogs belonging to company locations.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET", + "description": "Catalogs belonging to markets.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CatalogUpdateInput", + "description": "The input fields used to update a catalog.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The name of the catalog.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "type": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "context", + "description": "The context associated with the catalog.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CatalogContextInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "priceListId", + "description": "The ID of the price list to associate to the catalog.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "publicationId", + "description": "The ID of the publication to associate to the catalog.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogUpdatePayload", + "description": "Return type for `catalogUpdate` mutation.", + "fields": [ + { + "name": "catalog", + "description": "The updated catalog.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CatalogUserError", + "description": "Defines errors encountered while managing a catalog.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CatalogUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CatalogUserErrorCode", + "description": "Possible error codes that can be returned by `CatalogUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APP_CATALOG_PRICE_LIST_ASSIGNMENT", + "description": "An app catalog cannot be assigned to a price list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_FAILED_TO_SAVE", + "description": "Catalog failed to save.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_NOT_FOUND", + "description": "The catalog wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET", + "description": "A price list cannot be assigned to the primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", + "description": "Quantity rules can be associated only with company location catalogs.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_ADD_MORE_THAN_ONE_MARKET", + "description": "The catalog can't be associated with more than one market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATION_CATALOG_STATUS_PLAN", + "description": "A company location catalog outside of a supported plan can only have an archived status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_ALREADY_ASSIGNED_TO_CATALOG", + "description": "Context driver already assigned to this catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_CATALOG_LIMIT_REACHED", + "description": "Cannot save the catalog because the catalog limit for the context was reached.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATION_NOT_FOUND", + "description": "The company location could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_DRIVER_MISMATCH", + "description": "The arguments `contextsToAdd` and `contextsToRemove` must match existing catalog context type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COUNTRY_PRICE_LIST_ASSIGNMENT", + "description": "A country price list cannot be assigned to a catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CATALOG_CONTEXT_TYPE", + "description": "The catalog context type is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_CATALOG_STATUS", + "description": "A market catalog must have an active status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_NOT_FOUND", + "description": "Market not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH", + "description": "The catalog's market and price list currencies do not match.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_TAKEN", + "description": "Market already belongs to another catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUST_PROVIDE_EXACTLY_ONE_CONTEXT_TYPE", + "description": "Must provide exactly one context type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_FAILED_TO_SAVE", + "description": "Price list failed to save.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_NOT_FOUND", + "description": "Price list not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_LOCKED", + "description": "The price list is currently being modified. Please try again later.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLICATION_NOT_FOUND", + "description": "Publication not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRES_CONTEXTS_TO_ADD_OR_REMOVE", + "description": "Must have `contexts_to_add` or `contexts_to_remove` argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_CATALOG_ACTION", + "description": "Can't perform this action on a catalog of this type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_CREATE_APP_CATALOG", + "description": "Cannot create a catalog for an app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_APP_CATALOG", + "description": "Cannot modify a catalog for an app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_APP_CATALOG", + "description": "Cannot delete a catalog for an app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_CREATE_MARKET_CATALOG", + "description": "Cannot create a catalog for a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_MARKET_CATALOG", + "description": "Cannot modify a catalog for a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_MARKET_CATALOG", + "description": "Cannot delete a catalog for a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Channel", + "description": "A channel represents an app where you sell a group of products and collections.\nA channel can be a platform or marketplace such as Facebook or Pinterest, an online store, or POS.\n", + "fields": [ + { + "name": "app", + "description": "The underlying app used by the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionPublicationsV3", + "description": "The collection publications for the list of collections published to the channel.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collections", + "description": "The list of collections published to the channel.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique identifier for the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `id` instead." + }, + { + "name": "hasCollection", + "description": "Whether the collection is available to the channel.", + "args": [ + { + "name": "id", + "description": "The collection ID to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "navigationItems", + "description": "The menu items for the channel, which also appear as submenu items in the left navigation sidebar in the Shopify admin.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NavigationItem", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use [AppInstallation.navigationItems](\n https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-navigationitems) instead." + }, + { + "name": "overviewPath", + "description": "Home page for the channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use [AppInstallation.launchUrl](\n https://shopify.dev/api/admin-graphql/current/objects/AppInstallation#field-appinstallation-launchurl) instead." + }, + { + "name": "productPublications", + "description": "The product publications for the products published to the channel.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublicationConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `productPublicationsV3` instead." + }, + { + "name": "productPublicationsV3", + "description": "The product publications for the list of products published to the channel.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products published to the channel.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportsFuturePublishing", + "description": "Whether the channel supports future publishing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ChannelConnection", + "description": "An auto-generated type for paginating through multiple Channels.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ChannelEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ChannelDefinition", + "description": "A channel definition represents channels surfaces on the platform.\nA channel definition can be a platform or a subsegment of it such as Facebook Home, Instagram Live, Instagram Shops, or WhatsApp chat.\n", + "fields": [ + { + "name": "channelName", + "description": "Name of the channel that this sub channel belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "Unique string used as a public identifier for the channel definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the channel definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isMarketplace", + "description": "Whether this channel definition represents a marketplace.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subChannelName", + "description": "Name of the sub channel (e.g. Online Store, Instagram Shopping, TikTok Live).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "svgIcon", + "description": "Icon displayed when showing the channel in admin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ChannelEdge", + "description": "An auto-generated type which holds one Channel and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ChannelEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ChannelInformation", + "description": "Contains the information for a given sales channel.\n", + "fields": [ + { + "name": "app", + "description": "The app associated with the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channelDefinition", + "description": "The channel definition associated with the channel.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ChannelDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channelId", + "description": "The unique ID for the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProfile", + "description": "A checkout profile defines the branding settings and the UI extensions for a store's checkout. A checkout profile could be published or draft. A store might have at most one published checkout profile, which is used to render their live checkout. The store could also have multiple draft profiles that were created, previewed, and published using the admin checkout editor.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the checkout profile was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editedAt", + "description": "The date and time when the checkout profile was last edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPublished", + "description": "Whether the checkout profile is published or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The profile name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the checkout profile was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProfileConnection", + "description": "An auto-generated type for paginating through multiple CheckoutProfiles.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProfileEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CheckoutProfileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProfile", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProfileEdge", + "description": "An auto-generated type which holds one CheckoutProfile and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CheckoutProfileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProfile", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CheckoutProfileSortKeys", + "description": "The set of valid sort keys for the CheckoutProfile query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EDITED_AT", + "description": "Sort by the `edited_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS_PUBLISHED", + "description": "Sort by the `is_published` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CodeDiscountSortKeys", + "description": "The set of valid sort keys for the CodeDiscount query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STARTS_AT", + "description": "Sort by the `starts_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENDS_AT", + "description": "Sort by the `ends_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "description": "Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.\n\nCollections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.\n\nCollections can also be created for a custom group of products. These are called custom or manual collections.\n", + "fields": [ + { + "name": "availablePublicationCount", + "description": "The number of publications a resource is published to without feedback errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.\n", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "descriptionHtml", + "description": "The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "feedback", + "description": "Information about the collection that's provided through resource feedback.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ResourceFeedback", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`.\n\nIf the title is changed, the handle doesn't automatically change.\n\nThe handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasProduct", + "description": "Whether the collection includes the specified product.", + "args": [ + { + "name": "id", + "description": "The ID of the product to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated with the collection.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "products", + "description": "The products that are included in the collection.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductCollectionSortKeys", + "ofType": null + }, + "defaultValue": "COLLECTION_DEFAULT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productsCount", + "description": "The number of products in the collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationCount", + "description": "The number of publications a resource is published on.", + "args": [ + { + "name": "onlyPublished", + "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publications", + "description": "The channels where the collection is published.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether or not to return only the collection publications that are published.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionPublicationConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `resourcePublications` instead." + }, + { + "name": "publishedOnChannel", + "description": "Check to see whether the resource is published to a given channel.", + "args": [ + { + "name": "channelId", + "description": "The ID of the channel to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnPublication` instead." + }, + { + "name": "publishedOnCurrentChannel", + "description": "Check to see whether the resource is published to the calling app's channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnCurrentPublication` instead." + }, + { + "name": "publishedOnCurrentPublication", + "description": "Check to see whether the resource is published to the calling app's publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedOnPublication", + "description": "Check to see whether the resource is published to a given publication.", + "args": [ + { + "name": "publicationId", + "description": "The ID of the publication to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublications", + "description": "The list of resources that are published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublicationsV2", + "description": "The list of resources that are either published or staged to be published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "catalogType", + "description": "Filter publications by catalog type.", + "type": { + "kind": "ENUM", + "name": "CatalogType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2Connection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ruleSet", + "description": "For a smart (automated) collection, specifies the rules that determine whether a product is included.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CollectionRuleSet", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "If the default SEO fields for page title and description have been modified, contains the modified information.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sortOrder", + "description": "The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionSortOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontId", + "description": "The Storefront GraphQL API ID of the `Collection`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "StorefrontID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `id` instead." + }, + { + "name": "templateSuffix", + "description": "The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unpublishedChannels", + "description": "The list of channels that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unpublishedPublications` instead." + }, + { + "name": "unpublishedPublications", + "description": "The list of publications that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionAddProductsPayload", + "description": "Return type for `collectionAddProducts` mutation.", + "fields": [ + { + "name": "collection", + "description": "The updated collection. Returns `null` if an error is raised.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionAddProductsV2Payload", + "description": "Return type for `collectionAddProductsV2` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job adding the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionAddProductsV2UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionAddProductsV2UserError", + "description": "An error that occurs during the execution of `CollectionAddProductsV2`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CollectionAddProductsV2UserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionAddProductsV2UserErrorCode", + "description": "Possible error codes that can be returned by `CollectionAddProductsV2UserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CANT_ADD_TO_SMART_COLLECTION", + "description": "Can't manually add products to a smart collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_DOES_NOT_EXIST", + "description": "Collection doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionConnection", + "description": "An auto-generated type for paginating through multiple Collections.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CollectionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionCreatePayload", + "description": "Return type for `collectionCreate` mutation.", + "fields": [ + { + "name": "collection", + "description": "The collection that has been created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionDeleteInput", + "description": "The input fields for specifying the collection to delete.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the collection to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionDeletePayload", + "description": "Return type for `collectionDelete` mutation.", + "fields": [ + { + "name": "deletedCollectionId", + "description": "The ID of the collection that was deleted. Returns `null` if the collection doesn't exist.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionEdge", + "description": "An auto-generated type which holds one Collection and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CollectionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionInput", + "description": "The input fields required to create a collection.", + "fields": null, + "inputFields": [ + { + "name": "descriptionHtml", + "description": "The description of the collection, in HTML format.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "A unique human-friendly string for the collection. Automatically generated from the collection's title.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "Specifies the collection to update or create a new collection if absent. Required for updating a collection.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "image", + "description": "The image associated with the collection.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ImageInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "products", + "description": "Initial list of collection products. Only valid with `collectionCreate` and without rules.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "ruleSet", + "description": "The rules used to assign products to the collection.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "CollectionRuleSetInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "templateSuffix", + "description": "The theme template used when viewing the collection in a store.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortOrder", + "description": "The order in which the collection's products are sorted.", + "type": { + "kind": "ENUM", + "name": "CollectionSortOrder", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the collection. Required for creating a new collection.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "The metafields to associate with the collection.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "seo", + "description": "SEO information for the collection.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SEOInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "redirectNewHandle", + "description": "Indicates whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionPublication", + "description": "Represents the publications where a collection is published.", + "fields": [ + { + "name": "channel", + "description": "The channel where the collection will be published.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publication` instead." + }, + { + "name": "collection", + "description": "The collection to be published on the publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPublished", + "description": "Whether the publication is published or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "The publication where the collection will be published.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishDate", + "description": "The date that the publication was or is going to be published.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionPublicationConnection", + "description": "An auto-generated type for paginating through multiple CollectionPublications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionPublicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CollectionPublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionPublication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionPublicationEdge", + "description": "An auto-generated type which holds one CollectionPublication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CollectionPublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionPublication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionPublicationInput", + "description": "The input fields for publications to which a collection will be published.", + "fields": null, + "inputFields": [ + { + "name": "publicationId", + "description": "The ID of the publication.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionPublishInput", + "description": "The input fields for specifying a collection to publish and the sales channels to publish it to.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The collection to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "collectionPublications", + "description": "The channels where the collection will be published.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionPublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionPublishPayload", + "description": "Return type for `collectionPublish` mutation.", + "fields": [ + { + "name": "collection", + "description": "The published collection.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionPublications", + "description": "The channels where the collection has been published.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionPublication", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRemoveProductsPayload", + "description": "Return type for `collectionRemoveProducts` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionReorderProductsPayload", + "description": "Return type for `collectionReorderProducts` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job reordering the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRule", + "description": "Represents at rule that's used to assign products to a collection.", + "fields": [ + { + "name": "column", + "description": "The attribute that the rule focuses on. For example, `title` or `product_type`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleColumn", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "condition", + "description": "The value that the operator is applied to. For example, `Hats`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "conditionObject", + "description": "The value that the operator is applied to.", + "args": [], + "type": { + "kind": "UNION", + "name": "CollectionRuleConditionObject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "relation", + "description": "The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleRelation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionRuleColumn", + "description": "Specifies the attribute of a product being used to populate the smart collection.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAG", + "description": "The [`tag`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "The [`title`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-title) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE", + "description": "The [`type`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-producttype) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TAXONOMY_NODE_ID", + "description": "The [`product_taxonomy_node_id`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-productcategory) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VENDOR", + "description": "The [`vendor`](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-product-vendor) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_PRICE", + "description": "The [`variant_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-price) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS_PRICE_REDUCED", + "description": "An attribute evaluated based on the `compare_at_price` attribute of the product's variants.\nWith `is_set` relation, the rule matches products with at least one variant with `compare_at_price` set.\nWith `is_not_set` relation, the rule matches matches products with at least one variant with `compare_at_price` not set.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_COMPARE_AT_PRICE", + "description": "The [`variant_compare_at_price`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-compareatprice) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_WEIGHT", + "description": "The [`variant_weight`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-weight) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_INVENTORY", + "description": "The [`variant_inventory`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryquantity) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_TITLE", + "description": "The [`variant_title`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-title) attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_METAFIELD_DEFINITION", + "description": "This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_METAFIELD_DEFINITION", + "description": "This category includes metafield definitions that have the `useAsCollectionCondition` flag set to true.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CollectionRuleConditionObject", + "description": "Specifies object for the condition of the rule.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CollectionRuleMetafieldCondition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleProductCategoryCondition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleTextCondition", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CollectionRuleConditions", + "description": "This object defines all columns and allowed relations that can be used in rules for smart collections to automatically include the matching products.", + "fields": [ + { + "name": "allowedRelations", + "description": "Allowed relations of the rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleRelation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultRelation", + "description": "Most commonly used relation for this rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleRelation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ruleObject", + "description": "Additional attributes defining the rule.", + "args": [], + "type": { + "kind": "UNION", + "name": "CollectionRuleConditionsRuleObject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ruleType", + "description": "Type of the rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleColumn", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CollectionRuleConditionsRuleObject", + "description": "Specifies object with additional rule attributes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CollectionRuleMetafieldCondition", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionRuleInput", + "description": "The input fields for a rule to associate with a collection.", + "fields": null, + "inputFields": [ + { + "name": "column", + "description": "The attribute that the rule focuses on. For example, `title` or `product_type`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleColumn", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "relation", + "description": "The type of operator that the rule is based on. For example, `equals`, `contains`, or `not_equals`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CollectionRuleRelation", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "condition", + "description": "The value that the operator is applied to. For example, `Hats`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "conditionObjectId", + "description": "The object ID that points to additional attributes for the collection rule.\nThis is only required when using metafield definition rules.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleMetafieldCondition", + "description": "Identifies a metafield definition used as a rule for the smart collection.", + "fields": [ + { + "name": "metafieldDefinition", + "description": "The metafield definition associated with the condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleProductCategoryCondition", + "description": "Specifies the condition for a Product Category field.", + "fields": [ + { + "name": "value", + "description": "The value of the condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductTaxonomyNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionRuleRelation", + "description": "Specifies the relationship between the `column` and the `condition`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CONTAINS", + "description": "The attribute contains the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENDS_WITH", + "description": "The attribute ends with the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EQUALS", + "description": "The attribute is equal to the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The attribute is greater than the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS_NOT_SET", + "description": "The attribute is not set (equal to `null`).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS_SET", + "description": "The attribute is set (not equal to `null`).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The attribute is less than the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_CONTAINS", + "description": "The attribute does not contain the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_EQUALS", + "description": "The attribute does not equal the condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STARTS_WITH", + "description": "The attribute starts with the condition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleSet", + "description": "The set of rules that are used to determine which products are included in the collection.", + "fields": [ + { + "name": "appliedDisjunctively", + "description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match at least one of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rules", + "description": "The rules used to assign products to the collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionRule", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionRuleSetInput", + "description": "The input fields for a rule set of the collection.", + "fields": null, + "inputFields": [ + { + "name": "appliedDisjunctively", + "description": "Whether products must match any or all of the rules to be included in the collection.\nIf true, then products must match at least one of the rules to be included in the collection.\nIf false, then products must match all of the rules to be included in the collection.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "rules", + "description": "The rules used to assign products to the collection.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionRuleInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionRuleTextCondition", + "description": "Specifies the condition for a text field.", + "fields": [ + { + "name": "value", + "description": "The value of the condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionSortKeys", + "description": "The set of valid sort keys for the Collection query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionSortOrder", + "description": "Specifies the sort order for the products in the collection.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALPHA_ASC", + "description": "Alphabetically, in ascending order (A - Z).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALPHA_DESC", + "description": "Alphabetically, in descending order (Z - A).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BEST_SELLING", + "description": "By best-selling products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED", + "description": "By date created, in ascending order (oldest - newest).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_DESC", + "description": "By date created, in descending order (newest - oldest).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "In the order set manually by the merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_ASC", + "description": "By price, in ascending order (lowest - highest).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_DESC", + "description": "By price, in descending order (highest - lowest).", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CollectionUnpublishInput", + "description": "The input fields for specifying the collection to unpublish and the sales channels to remove it from.\n", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The collection to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "collectionPublications", + "description": "The channels where the collection is published.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionPublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionUnpublishPayload", + "description": "Return type for `collectionUnpublish` mutation.", + "fields": [ + { + "name": "collection", + "description": "The collection that has been unpublished.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionUpdatePayload", + "description": "Return type for `collectionUpdate` mutation.", + "fields": [ + { + "name": "collection", + "description": "The updated collection.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job", + "description": "The asynchronous job updating the products based on the new rule set.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CommentEvent", + "description": "Comment events are generated by staff members of a shop.\nThey are created when a staff member adds a comment to the timeline of an order, draft order, customer, or transfer.\n", + "fields": [ + { + "name": "appTitle", + "description": "The name of the app that created the event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attachments", + "description": "The attachments associated with the comment event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CommentEventAttachment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToApp", + "description": "Whether the event was created by an app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToUser", + "description": "Whether the event was caused by an admin user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "author", + "description": "The name of the user that authored the comment event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canDelete", + "description": "Whether the comment event can be deleted. If true, then the comment event can be deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canEdit", + "description": "Whether the comment event can be edited. If true, then the comment event can be edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the event was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "criticalAlert", + "description": "Whether the event is critical.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "edited", + "description": "Whether the comment event has been edited. If true, then the comment event has been edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "embed", + "description": "The object reference associated with the comment event. For example, a product or discount).", + "args": [], + "type": { + "kind": "UNION", + "name": "CommentEventEmbed", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human readable text that describes the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rawMessage", + "description": "The raw body of the comment event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subject", + "description": "The parent subject to which the comment event belongs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Event", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CommentEventAttachment", + "description": "A file attachment associated to a comment event.", + "fields": [ + { + "name": "fileExtension", + "description": "The file extension of the comment event attachment, indicating the file format.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image attached to the comment event.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The filename of the comment event attachment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "size", + "description": "The size of the attachment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the attachment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CommentEventEmbed", + "description": "The main embed of a comment event.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "description": "The subject line of a comment event.", + "fields": [ + { + "name": "hasTimelineComment", + "description": "Whether the timeline subject has a timeline comment. If true, then a timeline comment exists.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CompaniesDeletePayload", + "description": "Return type for `companiesDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyIds", + "description": "A list of IDs of the deleted companies.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Company", + "description": "Represents information about a company which is also a customer of the shop.", + "fields": [ + { + "name": "contactCount", + "description": "The number of contacts that belong to the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contactRoles", + "description": "The list of roles for the company contacts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyContactRoleSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contacts", + "description": "The list of contacts in the company.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyContactSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_id`\n - `company_location_id`\n - `created_at`\n - `email`\n - `location_name`\n - `name`\n - `role_name`\n - `status`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSince", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company became the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultRole", + "description": "The role proposed by default for a contact at the company.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "The list of the company's draft orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `source`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "externalId", + "description": "A unique externally-supplied ID for the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Whether the merchant added a timeline comment to the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lifetimeDuration", + "description": "The lifetime duration of the company, since it became a customer of the shop. Examples: `2 days`, `3 months`, `1 year`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationCount", + "description": "The number of locations that belong to the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "The list of locations in the company.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyLocationSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_id`\n - `created_at`\n - `external_id`\n - `ids`\n - `name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mainContact", + "description": "The main contact for the company.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note about the company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCount", + "description": "The total number of orders placed for this company, across all its locations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The list of the company's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "totalSpent", + "description": "The total amount spent by this company, across all its locations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAddress", + "description": "Represents a billing or shipping address for a company location.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyName", + "description": "The name of the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\nFor example, US.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedAddress", + "description": "The formatted version of the address.", + "args": [ + { + "name": "withName", + "description": "Whether to include the recipient's name in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "withCompanyName", + "description": "Whether to include the company name in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedArea", + "description": "A comma-separated list of the values for city, province, and country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recipient", + "description": "The identity of the recipient e.g. 'Receiving Department'.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company address was last updated.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zoneCode", + "description": "The two-letter code for the region.\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAddressDeletePayload", + "description": "Return type for `companyAddressDelete` mutation.", + "fields": [ + { + "name": "deletedAddressId", + "description": "The ID of the deleted address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyAddressInput", + "description": "The input fields to create or update the address of a company location.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recipient", + "description": "The identity of the recipient e.g. 'Receiving Department'.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "A phone number for the recipient. Formatted using E.164 standard. For example, _+16135551111_.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zoneCode", + "description": "The two-letter code ([ISO 3166-2 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-2) format) for the region of the address, such as the province, state, or district. For example, `ON` for Ontario, Canada.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The two-letter code ([ISO 3166-1 alpha-2]](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format) for the country of the address. For example, `US`` for the United States.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyAddressType", + "description": "The valid values for the address type of a company.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BILLING", + "description": "The address is a billing address.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING", + "description": "The address is a shipping address.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAssignCustomerAsContactPayload", + "description": "Return type for `companyAssignCustomerAsContact` mutation.", + "fields": [ + { + "name": "companyContact", + "description": "The created company contact.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyAssignMainContactPayload", + "description": "Return type for `companyAssignMainContact` mutation.", + "fields": [ + { + "name": "company", + "description": "The company for which the main contact is assigned.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyConnection", + "description": "An auto-generated type for paginating through multiple Companies.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CompanyEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContact", + "description": "A person that acts on behalf of company associated to [a customer](https://shopify.dev/api/admin-graphql/latest/objects/customer).", + "fields": [ + { + "name": "company", + "description": "The company to which the contact belongs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was created at Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer associated to this contact.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "The list of draft orders for the company contact.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `source`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isMainContact", + "description": "Whether the contact is the main contact of the company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lifetimeDuration", + "description": "The lifetime duration of the company contact, since its creation date on Shopify. Examples: `1 year`, `2 months`, `3 days`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "The company contact's locale (language).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The list of orders for the company contact.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "roleAssignments", + "description": "The list of roles assigned to this company contact.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyContactRoleAssignmentSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_contact_id`\n - `company_contact_role_id`\n - `company_id`\n - `company_location_id`\n - `created_at`\n - `location_name`\n - `role_name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignmentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The company contact's job title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactAssignRolePayload", + "description": "Return type for `companyContactAssignRole` mutation.", + "fields": [ + { + "name": "companyContactRoleAssignment", + "description": "The company contact role assignment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactAssignRolesPayload", + "description": "Return type for `companyContactAssignRoles` mutation.", + "fields": [ + { + "name": "roleAssignments", + "description": "A list of newly created assignments of company contacts to a company location.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactConnection", + "description": "An auto-generated type for paginating through multiple CompanyContacts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CompanyContactEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactCreatePayload", + "description": "Return type for `companyContactCreate` mutation.", + "fields": [ + { + "name": "companyContact", + "description": "The created company contact.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactDeletePayload", + "description": "Return type for `companyContactDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyContactId", + "description": "The ID of the deleted company contact.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactEdge", + "description": "An auto-generated type which holds one CompanyContact and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CompanyContactEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyContactInput", + "description": "The input fields for company contact attributes when creating or updating a company contact.", + "fields": null, + "inputFields": [ + { + "name": "firstName", + "description": "The company contact's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The company contact's last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The unique email address of the company contact.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the company contact.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locale", + "description": "The contact's locale.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the company contact.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRemoveFromCompanyPayload", + "description": "Return type for `companyContactRemoveFromCompany` mutation.", + "fields": [ + { + "name": "removedCompanyContactId", + "description": "The ID of the removed company contact.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRevokeRolePayload", + "description": "Return type for `companyContactRevokeRole` mutation.", + "fields": [ + { + "name": "revokedCompanyContactRoleAssignmentId", + "description": "The role assignment that was revoked.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRevokeRolesPayload", + "description": "Return type for `companyContactRevokeRoles` mutation.", + "fields": [ + { + "name": "revokedRoleAssignmentIds", + "description": "A list of role assignment IDs that were removed from the company contact.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRole", + "description": "The role for a [company contact](https://shopify.dev/api/admin-graphql/latest/objects/companycontact).", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of a role.\nFor example, `admin` or `buyer`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note for the role.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyContactRoleAssign", + "description": "The input fields for the role and location to assign to a company contact.\n", + "fields": null, + "inputFields": [ + { + "name": "companyContactRoleId", + "description": "The role ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyLocationId", + "description": "The location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "description": "The CompanyContactRoleAssignment describes the company and location associated to a company contact's role.", + "fields": [ + { + "name": "company", + "description": "The company this role assignment belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContact", + "description": "The company contact for whom this role is assigned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocation", + "description": "The company location to which the role is assigned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "role", + "description": "The role that's assigned to the company contact.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the assignment record was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignmentConnection", + "description": "An auto-generated type for paginating through multiple CompanyContactRoleAssignments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignmentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CompanyContactRoleAssignmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignmentEdge", + "description": "An auto-generated type which holds one CompanyContactRoleAssignment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CompanyContactRoleAssignmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyContactRoleAssignmentSortKeys", + "description": "The set of valid sort keys for the CompanyContactRoleAssignment query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_NAME", + "description": "Sort by the `location_name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleConnection", + "description": "An auto-generated type for paginating through multiple CompanyContactRoles.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CompanyContactRoleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleEdge", + "description": "An auto-generated type which holds one CompanyContactRole and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CompanyContactRoleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyContactRoleSortKeys", + "description": "The set of valid sort keys for the CompanyContactRole query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactSendWelcomeEmailPayload", + "description": "Return type for `companyContactSendWelcomeEmail` mutation.", + "fields": [ + { + "name": "companyContact", + "description": "The company contact to whom a welcome email was sent.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyContactSortKeys", + "description": "The set of valid sort keys for the CompanyContact query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_ID", + "description": "Sort by the `company_id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMAIL", + "description": "Sort by the `email` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME_EMAIL", + "description": "Sort by the `name_email` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactUpdatePayload", + "description": "Return type for `companyContactUpdate` mutation.", + "fields": [ + { + "name": "companyContact", + "description": "The updated company contact.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactsDeletePayload", + "description": "Return type for `companyContactsDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyContactIds", + "description": "The list of IDs of the deleted company contacts.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "description": "The input fields and values for creating a company and its associated resources.\n", + "fields": null, + "inputFields": [ + { + "name": "company", + "description": "The attributes for the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContact", + "description": "The attributes for the company contact.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyContactInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "companyLocation", + "description": "The attributes for the company location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyCreatePayload", + "description": "Return type for `companyCreate` mutation.", + "fields": [ + { + "name": "company", + "description": "The created company.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyDeletePayload", + "description": "Return type for `companyDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyId", + "description": "The ID of the deleted company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyEdge", + "description": "An auto-generated type which holds one Company and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CompanyEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyInput", + "description": "The input fields for company attributes when creating or updating a company.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A note about the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "externalId", + "description": "A unique externally-supplied ID for the company.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSince", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at\n which the company became the customer.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "description": "A location or branch of a [company that's a customer](https://shopify.dev/api/admin-graphql/latest/objects/company) of the shop. Configuration of B2B relationship, for example prices lists and checkout settings, may be done for a location.", + "fields": [ + { + "name": "billingAddress", + "description": "The address used as billing address for the location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyerExperienceConfiguration", + "description": "The configuration for the buyer's B2B checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BuyerExperienceConfiguration", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogs", + "description": "The list of catalogs associated with the company location.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company that the company location belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "The location's currency based on the shipping address. If the shipping address is empty, then the value is the shop's primary market.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "The list of draft orders for the company location.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `source`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "externalId", + "description": "A unique externally-supplied ID for the company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Whether the merchant added a timeline comment to the company location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inCatalog", + "description": "Whether the company location is assigned a specific catalog.", + "args": [ + { + "name": "catalogId", + "description": "The ID of the catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "The preferred locale of the company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market that includes the location's shipping address. If the shipping address is empty, then the value is the shop's primary market.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the company location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note about the company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCount", + "description": "The total number of orders placed for the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The list of orders for the company location.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "roleAssignments", + "description": "The list of roles assigned to the company location.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyContactRoleAssignmentSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_contact_id`\n - `company_contact_role_id`\n - `company_id`\n - `company_location_id`\n - `created_at`\n - `location_name`\n - `role_name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignmentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The address used as shipping address for the location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions applied to the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxRegistrationId", + "description": "The tax registration ID for the company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSpent", + "description": "The total amount spent by the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationAssignAddressPayload", + "description": "Return type for `companyLocationAssignAddress` mutation.", + "fields": [ + { + "name": "addresses", + "description": "The list of updated addresses on the company location.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyAddress", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationAssignRolesPayload", + "description": "Return type for `companyLocationAssignRoles` mutation.", + "fields": [ + { + "name": "roleAssignments", + "description": "A list of newly created assignments of company contacts to a company location.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationAssignTaxExemptionsPayload", + "description": "Return type for `companyLocationAssignTaxExemptions` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The updated company location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationCatalog", + "description": "A list of products with publishing and pricing information associated with company locations.\n", + "fields": [ + { + "name": "companyLocations", + "description": "The company locations associated with the catalog.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyLocationSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_id`\n - `created_at`\n - `external_id`\n - `ids`\n - `name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationsCount", + "description": "The number of company locations associated with the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operations", + "description": "Most recent catalog operations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The price list associated with the catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "A group of products and collections that's published to a catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationConnection", + "description": "An auto-generated type for paginating through multiple CompanyLocations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CompanyLocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationCreatePayload", + "description": "Return type for `companyLocationCreate` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The created company location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationCreateTaxRegistrationPayload", + "description": "Return type for `companyLocationCreateTaxRegistration` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The company location with the created tax registration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationDeletePayload", + "description": "Return type for `companyLocationDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyLocationId", + "description": "The ID of the deleted company location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationEdge", + "description": "An auto-generated type which holds one CompanyLocation and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CompanyLocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationInput", + "description": "The input fields for company location when creating or updating a company location.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locale", + "description": "The preferred locale of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "externalId", + "description": "A unique externally-supplied ID for the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A note about the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "buyerExperienceConfiguration", + "description": "The configuration for the buyer's checkout at the company location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "BuyerExperienceConfigurationInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The input fields to create or update the billing address for a company location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingAddress", + "description": "The input fields to create or update the shipping address for a company location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CompanyAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingSameAsShipping", + "description": "Whether the billing address is the same as the shipping address. If the value is true, then the input for `billingAddress` is ignored.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxRegistrationId", + "description": "The tax registration ID of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions to apply to the company location.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationRevokeRolesPayload", + "description": "Return type for `companyLocationRevokeRoles` mutation.", + "fields": [ + { + "name": "revokedRoleAssignmentIds", + "description": "A list of role assignment IDs that were removed from the company location.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationRevokeTaxExemptionsPayload", + "description": "Return type for `companyLocationRevokeTaxExemptions` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The updated company location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationRevokeTaxRegistrationPayload", + "description": "Return type for `companyLocationRevokeTaxRegistration` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The updated company location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationRoleAssign", + "description": "The input fields for the role and contact to assign on a location.\n", + "fields": null, + "inputFields": [ + { + "name": "companyContactRoleId", + "description": "The role ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContactId", + "description": "The company contact ID..", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanyLocationSortKeys", + "description": "The set of valid sort keys for the CompanyLocation query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_ID", + "description": "Sort by the `company_id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_AND_LOCATION_NAME", + "description": "Sort by the `company_and_location_name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationUpdateInput", + "description": "The input fields for company location when creating or updating a company location.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locale", + "description": "The preferred locale of the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "externalId", + "description": "A unique externally-supplied ID for the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A note about the company location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "buyerExperienceConfiguration", + "description": "The configuration for the buyer's checkout at the company location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "BuyerExperienceConfigurationInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationUpdatePayload", + "description": "Return type for `companyLocationUpdate` mutation.", + "fields": [ + { + "name": "companyLocation", + "description": "The updated company location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationsDeletePayload", + "description": "Return type for `companyLocationsDelete` mutation.", + "fields": [ + { + "name": "deletedCompanyLocationIds", + "description": "A list of IDs of the deleted company locations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyRevokeMainContactPayload", + "description": "Return type for `companyRevokeMainContact` mutation.", + "fields": [ + { + "name": "company", + "description": "The company from which the main contact is revoked.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompanySortKeys", + "description": "The set of valid sort keys for the Company query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SINCE_DATE", + "description": "Sort by the `since_date` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_COUNT", + "description": "Sort by the `order_count` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_SPENT", + "description": "Sort by the `total_spent` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompanyUpdatePayload", + "description": "Return type for `companyUpdate` mutation.", + "fields": [ + { + "name": "company", + "description": "The updated company.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ContextualPricingContext", + "description": "The input fields for the context data that determines the pricing of a variant.", + "fields": null, + "inputFields": [ + { + "name": "country", + "description": "The country code used to fetch country-specific prices.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "companyLocationId", + "description": "The CompanyLocation ID used to fetch company location specific prices.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ContextualPublicationContext", + "description": "The context data that determines the publication status of a product.", + "fields": null, + "inputFields": [ + { + "name": "country", + "description": "The country code used to fetch country-specific publication.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "companyLocationId", + "description": "The company location ID used to fetch company-specific publication.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CountriesInShippingZones", + "description": "The list of all the countries from the combined shipping zones for the shop.", + "fields": [ + { + "name": "countryCodes", + "description": "The list of all the countries from all the combined shipping zones.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "includeRestOfWorld", + "description": "Whether 'Rest of World' has been defined in any of the shipping zones.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CountryCode", + "description": "The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.\nIf a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision\nof another country. For example, the territories associated with Spain are represented by the country code `ES`,\nand the territories associated with the United States of America are represented by the country code `US`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AF", + "description": "Afghanistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AX", + "description": "Åland Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AL", + "description": "Albania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZ", + "description": "Algeria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AD", + "description": "Andorra.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AO", + "description": "Angola.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AI", + "description": "Anguilla.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AG", + "description": "Antigua & Barbuda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AR", + "description": "Argentina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AM", + "description": "Armenia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AW", + "description": "Aruba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AC", + "description": "Ascension Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AU", + "description": "Australia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AT", + "description": "Austria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZ", + "description": "Azerbaijan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BS", + "description": "Bahamas.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BH", + "description": "Bahrain.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BD", + "description": "Bangladesh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BB", + "description": "Barbados.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BY", + "description": "Belarus.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BE", + "description": "Belgium.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZ", + "description": "Belize.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BJ", + "description": "Benin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BM", + "description": "Bermuda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BT", + "description": "Bhutan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BO", + "description": "Bolivia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BA", + "description": "Bosnia & Herzegovina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BW", + "description": "Botswana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BV", + "description": "Bouvet Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BR", + "description": "Brazil.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IO", + "description": "British Indian Ocean Territory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BN", + "description": "Brunei.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BG", + "description": "Bulgaria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BF", + "description": "Burkina Faso.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BI", + "description": "Burundi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KH", + "description": "Cambodia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA", + "description": "Canada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CV", + "description": "Cape Verde.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BQ", + "description": "Caribbean Netherlands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KY", + "description": "Cayman Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CF", + "description": "Central African Republic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TD", + "description": "Chad.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CL", + "description": "Chile.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CN", + "description": "China.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CX", + "description": "Christmas Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CC", + "description": "Cocos (Keeling) Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CO", + "description": "Colombia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KM", + "description": "Comoros.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CG", + "description": "Congo - Brazzaville.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CD", + "description": "Congo - Kinshasa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CK", + "description": "Cook Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CR", + "description": "Costa Rica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HR", + "description": "Croatia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CU", + "description": "Cuba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CW", + "description": "Curaçao.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CY", + "description": "Cyprus.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZ", + "description": "Czechia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CI", + "description": "Côte d’Ivoire.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DK", + "description": "Denmark.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DJ", + "description": "Djibouti.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DM", + "description": "Dominica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DO", + "description": "Dominican Republic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EC", + "description": "Ecuador.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EG", + "description": "Egypt.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SV", + "description": "El Salvador.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GQ", + "description": "Equatorial Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ER", + "description": "Eritrea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EE", + "description": "Estonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZ", + "description": "Eswatini.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ET", + "description": "Ethiopia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FK", + "description": "Falkland Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FO", + "description": "Faroe Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJ", + "description": "Fiji.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FI", + "description": "Finland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FR", + "description": "France.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GF", + "description": "French Guiana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PF", + "description": "French Polynesia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TF", + "description": "French Southern Territories.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GA", + "description": "Gabon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GM", + "description": "Gambia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GE", + "description": "Georgia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DE", + "description": "Germany.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GH", + "description": "Ghana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GI", + "description": "Gibraltar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GR", + "description": "Greece.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GL", + "description": "Greenland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GD", + "description": "Grenada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GP", + "description": "Guadeloupe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GT", + "description": "Guatemala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GG", + "description": "Guernsey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GN", + "description": "Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GW", + "description": "Guinea-Bissau.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GY", + "description": "Guyana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HT", + "description": "Haiti.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HM", + "description": "Heard & McDonald Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VA", + "description": "Vatican City.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HN", + "description": "Honduras.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HK", + "description": "Hong Kong SAR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HU", + "description": "Hungary.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": "Iceland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN", + "description": "India.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Indonesia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IR", + "description": "Iran.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQ", + "description": "Iraq.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IE", + "description": "Ireland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IM", + "description": "Isle of Man.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IL", + "description": "Israel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IT", + "description": "Italy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JM", + "description": "Jamaica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JP", + "description": "Japan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JE", + "description": "Jersey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JO", + "description": "Jordan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZ", + "description": "Kazakhstan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KE", + "description": "Kenya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KI", + "description": "Kiribati.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KP", + "description": "North Korea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XK", + "description": "Kosovo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KW", + "description": "Kuwait.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KG", + "description": "Kyrgyzstan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LA", + "description": "Laos.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LV", + "description": "Latvia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LB", + "description": "Lebanon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LS", + "description": "Lesotho.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LR", + "description": "Liberia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LY", + "description": "Libya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LI", + "description": "Liechtenstein.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LT", + "description": "Lithuania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LU", + "description": "Luxembourg.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MO", + "description": "Macao SAR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "Madagascar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MW", + "description": "Malawi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MY", + "description": "Malaysia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MV", + "description": "Maldives.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ML", + "description": "Mali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MT", + "description": "Malta.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MQ", + "description": "Martinique.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MR", + "description": "Mauritania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MU", + "description": "Mauritius.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YT", + "description": "Mayotte.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MX", + "description": "Mexico.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MD", + "description": "Moldova.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MC", + "description": "Monaco.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MN", + "description": "Mongolia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ME", + "description": "Montenegro.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MS", + "description": "Montserrat.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MA", + "description": "Morocco.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZ", + "description": "Mozambique.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MM", + "description": "Myanmar (Burma).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NA", + "description": "Namibia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NR", + "description": "Nauru.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NP", + "description": "Nepal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NL", + "description": "Netherlands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AN", + "description": "Netherlands Antilles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NC", + "description": "New Caledonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZ", + "description": "New Zealand.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NI", + "description": "Nicaragua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NE", + "description": "Niger.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NG", + "description": "Nigeria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NU", + "description": "Niue.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NF", + "description": "Norfolk Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MK", + "description": "North Macedonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO", + "description": "Norway.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OM", + "description": "Oman.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PK", + "description": "Pakistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PS", + "description": "Palestinian Territories.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PA", + "description": "Panama.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PG", + "description": "Papua New Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PY", + "description": "Paraguay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PE", + "description": "Peru.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PH", + "description": "Philippines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PN", + "description": "Pitcairn Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PL", + "description": "Poland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT", + "description": "Portugal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QA", + "description": "Qatar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CM", + "description": "Cameroon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RE", + "description": "Réunion.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RO", + "description": "Romania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RU", + "description": "Russia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RW", + "description": "Rwanda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BL", + "description": "St. Barthélemy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SH", + "description": "St. Helena.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KN", + "description": "St. Kitts & Nevis.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LC", + "description": "St. Lucia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MF", + "description": "St. Martin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PM", + "description": "St. Pierre & Miquelon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WS", + "description": "Samoa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SM", + "description": "San Marino.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ST", + "description": "São Tomé & Príncipe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SA", + "description": "Saudi Arabia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SN", + "description": "Senegal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RS", + "description": "Serbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SC", + "description": "Seychelles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SL", + "description": "Sierra Leone.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SG", + "description": "Singapore.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SX", + "description": "Sint Maarten.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SK", + "description": "Slovakia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SI", + "description": "Slovenia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SB", + "description": "Solomon Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SO", + "description": "Somalia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZA", + "description": "South Africa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GS", + "description": "South Georgia & South Sandwich Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KR", + "description": "South Korea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SS", + "description": "South Sudan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ES", + "description": "Spain.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LK", + "description": "Sri Lanka.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VC", + "description": "St. Vincent & Grenadines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SD", + "description": "Sudan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SR", + "description": "Suriname.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SJ", + "description": "Svalbard & Jan Mayen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SE", + "description": "Sweden.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CH", + "description": "Switzerland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SY", + "description": "Syria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TW", + "description": "Taiwan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJ", + "description": "Tajikistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZ", + "description": "Tanzania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TH", + "description": "Thailand.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TL", + "description": "Timor-Leste.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TG", + "description": "Togo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TK", + "description": "Tokelau.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TO", + "description": "Tonga.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TT", + "description": "Trinidad & Tobago.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TA", + "description": "Tristan da Cunha.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TN", + "description": "Tunisia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TR", + "description": "Turkey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TM", + "description": "Turkmenistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TC", + "description": "Turks & Caicos Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TV", + "description": "Tuvalu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UG", + "description": "Uganda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UA", + "description": "Ukraine.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AE", + "description": "United Arab Emirates.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GB", + "description": "United Kingdom.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US", + "description": "United States.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UM", + "description": "U.S. Outlying Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UY", + "description": "Uruguay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZ", + "description": "Uzbekistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VU", + "description": "Vanuatu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VE", + "description": "Venezuela.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VN", + "description": "Vietnam.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VG", + "description": "British Virgin Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WF", + "description": "Wallis & Futuna.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EH", + "description": "Western Sahara.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YE", + "description": "Yemen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZM", + "description": "Zambia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZW", + "description": "Zimbabwe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZZ", + "description": "Unknown Region.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCode", + "description": "The country-specific harmonized system code and ISO country code for an inventory item.\n", + "fields": [ + { + "name": "countryCode", + "description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "harmonizedSystemCode", + "description": "The country-specific harmonized system code. These are usually longer than 6 digits.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCodeConnection", + "description": "An auto-generated type for paginating through multiple CountryHarmonizedSystemCodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CountryHarmonizedSystemCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCodeEdge", + "description": "An auto-generated type which holds one CountryHarmonizedSystemCode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CountryHarmonizedSystemCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CountryHarmonizedSystemCodeInput", + "description": "The input fields required to specify a harmonized system code.\n", + "fields": null, + "inputFields": [ + { + "name": "harmonizedSystemCode", + "description": "Country specific harmonized system code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The ISO 3166-1 alpha-2 country code for the country that issued the specified harmonized system code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "description": "The input fields required to create a media object.", + "fields": null, + "inputFields": [ + { + "name": "originalSource", + "description": "The original source of the media object. This might be an external URL or a staged upload URL.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "alt", + "description": "The alt text associated with the media.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CropRegion", + "description": "The part of the image that should remain after cropping.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CENTER", + "description": "Keep the center of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOP", + "description": "Keep the top of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTTOM", + "description": "Keep the bottom of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "Keep the left of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RIGHT", + "description": "Keep the right of the image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CurrencyCode", + "description": "The three-letter currency codes that represent the world currencies used in stores. These include standard ISO 4217 codes, legacy codes,\nand non-standard codes.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "USD", + "description": "United States Dollars (USD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EUR", + "description": "Euro (EUR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GBP", + "description": "United Kingdom Pounds (GBP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAD", + "description": "Canadian Dollars (CAD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AFN", + "description": "Afghan Afghani (AFN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL", + "description": "Albanian Lek (ALL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZD", + "description": "Algerian Dinar (DZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AOA", + "description": "Angolan Kwanza (AOA).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARS", + "description": "Argentine Pesos (ARS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMD", + "description": "Armenian Dram (AMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWG", + "description": "Aruban Florin (AWG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUD", + "description": "Australian Dollars (AUD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BBD", + "description": "Barbadian Dollar (BBD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZN", + "description": "Azerbaijani Manat (AZN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BDT", + "description": "Bangladesh Taka (BDT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BSD", + "description": "Bahamian Dollar (BSD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BHD", + "description": "Bahraini Dinar (BHD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BIF", + "description": "Burundian Franc (BIF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZD", + "description": "Belize Dollar (BZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BMD", + "description": "Bermudian Dollar (BMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BTN", + "description": "Bhutanese Ngultrum (BTN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAM", + "description": "Bosnia and Herzegovina Convertible Mark (BAM).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRL", + "description": "Brazilian Real (BRL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOB", + "description": "Bolivian Boliviano (BOB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BWP", + "description": "Botswana Pula (BWP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BND", + "description": "Brunei Dollar (BND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BGN", + "description": "Bulgarian Lev (BGN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MMK", + "description": "Burmese Kyat (MMK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KHR", + "description": "Cambodian Riel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CVE", + "description": "Cape Verdean escudo (CVE).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KYD", + "description": "Cayman Dollars (KYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XAF", + "description": "Central African CFA Franc (XAF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLP", + "description": "Chilean Peso (CLP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CNY", + "description": "Chinese Yuan Renminbi (CNY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COP", + "description": "Colombian Peso (COP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KMF", + "description": "Comorian Franc (KMF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CDF", + "description": "Congolese franc (CDF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CRC", + "description": "Costa Rican Colones (CRC).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HRK", + "description": "Croatian Kuna (HRK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZK", + "description": "Czech Koruny (CZK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DKK", + "description": "Danish Kroner (DKK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOP", + "description": "Dominican Peso (DOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XCD", + "description": "East Caribbean Dollar (XCD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EGP", + "description": "Egyptian Pound (EGP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ETB", + "description": "Ethiopian Birr (ETB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XPF", + "description": "CFP Franc (XPF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJD", + "description": "Fijian Dollars (FJD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GMD", + "description": "Gambian Dalasi (GMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GHS", + "description": "Ghanaian Cedi (GHS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GTQ", + "description": "Guatemalan Quetzal (GTQ).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GYD", + "description": "Guyanese Dollar (GYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GEL", + "description": "Georgian Lari (GEL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HTG", + "description": "Haitian Gourde (HTG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HNL", + "description": "Honduran Lempira (HNL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HKD", + "description": "Hong Kong Dollars (HKD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HUF", + "description": "Hungarian Forint (HUF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ISK", + "description": "Icelandic Kronur (ISK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INR", + "description": "Indian Rupees (INR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IDR", + "description": "Indonesian Rupiah (IDR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ILS", + "description": "Israeli New Shekel (NIS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQD", + "description": "Iraqi Dinar (IQD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JMD", + "description": "Jamaican Dollars (JMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JPY", + "description": "Japanese Yen (JPY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JEP", + "description": "Jersey Pound.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JOD", + "description": "Jordanian Dinar (JOD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZT", + "description": "Kazakhstani Tenge (KZT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KES", + "description": "Kenyan Shilling (KES).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KWD", + "description": "Kuwaiti Dinar (KWD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KGS", + "description": "Kyrgyzstani Som (KGS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAK", + "description": "Laotian Kip (LAK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LVL", + "description": "Latvian Lati (LVL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LBP", + "description": "Lebanese Pounds (LBP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LSL", + "description": "Lesotho Loti (LSL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LRD", + "description": "Liberian Dollar (LRD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LTL", + "description": "Lithuanian Litai (LTL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MGA", + "description": "Malagasy Ariary (MGA).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MKD", + "description": "Macedonia Denar (MKD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MOP", + "description": "Macanese Pataca (MOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MWK", + "description": "Malawian Kwacha (MWK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MVR", + "description": "Maldivian Rufiyaa (MVR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MXN", + "description": "Mexican Pesos (MXN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MYR", + "description": "Malaysian Ringgits (MYR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUR", + "description": "Mauritian Rupee (MUR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MDL", + "description": "Moldovan Leu (MDL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAD", + "description": "Moroccan Dirham.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MNT", + "description": "Mongolian Tugrik.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZN", + "description": "Mozambican Metical.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAD", + "description": "Namibian Dollar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NPR", + "description": "Nepalese Rupee (NPR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ANG", + "description": "Netherlands Antillean Guilder.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZD", + "description": "New Zealand Dollars (NZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NIO", + "description": "Nicaraguan Córdoba (NIO).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NGN", + "description": "Nigerian Naira (NGN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOK", + "description": "Norwegian Kroner (NOK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OMR", + "description": "Omani Rial (OMR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAB", + "description": "Panamian Balboa (PAB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PKR", + "description": "Pakistani Rupee (PKR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PGK", + "description": "Papua New Guinean Kina (PGK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PYG", + "description": "Paraguayan Guarani (PYG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PEN", + "description": "Peruvian Nuevo Sol (PEN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PHP", + "description": "Philippine Peso (PHP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLN", + "description": "Polish Zlotych (PLN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QAR", + "description": "Qatari Rial (QAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RON", + "description": "Romanian Lei (RON).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RUB", + "description": "Russian Rubles (RUB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RWF", + "description": "Rwandan Franc (RWF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WST", + "description": "Samoan Tala (WST).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAR", + "description": "Saudi Riyal (SAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RSD", + "description": "Serbian dinar (RSD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCR", + "description": "Seychellois Rupee (SCR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SGD", + "description": "Singapore Dollars (SGD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SDG", + "description": "Sudanese Pound (SDG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYP", + "description": "Syrian Pound (SYP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZAR", + "description": "South African Rand (ZAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KRW", + "description": "South Korean Won (KRW).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SSP", + "description": "South Sudanese Pound (SSP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SBD", + "description": "Solomon Islands Dollar (SBD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LKR", + "description": "Sri Lankan Rupees (LKR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SRD", + "description": "Surinamese Dollar (SRD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZL", + "description": "Swazi Lilangeni (SZL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEK", + "description": "Swedish Kronor (SEK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHF", + "description": "Swiss Francs (CHF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWD", + "description": "Taiwan Dollars (TWD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THB", + "description": "Thai baht (THB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZS", + "description": "Tanzanian Shilling (TZS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TTD", + "description": "Trinidad and Tobago Dollars (TTD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TND", + "description": "Tunisian Dinar (TND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRY", + "description": "Turkish Lira (TRY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TMT", + "description": "Turkmenistani Manat (TMT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UGX", + "description": "Ugandan Shilling (UGX).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UAH", + "description": "Ukrainian Hryvnia (UAH).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AED", + "description": "United Arab Emirates Dirham (AED).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UYU", + "description": "Uruguayan Pesos (UYU).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZS", + "description": "Uzbekistan som (UZS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VUV", + "description": "Vanuatu Vatu (VUV).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VND", + "description": "Vietnamese đồng (VND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XOF", + "description": "West African CFA franc (XOF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YER", + "description": "Yemeni Rial (YER).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZMW", + "description": "Zambian Kwacha (ZMW).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BYN", + "description": "Belarusian Ruble (BYN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BYR", + "description": "Belarusian Ruble (BYR).", + "isDeprecated": true, + "deprecationReason": "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead." + }, + { + "name": "DJF", + "description": "Djiboutian Franc (DJF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERN", + "description": "Eritrean Nakfa (ERN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FKP", + "description": "Falkland Islands Pounds (FKP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIP", + "description": "Gibraltar Pounds (GIP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GNF", + "description": "Guinean Franc (GNF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IRR", + "description": "Iranian Rial (IRR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KID", + "description": "Kiribati Dollar (KID).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LYD", + "description": "Libyan Dinar (LYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MRU", + "description": "Mauritanian Ouguiya (MRU).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SLL", + "description": "Sierra Leonean Leone (SLL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHP", + "description": "Saint Helena Pounds (SHP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOS", + "description": "Somali Shilling (SOS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STD", + "description": "Sao Tome And Principe Dobra (STD).", + "isDeprecated": true, + "deprecationReason": "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead." + }, + { + "name": "STN", + "description": "Sao Tome And Principe Dobra (STN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJS", + "description": "Tajikistani Somoni (TJS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOP", + "description": "Tongan Pa'anga (TOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VED", + "description": "Venezuelan Bolivares (VED).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VEF", + "description": "Venezuelan Bolivares (VEF).", + "isDeprecated": true, + "deprecationReason": "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead." + }, + { + "name": "VES", + "description": "Venezuelan Bolivares (VES).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XXX", + "description": "Unrecognized currency.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CurrencyFormats", + "description": "Currency formats configured for the merchant. These formats are available to use within Liquid.", + "fields": [ + { + "name": "moneyFormat", + "description": "Money without currency in HTML.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moneyInEmailsFormat", + "description": "Money without currency in emails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moneyWithCurrencyFormat", + "description": "Money with currency in HTML.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moneyWithCurrencyInEmailsFormat", + "description": "Money with currency in emails.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CurrencySetting", + "description": "A setting for a presentment currency.", + "fields": [ + { + "name": "currencyCode", + "description": "The currency's ISO code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyName", + "description": "The full name of the currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Whether the currency is enabled or not. An enabled currency setting is visible to buyers and allows orders to be generated with that currency as presentment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rateUpdatedAt", + "description": "The date and time when the active exchange rate for the currency was last modified. It can be the automatic rate's creation date, or the manual rate's last updated at date if active.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CurrencySettingConnection", + "description": "An auto-generated type for paginating through multiple CurrencySettings.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySettingEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CurrencySettingEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySetting", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CurrencySettingEdge", + "description": "An auto-generated type which holds one CurrencySetting and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CurrencySettingEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySetting", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomShippingPackageInput", + "description": "The input fields for a custom shipping package used to pack shipment.", + "fields": null, + "inputFields": [ + { + "name": "weight", + "description": "Weight of the empty shipping package.", + "type": { + "kind": "INPUT_OBJECT", + "name": "WeightInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dimensions", + "description": "Outside dimensions of the empty shipping package.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ObjectDimensionsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "default", + "description": "The default package is the one used to calculate shipping costs on checkout.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "name", + "description": "Descriptive name for the package.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": "Type of package.", + "type": { + "kind": "ENUM", + "name": "ShippingPackageType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "description": "Represents information about a customer of the shop, such as the customer's contact details, their order\nhistory, and whether they've agreed to receive marketing material by email.\n\n**Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data.\n", + "fields": [ + { + "name": "acceptsMarketing", + "description": "Whether the customer has agreed to receive marketing material.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `emailMarketingConsent` instead." + }, + { + "name": "acceptsMarketingUpdatedAt", + "description": "The date and time when the customer consented or objected to receiving marketing material by email.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `emailMarketingConsent` instead." + }, + { + "name": "addresses", + "description": "A list of addresses associated with the customer.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountSpent", + "description": "The total amount that the customer has spent on orders in their lifetime.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "averageOrderAmount", + "description": "The average amount that the customer spent per order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This field is no longer supported." + }, + { + "name": "averageOrderAmountV2", + "description": "The average amount that the customer spent per order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This field is no longer supported." + }, + { + "name": "canDelete", + "description": "Whether the merchant can delete the customer from their store.\n\nA customer can be deleted from a store only if they haven't yet made an order. After a customer makes an\norder, they can't be deleted from a store.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactProfiles", + "description": "A list of the customer's company contact profiles.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the customer was added to the store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultAddress", + "description": "The default address associated with the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The full name of the customer, based on the values for first_name and last_name. If the first_name and\nlast_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The customer's email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "emailMarketingConsent", + "description": "The current email marketing state for the customer.\nIf the customer doesn't have an email address, then this property is `null`.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentState", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "A list of events associated with the customer.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The customer's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Whether the merchant has added timeline comments about the customer on the customer's page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "To query for comments on the timeline, use the events connection and a `query` argument containing `verb:comment`, or look for a `CommentEvent` in the `__typename` of events." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated with the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The customer's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastOrder", + "description": "The customer's last order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lifetimeDuration", + "description": "The amount of time since the customer was first added to the store.\n\nExample: 'about 12 years'.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "The customer's locale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market that includes the customer’s default address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingOptInLevel", + "description": "The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the\ncustomer gave when they consented to receive marketing material by email.\n\nIf the customer doesn't accept email marketing, then this property is `null`.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `emailMarketingConsent` instead." + }, + { + "name": "mergeable", + "description": "Whether the customer can be merged with another customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergeable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multipassIdentifier", + "description": "A unique identifier for the customer that's used with Multipass login.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note about the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfOrders", + "description": "The number of orders that the customer has made at the store in their lifetime.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "A list of the customer's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `cart_token`\n - `channel`\n - `channel_id`\n - `chargeback_status`\n - `checkout_token`\n - `confirmation_number`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `delivery_method`\n - `discount_code`\n - `earliest_fulfill_by`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_location_id`\n - `fulfillment_status`\n - `gateway`\n - `location_id`\n - `name`\n - `payment_id`\n - `payment_provider_id`\n - `po_number`\n - `processed_at`\n - `reference_location_id`\n - `return_status`\n - `risk_level`\n - `sales_channel`\n - `sku`\n - `source_identifier`\n - `source_name`\n - `status`\n - `tag`\n - `tag_not`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentMethods", + "description": "A list of the customer's payment methods.", + "args": [ + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The customer's phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "productSubscriberStatus", + "description": "Possible subscriber states of a customer defined by their subscription contracts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerProductSubscriberStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "smsMarketingConsent", + "description": "The current SMS marketing state for the customer's phone number.\n\nIf the customer does not have a phone number, then this property is `null`.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentState", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "The state of the customer's account with the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statistics", + "description": "The statistics for a given customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerStatistics", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContracts", + "description": "A list of the customer's subscription contracts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContractConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A comma separated list of tags that have been added to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxExempt", + "description": "Whether the customer is exempt from being charged taxes on their orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions applied to the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unsubscribeUrl", + "description": "The URL to unsubscribe the customer from the mailing list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the customer was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validEmailAddress", + "description": "Whether the email address is formatted correctly.\n\nReturns `true` when the email is formatted correctly and\nbelongs to an existing domain. This doesn't guarantee that\nthe email address actually exists.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "verifiedEmail", + "description": "Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddTaxExemptionsPayload", + "description": "Return type for `customerAddTaxExemptions` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerConnection", + "description": "An auto-generated type for paginating through multiple Customers.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CustomerEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerConsentCollectedFrom", + "description": "The source that collected the customer's consent to receive marketing materials.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHOPIFY", + "description": "The customer consent was collected by Shopify.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The customer consent was collected outside of Shopify.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerCreatePayload", + "description": "Return type for `customerCreate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The created customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerCreditCard", + "description": "Represents a card instrument for customer payment method.", + "fields": [ + { + "name": "billingAddress", + "description": "The billing address of the card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerCreditCardBillingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "brand", + "description": "The brand of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiresSoon", + "description": "Whether the card is about to expire.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryMonth", + "description": "The expiry month of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryYear", + "description": "The expiry year of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstDigits", + "description": "The card's BIN number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRevocable", + "description": "The payment method can be revoked if there are no active subscription contracts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastDigits", + "description": "The last 4 digits of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maskedNumber", + "description": "The masked card number with only the last 4 digits displayed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the card holder.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source", + "description": "The source of the card if coming from a wallet such as Apple Pay.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "virtualLastDigits", + "description": "The last 4 digits of the Device Account Number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerCreditCardBillingAddress", + "description": "The billing address of a credit card payment instrument.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name in the billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name in the billing address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerDeleteInput", + "description": "The input fields to delete a customer.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the customer to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerDeletePayload", + "description": "Return type for `customerDelete` mutation.", + "fields": [ + { + "name": "deletedCustomerId", + "description": "The ID of the deleted customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop of the deleted customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerEdge", + "description": "An auto-generated type which holds one Customer and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CustomerEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerEmailAddress", + "description": "Represents an email address.\n", + "fields": [ + { + "name": "emailAddress", + "description": "The customer's default email address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingState", + "description": "Whether the customer has subscribed to email marketing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerEmailAddressMarketingState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingUnsubscribeUrl", + "description": "The URL to unsubscribe a member from all mailing lists.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openTrackingLevel", + "description": "Whether the customer has opted in to having their opened emails tracked.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerEmailAddressOpenTrackingLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openTrackingUrl", + "description": "The URL that can be used to opt a customer in or out of email open tracking.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerEmailAddressMarketingState", + "description": "Possible marketing states for the customer’s email address.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The customer’s email address marketing state is invalid.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SUBSCRIBED", + "description": "The customer is not subscribed to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The customer is in the process of subscribing to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIBED", + "description": "The customer is subscribed to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUBSCRIBED", + "description": "The customer is not subscribed to email marketing but was previously subscribed.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerEmailAddressOpenTrackingLevel", + "description": "The different levels related to whether a customer has opted in to having their opened emails tracked.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN", + "description": "The customer has not specified whether they want to opt in or out of having their open emails tracked.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTED_IN", + "description": "The customer has opted in to having their open emails tracked.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTED_OUT", + "description": "The customer has opted out of having their open emails tracked.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailMarketingConsentInput", + "description": "Information that describes when a customer consented to\n receiving marketing material by email.", + "fields": null, + "inputFields": [ + { + "name": "marketingOptInLevel", + "description": "The customer opt-in level at the time of subscribing to marketing material.", + "type": { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketingState", + "description": "The current marketing state associated with the customer's email.\n If the customer doesn't have an email, then this field is `null`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerEmailMarketingState", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "consentUpdatedAt", + "description": "The latest date and time when the customer consented or objected to\n receiving marketing material by email.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentState", + "description": "The record of when a customer consented to receive marketing material by email.\n", + "fields": [ + { + "name": "consentUpdatedAt", + "description": "The date and time at which the customer consented to receive marketing material by email.\nThe customer's consent state reflects the consent record with the most recent `consent_updated_at` date.\nIf no date is provided, then the date and time at which the consent information was sent is used.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingOptInLevel", + "description": "The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines,\nthat the customer gave when they consented to receive marketing material by email.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingState", + "description": "The current email marketing state for the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerEmailMarketingState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailMarketingConsentUpdateInput", + "description": "The input fields for the email consent information to update for a given customer ID.\n", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The ID of the customer for which to update the email marketing consent information. The customer must have a unique email address associated to the record. If not, add the email address using the `customerUpdate` mutation first.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "emailMarketingConsent", + "description": "The marketing consent information when the customer consented to receiving marketing material by email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailMarketingConsentInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentUpdatePayload", + "description": "Return type for `customerEmailMarketingConsentUpdate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentUpdateUserError", + "description": "An error that occurs during the execution of `CustomerEmailMarketingConsentUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerEmailMarketingConsentUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerEmailMarketingConsentUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerEmailMarketingConsentUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENT", + "description": "Missing a required argument.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerEmailMarketingState", + "description": "The possible email marketing states for a customer.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_SUBSCRIBED", + "description": "The customer isn't subscribed to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The customer is in the process of subscribing to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIBED", + "description": "The customer is subscribed to email marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUBSCRIBED", + "description": "The customer isn't currently subscribed to email marketing but was previously subscribed.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDACTED", + "description": "The customer's personal data is erased. This value is internally-set and read-only.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The customer’s email address marketing state is invalid.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerGenerateAccountActivationUrlPayload", + "description": "Return type for `customerGenerateAccountActivationUrl` mutation.", + "fields": [ + { + "name": "accountActivationUrl", + "description": "The generated account activation URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "description": "The input fields and values to use when creating or updating a customer.", + "fields": null, + "inputFields": [ + { + "name": "addresses", + "description": "The addresses for a customer.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The unique email address of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstName", + "description": "The customer's first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The ID of the customer to update.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The customer's last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locale", + "description": "The customer's locale.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional metafields to associate to the customer.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A note about the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The unique phone number for the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A list of tags to associate with the customer. Can be an array or a comma-separated list. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`\n\nUpdating `tags` overwrites any existing tags that were previously added to the customer. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "emailMarketingConsent", + "description": "Information that describes when the customer consented to receiving marketing\n material by email. The `email` field is required when creating a customer with email marketing\n consent information.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailMarketingConsentInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "smsMarketingConsent", + "description": "The marketing consent information when the customer consented to receiving marketing\n material by SMS. The `phone` field is required when creating a customer with SMS\n marketing consent information.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerSmsMarketingConsentInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxExempt", + "description": "Whether the customer is exempt from paying taxes on their order.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions to apply to the customer.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerJourney", + "description": "Represents a customer's visiting activities on a shop's online store.", + "fields": [ + { + "name": "customerOrderIndex", + "description": "The position of the current order within the customer's order history.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "daysToConversion", + "description": "The amount of days between first session and order creation date. First session represents first session since the last order, or first session within the 30 day attribution window, if more than 30 days has passed since the last order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstVisit", + "description": "The customer's first session going into the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastVisit", + "description": "The last session before an order is made.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moments", + "description": "Events preceding a customer order, such as shop sessions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomerMoment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerJourneySummary", + "description": "Represents a customer's visiting activities on a shop's online store.", + "fields": [ + { + "name": "customerOrderIndex", + "description": "The position of the current order within the customer's order history. Test orders aren't included.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "daysToConversion", + "description": "The number of days between the first session and the order creation date. The first session represents the first session since the last order, or the first session within the 30 day attribution window, if more than 30 days have passed since the last order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstVisit", + "description": "The customer's first session going into the shop.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastVisit", + "description": "The last session before an order is made.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moments", + "description": "The events preceding a customer's order, such as shop sessions.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerMomentConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "momentsCount", + "description": "The total number of customer moments associated with this order. Returns null if the order is still in the process of being attributed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ready", + "description": "Whether the attributed sessions for the order have been created yet.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "description": "The possible values for the marketing subscription opt-in level enabled at the time the customer consented to receive marketing information.\n\nThe levels are defined by [the M3AAWG best practices guideline\n document](https://www.m3aawg.org/sites/maawg/files/news/M3AAWG_Senders_BCP_Ver3-2015-02.pdf).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SINGLE_OPT_IN", + "description": "After providing their information, the customer receives marketing information without any\nintermediate steps.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFIRMED_OPT_IN", + "description": "After providing their information, the customer receives a confirmation and is required to\nperform a intermediate step before receiving marketing information.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "The customer receives marketing information but how they were opted in is unknown.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergeError", + "description": "The error blocking a customer merge.", + "fields": [ + { + "name": "errorFields", + "description": "The list of fields preventing the customer from being merged.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerMergeErrorFieldType", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The customer merge error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerMergeErrorCode", + "description": "Possible error codes that can be returned by `CustomerMergeUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CUSTOMER", + "description": "The customer cannot be merged.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CUSTOMER_ID", + "description": "The customer ID is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_HAS_GIFT_CARDS", + "description": "The customer cannot be merged because it has associated gift cards.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_OVERRIDE_ATTRIBUTE", + "description": "The customer is missing the attribute requested for override.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OVERRIDE_ATTRIBUTE_INVALID", + "description": "The override attribute is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerMergeErrorFieldType", + "description": "The types of the hard blockers preventing a customer from being merged to another customer.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DELETED_AT", + "description": "The customer does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDACTED_AT", + "description": "The customer has a pending or completed redaction.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTIONS", + "description": "The customer has a subscription history.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERGE_IN_PROGRESS", + "description": "The customer has a merge in progress.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARDS", + "description": "The customer has gift cards.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACT", + "description": "The customer is a company contact.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PAYMENT_METHODS", + "description": "The customer has payment methods.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING_DATA_REQUEST", + "description": "The customer has a pending data request.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTIPASS_IDENTIFIER", + "description": "The customer has a multipass identifier.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerMergeOverrideFields", + "description": "The input fields to override default customer merge rules.\n", + "fields": null, + "inputFields": [ + { + "name": "customerIdOfFirstNameToKeep", + "description": "The ID of the customer whose first name will be kept.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerIdOfLastNameToKeep", + "description": "The ID of the customer whose last name will be kept.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerIdOfEmailToKeep", + "description": "The ID of the customer whose email will be kept.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerIdOfPhoneNumberToKeep", + "description": "The ID of the customer whose phone number will be kept.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerIdOfDefaultAddressToKeep", + "description": "The ID of the customer whose default address will be kept.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The note to keep.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "The tags to keep.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergePayload", + "description": "Return type for `customerMerge` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job for merging the customers.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resultingCustomerId", + "description": "The ID of the customer resulting from the merge.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergeUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergePreview", + "description": "A preview of the results of a customer merge request.", + "fields": [ + { + "name": "alternateFields", + "description": "The fields that can be used to override the default fields.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerMergePreviewAlternateFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "blockingFields", + "description": "The fields that will block the merge if the two customers are merged.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerMergePreviewBlockingFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerMergeErrors", + "description": "The errors blocking the customer merge.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergeError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultFields", + "description": "The fields that will be kept if the two customers are merged.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerMergePreviewDefaultFields", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resultingCustomerId", + "description": "The resulting customer ID if the two customers are merged.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergePreviewAlternateFields", + "description": "The fields that can be used to override the default fields.", + "fields": [ + { + "name": "defaultAddress", + "description": "The default address of a customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email state of a customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerEmailAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of a customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of a customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "The phone number state of a customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPhoneNumber", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergePreviewBlockingFields", + "description": "The blocking fields of a customer merge preview. These fields will block customer merge unless edited.\n", + "fields": [ + { + "name": "note", + "description": "The merged note resulting from a customer merge. The merged note is over the 5000 character limit and will block customer merge.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "The merged tags resulting from a customer merge. The merged tags are over the 250 limit and will block customer merge.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergePreviewDefaultFields", + "description": "The fields that will be kept as part of a customer merge preview.", + "fields": [ + { + "name": "addresses", + "description": "The merged addresses resulting from a customer merge.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddressConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultAddress", + "description": "The default address resulting from a customer merge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountNodeCount", + "description": "The total number of customer-specific discounts resulting from a customer merge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountNodes", + "description": "The merged customer-specific discounts resulting from a customer merge.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountNodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The full name of the customer, based on the values for `first_name` and `last_name`. If `first_name` and `last_name` aren't available, then this field falls back to the customer's email address. If the customer's email isn't available, then this field falls back to the customer's phone number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderCount", + "description": "The total number of merged draft orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "The merged draft orders resulting from a customer merge.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "UPDATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email state of a customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerEmailAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name resulting from a customer merge.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardCount", + "description": "The total number of merged gift cards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCards", + "description": "The merged gift cards resulting from a customer merge.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "GiftCardSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name resulting from a customer merge.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldCount", + "description": "The total number of merged metafields.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The merged note resulting from a customer merge.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCount", + "description": "The total number of merged orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The merged orders resulting from a customer merge.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "PROCESSED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "The phone number state of a customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPhoneNumber", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "The merged tags resulting from a customer merge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergeRequest", + "description": "A merge request for merging two customers.\n", + "fields": [ + { + "name": "customerMergeErrors", + "description": "The merge errors that occurred during the customer merge request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergeError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "jobId", + "description": "The UUID of the merge job.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resultingCustomerId", + "description": "The ID of the customer resulting from the merge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the customer merge request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerMergeRequestStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerMergeRequestStatus", + "description": "The status of the customer merge request.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REQUESTED", + "description": "The customer merge request has been requested.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "The customer merge request is currently in progress.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPLETED", + "description": "The customer merge request has been completed.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "The customer merge request has failed.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergeUserError", + "description": "An error that occurs while merging two customers.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerMergeErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergeable", + "description": "An object that represents whether a customer can be merged with another customer.\n", + "fields": [ + { + "name": "errorFields", + "description": "The list of fields preventing the customer from being merged.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerMergeErrorFieldType", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isMergeable", + "description": "Whether the customer can be merged with another customer.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mergeInProgress", + "description": "The merge request if one is currently in progress.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerMergeRequest", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason why the customer can't be merged with another customer.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CustomerMoment", + "description": "Represents a session preceding an order, often used for building a timeline of events leading to an order.", + "fields": [ + { + "name": "occurredAt", + "description": "The date and time when the customer's session occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CustomerMomentConnection", + "description": "An auto-generated type for paginating through multiple CustomerMoments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMomentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CustomerMomentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomerMoment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerMomentEdge", + "description": "An auto-generated type which holds one CustomerMoment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CustomerMomentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CustomerMoment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CustomerPaymentInstrument", + "description": "All possible instruments for CustomerPaymentMethods.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomerCreditCard", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaypalBillingAgreement", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerShopPayAgreement", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentInstrumentBillingAddress", + "description": "The billing address of a payment instrument.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the buyer of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "description": "A customer's payment method.", + "fields": [ + { + "name": "customer", + "description": "The customer to whom the payment method belongs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of this payment method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "instrument", + "description": "The instrument for this payment method.", + "args": [], + "type": { + "kind": "UNION", + "name": "CustomerPaymentInstrument", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "revokedAt", + "description": "The time that the payment method was revoked.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "revokedReason", + "description": "The revocation reason for this payment method.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodRevocationReason", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContracts", + "description": "List Subscription Contracts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContractConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodConnection", + "description": "An auto-generated type for paginating through multiple CustomerPaymentMethods.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CustomerPaymentMethodEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreateFromDuplicationDataPayload", + "description": "Return type for `customerPaymentMethodCreateFromDuplicationData` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", + "description": "An error that occurs during the execution of `CustomerPaymentMethodCreateFromDuplicationData`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodCreateFromDuplicationDataUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodCreateFromDuplicationDataUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerPaymentMethodCreateFromDuplicationDataUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOO_MANY_REQUESTS", + "description": "Too many requests.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_DOES_NOT_EXIST", + "description": "Customer doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ENCRYPTED_DUPLICATION_DATA", + "description": "Invalid encrypted duplication data.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreditCardCreatePayload", + "description": "Return type for `customerPaymentMethodCreditCardCreate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreditCardUpdatePayload", + "description": "Return type for `customerPaymentMethodCreditCardUpdate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodEdge", + "description": "An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CustomerPaymentMethodEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetDuplicationDataPayload", + "description": "Return type for `customerPaymentMethodGetDuplicationData` mutation.", + "fields": [ + { + "name": "encryptedDuplicationData", + "description": "The encrypted data from the payment method to be duplicated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetDuplicationDataUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetDuplicationDataUserError", + "description": "An error that occurs during the execution of `CustomerPaymentMethodGetDuplicationData`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodGetDuplicationDataUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodGetDuplicationDataUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerPaymentMethodGetDuplicationDataUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_METHOD_DOES_NOT_EXIST", + "description": "Payment method doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INSTRUMENT", + "description": "Invalid payment instrument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_REQUESTS", + "description": "Too many requests.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_DOES_NOT_EXIST", + "description": "Customer doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAME_SHOP", + "description": "Target shop cannot be the same as the source.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ORGANIZATION_SHOP", + "description": "Must be targeted to another shop in the same organization.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetUpdateUrlPayload", + "description": "Return type for `customerPaymentMethodGetUpdateUrl` mutation.", + "fields": [ + { + "name": "updatePaymentMethodUrl", + "description": "The URL to redirect the customer to update the payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetUpdateUrlUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetUpdateUrlUserError", + "description": "An error that occurs during the execution of `CustomerPaymentMethodGetUpdateUrl`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodGetUpdateUrlUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerPaymentMethodGetUpdateUrlUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_METHOD_DOES_NOT_EXIST", + "description": "Payment method doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INSTRUMENT", + "description": "Invalid payment instrument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_REQUESTS", + "description": "Too many requests.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_DOES_NOT_EXIST", + "description": "Customer doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodPaypalBillingAgreementCreatePayload", + "description": "Return type for `customerPaymentMethodPaypalBillingAgreementCreate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodPaypalBillingAgreementUpdatePayload", + "description": "Return type for `customerPaymentMethodPaypalBillingAgreementUpdate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteCreatePayload", + "description": "Return type for `customerPaymentMethodRemoteCreate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteCreditCardCreatePayload", + "description": "Return type for `customerPaymentMethodRemoteCreditCardCreate` mutation.", + "fields": [ + { + "name": "customerPaymentMethod", + "description": "The customer payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerPaymentMethodRemoteInput", + "description": "The input fields for a remote gateway payment method, only one remote reference permitted.\n", + "fields": null, + "inputFields": [ + { + "name": "stripePaymentMethod", + "description": "Input containing the fields for a remote stripe payment method.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoteStripePaymentMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "authorizeNetCustomerPaymentProfile", + "description": "The input fields for a remote authorize net customer profile.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoteAuthorizeNetCustomerPaymentProfileInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "braintreePaymentMethod", + "description": "The input fields for a remote Braintree customer profile.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RemoteBraintreePaymentMethodInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteUserError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodRemoteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodRemoteUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerPaymentMethodRemoteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXACTLY_ONE_REMOTE_REFERENCE_REQUIRED", + "description": "Exactly one remote reference is required.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZE_NET_NOT_ENABLED_FOR_SUBSCRIPTIONS", + "description": "Authorize.net is not enabled for subscriptions.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE_NOT_ENABLED_FOR_SUBSCRIPTIONS", + "description": "Braintree is not enabled for subscriptions.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodRevocationReason", + "description": "The revocation reason types for a customer payment method.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AUTHORIZE_NET_GATEWAY_NOT_ENABLED", + "description": "The Authorize.net payment gateway is not enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZE_NET_RETURNED_NO_PAYMENT_METHOD", + "description": "Authorize.net did not return any payment methods. Make sure that the correct Authorize.net account is linked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_UPDATE_CREDIT_CARD", + "description": "The credit card failed to update.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_API_AUTHENTICATION_ERROR", + "description": "Failed to contact the Stripe API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_API_INVALID_REQUEST_ERROR", + "description": "Invalid request. Failed to retrieve payment method from Stripe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_GATEWAY_NOT_ENABLED", + "description": "The Stripe payment gateway is not enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_RETURNED_NO_PAYMENT_METHOD", + "description": "Stripe did not return any payment methods. Make sure that the correct Stripe account is linked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_PAYMENT_METHOD_NOT_CARD", + "description": "The Stripe payment method type should be card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE_API_AUTHENTICATION_ERROR", + "description": "Failed to contact Braintree API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE_GATEWAY_NOT_ENABLED", + "description": "The Braintree payment gateway is not enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE_RETURNED_NO_PAYMENT_METHOD", + "description": "Braintree returned no payment methods. Make sure the correct Braintree account is linked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAINTREE_PAYMENT_METHOD_NOT_CARD", + "description": "The Braintree payment method type should be a credit card or Apple Pay card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUALLY_REVOKED", + "description": "The payment method was manually revoked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERGED", + "description": "The payment method was replaced with an existing payment method. The associated contracts have been migrated to the other payment method.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRevokePayload", + "description": "Return type for `customerPaymentMethodRevoke` mutation.", + "fields": [ + { + "name": "revokedCustomerPaymentMethodId", + "description": "The ID of the revoked customer payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodSendUpdateEmailPayload", + "description": "Return type for `customerPaymentMethodSendUpdateEmail` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer to whom an update payment method email was sent.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodUserError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPaymentMethodUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPaymentMethodUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerPaymentMethodUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaypalBillingAgreement", + "description": "Represents a PayPal instrument for customer payment method.", + "fields": [ + { + "name": "billingAddress", + "description": "The billing address of this payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentInstrumentBillingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inactive", + "description": "Whether the PayPal billing agreement is inactive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRevocable", + "description": "Whether the payment method can be revoked.The payment method can be revoked if there are no active subscription contracts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paypalAccountEmail", + "description": "The customers's PayPal account email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPhoneNumber", + "description": "A phone number.\n", + "fields": [ + { + "name": "marketingState", + "description": "Whether the customer has subscribed to SMS marketing material.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerSmsMarketingState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "A customer's phone number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerPredictedSpendTier", + "description": "The valid tiers for the predicted spend of a customer with a shop.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "HIGH", + "description": "The customer's spending is predicted to be in the top spending range for the shop in the following year.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIUM", + "description": "The customer's spending is predicted to be in the normal spending range for the shop in the following year.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOW", + "description": "The customer's spending is predicted to be zero, or in the lowest spending range for the shop in the following year.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerProductSubscriberStatus", + "description": "The possible product subscription states for a customer, as defined by the customer's subscription contracts.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The customer has at least one active subscription contract.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "The customer's last subscription contract was cancelled and there are no other active or paused\nsubscription contracts.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The customer's last subscription contract expired and there are no other active or paused\nsubscription contracts.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "The customer's last subscription contract failed and there are no other active or paused\nsubscription contracts.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEVER_SUBSCRIBED", + "description": "The customer has never had a subscription contract.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAUSED", + "description": "The customer has at least one paused subscription contract and there are no other active\nsubscription contracts.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerRemoveTaxExemptionsPayload", + "description": "Return type for `customerRemoveTaxExemptions` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerReplaceTaxExemptionsPayload", + "description": "Return type for `customerReplaceTaxExemptions` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSavedSearchSortKeys", + "description": "The set of valid sort keys for the CustomerSavedSearch query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMember", + "description": "The member of a segment.\n", + "fields": [ + { + "name": "amountSpent", + "description": "The total amount of money that the member has spent on orders.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultAddress", + "description": "The member's default address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultEmailAddress", + "description": "The member's default email address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerEmailAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultPhoneNumber", + "description": "The member's default phone number.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerPhoneNumber", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The full name of the member, which is based on the values of the `first_name` and `last_name` fields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The member's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The member’s ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The member's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastOrderId", + "description": "The ID of the member's most recent order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mergeable", + "description": "Whether the customer can be merged with another customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergeable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note about the member.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfOrders", + "description": "The total number of orders that the member has made.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMemberConnection", + "description": "The connection type for the `CustomerSegmentMembers` object.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentMemberEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statistics", + "description": "The statistics for a given segment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentStatistics", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total number of members in a given segment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMemberEdge", + "description": "An auto-generated type which holds one CustomerSegmentMember and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CustomerSegmentMemberEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentMember", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQuery", + "description": "A job to determine a list of members, such as customers, that are associated with an individual segment.", + "fields": [ + { + "name": "currentCount", + "description": "The current total number of members in a given segment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "done", + "description": "This indicates if the job is still queued or has been run.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID that's returned when running an asynchronous mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "JobResult", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQueryCreatePayload", + "description": "Return type for `customerSegmentMembersQueryCreate` mutation.", + "fields": [ + { + "name": "customerSegmentMembersQuery", + "description": "The newly created customer segment members query.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQuery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQueryUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerSegmentMembersQueryInput", + "description": "The input fields and values for creating a customer segment members query.", + "fields": null, + "inputFields": [ + { + "name": "segmentId", + "description": "The ID of the segment.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the list. The sorting behaviour defaults to ascending order.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the list by a given key.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQueryUserError", + "description": "Represents a customer segment members query custom error.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerSegmentMembersQueryUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSegmentMembersQueryUserErrorCode", + "description": "Possible error codes that can be returned by `CustomerSegmentMembersQueryUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerShopPayAgreement", + "description": "Represents a Shop Pay card instrument for customer payment method.", + "fields": [ + { + "name": "billingAddress", + "description": "The billing address of the card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerCreditCardBillingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiresSoon", + "description": "Whether the card is about to expire.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryMonth", + "description": "The expiry month of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryYear", + "description": "The expiry year of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inactive", + "description": "Whether the Shop Pay billing agreement is inactive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRevocable", + "description": "The payment method can be revoked if there are no active subscription contracts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastDigits", + "description": "The last 4 digits of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maskedNumber", + "description": "The masked card number with only the last 4 digits displayed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the card holder.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentError", + "description": "An error that occurs during execution of an SMS marketing consent mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerSmsMarketingConsentErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSmsMarketingConsentErrorCode", + "description": "Possible error codes that can be returned by `CustomerSmsMarketingConsentError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENT", + "description": "Missing a required argument.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerSmsMarketingConsentInput", + "description": "The marketing consent information when the customer consented to\n receiving marketing material by SMS.", + "fields": null, + "inputFields": [ + { + "name": "marketingOptInLevel", + "description": "The marketing subscription opt-in level that was set when the customer consented to receive marketing information.\n", + "type": { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketingState", + "description": "The current SMS marketing state for the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerSmsMarketingState", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "consentUpdatedAt", + "description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentState", + "description": "The record of when a customer consented to receive marketing material by SMS.\n\nThe customer's consent state reflects the record with the most recent date when consent was updated.\n", + "fields": [ + { + "name": "consentCollectedFrom", + "description": "The source from which the SMS marketing information for the customer was collected.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerConsentCollectedFrom", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "consentUpdatedAt", + "description": "The date and time when the customer consented to receive marketing material by SMS.\nIf no date is provided, then the date and time when the consent information was sent is used.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingOptInLevel", + "description": "The marketing subscription opt-in level that was set when the customer consented to receive marketing information.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerMarketingOptInLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingState", + "description": "The current SMS marketing state for the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CustomerSmsMarketingState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerSmsMarketingConsentUpdateInput", + "description": "The input fields for updating SMS marketing consent information for a given customer ID.\n", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The ID of the customer to update the SMS marketing consent information for. The customer must have a unique phone number associated to the record. If not, add the phone number using the `customerUpdate` mutation first.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "smsMarketingConsent", + "description": "The marketing consent information when the customer consented to receiving marketing material by SMS.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerSmsMarketingConsentInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentUpdatePayload", + "description": "Return type for `customerSmsMarketingConsentUpdate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSmsMarketingState", + "description": "The valid SMS marketing states for a customer’s phone number.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_SUBSCRIBED", + "description": "The customer hasn't subscribed to SMS marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The customer is in the process of subscribing to SMS marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIBED", + "description": "The customer is subscribed to SMS marketing.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUBSCRIBED", + "description": "The customer isn't currently subscribed to SMS marketing but was previously subscribed.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDACTED", + "description": "The customer's personal data is erased. This value is internally-set and read-only.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerSortKeys", + "description": "The set of valid sort keys for the Customer query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION", + "description": "Sort by the `location` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_COUNT", + "description": "Sort by the `orders_count` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAST_ORDER_DATE", + "description": "Sort by the `last_order_date` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_SPENT", + "description": "Sort by the `total_spent` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerState", + "description": "The valid values for the state of a customer's account with a shop.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DECLINED", + "description": "The customer declined the email invite to create an account.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED", + "description": "The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENABLED", + "description": "The customer has created an account.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVITED", + "description": "The customer has received an email invite to create an account.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerStatistics", + "description": "A customer's computed statistics.", + "fields": [ + { + "name": "predictedSpendTier", + "description": "The predicted spend tier of a customer with a shop.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerPredictedSpendTier", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerUpdateDefaultAddressPayload", + "description": "Return type for `customerUpdateDefaultAddress` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer whose address was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerUpdatePayload", + "description": "Return type for `customerUpdate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerVisit", + "description": "Represents a customer's session visiting a shop's online store, including information about the marketing activity attributed to starting the session.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "landingPage", + "description": "URL of the first page the customer landed on for the session.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "landingPageHtml", + "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was store.myshopify.com/products/1.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingEvent", + "description": "Represent actions taken by an app, on behalf of a merchant,\nto market Shopify resources such as products, collections, and discounts.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "occurredAt", + "description": "The date and time when the customer's session occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referralCode", + "description": "Marketing referral code from the link that the customer clicked to visit the store.\nSupports the following URL attributes: _ref_, _source_, or _r_.\nFor example, if the URL is myshopifystore.com/products/slide?ref=j2tj1tn2, then this value is j2tj1tn2.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referralInfoHtml", + "description": "Referral information with URLs linked in HTML.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referrerUrl", + "description": "Webpage where the customer clicked a link that sent them to the online store.\nFor example, _https://randomblog.com/page1_ or _android-app://com.google.android.gm_.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source", + "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct,\na website domain, QR code, or unknown.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceDescription", + "description": "Describes the source explicitly for first or last session.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceType", + "description": "Type of marketing tactic.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketingTactic", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utmParameters", + "description": "A set of UTM parameters gathered from the URL parameters of the referrer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UTMParameters", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CustomerMoment", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerVisitProductInfo", + "description": "This type returns the information about the product and product variant from a customer visit.\n", + "fields": [ + { + "name": "product", + "description": "The product information. If `null`, then the product was deleted from the store.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the product that the customer requested.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant information, if the product variant exists.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerVisitProductInfoConnection", + "description": "An auto-generated type for paginating through multiple CustomerVisitProductInfos.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisitProductInfoEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CustomerVisitProductInfoEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisitProductInfo", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerVisitProductInfoEdge", + "description": "An auto-generated type which holds one CustomerVisitProductInfo and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CustomerVisitProductInfoEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerVisitProductInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Date", + "description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date string.\nFor example, September 7, 2019 is represented as `\"2019-07-16\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "DateTime", + "description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.\nFor example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is\nrepresented as `\"2019-09-07T15:50:00Z`\".\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DayOfTheWeek", + "description": "Days of the week from Monday to Sunday.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MONDAY", + "description": "Monday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TUESDAY", + "description": "Tuesday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEDNESDAY", + "description": "Wednesday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THURSDAY", + "description": "Thursday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRIDAY", + "description": "Friday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SATURDAY", + "description": "Saturday.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUNDAY", + "description": "Sunday.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Decimal", + "description": "A signed decimal number, which supports arbitrary precision and is serialized as a string.\n\nExample values: `\"29.99\"`, `\"29.999\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessToken", + "description": "A token that delegates a set of scopes from the original permission.\n\nTo learn more about creating delegate access tokens, refer to\n[Delegate OAuth access tokens to subsystems]\n(https://shopify.dev/apps/auth/oauth/delegate-access-tokens).\n", + "fields": [ + { + "name": "accessScopes", + "description": "The list of permissions associated with the token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "accessToken", + "description": "The issued delegate access token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the delegate access token was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenCreatePayload", + "description": "Return type for `delegateAccessTokenCreate` mutation.", + "fields": [ + { + "name": "delegateAccessToken", + "description": "The delegate access token.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DelegateAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DelegateAccessTokenCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenCreateUserError", + "description": "An error that occurs during the execution of `DelegateAccessTokenCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DelegateAccessTokenCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DelegateAccessTokenCreateUserErrorCode", + "description": "Possible error codes that can be returned by `DelegateAccessTokenCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "EMPTY_ACCESS_SCOPE", + "description": "The access scope can't be empty.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELEGATE_ACCESS_TOKEN", + "description": "The parent access token can't be a delegate token.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEGATIVE_EXPIRES_IN", + "description": "The expires_in value must be greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRES_AFTER_PARENT", + "description": "The delegate token can't expire after the parent token.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFRESH_TOKEN", + "description": "The parent access token can't have a refresh token.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERSISTENCE_FAILED", + "description": "Persistence failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN_SCOPES", + "description": "Unknown scopes.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenDestroyPayload", + "description": "Return type for `delegateAccessTokenDestroy` mutation.", + "fields": [ + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the delegate access token destroy operation. Returns true if successful.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DelegateAccessTokenDestroyUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenDestroyUserError", + "description": "An error that occurs during the execution of `DelegateAccessTokenDestroy`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DelegateAccessTokenDestroyUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DelegateAccessTokenDestroyUserErrorCode", + "description": "Possible error codes that can be returned by `DelegateAccessTokenDestroyUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERSISTENCE_FAILED", + "description": "Persistence failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCESS_TOKEN_NOT_FOUND", + "description": "Access token not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAN_ONLY_DELETE_DELEGATE_TOKENS", + "description": "Cannot delete parent access token.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCESS_DENIED", + "description": "Access denied.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DelegateAccessTokenInput", + "description": "The input fields for a delegate access token.", + "fields": null, + "inputFields": [ + { + "name": "delegateAccessScope", + "description": "The list of scopes that will be delegated to the new access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "expiresIn", + "description": "The amount of time, in seconds, after which the delegate access token is no longer valid.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletionEvent", + "description": "Deletion events chronicle the destruction of resources (e.g. products and collections).\nOnce deleted, the deletion event is the only trace of the original's existence,\nas the resource itself has been removed and can no longer be accessed.\n", + "fields": [ + { + "name": "occurredAt", + "description": "The date and time when the deletion event for the related resource was generated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subjectId", + "description": "The ID of the resource that was deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subjectType", + "description": "The type of resource that was deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeletionEventSubjectType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletionEventConnection", + "description": "An auto-generated type for paginating through multiple DeletionEvents.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeletionEventEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeletionEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeletionEvent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeletionEventEdge", + "description": "An auto-generated type which holds one DeletionEvent and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeletionEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeletionEvent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeletionEventSortKeys", + "description": "The set of valid sort keys for the DeletionEvent query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeletionEventSubjectType", + "description": "The supported subject types of deletion events.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COLLECTION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryAvailableService", + "description": "A shipping service and a list of countries that the service is available for.", + "fields": [ + { + "name": "countries", + "description": "The countries the service provider ships to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCountryCodesOrRestOfWorld", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryBrandedPromise", + "description": "Represents a branded promise presented to buyers.\n", + "fields": [ + { + "name": "handle", + "description": "The handle of the branded promise. For example: `shop_promise`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the branded promise. For example: `Shop Promise`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "description": "A shipping service provider or a carrier account.", + "fields": [ + { + "name": "availableServicesForCountries", + "description": "The list of services offered for given destinations.", + "args": [ + { + "name": "origins", + "description": "The locations of the possible origins.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "countryCodes", + "description": "The country codes of the destinations.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "restOfWorld", + "description": "Whether to use 'Rest of World' as the destination.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryAvailableService", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedName", + "description": "The properly formatted name of the shipping service provider, ready to display.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "icon", + "description": "The logo of the service provider.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the shipping service provider.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCarrierServiceAndLocations", + "description": "A carrier service and the associated list of shop locations.", + "fields": [ + { + "name": "carrierService", + "description": "The carrier service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "The list of locations that support this carrier service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCondition", + "description": "A condition that must pass for a delivery method definition to be applied to an order.", + "fields": [ + { + "name": "conditionCriteria", + "description": "The value (weight or price) that the condition field is compared to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DeliveryConditionCriteria", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The field to compare the criterion value against, using the operator.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryConditionField", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operator", + "description": "The operator to compare the field and criterion value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryConditionOperator", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DeliveryConditionCriteria", + "description": "The value (weight or price) that the condition field is compared to.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Weight", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "DeliveryConditionField", + "description": "The field type that the condition will be applied to.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOTAL_WEIGHT", + "description": "The condition will check against the total weight of the order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_PRICE", + "description": "The condition will check against the total price of the order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryConditionOperator", + "description": "The operator to use to determine if the condition passes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The condition will check whether the field is greater than or equal to the criterion.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The condition will check if the field is less than or equal to the criterion.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCountry", + "description": "A country that is used to define a shipping zone.", + "fields": [ + { + "name": "code", + "description": "A two-letter country code in ISO 3166-1 alpha-2 standard.\nIt also includes a flag indicating whether the country should be\na part of the 'Rest Of World' shipping zone.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCountryCodeOrRestOfWorld", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name of the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinces", + "description": "The list of regions associated with this country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProvince", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatedName", + "description": "The translated name of the country. The translation returned is based on the system's locale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCountryAndZone", + "description": "The country details and the associated shipping zone.", + "fields": [ + { + "name": "country", + "description": "The country details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCountry", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zone", + "description": "The name of the shipping zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCountryCodeOrRestOfWorld", + "description": "The country code and whether the country is a part of the 'Rest Of World' shipping zone.\n", + "fields": [ + { + "name": "countryCode", + "description": "The country code in the ISO 3166-1 alpha-2 format.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restOfWorld", + "description": "Whether the country is a part of the 'Rest of World' shipping zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCountryCodesOrRestOfWorld", + "description": "The list of country codes and information whether the countries\nare a part of the 'Rest Of World' shipping zone.\n", + "fields": [ + { + "name": "countryCodes", + "description": "List of applicable country codes in the ISO 3166-1 alpha-2 format.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restOfWorld", + "description": "Whether the countries are a part of the 'Rest of World' shipping zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryCountryInput", + "description": "The input fields to specify a country.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The country code of the country in the ISO 3166-1 alpha-2 format.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "restOfWorld", + "description": "Whether the country is a part of the 'Rest of World' shipping zone.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "provinces", + "description": "The regions associated with this country.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProvinceInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "includeAllProvinces", + "description": "Associate all available provinces with this country.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "description": "A delivery customization.", + "fields": [ + { + "name": "enabled", + "description": "The enabled status of the delivery customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorHistory", + "description": "The error history on the most recent version of the delivery customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FunctionsErrorHistory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "functionId", + "description": "The ID of the Shopify Function implementing the delivery customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "shopifyFunction", + "description": "The Shopify Function implementing the delivery customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the delivery customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationActivationPayload", + "description": "Return type for `deliveryCustomizationActivation` mutation.", + "fields": [ + { + "name": "ids", + "description": "The IDs of the updated delivery customizations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationConnection", + "description": "An auto-generated type for paginating through multiple DeliveryCustomizations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeliveryCustomizationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationCreatePayload", + "description": "Return type for `deliveryCustomizationCreate` mutation.", + "fields": [ + { + "name": "deliveryCustomization", + "description": "Returns the created delivery customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationDeletePayload", + "description": "Return type for `deliveryCustomizationDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "Returns the deleted delivery customization ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationEdge", + "description": "An auto-generated type which holds one DeliveryCustomization and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeliveryCustomizationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "description": "An error that occurs during the execution of a delivery customization mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DeliveryCustomizationErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryCustomizationErrorCode", + "description": "Possible error codes that can be returned by `DeliveryCustomizationError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_NOT_FOUND", + "description": "Function not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CUSTOMIZATION_NOT_FOUND", + "description": "Delivery customization not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE", + "description": "Shop must be on a Shopify Plus plan to activate delivery customizations from a custom app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAUTHORIZED_APP_SCOPE", + "description": "Unauthorized app scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_ACTIVE_DELIVERY_CUSTOMIZATIONS", + "description": "Maximum delivery customizations are already enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", + "description": "Shop must be on a Shopify Plus plan to activate functions from a custom app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_DOES_NOT_IMPLEMENT", + "description": "Function does not implement the required interface for this delivery customization.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_PENDING_DELETION", + "description": "Function is pending deletion.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_ID_CANNOT_BE_CHANGED", + "description": "Function ID cannot be changed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED_INPUT_FIELD", + "description": "Required input field must be present.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_METAFIELDS", + "description": "Could not create or update metafields.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryCustomizationInput", + "description": "The input fields to create and update a delivery customization.", + "fields": null, + "inputFields": [ + { + "name": "functionId", + "description": "The ID of the function providing the delivery customization.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the delivery customization.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "The enabled status of the delivery customization.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional metafields to associate to the delivery customization.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationUpdatePayload", + "description": "Return type for `deliveryCustomizationUpdate` mutation.", + "fields": [ + { + "name": "deliveryCustomization", + "description": "Returns the updated delivery customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLegacyModeBlocked", + "description": "Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.", + "fields": [ + { + "name": "blocked", + "description": "Whether the shop can convert to full multi-location delivery profiles mode.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reasons", + "description": "The reasons why the shop is blocked from converting to full multi-location delivery profiles mode.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryLegacyModeBlockedReason", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryLegacyModeBlockedReason", + "description": "Reasons the shop is blocked from converting to full multi-location delivery profiles mode.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MULTI_LOCATION_DISABLED", + "description": "Multi-Location mode is disabled. The shop can't convert to full multi-location delivery profiles mode.", + "isDeprecated": true, + "deprecationReason": "All shops are now using multi-location mode." + }, + { + "name": "NO_LOCATIONS_FULFILLING_ONLINE_ORDERS", + "description": "There are no locations for this store that can fulfill online orders.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocalPickupSettings", + "description": "Local pickup settings associated with a location.", + "fields": [ + { + "name": "instructions", + "description": "Additional instructions or information related to the local pickup.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickupTime", + "description": "The estimated pickup time to show customers at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryLocalPickupTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryLocalPickupTime", + "description": "Possible pickup time values that a location enabled for local pickup can have.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ONE_HOUR", + "description": "Usually ready in 1 hour.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWO_HOURS", + "description": "Usually ready in 2 hours.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOUR_HOURS", + "description": "Usually ready in 4 hours.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWENTY_FOUR_HOURS", + "description": "Usually ready in 24 hours.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWO_TO_FOUR_DAYS", + "description": "Usually ready in 2-4 days.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIVE_OR_MORE_DAYS", + "description": "Usually ready in 5+ days.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationGroup", + "description": "A location group is a collection of locations. They share zones and delivery methods across delivery\nprofiles.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "A list of all locations that are part of this location group.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "LocationSortKeys", + "ofType": null + }, + "defaultValue": "NAME" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `active`\n - `address1`\n - `address2`\n - `city`\n - `country`\n - `legacy`\n - `name`\n - `province`\n - `zip`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeLegacy", + "description": "If true, also include the legacy locations of fulfillment services.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "includeInactive", + "description": "If true, also include the locations that are deactivated.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationsCount", + "description": "A count of all locations that are part of this location group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZone", + "description": "Links a location group with a zone and the associated method definitions.", + "fields": [ + { + "name": "methodDefinitionCounts", + "description": "The number of method definitions for the zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionCounts", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "methodDefinitions", + "description": "The method definitions associated to a zone and location group.", + "args": [ + { + "name": "eligible", + "description": "Return only eligible or ineligible method definitions.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": "Return only merchant or participant method definitions.", + "type": { + "kind": "ENUM", + "name": "DeliveryMethodDefinitionType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MethodDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zone", + "description": "The zone associated to a location group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryZone", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZoneConnection", + "description": "An auto-generated type for paginating through multiple DeliveryLocationGroupZones.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZoneEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeliveryLocationGroupZoneEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZone", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZoneEdge", + "description": "An auto-generated type which holds one DeliveryLocationGroupZone and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeliveryLocationGroupZoneEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZone", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryLocationGroupZoneInput", + "description": "The input fields for a delivery zone associated to a location group and profile.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "A globally-unique ID of the zone.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the zone.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countries", + "description": "A list of countries to associate with the zone.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryCountryInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "methodDefinitionsToCreate", + "description": "A list of method definitions to create.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryMethodDefinitionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "methodDefinitionsToUpdate", + "description": "A list of method definitions to update.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryMethodDefinitionInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryLocationLocalPickupEnableInput", + "description": "The input fields for a local pickup setting associated with a location.", + "fields": null, + "inputFields": [ + { + "name": "locationId", + "description": "The ID of the location associated with the location setting.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pickupTime", + "description": "The time of the local pickup.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryLocalPickupTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "instructions", + "description": "The instructions for the local pickup.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationLocalPickupSettingsError", + "description": "Represents an error that happened when changing local pickup settings for a location.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DeliveryLocationLocalPickupSettingsErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryLocationLocalPickupSettingsErrorCode", + "description": "Possible error codes that can be returned by `DeliveryLocationLocalPickupSettingsError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE_LOCATION_NOT_FOUND", + "description": "Provided locationId is not for an active location belonging to this store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "An error occurred while changing the local pickup settings.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethod", + "description": "The delivery method used by a fulfillment order.", + "fields": [ + { + "name": "brandedPromise", + "description": "The branded promise that was presented to the buyer during checkout. For example: Shop Promise.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryBrandedPromise", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxDeliveryDateTime", + "description": "The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "methodType", + "description": "The type of the delivery method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryMethodType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minDeliveryDateTime", + "description": "The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethodDefinition", + "description": "A method definition contains the delivery rate and the conditions that must be met for the method to be\napplied.\n", + "fields": [ + { + "name": "active", + "description": "Whether this method definition is active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the method definition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "methodConditions", + "description": "The method conditions that must pass for this method definition to be applied to an order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCondition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the method definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rateProvider", + "description": "The provided rate for this method definition, from a rate definition or participant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DeliveryRateProvider", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionConnection", + "description": "An auto-generated type for paginating through multiple DeliveryMethodDefinitions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeliveryMethodDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryMethodDefinition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionCounts", + "description": "The number of method definitions for a zone, separated into merchant-owned and participant definitions.\n", + "fields": [ + { + "name": "participantDefinitionsCount", + "description": "The number of participant method definitions for the specified zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rateDefinitionsCount", + "description": "The number of merchant-defined method definitions for the specified zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethodDefinitionEdge", + "description": "An auto-generated type which holds one DeliveryMethodDefinition and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeliveryMethodDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryMethodDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryMethodDefinitionInput", + "description": "The input fields for a method definition.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "A globally-unique ID of the method definition. Use only when updating a method definiton.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the method definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description of the method definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "active", + "description": "Whether to use this method definition during rate calculation.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "rateDefinition", + "description": "A rate definition to apply to the method definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DeliveryRateDefinitionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "participant", + "description": "A participant to apply to the method definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DeliveryParticipantInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weightConditionsToCreate", + "description": "A list of weight conditions on the method definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryWeightConditionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "priceConditionsToCreate", + "description": "A list of price conditions on the method definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryPriceConditionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "conditionsToUpdate", + "description": "A list of conditions to update on the method definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryUpdateConditionInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryMethodDefinitionType", + "description": "The different types of method definitions to filter by.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MERCHANT", + "description": "A static merchant-defined rate.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTICIPANT", + "description": "A dynamic participant rate.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryMethodType", + "description": "Possible method types that a delivery method can have.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHIPPING", + "description": "The order is shipped.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICK_UP", + "description": "The order is picked up by the customer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NONE", + "description": "No delivery is needed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETAIL", + "description": "The order is delivered to a retail store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCAL", + "description": "The order is delivered using a local delivery service.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryParticipant", + "description": "A participant defines carrier-calculated rates for shipping services\nwith a possible merchant-defined fixed fee or a percentage-of-rate fee.\n", + "fields": [ + { + "name": "adaptToNewServicesFlag", + "description": "Whether to display new shipping services automatically to the customer when the service becomes available.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "carrierService", + "description": "The carrier used for this participant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixedFee", + "description": "The merchant-defined fixed fee for this participant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "participantServices", + "description": "The carrier-specific services offered by the participant, and whether each service is active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryParticipantService", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "percentageOfRateFee", + "description": "The merchant-defined percentage-of-rate fee for this participant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryParticipantInput", + "description": "The input fields for a participant.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the participant.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "carrierServiceId", + "description": "The ID of the carrier service for this participant.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedFee", + "description": "The fixed feed that's defined by the merchant for this participant.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "percentageOfRateFee", + "description": "The merchant-defined percentage-of-rate fee for this participant.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "participantServices", + "description": "The list of shipping services offered by the participant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryParticipantServiceInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "adaptToNewServices", + "description": "Whether to automatically display new shipping services to the customer when a service becomes available.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryParticipantService", + "description": "A mail service provided by the participant.", + "fields": [ + { + "name": "active", + "description": "Whether the service is active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryParticipantServiceInput", + "description": "The input fields for a shipping service provided by a participant.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the service.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "active", + "description": "Whether the service is active.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryPriceConditionInput", + "description": "The input fields for a price-based condition of a delivery method definition.", + "fields": null, + "inputFields": [ + { + "name": "criteria", + "description": "The monetary value to compare the price of an order to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operator", + "description": "The operator to use for comparison.", + "type": { + "kind": "ENUM", + "name": "DeliveryConditionOperator", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProductVariantsCount", + "description": "How many product variants are in a profile. This count is capped at 500.", + "fields": [ + { + "name": "capped", + "description": "Whether the count has reached the cap of 500.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "count", + "description": "The product variant count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfile", + "description": "A shipping profile. In Shopify, a shipping profile is a set of shipping rates scoped to a set of products or variants that can be shipped from selected locations to zones.\n", + "fields": [ + { + "name": "activeMethodDefinitionsCount", + "description": "The number of active shipping rates for the profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "default", + "description": "Whether this is the default profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyMode", + "description": "Whether this shop has enabled legacy compatibility mode for delivery profiles.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationsWithoutRatesCount", + "description": "The number of locations without rates defined.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the delivery profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originLocationCount", + "description": "The number of active origin locations for the profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantsCount", + "description": "The number of product variants for this profile. The count for the default profile isn't supported and will return -1.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `productVariantsCountV2` instead." + }, + { + "name": "productVariantsCountV2", + "description": "How many product variants are in this profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProductVariantsCount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "profileItems", + "description": "The products and variants associated with this profile.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "profileLocationGroups", + "description": "The location groups and associated zones using this profile.", + "args": [ + { + "name": "locationGroupId", + "description": "Filter the location groups of the profile by location group ID.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileLocationGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroups", + "description": "Selling plan groups associated with the specified delivery profile.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unassignedLocations", + "description": "List of locations that haven't been assigned to a location group for this profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unassignedLocationsPaginated", + "description": "List of locations that have not been assigned to a location group for this profile.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zoneCountryCount", + "description": "The number of countries with active rates to deliver to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileConnection", + "description": "An auto-generated type for paginating through multiple DeliveryProfiles.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeliveryProfileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileEdge", + "description": "An auto-generated type which holds one DeliveryProfile and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeliveryProfileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileInput", + "description": "The input fields for a delivery profile.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the delivery profile.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "profileLocationGroups", + "description": "The list of location groups associated with the delivery profile.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileLocationGroupInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationGroupsToCreate", + "description": "The list of location groups to be created in the delivery profile.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileLocationGroupInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationGroupsToUpdate", + "description": "The list of location groups to be updated in the delivery profile.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 location groups per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileLocationGroupInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationGroupsToDelete", + "description": "The list of location groups to be deleted from the delivery profile.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "variantsToAssociate", + "description": "The list of product variant IDs to be associated with the delivery profile.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "variantsToDissociate", + "description": "The list of product variant IDs to be dissociated from the delivery profile.\nThe dissociated product variants are moved back to the default delivery profile.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "zonesToDelete", + "description": "The list of zone IDs to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "methodDefinitionsToDelete", + "description": "The list of method definition IDs to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "conditionsToDelete", + "description": "The list of condition IDs to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupsToAssociate", + "description": "The list of selling plan groups to be associated with the delivery profile.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupsToDissociate", + "description": "The list of selling plan groups to be dissociated with the delivery profile.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileItem", + "description": "A product and the subset of associated variants that are part of this delivery profile.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "A product associated with this profile.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variants", + "description": "The product variants associated with this delivery profile.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileItemConnection", + "description": "An auto-generated type for paginating through multiple DeliveryProfileItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DeliveryProfileItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileItemEdge", + "description": "An auto-generated type which holds one DeliveryProfileItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DeliveryProfileItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileLocationGroup", + "description": "Links a location group with zones. Both are associated to a delivery profile.", + "fields": [ + { + "name": "countriesInAnyZone", + "description": "The countries already selected in any zone for the specified location group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCountryAndZone", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationGroup", + "description": "The collection of locations that make up the specified location group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationGroupZones", + "description": "The applicable zones associated to the specified location group.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationGroupZoneConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileLocationGroupInput", + "description": "The input fields for a location group associated to a delivery profile.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The globally-unique ID of the delivery profile location group.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locations", + "description": "The list of location IDs to be moved to this location group.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationsToAdd", + "description": "The list of location IDs to be added to this location group.\n\n**Note:** due to API input array limits, a maximum of 250 items can be sent per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationsToRemove", + "description": "The list of location IDs to be removed from this location group.\n\n**Note:** due to API input array limits, a maximum of 250 items can be sent per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "zonesToCreate", + "description": "The list of location group zones to create.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryLocationGroupZoneInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "zonesToUpdate", + "description": "The list of location group zones to update.\n\n**Note:** due to the potential complexity of the nested data, it is recommended to send no more than 5 zones per each request.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryLocationGroupZoneInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProvince", + "description": "A region that is used to define a shipping zone.", + "fields": [ + { + "name": "code", + "description": "The code of the region.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name of the region.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatedName", + "description": "The translated name of the region. The translation returned is based on the system's locale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryProvinceInput", + "description": "The input fields to specify a region.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The code of the region.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryRateDefinition", + "description": "The merchant-defined rate of the [DeliveryMethodDefinition](https://shopify.dev/api/admin-graphql/latest/objects/DeliveryMethodDefinition).", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of this rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryRateDefinitionInput", + "description": "The input fields for a rate definition.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "A globally-unique ID of the rate definition.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the rate definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DeliveryRateProvider", + "description": "A rate provided by a merchant-defined rate or a participant.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DeliveryParticipant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryRateDefinition", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DeliverySetting", + "description": "The `DeliverySetting` object enables you to manage shop-wide shipping settings.\nYou can enable legacy compatibility mode for the multi-location delivery profiles feature\nif the legacy mode isn't blocked.\n", + "fields": [ + { + "name": "legacyModeBlocked", + "description": "Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLegacyModeBlocked", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyModeProfiles", + "description": "Enables legacy compatability mode for the multi-location delivery profiles feature.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliverySettingInput", + "description": "The input fields for shop-level delivery settings.", + "fields": null, + "inputFields": [ + { + "name": "legacyModeProfiles", + "description": "Whether legacy compatability mode is enabled for the multi-location delivery profiles feature.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliverySettingUpdatePayload", + "description": "Return type for `deliverySettingUpdate` mutation.", + "fields": [ + { + "name": "setting", + "description": "The updated delivery shop level settings.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliverySetting", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryShippingOriginAssignPayload", + "description": "Return type for `deliveryShippingOriginAssign` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryUpdateConditionInput", + "description": "The input fields for updating the condition of a delivery method definition.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "A globally-unique ID of the condition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "criteria", + "description": "The value that will be used in comparison.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "criteriaUnit", + "description": "The unit associated with the value that will be used in comparison.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "field", + "description": "The property of an order that will be used in comparison.", + "type": { + "kind": "ENUM", + "name": "DeliveryConditionField", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operator", + "description": "The operator to use for comparison.", + "type": { + "kind": "ENUM", + "name": "DeliveryConditionOperator", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryWeightConditionInput", + "description": "The input fields for a weight-based condition of a delivery method definition.", + "fields": null, + "inputFields": [ + { + "name": "criteria", + "description": "The weight value to compare the weight of an order to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "WeightInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "operator", + "description": "The operator to use for comparison.", + "type": { + "kind": "ENUM", + "name": "DeliveryConditionOperator", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryZone", + "description": "A zone is a group of countries that have the same shipping rates. Customers can order products from a store only if they choose a shipping destination that's included in one of the store's zones.\n", + "fields": [ + { + "name": "countries", + "description": "The list of countries within the zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCountry", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the zone.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DigitalWallet", + "description": "Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLE_PAY", + "description": "Apple Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ANDROID_PAY", + "description": "Android Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GOOGLE_PAY", + "description": "Google Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOPIFY_PAY", + "description": "Shopify Pay.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "Discount", + "description": "A discount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountAutomaticApp", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBasic", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApp", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBasic", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBxgy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeFreeShipping", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DiscountAllocation", + "description": "An amount that's allocated to a line based on an associated discount application.", + "fields": [ + { + "name": "allocatedAmount", + "description": "The money amount that's allocated to a line based on the associated discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `allocatedAmountSet` instead." + }, + { + "name": "allocatedAmountSet", + "description": "The money amount that's allocated to a line based on the associated discount application in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplication", + "description": "The discount application that the allocated amount originated from.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAmount", + "description": "The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items.", + "fields": [ + { + "name": "amount", + "description": "The value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOnEachItem", + "description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountAmountInput", + "description": "The input fields for the value of the discount and how it is applied.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The value of the discount.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnEachItem", + "description": "If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "description": "Discount applications capture the intentions of a discount source at\nthe time of application on an order's line items or shipping lines.\n\nDiscount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is applied to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "index", + "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AutomaticDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ManualDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ScriptDiscountApplication", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "description": "The method by which the discount's value is allocated onto its entitled lines.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACROSS", + "description": "The value is spread across all entitled lines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EACH", + "description": "The value is applied onto every entitled line.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONE", + "description": "The value is specifically applied onto a particular line.", + "isDeprecated": true, + "deprecationReason": "Use ACROSS instead." + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountApplicationConnection", + "description": "An auto-generated type for paginating through multiple DiscountApplications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountApplicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountApplicationEdge", + "description": "An auto-generated type which holds one DiscountApplication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountApplicationLevel", + "description": "The level at which the discount's value is applied.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER", + "description": "The discount is applied at the order level.\nOrder level discounts are not factored into the discountedUnitPriceSet on line items.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LINE", + "description": "The discount is applied at the line level.\nLine level discounts are factored into the discountedUnitPriceSet on line items.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "description": "The lines on the order to which the discount is applied, of the type defined by\nthe discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of\n`LINE_ITEM`, applies the discount on all line items that are entitled to the discount.\nThe value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": "The discount is allocated onto all the lines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENTITLED", + "description": "The discount is allocated onto only the lines that it's entitled for.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPLICIT", + "description": "The discount is allocated onto explicitly chosen lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "description": "The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LINE_ITEM", + "description": "The discount applies onto line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_LINE", + "description": "The discount applies onto shipping lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountAutomatic", + "description": "The type of discount associated to the automatic discount. For example, the automatic discount might offer a basic discount using a fixed percentage, or a fixed amount, on specific products from the order. The automatic discount may also be a BXGY discount, which offers customer discounts on select products if they add a specific product to their order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountAutomaticApp", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBasic", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgy", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticActivatePayload", + "description": "Return type for `discountAutomaticActivate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The activated automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticApp", + "description": "An automatic app discount.", + "fields": [ + { + "name": "appDiscountType", + "description": "The app discount type providing the discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppDiscountType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "asyncUsageCount", + "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountId", + "description": "The ID for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorHistory", + "description": "The error history on the most recent version of the app discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FunctionsErrorHistory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticAppCreatePayload", + "description": "Return type for `discountAutomaticAppCreate` mutation.", + "fields": [ + { + "name": "automaticAppDiscount", + "description": "The created app discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticAppInput", + "description": "The input fields to create an app discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "functionId", + "description": "The ID of the function providing the app discount type.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional metafields to associate to the discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticAppUpdatePayload", + "description": "Return type for `discountAutomaticAppUpdate` mutation.", + "fields": [ + { + "name": "automaticAppDiscount", + "description": "The updated automatic app discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBasic", + "description": "An automatic discount that offers customers a percentage discount, or fixed amount discount, on specific products, collections, or the entire order.", + "fields": [ + { + "name": "asyncUsageCount", + "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerGets", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MerchandiseDiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountMinimumRequirement", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shortSummary", + "description": "A short summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `asyncUsageCount` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBasicCreatePayload", + "description": "Return type for `discountAutomaticBasicCreate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The created automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBasicInput", + "description": "The input fields to create or update an automatic basic discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumRequirementInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerGets", + "description": "Information about the qualifying items and their discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBasicUpdatePayload", + "description": "Return type for `discountAutomaticBasicUpdate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The updated automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBulkDeletePayload", + "description": "Return type for `discountAutomaticBulkDelete` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the automatic discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgy", + "description": "An automatic discount that offers customers a Buy X, Get Y (BXGY) discount.", + "fields": [ + { + "name": "asyncUsageCount", + "description": "The number of times the discount has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerBuys", + "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerBuys", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerGets", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MerchandiseDiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A legacy unique ID for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use DiscountAutomaticNode.id instead." + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `asyncUsageCount` instead." + }, + { + "name": "usesPerOrderLimit", + "description": "The maximum number of times that the discount can be applied to an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgyCreatePayload", + "description": "Return type for `discountAutomaticBxgyCreate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The created automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBxgyInput", + "description": "The input fields to create or update an automatic Buy X, Get Y (BXGY) discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usesPerOrderLimit", + "description": "The maximum number of times that the discount can be applied to an order.", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerBuys", + "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerBuysInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgyUpdatePayload", + "description": "Return type for `discountAutomaticBxgyUpdate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The updated automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticConnection", + "description": "An auto-generated type for paginating through multiple DiscountAutomatics.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountAutomaticEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountAutomatic", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticDeactivatePayload", + "description": "Return type for `discountAutomaticDeactivate` mutation.", + "fields": [ + { + "name": "automaticDiscountNode", + "description": "The deactivated automatic discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticDeletePayload", + "description": "Return type for `discountAutomaticDelete` mutation.", + "fields": [ + { + "name": "deletedAutomaticDiscountId", + "description": "The deleted automatic discount ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticEdge", + "description": "An auto-generated type which holds one DiscountAutomatic and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountAutomaticEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountAutomatic", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "description": "A node containing an automatic discount and its related events.", + "fields": [ + { + "name": "automaticDiscount", + "description": "The automatic discount object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountAutomatic", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNodeConnection", + "description": "An auto-generated type for paginating through multiple DiscountAutomaticNodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticNodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountAutomaticNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNodeEdge", + "description": "An auto-generated type which holds one DiscountAutomaticNode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountAutomaticNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountClass", + "description": "The class of the discount for combining purposes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT", + "description": "Combined as a product discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER", + "description": "Combined as an order discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING", + "description": "Combined as a shipping discount.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountCode", + "description": "The type of discount associated with the discount code. For example, the discount code might offer a basic discount of a fixed percentage, or a fixed amount, on specific products or the order. Alternatively, the discount might offer the customer free shipping on their order. A third option is a Buy X, Get Y (BXGY) discount, which offers a customer discounts on select products if they add a specific product to their order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountCodeApp", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBasic", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBxgy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeFreeShipping", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DiscountCodeActivatePayload", + "description": "Return type for `discountCodeActivate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The activated code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApp", + "description": "A code app discount.", + "fields": [ + { + "name": "appDiscountType", + "description": "The app discount type providing the discount type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppDiscountType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "asyncUsageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeCount", + "description": "The number of redeem codes for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codes", + "description": "A list of redeem codes for the discount.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountId", + "description": "The ID for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorHistory", + "description": "The error history on the most recent version of the discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FunctionsErrorHistory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Indicates whether there are any timeline comments on the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringCycleLimit", + "description": "The number of times a discount applies on recurring purchases (subscriptions).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareableUrls", + "description": "URLs that can be used to share the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountShareableUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSales", + "description": "The total sales from orders where the discount was used.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeAppCreatePayload", + "description": "Return type for `discountCodeAppCreate` mutation.", + "fields": [ + { + "name": "codeAppDiscount", + "description": "The created code app discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeAppInput", + "description": "The input fields to create a code app discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "functionId", + "description": "The ID of the function providing the app discount type.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code to use the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional metafields to associate to the discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeAppUpdatePayload", + "description": "Return type for `discountCodeAppUpdate` mutation.", + "fields": [ + { + "name": "codeAppDiscount", + "description": "The updated code app discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApplication", + "description": "Discount code applications capture the intentions of a discount code at\nthe time that it is applied onto an order.\n\nDiscount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is applied to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The string identifying the discount code that was used at the time of application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "index", + "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBasic", + "description": "A code discount that offers customers a percentage or fixed amount discount on specific products, collections, or the entire order.", + "fields": [ + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "asyncUsageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeCount", + "description": "The number of redeem codes for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codes", + "description": "A list of redeem codes for the discount.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerGets", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MerchandiseDiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Indicates whether there are any timeline comments on the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "args": [], + "type": { + "kind": "UNION", + "name": "DiscountMinimumRequirement", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringCycleLimit", + "description": "The number of times a discount applies on recurring purchases (subscriptions).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareableUrls", + "description": "URLs that can be used to share the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountShareableUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shortSummary", + "description": "A short summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSales", + "description": "The total sales from orders where the discount was used.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBasicCreatePayload", + "description": "Return type for `discountCodeBasicCreate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The created code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBasicInput", + "description": "The input fields to create or update a basic code discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumRequirementInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code to use the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurringCycleLimit", + "description": "The number of times a discount applies on recurring purchases (subscriptions).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBasicUpdatePayload", + "description": "Return type for `discountCodeBasicUpdate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The updated code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBulkActivatePayload", + "description": "Return type for `discountCodeBulkActivate` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that activates the code discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBulkDeactivatePayload", + "description": "Return type for `discountCodeBulkDeactivate` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that deactivates the code discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBulkDeletePayload", + "description": "Return type for `discountCodeBulkDelete` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that deletes the code discounts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBxgy", + "description": "A code discount that offers customers a Buy X, Get Y (BXGY) discount.", + "fields": [ + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "asyncUsageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeCount", + "description": "The number of redeem codes for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codes", + "description": "A list of redeem codes for the discount.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerBuys", + "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerBuys", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCustomerGets", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MerchandiseDiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Indicates whether there are any timeline comments on the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareableUrls", + "description": "URLs that can be used to share the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountShareableUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSales", + "description": "The total sales from orders where the discount was used.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usesPerOrderLimit", + "description": "The maximum number of times that the discount can be applied to an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBxgyCreatePayload", + "description": "Return type for `discountCodeBxgyCreate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The created code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBxgyInput", + "description": "The input fields to create or update a BXGY code discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerBuys", + "description": "The qualifying items and the quantity of each one that the customer has to buy to be eligible for the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerBuysInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerGets", + "description": "The qualifying items that will be discounted, the quantity of each one, and the total value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSelection", + "description": "The customers that are eligible to use the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code to use the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usesPerOrderLimit", + "description": "The maximum number of times that the discount can be applied to an order.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeBxgyUpdatePayload", + "description": "Return type for `discountCodeBxgyUpdate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The updated code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeDeactivatePayload", + "description": "Return type for `discountCodeDeactivate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The deactivated code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeDeletePayload", + "description": "Return type for `discountCodeDelete` mutation.", + "fields": [ + { + "name": "deletedCodeDiscountId", + "description": "The deleted code discount ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeFreeShipping", + "description": "A code discount that offers customers free shipping on their order.", + "fields": [ + { + "name": "appliesOnOneTimePurchase", + "description": "Whether the discount applies on regular one-time-purchase shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOnSubscription", + "description": "Whether the discount applies on subscription shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "asyncUsageCount", + "description": "The number of times that the discount has been used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeCount", + "description": "The number of redeem codes for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codes", + "description": "A list of redeem codes for the discount.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the discount was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSelection", + "description": "The customers that can use the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "destinationSelection", + "description": "A shipping destination that qualifies for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountShippingDestinationSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShippingDiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Indicates whether there are any timeline comments on the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumShippingPrice", + "description": "The maximum shipping price amount accepted to qualify for the discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "args": [], + "type": { + "kind": "UNION", + "name": "DiscountMinimumRequirement", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringCycleLimit", + "description": "The number of times a discount applies on recurring purchases (subscriptions).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareableUrls", + "description": "URLs that can be used to share the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountShareableUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shortSummary", + "description": "A short summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSales", + "description": "The total sales from orders where the discount was used.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the discount was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeFreeShippingCreatePayload", + "description": "Return type for `discountCodeFreeShippingCreate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The created code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeFreeShippingInput", + "description": "The input fields to create or update a free shipping code discount.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the shipping discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "startsAt", + "description": "The date and time when the discount starts.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "endsAt", + "description": "The date and time when the discount ends. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code to use the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the discount can be used. For open-ended discounts, use `null`.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOncePerCustomer", + "description": "Whether the discount can be applied only once per customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumRequirement", + "description": "The minimum subtotal or quantity that's required for the discount to be applied.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumRequirementInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSelection", + "description": "The customers that are eligible to use the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "destination", + "description": "A list of destinations where the discount will apply.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountShippingDestinationSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maximumShippingPrice", + "description": "The maximum shipping price that qualifies for the discount.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurringCycleLimit", + "description": "The number of times a discount applies on recurring purchases (subscriptions).", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnOneTimePurchase", + "description": "Whether the discount applies on regular one-time-purchase items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnSubscription", + "description": "Whether the discount applies on subscription items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeFreeShippingUpdatePayload", + "description": "Return type for `discountCodeFreeShippingUpdate` mutation.", + "fields": [ + { + "name": "codeDiscountNode", + "description": "The updated code discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "description": "A node containing a code discount and its related events.", + "fields": [ + { + "name": "codeDiscount", + "description": "The underlying code discount object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNodeConnection", + "description": "An auto-generated type for paginating through multiple DiscountCodeNodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCodeNodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountCodeNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNodeEdge", + "description": "An auto-generated type which holds one DiscountCodeNode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountCodeNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeRedeemCodeBulkDeletePayload", + "description": "Return type for `discountCodeRedeemCodeBulkDelete` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that deletes the discount redeem codes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "description": "The set of valid sort keys for the DiscountCode query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CODE", + "description": "Sort by the `code` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCollections", + "description": "A list of collections that the discount can have as a prerequisite or a list of collections to which the discount can be applied.", + "fields": [ + { + "name": "collections", + "description": "The list of collections that the discount can have as a prerequisite or the list of collections to which the discount can be applied.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCollectionsInput", + "description": "The input fields for collections attached to a discount.", + "fields": null, + "inputFields": [ + { + "name": "add", + "description": "Specifies list of collection ids to add.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "remove", + "description": "Specifies list of collection ids to remove.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "description": "Determines which discount classes the discount can combine with.", + "fields": [ + { + "name": "orderDiscounts", + "description": "Combines with order discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDiscounts", + "description": "Combines with product discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDiscounts", + "description": "Combines with shipping discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "description": "The input fields to determine which discount classes the discount can combine with.", + "fields": null, + "inputFields": [ + { + "name": "productDiscounts", + "description": "Combines with product discounts.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "orderDiscounts", + "description": "Combines with order discounts.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "shippingDiscounts", + "description": "Combines with shipping discounts.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCountries", + "description": "The shipping destinations where the discount can be applied.", + "fields": [ + { + "name": "countries", + "description": "The codes for the countries where the discount can be applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "includeRestOfWorld", + "description": "Whether the discount is applicable to countries that haven't been defined in the shop's shipping zones.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCountriesInput", + "description": "The input fields for a list of countries to add or remove from the free shipping discount.", + "fields": null, + "inputFields": [ + { + "name": "add", + "description": "The country codes to add to the list of countries where the discount applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "remove", + "description": "The country codes to remove from the list of countries where the discount applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "includeRestOfWorld", + "description": "Whether the discount code is applicable to countries that haven't been defined in the shop's shipping zones.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCountryAll", + "description": "The `DiscountCountryAll` object lets you target all countries as shipping destination for discount eligibility.", + "fields": [ + { + "name": "allCountries", + "description": "Whether the discount can be applied to all countries as shipping destination. This value is always `true`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomerAll", + "description": "The `DiscountCustomerAll` object lets you target all customers for discount eligibility.", + "fields": [ + { + "name": "allCustomers", + "description": "Whether the discount can be applied by all customers. This value is always `true`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomerBuys", + "description": "The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable.", + "fields": [ + { + "name": "items", + "description": "The items required for the discount to be applicable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountItems", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The prerequisite value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerBuysValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerBuysInput", + "description": "The input fields for prerequisite items and quantity for the discount.", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The quantity of prerequisite items.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerBuysValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "items", + "description": "The IDs of items that the customer buys. The items can be either collections or products.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountItemsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountCustomerBuysValue", + "description": "The prerequisite for the discount to be applicable. For example, the discount might require a customer to buy a minimum quantity of select items. Alternatively, the discount might require a customer to spend a minimum amount on select items.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountPurchaseAmount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountQuantity", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerBuysValueInput", + "description": "The input fields for prerequisite quantity or minimum purchase amount required for the discount.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The quantity of prerequisite items.", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "amount", + "description": "The prerequisite minimum purchase amount required for the discount to be applicable.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomerGets", + "description": "The qualifying items in an order, the quantity of each one, and the total value of the discount.", + "fields": [ + { + "name": "appliesOnOneTimePurchase", + "description": "Whether the discount applies on regular one-time-purchase items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOnSubscription", + "description": "Whether the discount applies on subscription items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The items to which the discount applies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountItems", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Entitled quantity and the discount value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountCustomerGetsValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsInput", + "description": "Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The quantity of items discounted and the discount value.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "items", + "description": "The IDs of the items that the customer gets. The items can be either collections or products.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountItemsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnOneTimePurchase", + "description": "Whether the discount applies on regular one-time-purchase items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnSubscription", + "description": "Whether the discount applies on subscription items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountCustomerGetsValue", + "description": "The type of the discount value and how it will be applied. For example, it might be a percentage discount on a fixed number of items. Alternatively, it might be a fixed amount evenly distributed across all items or on each individual item. A third example is a percentage discount on all items.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountAmount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountOnQuantity", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountPercentage", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerGetsValueInput", + "description": "The input fields for the quantity of items discounted and the discount value.", + "fields": null, + "inputFields": [ + { + "name": "discountOnQuantity", + "description": "The quantity of the items that are discounted and the discount value.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountOnQuantityInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "percentage", + "description": "The percentage value of the discount. Value must be between 0.00 - 1.00.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "discountAmount", + "description": "The value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountAmountInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomerSegments", + "description": "A list of customer segments that contain the customers that the discount applies to.", + "fields": [ + { + "name": "segments", + "description": "A list of customer segments that contain the customers who can use the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSegmentsInput", + "description": "The input fields for which customer segments to add to or remove from the discount.", + "fields": null, + "inputFields": [ + { + "name": "add", + "description": "A list of customer segments to add to the current list of customer segments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "remove", + "description": "A list of customer segments to remove from the current list of customer segments.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountCustomerSelection", + "description": "The type used for targeting a set of customers who are eligible for the discount. For example, the discount might be available to all customers or it might only be available to a specific set of customers. You can define the set of customers by targeting a list of customer segments, or by targeting a list of specific customers.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountCustomerAll", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomerSegments", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomers", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSelectionInput", + "description": "The input fields for the customers who can use this discount.", + "fields": null, + "inputFields": [ + { + "name": "all", + "description": "Whether all customers can use this discount.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customers", + "description": "The list of customer IDs to add or remove from the list of customers.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomersInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerSegments", + "description": "The list of customer segment IDs to add or remove from the list of customer segments.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomerSegmentsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCustomers", + "description": "A list of customers eligible for the discount.", + "fields": [ + { + "name": "customers", + "description": "The list of customers eligible for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountCustomersInput", + "description": "The input fields for which customers to add to or remove from the discount.", + "fields": null, + "inputFields": [ + { + "name": "add", + "description": "A list of customers to add to the current list of customers who can use the discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "remove", + "description": "A list of customers to remove from the current list of customers who can use the discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountEffect", + "description": "The type of discount that will be applied. Currently, only a percentage discount is supported.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountPercentage", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountEffectInput", + "description": "The input fields for how the discount will be applied. Currently, only percentage off is supported.", + "fields": null, + "inputFields": [ + { + "name": "percentage", + "description": "The percentage value of the discount. Value must be between 0.00 - 1.00.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountErrorCode", + "description": "Possible error codes that can be returned by `DiscountUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EQUAL_TO", + "description": "The input value should be equal to the value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_ARGUMENTS", + "description": "Too many arguments provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENT", + "description": "Missing a required argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACTIVE_PERIOD_OVERLAP", + "description": "The active period overlaps with other automatic discounts. At any given time, only one automatic discount can be active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCEEDED_MAX", + "description": "The value exceeded the maximum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MINIMUM_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT", + "description": "Specify a minimum subtotal or a quantity, but not both.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALUE_OUTSIDE_RANGE", + "description": "The value is outside of the allowed range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFLICT", + "description": "The attribute selection contains conflicting settings.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMPLICIT_DUPLICATE", + "description": "The value is already present through another selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE", + "description": "The input value is already present.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS", + "description": "The `combinesWith` settings are invalid for the discount class.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE", + "description": "The discountClass is invalid for the price rule.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_APP_DISCOUNTS", + "description": "The active period overlaps with too many other app-provided discounts. There's a limit on the number of app discounts that can be active at any given time.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountItems", + "description": "The type used to target the items required for discount eligibility, or the items to which the application of a discount might apply. For example, for a customer to be eligible for a discount, they're required to add an item from a specified collection to their order. Alternatively, a customer might be required to add a specific product or product variant. When using this type to target which items the discount will apply to, the discount might apply to all items on the order, or to specific products and product variants, or items in a given collection.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AllDiscountItems", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCollections", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountProducts", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountItemsInput", + "description": "The input fields for the items attached to a discount. You can specify the discount items by product ID or collection ID.\n", + "fields": null, + "inputFields": [ + { + "name": "products", + "description": "The products and product variants that are attached to a discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountProductsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "collections", + "description": "The collections that are attached to a discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCollectionsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "all", + "description": "Whether all items should be selected.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountMinimumQuantity", + "description": "The minimum quantity of items required for the discount to apply.", + "fields": [ + { + "name": "greaterThanOrEqualToQuantity", + "description": "The minimum quantity of items that's required for the discount to be applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumQuantityInput", + "description": "The input fields for the minimum quantity required for the discount.", + "fields": null, + "inputFields": [ + { + "name": "greaterThanOrEqualToQuantity", + "description": "The minimum quantity of items that's required for the discount to be applied.", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountMinimumRequirement", + "description": "The type of minimum requirement that must be met for the discount to be applied. For example, a customer must spend a minimum subtotal to be eligible for the discount. Alternatively, a customer must purchase a minimum quantity of items to be eligible for the discount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountMinimumQuantity", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountMinimumSubtotal", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumRequirementInput", + "description": "The input fields for the minimum quantity or subtotal required for a discount.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The minimum required quantity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumQuantityInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "subtotal", + "description": "The minimum required subtotal.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumSubtotalInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountMinimumSubtotal", + "description": "The minimum subtotal required for the discount to apply.", + "fields": [ + { + "name": "greaterThanOrEqualToSubtotal", + "description": "The minimum subtotal that's required for the discount to be applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountMinimumSubtotalInput", + "description": "The input fields for the minimum subtotal required for a discount.", + "fields": null, + "inputFields": [ + { + "name": "greaterThanOrEqualToSubtotal", + "description": "The minimum subtotal that's required for the discount to be applied.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "description": "A discount wrapper node.", + "fields": [ + { + "name": "discount", + "description": "A discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "Discount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountNodeConnection", + "description": "An auto-generated type for paginating through multiple DiscountNodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountNodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountNodeEdge", + "description": "An auto-generated type which holds one DiscountNode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountNodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountOnQuantity", + "description": "The quantity of items discounted, the discount value, and how the discount will be applied.", + "fields": [ + { + "name": "effect", + "description": "The discount's effect on qualifying items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DiscountEffect", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of items being discounted. The customer must have at least this many items of specified products or product variants in their order to be eligible for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountQuantity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountOnQuantityInput", + "description": "The input fields for the quantity of items discounted and the discount value.", + "fields": null, + "inputFields": [ + { + "name": "quantity", + "description": "The quantity of items that are discounted.", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "effect", + "description": "The percentage value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountEffectInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountPercentage", + "description": "A discount effect that gives customers a percentage off of specified items on their order.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountProducts", + "description": "A list of products and product variants that the discount can have as a prerequisite or a list of products and product variants to which the discount can be applied.", + "fields": [ + { + "name": "productVariants", + "description": "The list of product variants that the discount can have as a prerequisite or the list of product variants to which the discount can be applied.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products that the discount can have as a prerequisite or the list of products to which the discount can be applied.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountProductsInput", + "description": "The input fields for the products and product variants attached to a discount.", + "fields": null, + "inputFields": [ + { + "name": "productsToAdd", + "description": "Specifies list of product ids to add.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productsToRemove", + "description": "Specifies list of product ids to remove.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantsToAdd", + "description": "Specifies list of product variant ids to add.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantsToRemove", + "description": "Specifies list of product variant ids to remove.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountPurchaseAmount", + "description": "A purchase amount in the context of a discount. This object can be used to define the minimum purchase amount required for a discount to be applicable.", + "fields": [ + { + "name": "amount", + "description": "The purchase amount in decimal format.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountQuantity", + "description": "A quantity of items in the context of a discount. This object can be used to define the minimum quantity of items required to apply a discount. Alternatively, it can be used to define the quantity of items that can be discounted.", + "fields": [ + { + "name": "quantity", + "description": "The quantity of items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCode", + "description": "A code that a customer can use at checkout to receive a discount. For example, a customer can use the redeem code 'SUMMER20' at checkout to receive a 20% discount on their entire order.", + "fields": [ + { + "name": "asyncUsageCount", + "description": "The number of times that the discount redeem code has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The code that a customer can use at checkout to receive a discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdBy", + "description": "The application that created the discount redeem code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID of the discount redeem code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkAddPayload", + "description": "Return type for `discountRedeemCodeBulkAdd` mutation.", + "fields": [ + { + "name": "bulkCreation", + "description": "The ID of the discount redeem code bulk creation operation. The properties and status of the operation can be tracked using the [`DiscountRedeemCodeBulkCreation` query](https://shopify.dev/api/admin-graphql/2022-04/queries/discountRedeemCodeBulkCreation).", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreation", + "description": "The properties and status of a bulk discount redeem code creation operation.", + "fields": [ + { + "name": "codes", + "description": "The result of each code creation operation associated with the bulk creation operation including any errors that might have occurred during the operation.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codesCount", + "description": "The number of codes to create.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the bulk creation was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCode", + "description": "The code discount associated with the created codes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "done", + "description": "Whether the bulk creation is still queued (`false`) or has been run (`true`).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "failedCount", + "description": "The number of codes that weren't created successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "importedCount", + "description": "The number of codes created successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCode", + "description": "A result of a discount redeem code creation operation created by a bulk creation.", + "fields": [ + { + "name": "code", + "description": "The code to use in the discount redeem code creation operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountRedeemCode", + "description": "The successfully created discount redeem code.\n\nIf the discount redeem code couldn't be created, then this field is `null``.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DiscountRedeemCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "A list of errors that occurred during the creation operation of the discount redeem code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCodeConnection", + "description": "An auto-generated type for paginating through multiple DiscountRedeemCodeBulkCreationCodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountRedeemCodeBulkCreationCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCodeEdge", + "description": "An auto-generated type which holds one DiscountRedeemCodeBulkCreationCode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountRedeemCodeBulkCreationCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreationCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeConnection", + "description": "An auto-generated type for paginating through multiple DiscountRedeemCodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountRedeemCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeEdge", + "description": "An auto-generated type which holds one DiscountRedeemCode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountRedeemCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountRedeemCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountRedeemCodeInput", + "description": "The input fields for the redeem code to attach to a discount.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The code that a customer can use at checkout to receive the associated discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountShareableUrl", + "description": "A shareable URL for a discount code.", + "fields": [ + { + "name": "targetItemImage", + "description": "The image URL of the item (product or collection) to which the discount applies.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of page that's associated with the URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountShareableUrlTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the page that's associated with the URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL for the discount code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountShareableUrlTargetType", + "description": "The type of page where a shareable discount URL lands.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "HOME", + "description": "The URL lands on a home page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "The URL lands on a product page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION", + "description": "The URL lands on a collection page.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DiscountShippingDestinationSelection", + "description": "The type used to target the eligible countries of an order's shipping destination for which the discount applies. For example, the discount might be applicable when shipping to all countries, or only to a set of countries.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DiscountCountries", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCountryAll", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DiscountShippingDestinationSelectionInput", + "description": "The input fields for the destinations where the free shipping discount will be applied.", + "fields": null, + "inputFields": [ + { + "name": "all", + "description": "Whether the discount code applies to all countries.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "countries", + "description": "A list of countries where the discount code will apply.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCountriesInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountSortKeys", + "description": "The set of valid sort keys for the Discount query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STARTS_AT", + "description": "Sort by the `starts_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENDS_AT", + "description": "Sort by the `ends_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountStatus", + "description": "The status of the discount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The discount is active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The discount is expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "The discount is scheduled.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountTargetType", + "description": "The type of line (line item or shipping line) on an order that the subscription discount is applicable towards.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LINE_ITEM", + "description": "The discount applies onto line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_LINE", + "description": "The discount applies onto shipping lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountType", + "description": "The type of the subscription discount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MANUAL", + "description": "Manual discount type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CODE_DISCOUNT", + "description": "Code discount type.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountUserError", + "description": "An error that occurs during the execution of a discount mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DiscountErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "extraInfo", + "description": "Extra information about this error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "DisplayableError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AbandonmentEmailStateUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppSubscriptionTrialExtendUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BillingAttemptUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BulkMutationUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BulkProductResourceFeedbackCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BusinessCustomerUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartTransformCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartTransformDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CatalogUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CollectionAddProductsV2UserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerMergeUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreateFromDuplicationDataUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetDuplicationDataUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetUpdateUrlUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethodUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQueryUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DelegateAccessTokenDestroyUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomizationError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationLocalPickupSettingsError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DisputeEvidenceUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ErrorsWebPixelUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FilesUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderHoldUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMergeUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderReleaseHoldUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderRescheduleUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersReleaseHoldsUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustQuantitiesUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryBulkToggleActivationUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryMoveQuantitiesUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventorySetOnHandQuantitiesUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LocationActivateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LocationAddUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LocationDeactivateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LocationDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LocationEditUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketCurrencySettingsUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionPinUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUnpinUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderCreateMandatePaymentUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderInvoiceSendUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentReminderSendUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesByProductBulkUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceListPriceUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceListUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductChangeStatusUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductFullSyncUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantRelationshipBulkUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkReorderUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionUpdateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PublicationUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "QuantityRuleUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicyUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopResourceFeedbackCreateUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionEnableUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TaxAppConfigureUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TranslationUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteByIdsUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySavedSearchUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySearchUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImportUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "DisputeEvidenceUpdatePayload", + "description": "Return type for `disputeEvidenceUpdate` mutation.", + "fields": [ + { + "name": "disputeEvidence", + "description": "The updated dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEvidence", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DisputeEvidenceUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DisputeEvidenceUpdateUserError", + "description": "An error that occurs during the execution of `DisputeEvidenceUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "DisputeEvidenceUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DisputeEvidenceUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `DisputeEvidenceUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DISPUTE_EVIDENCE_NOT_FOUND", + "description": "Dispute evidence could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EVIDENCE_ALREADY_ACCEPTED", + "description": "Evidence already accepted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EVIDENCE_PAST_DUE_DATE", + "description": "Evidence past due date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILES_SIZE_EXCEEDED_LIMIT", + "description": "Combined files size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LARGE", + "description": "Individual file size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DisputeStatus", + "description": "The possible statuses of a dispute.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NEEDS_RESPONSE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDER_REVIEW", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHARGE_REFUNDED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCEPTED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WON", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOST", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DisputeType", + "description": "The possible types for a dispute.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CHARGEBACK", + "description": "The dispute has turned into a chargeback.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INQUIRY", + "description": "The dispute is in the inquiry phase.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Domain", + "description": "A unique string that represents the address of a Shopify store on the Internet.", + "fields": [ + { + "name": "host", + "description": "The host name of the domain. For example, `example.com`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localization", + "description": "The localization of the domain, if the domain doesn't redirect.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DomainLocalization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketWebPresence", + "description": "The web presence of the domain.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketWebPresence", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sslEnabled", + "description": "Whether SSL is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the domain (for example, `https://example.com`).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DomainLocalization", + "description": "The country and language settings assigned to a domain.", + "fields": [ + { + "name": "alternateLocales", + "description": "The ISO codes for the domain’s alternate locales. For example, `[\"en\"]`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The ISO code for the country assigned to the domain. For example, `\"CA\"` or \"*\" for a domain set to \"Rest of world\".", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultLocale", + "description": "The ISO code for the domain’s default locale. For example, `\"en\"`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "description": "An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:\n\n- Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.\n- Send invoices to customers to pay with a secure checkout link.\n- Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.\n- Re-create orders manually from active sales channels.\n- Sell products at discount or wholesale rates.\n- Take pre-orders.\n- Save an order as a draft and resume working on it later.\n\nFor Draft orders in multiple currencies `presentment_money` is the source of truth for what a customer is going to be charged and `shop_money` is an estimate of what the merchant might receive in their local currency.\n\n**Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data.\n", + "fields": [ + { + "name": "appliedDiscount", + "description": "The order-level discount applied to the draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrderAppliedDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddress", + "description": "The billing address of the customer.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddressMatchesShippingAddress", + "description": "Whether the billing address matches the shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completedAt", + "description": "The date and time when the draft order converted to a new order,\nand the draft order's status changed to **Completed**.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the draft order was created in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The three letter code for the currency of the store at the time of the most recent update to the draft order.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "The custom information added to the draft order on behalf of the customer.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer who will be sent an invoice for the draft order, if there is one.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the customer, which is used to send notifications.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The list of events associated with the draft order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Whether the merchant has added timeline comments to the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "invoiceEmailTemplateSubject", + "description": "The subject defined for the draft invoice email template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "invoiceSentAt", + "description": "The date and time when the invoice was last emailed to the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "invoiceUrl", + "description": "The link to the checkout, which is sent to the customer in the invoice email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "The list of the line items in the draft order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemsSubtotalPrice", + "description": "The subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localizationExtensions", + "description": "List of localization extensions for the resource.", + "args": [ + { + "name": "countryCodes", + "description": "The country codes of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "purposes", + "description": "The purpose of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionPurpose", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtensionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketName", + "description": "The name of the selected market.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketRegionCountryCode", + "description": "The selected market region country code for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The identifier for the draft order, which is unique within the store. For example, _#D1223_.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note2", + "description": "The text from an optional note attached to the draft order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order that was created from this draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTerms", + "description": "The associated payment terms for this draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number assigned to the draft order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "poNumber", + "description": "The purchase order number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentCurrencyCode", + "description": "The payment currency of the customer for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "purchasingEntity", + "description": "The purchasing entity for the draft order.", + "args": [], + "type": { + "kind": "UNION", + "name": "PurchasingEntity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ready", + "description": "Whether the Draft Order is ready and can be completed. Draft Orders\n might have asynchronous operations that can take time to finish.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reserveInventoryUntil", + "description": "The time after which inventory will automatically be restocked.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The shipping address of the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLine", + "description": "The line item that contains the shipping costs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Status of the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DraftOrderStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPrice", + "description": "The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceSet", + "description": "A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A comma separated list of tags associated with the draft order. Updating `tags` overwrites\nany existing tags that were previously added to the draft order. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxExempt", + "description": "Whether the draft order is tax exempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "Total amount of taxes charged for each line item and shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxesIncluded", + "description": "Whether the line item prices include taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountsSet", + "description": "The total discounts for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalLineItemsPriceSet", + "description": "The total price of line items for this draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPrice", + "description": "The total amount of the draft order, including taxes, shipping charges, and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "The total amount of the draft order including taxes, shipping charges, and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPrice", + "description": "The total shipping charge for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPriceSet", + "description": "The total shipping charge for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTax", + "description": "The total amount of taxes for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxSet", + "description": "The total amount of taxes for the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalWeight", + "description": "The total weight in grams of the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the draft order was last changed.\nThe format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visibleToCustomer", + "description": "Whether the draft order will be visible to the customer on the self-serve portal.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasLocalizationExtensions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderAppliedDiscount", + "description": "The order-level discount applied to a draft order.", + "fields": [ + { + "name": "amount", + "description": "Amount of the order-level discount that's applied to the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountV2` instead." + }, + { + "name": "amountSet", + "description": "The amount of money discounted, with values shown in both shop currency and presentment currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountV2", + "description": "Amount of money discounted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Description of the order-level discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Name of the order-level discount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The order level discount amount. If `valueType` is `\"percentage\"`,\nthen `value` is the percentage discount.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "valueType", + "description": "Type of the order-level discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DraftOrderAppliedDiscountType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DraftOrderAppliedDiscountInput", + "description": "The input fields for applying an order-level discount to a draft order.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The applied amount of the discount.\nIf the type of the discount is fixed amount, then this is the fixed dollar amount.\nIf the type is percentage, then this is the subtotal multiplied by the percentage.\n", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Reason for the discount.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "Title of the discount.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the discount.\nIf the type of the discount is fixed amount, then this is a fixed dollar amount.\nIf the type is percentage, then this is the percentage.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "valueType", + "description": "The type of discount.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DraftOrderAppliedDiscountType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DraftOrderAppliedDiscountType", + "description": "The valid discount types that can be applied to a draft order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED_AMOUNT", + "description": "A fixed amount in the store's currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERCENTAGE", + "description": "A percentage of the order subtotal.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderBulkAddTagsPayload", + "description": "Return type for `draftOrderBulkAddTags` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job for adding tags to the draft orders.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderBulkDeletePayload", + "description": "Return type for `draftOrderBulkDelete` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job for deleting the draft orders.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderBulkRemoveTagsPayload", + "description": "Return type for `draftOrderBulkRemoveTags` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job for removing tags from the draft orders.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderCalculatePayload", + "description": "Return type for `draftOrderCalculate` mutation.", + "fields": [ + { + "name": "calculatedDraftOrder", + "description": "The calculated properties for a draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedDraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderCompletePayload", + "description": "Return type for `draftOrderComplete` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The completed draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "description": "An auto-generated type for paginating through multiple DraftOrders.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DraftOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderCreateFromOrderPayload", + "description": "Return type for `draftOrderCreateFromOrder` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The created Draft Order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderCreateMerchantCheckoutPayload", + "description": "Return type for `draftOrderCreateMerchantCheckout` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderCreatePayload", + "description": "Return type for `draftOrderCreate` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The created draft order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DraftOrderDeleteInput", + "description": "The input fields to specify the draft order to delete by its ID.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the draft order to delete.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderDeletePayload", + "description": "Return type for `draftOrderDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted draft order.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderDuplicatePayload", + "description": "Return type for `draftOrderDuplicate` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The newly duplicated draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderEdge", + "description": "An auto-generated type which holds one DraftOrder and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DraftOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DraftOrderInput", + "description": "The input fields used to create or update a draft order.", + "fields": null, + "inputFields": [ + { + "name": "appliedDiscount", + "description": "The discount that will be applied to the draft order.\nA draft order line item can have one discount. A draft order can also have one order-level discount.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderAppliedDiscountInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The mailing address associated with the payment method.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "Extra information added to the customer.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The customer's email address.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lineItems", + "description": "Product variant line item or custom line item associated to the draft order.\nEach draft order must include at least one line item.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Metafields attached to the draft order.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "localizationExtensions", + "description": "The localization extensions attached to the draft order. For example, Tax IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LocalizationExtensionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The text of an optional note that a shop owner can attach to the draft order.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingAddress", + "description": "The mailing address to where the order will be shipped.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingLine", + "description": "A shipping line object, which details the shipping method used.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShippingLineInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A comma separated list of tags that have been added to the draft order.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "taxExempt", + "description": "Whether or not taxes are exempt for the draft order.\nIf false, then Shopify will refer to the taxable field for each line item.\nIf a customer is applied to the draft order, then Shopify will use the customer's tax exempt field instead.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "useCustomerDefaultAddress", + "description": "Sent as part of a draft order object to load customer shipping information.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "visibleToCustomer", + "description": "Whether the draft order will be visible to the customer on the self-serve portal.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reserveInventoryUntil", + "description": "Time after which inventory will automatically be restocked.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "presentmentCurrencyCode", + "description": "The payment currency of the customer for this draft order.", + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketRegionCountryCode", + "description": "The selected market region country code for the draft order.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The customer's phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentTerms", + "description": "The fields used to create payment terms.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "purchasingEntity", + "description": "The purchasing entity for this draft order.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PurchasingEntityInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sourceName", + "description": "The source of the checkout.\n To use this field for sales attribution, you must register the channels that your app is managing.\n You can register the channels that your app is managing by completing\n [this Google Form](https://docs.google.com/forms/d/e/1FAIpQLScmVTZRQNjOJ7RD738mL1lGeFjqKVe_FM2tO9xsm21QEo5Ozg/viewform?usp=sf_link).\n After you've submitted your request, you need to wait for your request to be processed by Shopify.\n You can find a list of your channels in the Partner Dashboard, in your app's Marketplace extension.\n You need to specify the handle as the `source_name` value in your request.\n The handle is the channel that the order was placed from.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "poNumber", + "description": "The purchase order number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderInvoicePreviewPayload", + "description": "Return type for `draftOrderInvoicePreview` mutation.", + "fields": [ + { + "name": "previewHtml", + "description": "The draft order invoice email rendered as HTML to allow previewing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewSubject", + "description": "The subject preview for the draft order invoice email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderInvoiceSendPayload", + "description": "Return type for `draftOrderInvoiceSend` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The draft order an invoice email is sent for.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderLineItem", + "description": "A line item included in a draft order.", + "fields": [ + { + "name": "appliedDiscount", + "description": "The discount that will be applied to the line item or the overall order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrderAppliedDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom", + "description": "Whether the line item is a custom line item (`true`) or a product variant line item (`false`).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributesV2", + "description": "Additional information (metafields) about the line item with the associated types.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TypedAttribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotal", + "description": "The line item price after discounts are applied.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotalSet", + "description": "The line item price after discounts are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPrice", + "description": "The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPriceSet", + "description": "The `discountedTotal` divided by `quantity`, resulting in the value of the discount per unit.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "grams", + "description": "The weight of the line item in grams. The weight can only be specified if the line item is a custom\nline item.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `weight` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated with the draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isGiftCard", + "description": "Whether the line item is a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotal", + "description": "The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalSet", + "description": "The total price (without discounts) of the line item,based on the original unit price of the variant x quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPrice", + "description": "The variant price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPriceSet", + "description": "The variant price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product corresponding to the line item’s product variant.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of product variants that are requested in the draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The SKU number of the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "A list of tax line objects, each of which details the total taxes applicable to the order.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product or variant. This field only applies to custom line items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscount", + "description": "The total value of the discount that's applied to the line item.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountSet", + "description": "The total value of the discount that's applied to the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The associated variant for the line item.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The name of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who created the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The weight unit and value for a draft order line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Weight", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderLineItemConnection", + "description": "An auto-generated type for paginating through multiple DraftOrderLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DraftOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderLineItemEdge", + "description": "An auto-generated type which holds one DraftOrderLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DraftOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DraftOrderLineItemInput", + "description": "The input fields used to create a line item for a draft order.", + "fields": null, + "inputFields": [ + { + "name": "appliedDiscount", + "description": "Discount which will be applied to the line item.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderAppliedDiscountInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "Represents a generic custom attribute using a key value pair.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "originalUnitPrice", + "description": "The price without any discounts applied. This value is ignored when `variantId` is provided.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The number of products that were purchased.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required. This value is ignored when `variantId` is provided.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU number of the item. This value is ignored when `variantId` is provided.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxable", + "description": "Whether the item is taxable. This value is ignored when `variantId` is provided.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "Title of the item. Ignored when `variantId` is provided.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "variantId", + "description": "The ID of the product variant corresponding to the line item.\nNull if custom line item. Required if product variant line item.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weight", + "description": "Specifies the weight unit and value inputs.\nThis value is ignored when `variantId` is provided.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "WeightInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "description": "The set of valid sort keys for the DraftOrder query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NUMBER", + "description": "Sort by the `number` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATUS", + "description": "Sort by the `status` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_PRICE", + "description": "Sort by the `total_price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_NAME", + "description": "Sort by the `customer_name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DraftOrderStatus", + "description": "The valid statuses for a draft order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COMPLETED", + "description": "The draft order has been paid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVOICE_SENT", + "description": "An invoice for the draft order has been sent to the customer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "The draft order is open. It has not been paid, and an invoice hasn't been sent.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderTag", + "description": "Represents a draft order tag.", + "fields": [ + { + "name": "handle", + "description": "Handle of draft order tag.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of draft order tag.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Title of draft order tag.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderUpdatePayload", + "description": "Return type for `draftOrderUpdate` mutation.", + "fields": [ + { + "name": "draftOrder", + "description": "The updated draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Duty", + "description": "The duty details for a line item.", + "fields": [ + { + "name": "countryCodeOfOrigin", + "description": "The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "harmonizedSystemCode", + "description": "The harmonized system code of the item used in calculating the duty.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The amount of the duty.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "A list of taxes charged on the duty.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DutySale", + "description": "A sale associated with a duty charge.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duty", + "description": "The duty for the associated sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Duty", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EditableProperty", + "description": "The attribute editable information.", + "fields": [ + { + "name": "locked", + "description": "Whether the attribute is locked for editing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the attribute is locked for editing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "description": "The input fields for an email.", + "fields": null, + "inputFields": [ + { + "name": "subject", + "description": "Specifies the email subject.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "to", + "description": "Specifies the email recipient.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "from", + "description": "Specifies the email sender.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "body", + "description": "Specifies the email body.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "bcc", + "description": "Specifies any bcc recipients for the email.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "customMessage", + "description": "Specifies a custom message to include in the email.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ErrorPosition", + "description": "Error position information in a ShopifyQL parsing error.", + "fields": [ + { + "name": "character", + "description": "The character position of the error in the line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "line", + "description": "The line number of the error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "description": "An error that occurs during the execution of a server pixel mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ErrorsServerPixelUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ErrorsServerPixelUserErrorCode", + "description": "Possible error codes that can be returned by `ErrorsServerPixelUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "A server pixel doesn't exist for this app and shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_EXISTS", + "description": "A server pixel already exists for this app and shop. Only one server pixel can exist for any app and shop combination.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUB_SUB_ERROR", + "description": "PubSubProject and PubSubTopic values resulted in an address that is not a valid GCP pub/sub format.Address format should be pubsub://project:topic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEEDS_CONFIGURATION_TO_CONNECT", + "description": "Server Pixel must be configured with a valid AWS Event Bridge or GCP pub/sub endpoint address to be connected.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ErrorsWebPixelUserError", + "description": "An error that occurs during the execution of a web pixel mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ErrorsWebPixelUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ErrorsWebPixelUserErrorCode", + "description": "Possible error codes that can be returned by `ErrorsWebPixelUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "The record with the ID used as the input value couldn't be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_SETTINGS", + "description": "The provided settings ID does not match the expected settings definition on the app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_DELETE", + "description": "An error occurred and the web pixel couldnt be deleted.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Event", + "description": "Events chronicle resource activities such as the creation of an article, the fulfillment of an order, or the\naddition of a product.\n", + "fields": [ + { + "name": "appTitle", + "description": "The name of the app that created the event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToApp", + "description": "Whether the event was created by an app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeToUser", + "description": "Whether the event was caused by an admin user.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the event was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "criticalAlert", + "description": "Whether the event is critical.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human readable text that describes the event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "BasicEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CommentEvent", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "EventBridgeServerPixelUpdatePayload", + "description": "Return type for `eventBridgeServerPixelUpdate` mutation.", + "fields": [ + { + "name": "serverPixel", + "description": "The server pixel as configured by the mutation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EventBridgeWebhookSubscriptionCreatePayload", + "description": "Return type for `eventBridgeWebhookSubscriptionCreate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "EventBridgeWebhookSubscriptionInput", + "description": "The input fields for an EventBridge webhook subscription.\n", + "fields": null, + "inputFields": [ + { + "name": "arn", + "description": "The ARN of the EventBridge partner event source.", + "type": { + "kind": "SCALAR", + "name": "ARN", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "format", + "description": "The format in which the webhook subscription should send the data.", + "type": { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeFields", + "description": "The list of fields to be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "metafieldNamespaces", + "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EventBridgeWebhookSubscriptionUpdatePayload", + "description": "Return type for `eventBridgeWebhookSubscriptionUpdate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EventConnection", + "description": "An auto-generated type for paginating through multiple Events.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in EventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Event", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EventEdge", + "description": "An auto-generated type which holds one Event and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of EventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Event", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "EventSortKeys", + "description": "The set of valid sort keys for the Event query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2", + "description": "An exchange where existing items on an order are returned and new items are added to the order.", + "fields": [ + { + "name": "additions", + "description": "The details of the new items in the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2Additions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completedAt", + "description": "The date and time when the exchange was completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the exchange was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location where the exchange happened.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The text of an optional note that a shop owner can attach to the exchange.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refunds", + "description": "The refunds processed during the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns", + "description": "The details of the returned items in the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2Returns", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "The staff member associated with the exchange.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmountProcessedSet", + "description": "The amount of money that was paid or refunded as part of the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "The difference in values of the items that were exchanged.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactions", + "description": "The order transactions related to the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2Additions", + "description": "New items associated to the exchange.", + "fields": [ + { + "name": "lineItems", + "description": "The list of new items for the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2LineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceSet", + "description": "The subtotal of the items being added, including discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The summary of all taxes of the items being added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "The total price of the items being added, including discounts and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2Connection", + "description": "An auto-generated type for paginating through multiple ExchangeV2s.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2Edge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ExchangeV2Edge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2Edge", + "description": "An auto-generated type which holds one ExchangeV2 and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ExchangeV2Edge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2LineItem", + "description": "Contains information about an item in the exchange.", + "fields": [ + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotalSet", + "description": "The total line price, in shop and presentment currencies, after discounts are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPriceSet", + "description": "The price, in shop and presentment currencies,\nof a single variant unit after line item discounts are applied.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "Name of the service provider who fulfilled the order.\n\nValid values are either **manual** or the name of the provider.\nFor example, **amazon**, **shipwire**.\n\nDeleted fulfillment services will return null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCard", + "description": "Indiciates if this line item is a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCards", + "description": "The gift cards associated with the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The line item associated with this object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalSet", + "description": "The total price, in shop and presentment currencies, before discounts are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPriceSet", + "description": "The price, in shop and presentment currencies,\nof a single variant unit before line item discounts are applied.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of products that were purchased.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The SKU number of the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The TaxLine object connected to this line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product or variant. This field only applies to custom line items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant of the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The name of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who created the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2Returns", + "description": "Return items associated to the exchange.", + "fields": [ + { + "name": "lineItems", + "description": "The list of return items for the exchange.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2LineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderDiscountAmountSet", + "description": "The amount of the order-level discount for the items and shipping being returned, which doesn't contain any line item discounts.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingRefundAmountSet", + "description": "The amount of money to be refunded for shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceSet", + "description": "The subtotal of the items being returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The summary of all taxes of the items being returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tipRefundAmountSet", + "description": "The amount of money to be refunded for tip.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceSet", + "description": "The total value of the items being returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExternalVideo", + "description": "Represents a video hosted outside of Shopify.\n", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "embedUrl", + "description": "The embed URL of the video for the respective host.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "embeddedUrl", + "description": "The URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originUrl` instead." + }, + { + "name": "host", + "description": "The host of the external video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaHost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaErrors", + "description": "Any errors which have occurred on the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaWarnings", + "description": "The warnings attached to the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originUrl", + "description": "The origin URL of the video on the respective host.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current status of the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FailedRequirement", + "description": "Requirements that must be met before an app can be installed.", + "fields": [ + { + "name": "action", + "description": "Action to be taken to resolve a failed requirement, including URL link.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "NavigationItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A concise set of copy strings to be displayed to merchants, to guide them in resolving problems your app\nencounters when trying to make use of their Shop and its resources.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "File", + "description": "A file interface.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to describe the contents or the function of a file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileErrors", + "description": "Any errors that have occurred on the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileStatus", + "description": "The status of the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FileStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "GenericFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "FileAcknowledgeUpdateFailedPayload", + "description": "Return type for `fileAcknowledgeUpdateFailed` mutation.", + "fields": [ + { + "name": "files", + "description": "The updated file(s).", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "File", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileConnection", + "description": "An auto-generated type for paginating through multiple Files.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "File", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FileContentType", + "description": "The possible content types for a file object.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IMAGE", + "description": "A Shopify-hosted image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE", + "description": "A Shopify-hosted generic file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO", + "description": "A Shopify-hosted video file. It's recommended to use this type for all video files.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FileCreateInput", + "description": "The input fields that are required to create a file object.", + "fields": null, + "inputFields": [ + { + "name": "filename", + "description": "When provided, the file will be created with the given filename,\notherwise the filename in the originalSource will be used.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "originalSource", + "description": "An external URL (for images only) or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "contentType", + "description": "The file content type. If omitted, then Shopify will attempt to determine the content type during file processing.", + "type": { + "kind": "ENUM", + "name": "FileContentType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "alt", + "description": "The alternative text description of the file.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "duplicateResolutionMode", + "description": "How to handle if filename is already in use.", + "type": { + "kind": "ENUM", + "name": "FileCreateInputDuplicateResolutionMode", + "ofType": null + }, + "defaultValue": "APPEND_UUID" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FileCreateInputDuplicateResolutionMode", + "description": "The input fields for handling if filename is already in use.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPEND_UUID", + "description": "Append a UUID if filename is already in use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RAISE_ERROR", + "description": "Raise an error if filename is already in use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REPLACE", + "description": "Replace the existing file if filename is already in use.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileCreatePayload", + "description": "Return type for `fileCreate` mutation.", + "fields": [ + { + "name": "files", + "description": "The newly created files.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "File", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileDeletePayload", + "description": "Return type for `fileDelete` mutation.", + "fields": [ + { + "name": "deletedFileIds", + "description": "The IDs of the deleted files.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileEdge", + "description": "An auto-generated type which holds one File and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FileEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "File", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileError", + "description": "A file error. This typically occurs when there is an issue with the file itself causing it to fail validation.\nCheck the file before attempting to upload again.\n", + "fields": [ + { + "name": "code", + "description": "Code representing the type of error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FileErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "details", + "description": "Additional details regarding the error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Translated error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FileErrorCode", + "description": "The error types for a file.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN", + "description": "File error has occurred for an unknown reason.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_SIGNED_URL", + "description": "File could not be processed because the signed URL was invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE_DOWNLOAD_FAILURE", + "description": "File could not be processed because the image could not be downloaded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE_PROCESSING_FAILURE", + "description": "File could not be processed because the image could not be processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_TIMEOUT_ERROR", + "description": "File timed out because it is currently being modified by another operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_NOT_FOUND", + "description": "File could not be created because the external video could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_UNLISTED", + "description": "File could not be created because the external video is not listed or is private.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO", + "description": "File could not be created because the external video has an invalid aspect ratio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_EMBED_DISABLED", + "description": "File could not be created because embed permissions are disabled for this video.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING", + "description": "File could not be created because video is either not found or still transcoding.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_FILE_DOWNLOAD_FAILURE", + "description": "File could not be processed because the source could not be downloaded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_FILE_INVALID_SIZE", + "description": "File could not be created because the size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_METADATA_READ_ERROR", + "description": "File could not be created because the metadata could not be read.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_INVALID_FILETYPE_ERROR", + "description": "File could not be created because it has an invalid file type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_WIDTH_ERROR", + "description": "File could not be created because it does not meet the minimum width requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_WIDTH_ERROR", + "description": "File could not be created because it does not meet the maximum width requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_HEIGHT_ERROR", + "description": "File could not be created because it does not meet the minimum height requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_HEIGHT_ERROR", + "description": "File could not be created because it does not meet the maximum height requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_DURATION_ERROR", + "description": "File could not be created because it does not meet the minimum duration requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_DURATION_ERROR", + "description": "File could not be created because it does not meet the maximum duration requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_VALIDATION_ERROR", + "description": "Video failed validation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_VALIDATION_ERROR", + "description": "Model failed validation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_THUMBNAIL_GENERATION_ERROR", + "description": "File could not be created because the model's thumbnail generation failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_THUMBNAIL_REGENERATION_ERROR", + "description": "There was an issue while trying to generate a new thumbnail.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR", + "description": "File could not be created because the model can't be converted to USDZ format.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_GLB_OUTPUT_CREATION_ERROR", + "description": "File could not be created because the model file failed processing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_PROCESSING_FAILURE", + "description": "File could not be created because the model file failed processing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_IMAGE_FILE_TYPE", + "description": "File could not be created because the image is an unsupported file type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_FILE_SIZE", + "description": "File could not be created because the image size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_ASPECT_RATIO", + "description": "File could not be created because the image has an invalid aspect ratio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_RESOLUTION", + "description": "File could not be created because the image's resolution exceeds the max limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_STORAGE_LIMIT_EXCEEDED", + "description": "File could not be created because the cumulative file storage limit would be exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_FILENAME_ERROR", + "description": "File could not be created because a file with the same name already exists.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FileSortKeys", + "description": "The set of valid sort keys for the File query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FILENAME", + "description": "Sort by the `filename` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORIGINAL_UPLOAD_SIZE", + "description": "Sort by the `original_upload_size` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FileStatus", + "description": "The possible statuses for a file object.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UPLOADED", + "description": "File has been uploaded but hasn't been processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING", + "description": "File is being processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY", + "description": "File is ready to be displayed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "File processing has failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FileUpdateInput", + "description": "The input fields that are required to update a file object.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the file to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "alt", + "description": "The alternative text description of the file.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "originalSource", + "description": "The source from which to update a media image or generic file.\nAn external URL (for images only) or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "previewImageSource", + "description": "The source from which to update the media preview image.\nMay be an external URL or a\n[staged upload URL](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "The name of the file including its extension.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FileUpdatePayload", + "description": "Return type for `fileUpdate` mutation.", + "fields": [ + { + "name": "files", + "description": "The list of updated files.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "File", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilesErrorCode", + "description": "Possible error codes that can be returned by `FilesUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_DOES_NOT_EXIST", + "description": "File does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_LOCKED", + "description": "File has a pending operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATE", + "description": "Filename update is only supported on Image and GenericFile.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_ARGUMENTS", + "description": "Specify one argument: search, IDs, or deleteAll.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK_SEARCH", + "description": "The search term must not be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENTS", + "description": "At least one argument is required.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUERY", + "description": "Search query isn't supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_FILENAME_EXTENSION", + "description": "Invalid filename extension.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_FILENAME", + "description": "The provided filename is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILENAME_ALREADY_EXISTS", + "description": "The provided filename already exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNACCEPTABLE_UNVERIFIED_TRIAL_ASSET", + "description": "The file is not supported on trial accounts that have not validated their email. Either select a plan or verify the shop owner email to upload this file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNACCEPTABLE_ASSET", + "description": "The file type is not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNACCEPTABLE_TRIAL_ASSET", + "description": "The file is not supported on trial accounts. Select a plan to upload this file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALT_VALUE_LIMIT_EXCEEDED", + "description": "The alt value exceeds the maximum limit of 512 characters.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_READY_STATE", + "description": "The file is not in the READY state.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDED", + "description": "Exceeded the limit of non-image media per shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISMATCHED_FILENAME_AND_ORIGINAL_SOURCE", + "description": "Cannot create file with custom filename which does not match original source extension.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DUPLICATE_MODE_FOR_TYPE", + "description": "Duplicate resolution mode is not supported for this file type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_SOURCE_URL", + "description": "Invalid image source url value provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACE", + "description": "Duplicate resolution mode REPLACE cannot be used without specifying filename.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FilesUserError", + "description": "An error that happens during the execution of a Files API query or mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FilesErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FilterOption", + "description": "A filter option is one possible value in a search filter.", + "fields": [ + { + "name": "label", + "description": "The filter option's label for display purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The filter option's value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Float", + "description": "Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FlowTriggerReceivePayload", + "description": "Return type for `flowTriggerReceive` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "FormattedString", + "description": "A string containing a strict subset of HTML code. Non-allowed tags will be stripped out.\nAllowed tags:\n* `a` (allowed attributes: `href`, `target`)\n* `b`\n* `br`\n* `em`\n* `i`\n* `strong`\n* `u`\nUse [HTML](https://shopify.dev/api/admin-graphql/latest/scalars/HTML) instead if you need to\ninclude other HTML tags.\n\nExample value: `\"Your current domain is johns-apparel.myshopify.com.\"`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Fulfillment", + "description": "Represents a fulfillment.\nIn Shopify, a fulfillment represents a shipment of one or more items in an order.\nWhen an order has been completely fulfilled, it means that all the items that are included\nin the order have been sent to the customer.\nThere can be more than one fulfillment for an order.\n", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the fulfillment was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveredAt", + "description": "The date that this fulfillment was delivered.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayStatus", + "description": "Human readable display status for this fulfillment.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentDisplayStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedDeliveryAt", + "description": "The estimated date that this fulfillment will arrive.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "The history of events associated with this fulfillment.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "FulfillmentEventSortKeys", + "ofType": null + }, + "defaultValue": "HAPPENED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentEventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentLineItems", + "description": "List of the fulfillment's line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrders", + "description": "A paginated list of fulfillment orders for the fulfillment.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inTransitAt", + "description": "The date and time when the fulfillment went into transit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location that the fulfillment was processed at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Human readable reference identifier for this fulfillment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order for which the fulfillment was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originAddress", + "description": "The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOriginAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether any of the line items in the fulfillment require shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "service", + "description": "Fulfillment service associated with the fulfillment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the fulfillment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalQuantity", + "description": "Sum of all line item quantities for the fulfillment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingInfo", + "description": "Tracking information associated with the fulfillment,\nsuch as the tracking company, tracking number, and tracking URL.\n", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfo", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the fulfillment was last modified.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentCancelPayload", + "description": "Return type for `fulfillmentCancel` mutation.", + "fields": [ + { + "name": "fulfillment", + "description": "The canceled fulfillment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentConnection", + "description": "An auto-generated type for paginating through multiple Fulfillments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentCreateV2Payload", + "description": "Return type for `fulfillmentCreateV2` mutation.", + "fields": [ + { + "name": "fulfillment", + "description": "The created fulfillment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentDisplayStatus", + "description": "The display status of a fulfillment.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ATTEMPTED_DELIVERY", + "description": "Displayed as **Attempted delivery**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELED", + "description": "Displayed as **Canceled**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFIRMED", + "description": "Displayed as **Confirmed**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERED", + "description": "Displayed as **Delivered**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "Displayed as **Failure**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLED", + "description": "Displayed as **Fulfilled**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_TRANSIT", + "description": "Displayed as **In transit**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LABEL_PRINTED", + "description": "Displayed as **Label printed**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LABEL_PURCHASED", + "description": "Displayed as **Label purchased**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LABEL_VOIDED", + "description": "Displayed as **Label voided**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKED_AS_FULFILLED", + "description": "Displayed as **Marked as fulfilled**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_DELIVERED", + "description": "Displayed as **Not delivered**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_FOR_DELIVERY", + "description": "Displayed as **Out for delivery**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY_FOR_PICKUP", + "description": "Displayed as **Ready for pickup**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICKED_UP", + "description": "Displayed as **Picked up**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBMITTED", + "description": "Displayed as **Submitted**.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEdge", + "description": "An auto-generated type which holds one Fulfillment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEvent", + "description": "The fulfillment event that describes the fulfilllment status at a particular time.", + "fields": [ + { + "name": "address1", + "description": "The street address where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedDeliveryAt", + "description": "The estimated delivery date and time of the fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "happenedAt", + "description": "The time at which this fulfillment event happened.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "The latitude where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A message associated with this fulfillment event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this fulfillment event.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentEventStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip code of the location where this fulfillment event occurred.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEventConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentEvents.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentEventEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentEvent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEventCreatePayload", + "description": "Return type for `fulfillmentEventCreate` mutation.", + "fields": [ + { + "name": "fulfillmentEvent", + "description": "The created fulfillment event.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentEvent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEventEdge", + "description": "An auto-generated type which holds one FulfillmentEvent and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentEvent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentEventInput", + "description": "The input fields used to create a fulfillment event.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The street address where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The city where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country", + "description": "The country where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "estimatedDeliveryAt", + "description": "The estimated delivery date and time of the fulfillment.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "happenedAt", + "description": "The time at which this fulfillment event happened.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillmentId", + "description": "The ID for the fulfillment that's associated with this fulfillment event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "latitude", + "description": "The latitude where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "longitude", + "description": "The longitude where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "message", + "description": "A message associated with this fulfillment event.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "province", + "description": "The province where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status of this fulfillment event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentEventStatus", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The zip code of the location where this fulfillment event occurred.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentEventSortKeys", + "description": "The set of valid sort keys for the FulfillmentEvent query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "HAPPENED_AT", + "description": "Sort by the `happened_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentEventStatus", + "description": "The status that describes a fulfillment or delivery event.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LABEL_PURCHASED", + "description": "A shipping label has been purchased.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LABEL_PRINTED", + "description": "A purchased shipping label has been printed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY_FOR_PICKUP", + "description": "The fulfillment is ready to be picked up.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFIRMED", + "description": "The fulfillment is confirmed. This is the default value when no other information is available.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_TRANSIT", + "description": "The fulfillment is in transit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_FOR_DELIVERY", + "description": "The fulfillment is out for delivery.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTEMPTED_DELIVERY", + "description": "A delivery was attempted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERED", + "description": "The fulfillment was successfully delivered.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "The fulfillment request failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentHold", + "description": "A fulfillment hold currently applied on a fulfillment order.\n", + "fields": [ + { + "name": "heldBy", + "description": "The name of the app or service that applied the fulfillment hold.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason for the fulfillment hold.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentHoldReason", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reasonNotes", + "description": "Additional information about the fulfillment hold reason.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentHoldReason", + "description": "The reason for a fulfillment hold.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AWAITING_PAYMENT", + "description": "The fulfillment hold is applied because payment is pending.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIGH_RISK_OF_FRAUD", + "description": "The fulfillment hold is applied because of a high risk of fraud.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_ADDRESS", + "description": "The fulfillment hold is applied because of an incorrect address.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_OUT_OF_STOCK", + "description": "The fulfillment hold is applied because inventory is out of stock.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN_DELIVERY_DATE", + "description": "The fulfillment hold is applied because of an unknown delivery date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_POST_PURCHASE_CROSS_SELL", + "description": "The fulfillment hold is applied because of a post purchase upsell offer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The fulfillment hold is applied for another reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "description": "Represents a line item from an order that's included in a fulfillment.", + "fields": [ + { + "name": "discountedTotal", + "description": "The total price after discounts are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedTotalSet` instead." + }, + { + "name": "discountedTotalSet", + "description": "The total price after discounts are applied in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The associated order's line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotal", + "description": "The total price before discounts are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalTotalSet` instead." + }, + { + "name": "originalTotalSet", + "description": "The total price before discounts are applied in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Number of line items in the fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItemConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItemEdge", + "description": "An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "description": "The FulfillmentOrder object represents either an item or a group of items in an\n[Order](https://shopify.dev/api/admin-graphql/latest/objects/Order)\nthat are expected to be fulfilled from the same location.\nThere can be more than one fulfillment order for an\n[order](https://shopify.dev/api/admin-graphql/latest/objects/Order)\nat a given location.\n\n{{ '/api/reference/fulfillment_order_relationships.png' | image }}\n\nFulfillment orders represent the work which is intended to be done in relation to an order.\nWhen fulfillment has started for one or more line items, a\n[Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment)\nis created by a merchant or third party to represent the ongoing or completed work of fulfillment.\n\n[See below for more details on creating fulfillments](#the-lifecycle-of-a-fulfillment-order-at-a-location-which-is-managed-by-a-fulfillment-service).\n\n> Note:\n> Shopify creates fulfillment orders automatically when an order is created.\n> It is not possible to manually create fulfillment orders.\n>\n> [See below for more details on the lifecycle of a fulfillment order](#the-lifecycle-of-a-fulfillment-order).\n\n## Retrieving fulfillment orders\n\n### Fulfillment orders from an order\n\nAll fulfillment orders related to a given order can be retrieved with the\n[Order.fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Order#connection-order-fulfillmentorders)\nconnection.\n\n[API access scopes](#api-access-scopes)\ngovern which fulfillments orders are returned to clients.\nAn API client will only receive a subset of the fulfillment orders which belong to an order\nif they don't have the necessary access scopes to view all of the fulfillment orders.\n\n### Fulfillment orders assigned to the app for fulfillment\n\nFulfillment service apps can retrieve the fulfillment orders which have been assigned to their locations with the\n[Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders)\nconnection.\nUse the `assignmentStatus` argument to control whether all assigned fulfillment orders\nshould be returned or only those where a merchant has sent a\n[fulfillment request](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderMerchantRequest)\nand it has yet to be responded to.\n\nThe API client must be granted the `read_assigned_fulfillment_orders` access scope to access\nthe assigned fulfillment orders.\n\n### All fulfillment orders\n\nApps can retrieve all fulfillment orders with the\n[fulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/queries/fulfillmentOrders)\nquery. This query returns all assigned, merchant-managed, and third-party fulfillment orders on the shop,\nwhich are accessible to the app according to the\n[fulfillment order access scopes](#api-access-scopes) it was granted with.\n\n## The lifecycle of a fulfillment order\n\n### Fulfillment Order Creation\n\nAfter an order is created, a background worker performs the order routing process which determines\nwhich locations will be responsible for fulfilling the purchased items.\nOnce the order routing process is complete, one or more fulfillment orders will be created\nand assigned to these locations. It is not possible to manually create fulfillment orders.\n\nOnce a fulfillment order has been created, it will have one of two different lifecycles depending on\nthe type of location which the fulfillment order is assigned to.\n\n### The lifecycle of a fulfillment order at a merchant managed location\n\nFulfillment orders are completed by creating\n[fulfillments](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment).\nFulfillments represents the work done.\n\nFor digital products a merchant or an order management app would create a fulfilment once the digital asset\nhas been provisioned.\nFor example, in the case of a digital gift card, a merchant would to do this once\nthe gift card has been activated - before the email has been shipped.\n\nOn the other hand, for a traditional shipped order,\na merchant or an order management app would create a fulfillment after picking and packing the items relating\nto a fulfillment order, but before the courier has collected the goods.\n\n[Learn about managing fulfillment orders as an order management app](https://shopify.dev/apps/fulfillment/order-management-apps/manage-fulfillments).\n\n### The lifecycle of a fulfillment order at a location which is managed by a fulfillment service\n\nFor fulfillment orders which are assigned to a location that is managed by a fulfillment service,\na merchant or an Order Management App can\n[send a fulfillment request](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitFulfillmentRequest)\nto the fulfillment service which operates the location to request that they fulfill the associated items.\nA fulfillment service has the option to\n[accept](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderAcceptFulfillmentRequest)\nor [reject](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderRejectFulfillmentRequest)\nthis fulfillment request.\n\nOnce the fulfillment service has accepted the request, the request can no longer be cancelled by the merchant\nor order management app and instead a\n[cancellation request must be submitted](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderSubmitCancellationRequest)\nto the fulfillment service.\n\nOnce a fulfillment service accepts a fulfillment request,\nthen after they are ready to pack items and send them for delivery, they create fulfillments with the\n[fulfillmentCreateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentCreateV2)\nmutation.\nThey can provide tracking information right away or create fulfillments without it and then\nupdate the tracking information for fulfillments with the\n[fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2)\nmutation.\n\n[Learn about managing fulfillment orders as a fulfillment service](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments).\n\n## API access scopes\n\nFulfillment orders are governed by the following API access scopes:\n\n* The `read_merchant_managed_fulfillment_orders` and\n `write_merchant_managed_fulfillment_orders` access scopes\n grant access to fulfillment orders assigned to merchant-managed locations.\n* The `read_assigned_fulfillment_orders` and `write_assigned_fulfillment_orders`\n access scopes are intended for fulfillment services.\n These scopes grant access to fulfillment orders assigned to locations that are being managed\n by fulfillment services.\n* The `read_third_party_fulfillment_orders` and `write_third_party_fulfillment_orders`\n access scopes grant access to fulfillment orders\n assigned to locations managed by other fulfillment services.\n\n### Fulfillment service app access scopes\n\nUsually, **fulfillment services** have the `write_assigned_fulfillment_orders` access scope\nand don't have the `*_third_party_fulfillment_orders`\nor `*_merchant_managed_fulfillment_orders` access scopes.\nThe app will only have access to the fulfillment orders assigned to their location\n(or multiple locations if the app registers multiple fulfillment services on the shop).\nThe app will not have access to fulfillment orders assigned to merchant-managed locations\nor locations owned by other fulfillment service apps.\n\n### Order management app access scopes\n\n**Order management apps** will usually request `write_merchant_managed_fulfillment_orders` and\n`write_third_party_fulfillment_orders` access scopes. This will allow them to manage all fulfillment orders\non behalf of a merchant.\n\nIf an app combines the functions of an order management app and a fulfillment service,\nthen the app should request all\naccess scopes to manage all assigned and all unassigned fulfillment orders.\n\n## Notifications about fulfillment orders\n\nFulfillment services are required to\n[register](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService)\na self-hosted callback URL which has a number of uses. One of these uses is that this callback URL will be notified\nwhenever a merchant submits a fulfillment or cancellation request.\n\nBoth merchants and apps can\n[subscribe](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks)\nto the\n[fulfillment order webhooks](https://shopify.dev/api/admin-graphql/latest/enums/WebhookSubscriptionTopic#value-fulfillmentorderscancellationrequestaccepted)\nto be notified whenever fulfillment order related domain events occur.\n\n[Learn about fulfillment workflows](https://shopify.dev/apps/fulfillment).\n", + "fields": [ + { + "name": "assignedLocation", + "description": "The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.\n\nThe fulfillment order's assigned location might change in the following cases:\n\n- The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder\n ) field within the mutation's response.\n- Work on the fulfillment order hasn't yet begun, which means that the fulfillment order has the\n [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open),\n [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or\n [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold)\n status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderAssignedLocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "Date and time when the fulfillment order was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethod", + "description": "Delivery method of this fulfillment order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "destination", + "description": "The destination where the items should be sent.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderDestination", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillAt", + "description": "The date and time at which the fulfillment order will be fulfillable. When this date and time is reached, the scheduled fulfillment order is automatically transitioned to open. For example, the `fulfill_at` date for a subscription order might be the 1st of each month, a pre-order `fulfill_at` date would be `nil`, and a standard order `fulfill_at` date would be the order creation date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillBy", + "description": "The latest date and time by which all items in the fulfillment order need to be fulfilled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentHolds", + "description": "The fulfillment holds applied on the fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentHold", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillments", + "description": "A list of fulfillments for the fulfillment order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "internationalDuties", + "description": "The duties delivery method of this fulfillment order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderInternationalDuties", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "A list of the fulfillment order's line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationsForMove", + "description": "A list of locations that the fulfillment order can potentially move to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMoveConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantRequests", + "description": "A list of requests sent by the merchant or an order management app to the fulfillment service for the fulfillment order.", + "args": [ + { + "name": "kind", + "description": "The kind of request the merchant sent.", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderMerchantRequestKind", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequestConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order that's associated with the fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestStatus", + "description": "The request status of the fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentOrderRequestStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentOrderStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportedActions", + "description": "The actions that can be performed on this fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderSupportedAction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the fulfillment order was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderAcceptCancellationRequestPayload", + "description": "Return type for `fulfillmentOrderAcceptCancellationRequest` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order whose cancellation request was accepted.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderAcceptFulfillmentRequestPayload", + "description": "Return type for `fulfillmentOrderAcceptFulfillmentRequest` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order whose fulfillment request was accepted.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderAction", + "description": "The actions that can be taken on a fulfillment order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATE_FULFILLMENT", + "description": "Creates a fulfillment for selected line items in the fulfillment order. The corresponding mutation for this action is `fulfillmentCreateV2`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUEST_FULFILLMENT", + "description": "Sends a request for fulfilling selected line items in a fulfillment order to a fulfillment service. The corresponding mutation for this action is `fulfillmentOrderSubmitFulfillmentRequest`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL_FULFILLMENT_ORDER", + "description": "Cancels a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderCancel`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MOVE", + "description": "Moves a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMove`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUEST_CANCELLATION", + "description": "Sends a cancellation request to the fulfillment service of a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSubmitCancellationRequest`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARK_AS_OPEN", + "description": "Marks the fulfillment order as open. The corresponding mutation for this action is `fulfillmentOrderOpen`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEASE_HOLD", + "description": "Releases the fulfillment hold on the fulfillment order. The corresponding mutation for this action is `fulfillmentOrderReleaseHold`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HOLD", + "description": "Applies a fulfillment hold on an open fulfillment order. The corresponding mutation for this action is `fulfillmentOrderHold`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL", + "description": "Opens an external URL to initiate the fulfillment process outside Shopify. This action should be paired with `FulfillmentOrderSupportedAction.externalUrl`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SPLIT", + "description": "Splits a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderSplit`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERGE", + "description": "Merges a fulfillment order. The corresponding mutation for this action is `fulfillmentOrderMerge`.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderAssignedLocation", + "description": "The fulfillment order's assigned location. This is the location where the fulfillment is expected to happen.\n\n The fulfillment order's assigned location might change in the following cases:\n\n - The fulfillment order has been entirely moved to a new location. For example, the [fulfillmentOrderMove](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n ) mutation has been called, and you see the original fulfillment order in the [movedFulfillmentOrder](\n https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove#field-fulfillmentordermovepayload-movedfulfillmentorder\n ) field within the mutation's response.\n\n - Work on the fulfillment order has not yet begun, which means that the fulfillment order has the\n [OPEN](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-open),\n [SCHEDULED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-scheduled), or\n [ON_HOLD](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-onhold)\n status, and the shop's location properties might be undergoing edits (for example, in the Shopify admin).\n\nIf the [fulfillmentOrderMove](\nhttps://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentOrderMove\n) mutation has moved the fulfillment order's line items to a new location,\nbut hasn't moved the fulfillment order instance itself, then the original fulfillment order's assigned location\ndoesn't change.\nThis happens if the fulfillment order is being split during the move, or if all line items can be moved\nto an existing fulfillment order at a new location.\n\nOnce the fulfillment order has been taken into work or canceled,\nwhich means that the fulfillment order has the\n[IN_PROGRESS](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-inprogress),\n[CLOSED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-closed),\n[CANCELLED](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-cancelled), or\n[INCOMPLETE](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderStatus#value-incomplete)\nstatus, `FulfillmentOrderAssignedLocation` acts as a snapshot of the shop's location content.\nUp-to-date shop's location data may be queried through [location](\n https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderAssignedLocation#field-fulfillmentorderassignedlocation-location\n) connection.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter country code of the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location where the fulfillment is expected to happen. This value might be different from\n`FulfillmentOrderAssignedLocation` if the location's attributes were updated\nafter the fulfillment order was taken into work of canceled.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The ZIP code of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderAssignmentStatus", + "description": "The assigment status to be used to filter fulfillment orders.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CANCELLATION_REQUESTED", + "description": "Fulfillment orders for which the merchant has requested cancellation of\nthe previously accepted fulfillment request.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_REQUESTED", + "description": "Fulfillment orders for which the merchant has requested fulfillment.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ACCEPTED", + "description": "Fulfillment orders for which the merchant's fulfillment request has been accepted.\nAny number of fulfillments can be created on these fulfillment orders\nto completely fulfill the requested items.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderCancelPayload", + "description": "Return type for `fulfillmentOrderCancel` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order that was marked as canceled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "replacementFulfillmentOrder", + "description": "The fulfillment order that was created to replace the canceled fulfillment order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderClosePayload", + "description": "Return type for `fulfillmentOrderClose` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order that was marked as incomplete.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentOrders.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderDestination", + "description": "Represents the destination where the items should be sent upon fulfillment.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the address of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The company of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter country code of the destination.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email of the customer at the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of the customer at the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of the customer at the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the customer at the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The ZIP code of the destination.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderEdge", + "description": "An auto-generated type which holds one FulfillmentOrder and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderHoldInput", + "description": "The input fields for the fulfillment hold applied on the fulfillment order.", + "fields": null, + "inputFields": [ + { + "name": "reason", + "description": "The reason for the fulfillment hold.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentHoldReason", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "reasonNotes", + "description": "Additional information about the fulfillment hold reason.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "notifyMerchant", + "description": "Whether the merchant receives a notification about the fulfillment hold. The default value is `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "externalId", + "description": "A configurable ID used to track the automation system releasing these holds.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be placed on hold.\nIf left blank, all line items of the fulfillment order are placed on hold.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderHoldPayload", + "description": "Return type for `fulfillmentOrderHold` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order on which a fulfillment hold was applied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingFulfillmentOrder", + "description": "The remaining fulfillment order containing the line items to which the hold wasn't applied,\nif specific line items were specified to be placed on hold.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderHoldUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderHoldUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderHold`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderHoldUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderHoldUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderHoldUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDER_NOT_FOUND", + "description": "The fulfillment order could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_ZERO", + "description": "The fulfillment order line item quantity must be greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LINE_ITEM_QUANTITY", + "description": "The fulfillment order line item quantity is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderInternationalDuties", + "description": "The international duties relevant to a fulfillment order.\n", + "fields": [ + { + "name": "incoterm", + "description": "The method of duties payment. Example values: `DDP`, `DAP`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItem", + "description": "Associates an order line item with quantities requiring fulfillment from the respective fulfillment order.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated to the line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItemId", + "description": "The ID of the inventory item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The associated order line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": " As of API version 2023-01, this field has been deprecated. The order line item associated with a `FulfillmentOrderLineItem`\n shouldn't be used to determine what to fulfill. Use the `FulfillmentOrderLineItem` and `FulfillmentOrder` objects\n instead. An order `LineItem` represents a single line item on an order, but it doesn't represent what should be fulfilled.\n" + }, + { + "name": "originalUnitPriceSet", + "description": "The variant unit price without discounts applied, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productTitle", + "description": "The title of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingQuantity", + "description": "The number of units remaining to be fulfilled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The variant SKU number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalQuantity", + "description": "The total number of units to be fulfilled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The name of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who made the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "warnings", + "description": "Warning messages for a fulfillment order line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The weight of a line item unit.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Weight", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentOrderLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemEdge", + "description": "An auto-generated type which holds one FulfillmentOrderLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "description": "The input fields used to include the quantity of the fulfillment order line item that should be fulfilled.\n", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the fulfillment order line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the fulfillment order line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemWarning", + "description": "A fulfillment order line item warning. For example, a warning about why a fulfillment request was rejected.\n", + "fields": [ + { + "name": "description", + "description": "The description of warning.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of warning.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemsInput", + "description": "The input fields used to include the line items of a specified fulfillment order that should be fulfilled.\n", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentOrderId", + "description": "The ID of the fulfillment order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be fulfilled.\nIf left blank, all line items of the fulfillment order will be fulfilled.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupInput", + "description": "The input fields for marking fulfillment order line items as ready for pickup.", + "fields": null, + "inputFields": [ + { + "name": "lineItemsByFulfillmentOrder", + "description": "The fulfillment orders associated with the line items which are ready to be picked up by a customer.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PreparedFulfillmentOrderLineItemsInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupPayload", + "description": "Return type for `fulfillmentOrderLineItemsPreparedForPickup` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderLineItemsPreparedForPickup`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderLineItemsPreparedForPickupUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderLineItemsPreparedForPickupUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderLineItemsPreparedForPickupUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NO_LINE_ITEMS_TO_PREPARE_FOR_FULFILLMENT_ORDER", + "description": "The fulfillment order does not have any line items that can be prepared.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDER_INVALID", + "description": "Invalid fulfillment order ID provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_PREPARE_QUANTITY", + "description": "Unable to prepare quantity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMove", + "description": "A location that a fulfillment order can potentially move to.\n", + "fields": [ + { + "name": "location", + "description": "The location being considered as the fulfillment order's new assigned location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A human-readable string with the reason why the fulfillment order, or some of its line items, can't be\nmoved to the location.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "movable", + "description": "Whether the fulfillment order can be moved to the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMoveConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentOrderLocationForMoves.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMoveEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentOrderLocationForMoveEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMove", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMoveEdge", + "description": "An auto-generated type which holds one FulfillmentOrderLocationForMove and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentOrderLocationForMoveEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderLocationForMove", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequest", + "description": "A request made by the merchant or an order management app to a fulfillment service\nfor a fulfillment order.\n", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order associated with the merchant request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": "The kind of request made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentOrderMerchantRequestKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The optional message that the merchant included in the request.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestOptions", + "description": "Additional options requested by the merchant. These depend on the `kind` of the request.\nFor example, for a `FULFILLMENT_REQUEST`, one option is `notify_customer`, which indicates whether the\nmerchant intends to notify the customer upon fulfillment. The fulfillment service can then set\n`notifyCustomer` when making calls to `FulfillmentCreateV2`.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "responseData", + "description": "The response from the fulfillment service.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sentAt", + "description": "The timestamp when the request was made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequestConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentOrderMerchantRequests.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequestEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentOrderMerchantRequestEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequest", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequestEdge", + "description": "An auto-generated type which holds one FulfillmentOrderMerchantRequest and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentOrderMerchantRequestEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequest", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderMerchantRequestKind", + "description": "The kinds of request merchants can make to a fulfillment service.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_REQUEST", + "description": "The merchant requests fulfillment for an `OPEN` fulfillment order.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLATION_REQUEST", + "description": "The merchant requests cancellation of an `IN_PROGRESS` fulfillment order.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderMergeInput", + "description": "The input fields for merging fulfillment orders.", + "fields": null, + "inputFields": [ + { + "name": "mergeIntents", + "description": "The details of the fulfillment orders to be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderMergeInputMergeIntent", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderMergeInputMergeIntent", + "description": "The input fields for merging fulfillment orders into a single merged fulfillment order.", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be merged.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderId", + "description": "The ID of the fulfillment order to be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMergePayload", + "description": "Return type for `fulfillmentOrderMerge` mutation.", + "fields": [ + { + "name": "fulfillmentOrderMerges", + "description": "The result of the fulfillment order merges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMergeResult", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderMergeUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMergeResult", + "description": "The result of merging a set of fulfillment orders.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The new fulfillment order as a result of the merge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMergeUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderMerge`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderMergeUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderMergeUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderMergeUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDER_NOT_FOUND", + "description": "The fulfillment order could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The fulfillment order line item quantity must be greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LINE_ITEM_QUANTITY", + "description": "The fulfillment order line item quantity is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMovePayload", + "description": "Return type for `fulfillmentOrderMove` mutation.", + "fields": [ + { + "name": "movedFulfillmentOrder", + "description": "The fulfillment order which now contains the moved line items and is assigned to the destination location.\n\n**First scenario:** All line items belonging to the original fulfillment order are re-assigned.\n\nIn this case, this will be the original fulfillment order.\n\n**Second scenario:** A subset of the line items belonging to the original fulfillment order are re-assigned.\n\nIf the new location is already assigned to fulfill line items on the order, then\nthis will be an existing active fulfillment order.\nOtherwise, this will be a new fulfillment order with the moved line items assigned.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalFulfillmentOrder", + "description": "The final state of the original fulfillment order.\n\nAs a result of the move operation, the original fulfillment order might be moved to the new location\nor remain in the original location. The original fulfillment order might have the same status or be closed.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingFulfillmentOrder", + "description": "This field is deprecated.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderOpenPayload", + "description": "Return type for `fulfillmentOrderOpen` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order that was transitioned to open and is fulfillable.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderRejectCancellationRequestPayload", + "description": "Return type for `fulfillmentOrderRejectCancellationRequest` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order whose cancellation request was rejected.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderRejectFulfillmentRequestPayload", + "description": "Return type for `fulfillmentOrderRejectFulfillmentRequest` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order whose fulfillment request was rejected.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderRejectionReason", + "description": "The reason for a fulfillment order rejection.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCORRECT_ADDRESS", + "description": "The fulfillment order was rejected because of an incorrect address.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_OUT_OF_STOCK", + "description": "The fulfillment order was rejected because inventory is out of stock.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INELIGIBLE_PRODUCT", + "description": "The fulfillment order was rejected because of an ineligible product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDELIVERABLE_DESTINATION", + "description": "The fulfillment order was rejected because of an undeliverable destination.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The fulfillment order was rejected for another reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderReleaseHoldPayload", + "description": "Return type for `fulfillmentOrderReleaseHold` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order on which the hold was released.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderReleaseHoldUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderReleaseHoldUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderReleaseHold`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderReleaseHoldUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderReleaseHoldUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderReleaseHoldUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDER_NOT_FOUND", + "description": "The fulfillment order wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_ZERO", + "description": "The fulfillment order line item quantity must be greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LINE_ITEM_QUANTITY", + "description": "The fulfillment order line item quantity is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderRequestStatus", + "description": "The request status of a fulfillment order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNSUBMITTED", + "description": "The initial request status for the newly-created fulfillment orders. This is the only valid\nrequest status for fulfillment orders that aren't assigned to a fulfillment service.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBMITTED", + "description": "The merchant requested fulfillment for this fulfillment order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACCEPTED", + "description": "The fulfillment service accepted the merchant's fulfillment request.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "The fulfillment service rejected the merchant's fulfillment request.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLATION_REQUESTED", + "description": "The merchant requested a cancellation of the fulfillment request for this fulfillment order.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLATION_ACCEPTED", + "description": "The fulfillment service accepted the merchant's fulfillment cancellation request.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLATION_REJECTED", + "description": "The fulfillment service rejected the merchant's fulfillment cancellation request.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "The fulfillment service closed the fulfillment order without completing it.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderReschedulePayload", + "description": "Return type for `fulfillmentOrderReschedule` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order that was rescheduled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderRescheduleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderRescheduleUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderReschedule`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderRescheduleUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderRescheduleUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderRescheduleUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDER_NOT_FOUND", + "description": "Fulfillment order could not be found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderSortKeys", + "description": "The set of valid sort keys for the FulfillmentOrder query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderSplitInput", + "description": "The input fields for the split applied to the fulfillment order.", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be split out.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderId", + "description": "The ID of the fulfillment order to be split.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitPayload", + "description": "Return type for `fulfillmentOrderSplit` mutation.", + "fields": [ + { + "name": "fulfillmentOrderSplits", + "description": "The result of the fulfillment order splits.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitResult", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitResult", + "description": "The result of splitting a fulfillment order.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The original fulfillment order as a result of the split.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingFulfillmentOrder", + "description": "The remaining fulfillment order as a result of the split.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "replacementFulfillmentOrder", + "description": "The replacement fulfillment order if the original fulfillment order wasn't in a state to be split.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitUserError", + "description": "An error that occurs during the execution of `FulfillmentOrderSplit`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderSplitUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderSplitUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrderSplitUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDER_NOT_FOUND", + "description": "The fulfillment order could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The fulfillment order line item quantity must be greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LINE_ITEM_QUANTITY", + "description": "The fulfillment order line item quantity is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrderStatus", + "description": "The status of a fulfillment order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OPEN", + "description": "The fulfillment order is ready for fulfillment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "The fulfillment order is being processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "The fulfillment order has been cancelled by the merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCOMPLETE", + "description": "The fulfillment order cannot be completed as requested.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "The fulfillment order has been completed and closed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "The fulfillment order is deferred and will be ready for fulfillment after the date and time specified in `fulfill_at`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ON_HOLD", + "description": "The fulfillment order is on hold. The fulfillment process can't be initiated until the hold on the fulfillment order is released.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSubmitCancellationRequestPayload", + "description": "Return type for `fulfillmentOrderSubmitCancellationRequest` mutation.", + "fields": [ + { + "name": "fulfillmentOrder", + "description": "The fulfillment order specified in the cancelation request.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSubmitFulfillmentRequestPayload", + "description": "Return type for `fulfillmentOrderSubmitFulfillmentRequest` mutation.", + "fields": [ + { + "name": "originalFulfillmentOrder", + "description": "The original fulfillment order intended to request fulfillment for.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "submittedFulfillmentOrder", + "description": "The fulfillment order that was submitted to the fulfillment service. This will be the same as\nthe original fulfillment order field. The exception to this is partial fulfillment requests or\nfulfillment request for cancelled or incomplete fulfillment orders.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unsubmittedFulfillmentOrder", + "description": "This field will only be present for partial fulfillment requests. This will represent the new\nfulfillment order with the remaining line items not submitted to the fulfillment service.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderSupportedAction", + "description": "One of the actions that the fulfillment order supports in its current state.\n", + "fields": [ + { + "name": "action", + "description": "The action value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentOrderAction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "externalUrl", + "description": "The external URL to be used to initiate the fulfillment process outside Shopify.\nApplicable only when the `action` value is `EXTERNAL`.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersReleaseHoldsPayload", + "description": "Return type for `fulfillmentOrdersReleaseHolds` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that will release the fulfillment holds.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrdersReleaseHoldsUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersReleaseHoldsUserError", + "description": "An error that occurs during the execution of `FulfillmentOrdersReleaseHolds`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrdersReleaseHoldsUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrdersReleaseHoldsUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrdersReleaseHoldsUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FAILED_TO_CREATE_JOB", + "description": "Failed to create release fulfillment order holds job.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersSetFulfillmentDeadlinePayload", + "description": "Return type for `fulfillmentOrdersSetFulfillmentDeadline` mutation.", + "fields": [ + { + "name": "success", + "description": "Whether the fulfillment deadline was successfully set.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrdersSetFulfillmentDeadlineUserError", + "description": "An error that occurs during the execution of `FulfillmentOrdersSetFulfillmentDeadline`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "FulfillmentOrdersSetFulfillmentDeadlineUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentOrdersSetFulfillmentDeadlineUserErrorCode", + "description": "Possible error codes that can be returned by `FulfillmentOrdersSetFulfillmentDeadlineUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_ORDERS_NOT_FOUND", + "description": "The fulfillment orders could not be found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOriginAddress", + "description": "The address at which the fulfillment occurred. Typically this is the address of the warehouse or fulfillment center.", + "fields": [ + { + "name": "address1", + "description": "The street address of the fulfillment location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city in which the fulfillment location is located.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The country code of the fulfillment location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The province code of the fulfillment location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip code of the fulfillment location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOriginAddressInput", + "description": "The input fields used to include the address at which the fulfillment occurred. Typically the address of a warehouse or a fulfillment center.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The street address of the fulfillment location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The city in which the fulfillment location is located.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The zip code of the fulfillment location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "provinceCode", + "description": "The province of the fulfillment location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The country of the fulfillment location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentService", + "description": "A **Fulfillment Service** is a third party warehouse that prepares and ships orders\non behalf of the store owner. Fulfillment services charge a fee to package and ship items\nand update product inventory levels. Some well known fulfillment services with Shopify integrations\ninclude: Amazon, Shipwire, and Rakuten. When an app registers a new `FulfillmentService` on a store,\nShopify automatically creates a `Location` that's associated to the fulfillment service.\nTo learn more about fulfillment services, refer to\n[Manage fulfillments as a fulfillment service app](https://shopify.dev/apps/fulfillment/fulfillment-service-apps)\nguide.\n\n## Mutations\n\nYou can work with the `FulfillmentService` object with the\n[fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate),\n[fulfillmentServiceUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceUpdate),\nand [fulfillmentServiceDelete](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceDelete)\nmutations.\n\n## Hosted endpoints\n\nFulfillment service providers integrate with Shopify by providing Shopify with a set of hosted endpoints that\nShopify can query on certain conditions.\nThese endpoints must have a common prefix, and this prefix should be supplied in the `callbackUrl` parameter\nin the\n[fulfillmentServiceCreate](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentServiceCreate)\nmutation.\n\n- Shopify sends POST requests to the `/fulfillment_order_notification` endpoint\n to notify the fulfillment service about fulfillment requests and fulfillment cancellation requests,\n if `fulfillment_orders_opt_in` is set to `true`.\n\n [As of the 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation),\n it's mandatory for a fulfillment service to follow a fulfillment order based workflow by\n having `fulfillment_orders_opt_in` set to `true`,\n hosting the `/fulfillment_order_notification` endpoint, and acting on fulfillment requests and cancellations.\n\n For more information, refer to\n [Receive fulfillment requests and cancellations](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n- Shopify sends GET requests to the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers for orders,\n if `trackingSupport` is set to `true`.\n\n For more information, refer to\n [Enable tracking support](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-8-enable-tracking-support-optional).\n\n Fulfillment services can also update tracking information with the\n [fulfillmentTrackingInfoUpdateV2](https://shopify.dev/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdateV2) mutation,\n rather than waiting for Shopify to ask for tracking numbers.\n- Shopify sends GET requests to the `/fetch_stock` endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n\n For more information, refer to\n [Sharing inventory levels with Shopify](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-9-share-inventory-levels-with-shopify-optional).\n\nTo make sure you have everything set up correctly, you can test the `callbackUrl`-prefixed endpoints\nin your development store.\n\n## Resources and webhooks\n\nThere are a variety of objects and webhooks that enable a fulfillment service to work.\nTo exchange fulfillment information with Shopify, fulfillment services use the\n[FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder),\n[Fulfillment](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment) and\n[Order](https://shopify.dev/api/admin-graphql/latest/objects/Order) objects and related mutations.\nTo act on fulfillment process events that happen on the Shopify side,\nbesides awaiting calls to `callbackUrl`-prefixed endpoints,\nfulfillment services can subscribe to the\n[fulfillment order](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#webhooks)\nand [order](https://shopify.dev/api/admin-rest/latest/resources/webhook)\nwebhooks.\n", + "fields": [ + { + "name": "callbackUrl", + "description": "The callback URL that the fulfillment service has registered for requests. The following considerations apply:\n\n- Shopify queries the `/fetch_tracking_numbers` endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the `/fetch_stock` endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the `/fulfillment_order_notification` endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations),\n if the fulfillment service has opted in to the fulfillment order based workflow for managing fulfillments\n (`fulfillmentOrdersOptIn` is set to `true`).\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrdersOptIn", + "description": "Whether the fulfillment service uses the [fulfillment order based workflow](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments) for managing fulfillments.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "Human-readable unique identifier for this fulfillment service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the fulfillment service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryManagement", + "description": "Whether the fulfillment service tracks product inventory and provides updates to Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "Location associated with the fulfillment service.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "permitsSkuSharing", + "description": "Whether the fulfillment service can stock inventory alongside other locations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productBased", + "description": "Whether the fulfillment service supports local deliveries.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serviceName", + "description": "The name of the fulfillment service as seen by merchants.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingMethods", + "description": "Shipping methods associated with the fulfillment service provider. Applies only to Fulfill By Amazon fulfillment service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingMethod", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "The Fulfillment by Amazon feature will no longer be supported from March 30, 2023. To continue using Amazon fulfillment, merchants need to set up a Multi-Channel Fulfillment solution recommended by Amazon: https://help.shopify.com/manual/shipping/fulfillment-services/amazon#activate-fulfillment-by-amazon" + }, + { + "name": "type", + "description": "Type associated with the fulfillment service.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FulfillmentServiceType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentServiceCreatePayload", + "description": "Return type for `fulfillmentServiceCreate` mutation.", + "fields": [ + { + "name": "fulfillmentService", + "description": "The created fulfillment service.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentServiceDeletePayload", + "description": "Return type for `fulfillmentServiceDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted fulfillment service.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentServiceType", + "description": "The type of a fulfillment service.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GIFT_CARD", + "description": "Fulfillment by gift card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "Manual fulfillment by the merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THIRD_PARTY", + "description": "Fullfillment by a third-party fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentServiceUpdatePayload", + "description": "Return type for `fulfillmentServiceUpdate` mutation.", + "fields": [ + { + "name": "fulfillmentService", + "description": "The updated fulfillment service.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FulfillmentStatus", + "description": "The status of a fulfillment.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Shopify has created the fulfillment and is waiting for the third-party fulfillment service to transition it to `open` or `success`.\n", + "isDeprecated": true, + "deprecationReason": "This is a legacy status and is due to be deprecated." + }, + { + "name": "OPEN", + "description": "The third-party fulfillment service has acknowledged the fulfillment and is processing it.\n", + "isDeprecated": true, + "deprecationReason": "This is a legacy status and is due to be deprecated." + }, + { + "name": "SUCCESS", + "description": "The fulfillment was completed successfully.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "The fulfillment was canceled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": "There was an error with the fulfillment request.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "The fulfillment request failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfo", + "description": "Represents the tracking information for a fulfillment.", + "fields": [ + { + "name": "company", + "description": "The name of the tracking company.\n\nFor tracking company names from the list below\nShopify will automatically build tracking URLs for all provided tracking numbers,\nwhich will make the tracking numbers clickable in the interface.\n\nAdditionally, for the tracking companies listed on the\n[Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers)\nShopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process.\n\n### Supported tracking companies\n\nThe following tracking companies display for shops located in any country:\n\n * 4PX\n * AGS\n * Amazon Logistics UK\n * Amazon Logistics US\n * An Post\n * Anjun Logistics\n * APC\n * Asendia USA\n * Australia Post\n * Bonshaw\n * BPost\n * BPost International\n * Canada Post\n * Canpar\n * CDL Last Mile\n * China Post\n * Chronopost\n * Chukou1\n * Colissimo\n * Comingle\n * Coordinadora\n * Correios\n * Correos\n * CTT\n * CTT Express\n * Cyprus Post\n * Delnext\n * Deutsche Post\n * DHL eCommerce\n * DHL eCommerce Asia\n * DHL Express\n * DoorDash\n * DPD\n * DPD Local\n * DPD UK\n * DTD Express\n * DX\n * Eagle\n * Estes\n * Evri\n * FedEx\n * First Global Logistics\n * First Line\n * FSC\n * Fulfilla\n * GLS\n * Guangdong Weisuyi Information Technology (WSE)\n * Heppner Internationale Spedition GmbH & Co.\n * Iceland Post\n * IDEX\n * Israel Post\n * Japan Post (EN)\n * Japan Post (JA)\n * La Poste\n * Lasership\n * Latvia Post\n * Lietuvos Paštas\n * Logisters\n * Lone Star Overnight\n * M3 Logistics\n * Meteor Space\n * Mondial Relay\n * New Zealand Post\n * NinjaVan\n * North Russia Supply Chain (Shenzhen) Co.\n * OnTrac\n * Packeta\n * Pago Logistics\n * Ping An Da Tengfei Express\n * Pitney Bowes\n * Portal PostNord\n * Poste Italiane\n * PostNL\n * PostNord DK\n * PostNord NO\n * PostNord SE\n * Purolator\n * Qxpress\n * Qyun Express\n * Royal Mail\n * Royal Shipments\n * Sagawa (EN)\n * Sagawa (JA)\n * Sendle\n * SF Express\n * SFC Fulfillment\n * SHREE NANDAN COURIER\n * Singapore Post\n * Southwest Air Cargo\n * StarTrack\n * Step Forward Freight\n * Swiss Post\n * TForce Final Mile\n * Tinghao\n * TNT\n * Toll IPEC\n * United Delivery Service\n * UPS\n * USPS\n * Venipak\n * We Post\n * Whistl\n * Wizmo\n * WMYC\n * Xpedigo\n * XPO Logistics\n * Yamato (EN)\n * Yamato (JA)\n * YiFan Express\n * YunExpress\n\nThe following tracking companies are displayed for shops located in specific countries:\n\n * **Australia**: Australia Post, Sendle, Aramex Australia, TNT Australia, Hunter Express, Couriers Please, Bonds, Allied Express, Direct Couriers, Northline, GO Logistics\n * **Austria**: Österreichische Post\n * **Bulgaria**: Speedy\n * **Canada**: Intelcom, BoxKnight, Loomis, GLS\n * **China**: China Post, DHL eCommerce Asia, WanbExpress, YunExpress, Anjun Logistics, SFC Fulfillment, FSC\n * **Czechia**: Zásilkovna\n * **Germany**: Deutsche Post (DE), Deutsche Post (EN), DHL, DHL Express, Swiship, Hermes, GLS\n * **Spain**: SEUR\n * **France**: Colissimo, Mondial Relay, Colis Privé, GLS\n * **United Kingdom**: Evri, DPD UK, Parcelforce, Yodel, DHL Parcel, Tuffnells\n * **Greece**: ACS Courier\n * **Hong Kong SAR**: SF Express\n * **Ireland**: Fastway, DPD Ireland\n * **India**: DTDC, India Post, Delhivery, Gati KWE, Professional Couriers, XpressBees, Ecom Express, Ekart, Shadowfax, Bluedart\n * **Italy**: BRT, GLS Italy\n * **Japan**: エコ配, 西濃運輸, 西濃スーパーエキスプレス, 福山通運, 日本通運, 名鉄運輸, 第一貨物\n * **Netherlands**: DHL Parcel, DPD\n * **Norway**: Bring\n * **Poland**: Inpost\n * **Turkey**: PTT, Yurtiçi Kargo, Aras Kargo, Sürat Kargo\n * **United States**: GLS, Alliance Air Freight, Pilot Freight, LSO, Old Dominion, R+L Carriers, Southwest Air Cargo\n * **South Africa**: Fastway, Skynet.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The tracking number of the fulfillment.\n\nThe tracking number is clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking url provided in the `url` field.\n* [Shopify-known tracking company name](#supported-tracking-companies) specified in the `company` field.\n Shopify will build the tracking URL automatically based on the tracking number specified.\n* The tracking number has a Shopify-known format.\n Shopify will guess the tracking provider and build the tracking url based on the tracking number format.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URL.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URLs to track the fulfillment.\n\nThe tracking URL is displayed in the merchant's admin on the order page.\nThe tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, it's also displayed in the customer's order history.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfoUpdateV2Payload", + "description": "Return type for `fulfillmentTrackingInfoUpdateV2` mutation.", + "fields": [ + { + "name": "fulfillment", + "description": "The updated fulfillment with tracking information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentTrackingInput", + "description": "The input fields that specify all possible fields for tracking information.\n\n> Note:\n> If you provide the `url` field, you should not provide the `urls` field.\n>\n> If you provide the `number` field, you should not provide the `numbers` field.\n>\n> If you provide the `url` field, you should provide the `number` field.\n>\n> If you provide the `urls` field, you should provide the `numbers` field.\n", + "fields": null, + "inputFields": [ + { + "name": "number", + "description": "The tracking number of the fulfillment.\n\nThe tracking number will be clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking url provided in the `url` field.\n* [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n specified in the `company` field.\n Shopify will build the tracking URL automatically based on the tracking number specified.\n* The tracking number has a Shopify-known format.\n Shopify will guess the tracking provider and build the tracking url based on the tracking number format.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URL.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url", + "description": "The URL to track the fulfillment.\n\nThe tracking URL is displayed in the merchant's admin on the order page.\nThe tracking URL is displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, it's also displayed in the customer's order history.\n\nThe URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\nFor example, `\"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER\"` is a valid URL.\nIt includes a scheme (`https`) and a host (`myshipping.com`).\n", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The name of the tracking company.\n\nIf you specify a tracking company name from\n[the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies),\nShopify will automatically build tracking URLs for all provided tracking numbers,\nwhich will make the tracking numbers clickable in the interface.\nThe same tracking company will be applied to all tracking numbers specified.\n\nAdditionally, for the tracking companies listed on the\n[Shipping Carriers help page](https://help.shopify.com/manual/shipping/understanding-shipping/shipping-carriers#integrated-shipping-carriers)\nShopify will automatically update the fulfillment's `shipment_status` field during the fulfillment process.\n\n> Note:\n> Send the tracking company name exactly as written in\n> [the list](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n> (capitalization matters).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "numbers", + "description": "The tracking numbers of the fulfillment, one or many.\n\nWith multiple tracking numbers, you can provide tracking information\nfor all shipments associated with the fulfillment, if there are more than one.\nFor example, if you're shipping assembly parts of one furniture item in several boxes.\n\nTracking numbers will be clickable in the interface if one of the following applies\n(the highest in the list has the highest priority):\n\n* Tracking URLs provided in the `urls` field.\n The tracking URLs will be matched to the tracking numbers based on their positions in the arrays.\n* [Shopify-known tracking company name](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\n specified in the `company` field.\n Shopify will build tracking URLs automatically for all tracking numbers specified.\n The same tracking company will be applied to all tracking numbers.\n* Tracking numbers have a Shopify-known format.\n Shopify will guess tracking providers and build tracking URLs based on the tracking number formats.\n Not all tracking carriers are supported, and multiple tracking carriers may use similarly formatted tracking numbers.\n This can result in an invalid tracking URL.\n It is highly recommended that you send the tracking company and the tracking URLs.\n\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "urls", + "description": "The URLs to track the fulfillment, one or many.\n\nThe tracking URLs are displayed in the merchant's admin on the order page.\nThe tracking URLs are displayed in the shipping confirmation email, which can optionally be sent to the customer.\nWhen accounts are enabled, the tracking URLs are also displayed in the customer's order history.\n\nIf you're not specifying a\n[Shopify-known](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies)\ntracking company name in the `company` field,\nthen provide tracking URLs for all tracking numbers from the `numbers` field.\n\nTracking URLs from the `urls` array field are being matched with the tracking numbers from the `numbers` array\nfield correspondingly their positions in the arrays.\n\nEach URL must be an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\nFor example, `\"https://www.myshipping.com/track/?tracknumbers=TRACKING_NUMBER\"` is a valid URL.\nIt includes a scheme (`https`) and a host (`myshipping.com`).\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "FulfillmentV2Input", + "description": "The input fields used to create a fulfillment from fulfillment orders.", + "fields": null, + "inputFields": [ + { + "name": "trackingInfo", + "description": "The fulfillment's tracking information, including a tracking URL, a tracking number,\nand the company associated with the fulfillment.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentTrackingInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "Whether the customer is notified.\nIf `true`, then a notification is sent when the fulfillment is created. The default value is `false`.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "lineItemsByFulfillmentOrder", + "description": "Pairs of `fulfillment_order_id` and `fulfillment_order_line_items` that represent the fulfillment\norder line items that have to be fulfilled for each fulfillment order. For any given pair, if the\nfulfillment order line items are left blank then all the fulfillment order line items of the\nassociated fulfillment order ID will be fulfilled.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemsInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "originAddress", + "description": "Address information about the location from which the order was fulfilled.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOriginAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FunctionsAppBridge", + "description": "The App Bridge information for a Shopify Function.", + "fields": [ + { + "name": "createPath", + "description": "The relative path for creating a customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "detailsPath", + "description": "The relative path for viewing a customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FunctionsErrorHistory", + "description": "The error history from running a Shopify Function.", + "fields": [ + { + "name": "errorsFirstOccurredAt", + "description": "The date and time that the first error occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstOccurredAt", + "description": "The date and time that the first error occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasBeenSharedSinceLastError", + "description": "Whether the merchant has shared all the recent errors with the developer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasSharedRecentErrors", + "description": "Whether the merchant has shared all the recent errors with the developer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "description": "Represents any file other than HTML.\n", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to describe the contents or the function of a file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileErrors", + "description": "Any errors that have occurred on the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileStatus", + "description": "The status of the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FileStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The generic file's MIME type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalFileSize", + "description": "The generic file's size in bytes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The generic file's URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "File", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCard", + "description": "Represents an issued gift card.", + "fields": [ + { + "name": "balance", + "description": "The gift card's remaining balance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time at which the gift card was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer who will receive the gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disabledAt", + "description": "The date and time at which the gift card was disabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Whether the gift card is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiresOn", + "description": "The date at which the gift card will expire.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "initialValue", + "description": "The initial value of the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastCharacters", + "description": "The final four characters of the gift card code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maskedCode", + "description": "The gift card code. Everything but the final four characters is masked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note associated with the gift card, which isn't visible to the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the gift card. This value is `null` if the gift card was issued manually.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardConnection", + "description": "An auto-generated type for paginating through multiple GiftCards.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in GiftCardEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftCardCreateInput", + "description": "The input fields to issue a gift card.", + "fields": null, + "inputFields": [ + { + "name": "initialValue", + "description": "The initial value of the gift card.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The gift card's code. It must be 8-20 characters long and contain only letters(a-z) and numbers(0-9).\nIt isn't case sensitive. If not provided, then a random code will be generated.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerId", + "description": "The ID of the customer who will receive the gift card. Requires `write_customers` access_scope.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "expiresOn", + "description": "The date at which the gift card will expire. If not provided, then the gift card will never expire.\n", + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The note associated with the gift card, which isn't visible to the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "templateSuffix", + "description": "The suffix of the Liquid template that's used to render the gift card online.\nFor example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`.\nIf not provided, then the default `gift_card.liquid` template is used.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardCreatePayload", + "description": "Return type for `giftCardCreate` mutation.", + "fields": [ + { + "name": "giftCard", + "description": "The created gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardCode", + "description": "The created gift card's code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardDisablePayload", + "description": "Return type for `giftCardDisable` mutation.", + "fields": [ + { + "name": "giftCard", + "description": "The disabled gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardEdge", + "description": "An auto-generated type which holds one GiftCard and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of GiftCardEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftCardErrorCode", + "description": "Possible error codes that can be returned by `GiftCardUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENT", + "description": "Missing a required argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardSale", + "description": "A sale associated with a gift card.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The line item for the associated sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "GiftCardSortKeys", + "description": "The set of valid sort keys for the GiftCard query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_NAME", + "description": "Sort by the `customer_name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CODE", + "description": "Sort by the `code` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BALANCE", + "description": "Sort by the `balance` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMOUNT_SPENT", + "description": "Sort by the `amount_spent` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INITIAL_VALUE", + "description": "Sort by the `initial_value` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED_AT", + "description": "Sort by the `disabled_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRES_ON", + "description": "Sort by the `expires_on` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GiftCardUpdateInput", + "description": "The input fields to update a gift card.", + "fields": null, + "inputFields": [ + { + "name": "note", + "description": "The note associated with the gift card, which isn't visible to the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "expiresOn", + "description": "The date at which the gift card will expire. If set to `null`, then the gift card will never expire.\n", + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerId", + "description": "The ID of the customer who will receive the gift card. The ID can't be changed if the gift card already has an assigned customer ID.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "templateSuffix", + "description": "The suffix of the Liquid template that's used to render the gift card online.\nFor example, if the value is `birthday`, then the gift card is rendered using the template `gift_card.birthday.liquid`.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardUpdatePayload", + "description": "Return type for `giftCardUpdate` mutation.", + "fields": [ + { + "name": "giftCard", + "description": "The updated gift card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GiftCardUserError", + "description": "Represents an error that happens during the execution of a gift card mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "GiftCardErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "HTML", + "description": "A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a\ncomplete list of HTML elements.\n\nExample value: `\"

Grey cotton knit sweater.

\"`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "description": "Represents an object that has a list of events.", + "fields": [ + { + "name": "events", + "description": "The paginated list of events associated with the host subject.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "HasLocalizationExtensions", + "description": "Localization extensions associated with the specified resource. For example, the tax id for government invoice.\n", + "fields": [ + { + "name": "localizationExtensions", + "description": "List of localization extensions for the resource.", + "args": [ + { + "name": "countryCodes", + "description": "The country codes of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "purposes", + "description": "The purpose of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionPurpose", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtensionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "description": "Resources that metafield definitions can be applied to.", + "fields": [ + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "description": "Represents information about the metafields associated to the specified resource.", + "fields": [ + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartTransform", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMember", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "description": "Published translations associated with the resource.", + "fields": [ + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Link", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreArticle", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreBlog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + } + ] + }, + { + "kind": "SCALAR", + "name": "ID", + "description": "Represents a unique identifier, often used to refetch an object.\nThe ID type appears in a JSON response as a String, but it is not intended to be human-readable.\n\nExample value: `\"gid://shopify/Product/10079785100\"`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Image", + "description": "Represents an image resource.", + "fields": [ + { + "name": "altText", + "description": "A word or phrase to share the nature or contents of an image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A unique ID for the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalSrc", + "description": "The location of the original image as a URL.\n\nIf there are any existing transformations in the original source URL, they will remain and not be stripped.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url` instead." + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "src", + "description": "The location of the image as a URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url` instead." + }, + { + "name": "transformedSrc", + "description": "The location of the transformed image as a URL.\n\nAll transformation arguments are considered \"best-effort\". If they can be applied to an image, they will be.\nOtherwise any transformations which an image type doesn't support will be ignored.\n", + "args": [ + { + "name": "maxWidth", + "description": "Image width in pixels between 1 and 5760.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxHeight", + "description": "Image height in pixels between 1 and 5760.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "crop", + "description": "Crops the image according to the specified region.", + "type": { + "kind": "ENUM", + "name": "CropRegion", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scale", + "description": "Image size multiplier for high-resolution retina displays. Must be between 1 and 3.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "preferredContentType", + "description": "Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported).", + "type": { + "kind": "ENUM", + "name": "ImageContentType", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url(transform:)` instead" + }, + { + "name": "url", + "description": "The location of the image as a URL.\n\nIf no transform options are specified, then the original image will be preserved including any pre-applied transforms.\n\nAll transformation options are considered \"best-effort\". Any transformation that the original image type doesn't support will be ignored.\n\nIf you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).\n", + "args": [ + { + "name": "transform", + "description": "A set of options to transform the original image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ImageTransformInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ImageConnection", + "description": "An auto-generated type for paginating through multiple Images.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ImageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ImageContentType", + "description": "List of supported image content types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PNG", + "description": "A PNG image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JPG", + "description": "A JPG image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEBP", + "description": "A WEBP image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ImageEdge", + "description": "An auto-generated type which holds one Image and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ImageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ImageInput", + "description": "The input fields for an image.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "altText", + "description": "A word or phrase to share the nature or contents of an image.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "src", + "description": "The URL of the image. May be a staged upload URL.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ImageTransformInput", + "description": "The available options for transforming an image.\n\nAll transformation options are considered best effort. Any transformation that the original image type doesn't support will be ignored.\n", + "fields": null, + "inputFields": [ + { + "name": "crop", + "description": "The region of the image to remain after cropping.\nMust be used in conjunction with the `maxWidth` and/or `maxHeight` fields, where the `maxWidth` and `maxHeight` aren't equal.\nThe `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while\na smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ maxWidth: 5, maxHeight: 10, crop: LEFT }` will result\nin an image with a width of 5 and height of 10, where the right side of the image is removed.\n", + "type": { + "kind": "ENUM", + "name": "CropRegion", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxWidth", + "description": "Image width in pixels between 1 and 5760.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxHeight", + "description": "Image height in pixels between 1 and 5760.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scale", + "description": "Image size multiplier for high-resolution retina displays. Must be within 1..3.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "preferredContentType", + "description": "Convert the source image into the preferred content type.\nSupported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`.\n", + "type": { + "kind": "ENUM", + "name": "ImageContentType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ImageUploadParameter", + "description": "A parameter to upload an image.\n\nDeprecated in favor of\n[StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter),\nwhich is used in\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget)\nand returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", + "fields": [ + { + "name": "name", + "description": "The parameter name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The parameter value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "IncomingRequestLineItemInput", + "description": "The input fields for the incoming line item.", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentOrderLineItemId", + "description": "The ID of the rejected line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "The rejection message of the line item.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Int", + "description": "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryActivatePayload", + "description": "Return type for `inventoryActivate` mutation.", + "fields": [ + { + "name": "inventoryLevel", + "description": "The inventory level that was activated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustItemInput", + "description": "The input fields for items and their adjustments.", + "fields": null, + "inputFields": [ + { + "name": "inventoryItemId", + "description": "ID of the inventory item to adjust.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "availableDelta", + "description": "The change applied to the `available` quantity of the item at the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustQuantitiesInput", + "description": "The input fields required to adjust inventory quantities.", + "fields": null, + "inputFields": [ + { + "name": "reason", + "description": "The reason for the quantity changes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The quantity name to be adjusted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "referenceDocumentUri", + "description": "The reference document URI for the changes. Used to denote what's causing the change.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "changes", + "description": "The quantity changes of items at locations to be made.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryChangeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustQuantitiesPayload", + "description": "Return type for `inventoryAdjustQuantities` mutation.", + "fields": [ + { + "name": "inventoryAdjustmentGroup", + "description": "The group of changes made by the operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryAdjustmentGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryAdjustQuantitiesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustQuantitiesUserError", + "description": "An error that occurs during the execution of `InventoryAdjustQuantities`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "InventoryAdjustQuantitiesUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "InventoryAdjustQuantitiesUserErrorCode", + "description": "Possible error codes that can be returned by `InventoryAdjustQuantitiesUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INTERNAL_LEDGER_DOCUMENT", + "description": "Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_AVAILABLE_DOCUMENT", + "description": "A ledger document URI is not allowed when adjusting available.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INVENTORY_ITEM", + "description": "The specified inventory item could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LEDGER_DOCUMENT", + "description": "The specified ledger document is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LOCATION", + "description": "The specified location could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_DOCUMENT", + "description": "A ledger document URI is required except when adjusting available.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_NAME", + "description": "The specified quantity name is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_TOO_LOW", + "description": "The quantity can't be lower than -2,000,000,000.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_TOO_HIGH", + "description": "The quantity can't be higher than 2,000,000,000.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REASON", + "description": "The specified reason is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REFERENCE_DOCUMENT", + "description": "The specified reference document is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ADJUST_QUANTITIES_FAILED", + "description": "The quantities couldn't be adjusted. Try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_ONE_LEDGER_DOCUMENT", + "description": "All changes must have the same ledger document URI or, in the case of adjusting available, no ledger document URI.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_NOT_STOCKED_AT_LOCATION", + "description": "The inventory item is not stocked at the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_MUTABLE_INVENTORY_ITEM", + "description": "The specified inventory item is not allowed to be adjusted via API.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustQuantityInput", + "description": "The input fields required to adjust the inventory quantity.", + "fields": null, + "inputFields": [ + { + "name": "inventoryLevelId", + "description": "ID of the inventory level to adjust.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "availableDelta", + "description": "The change applied to the `available` quantity of the item at the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustQuantityPayload", + "description": "Return type for `inventoryAdjustQuantity` mutation.", + "fields": [ + { + "name": "inventoryLevel", + "description": "Represents the updated inventory quantity of an inventory item at a specific location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustmentGroup", + "description": "Represents a group of adjustments made as part of the same operation.\n", + "fields": [ + { + "name": "app", + "description": "The app that triggered the inventory event, if one exists.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "changes", + "description": "The set of inventory quantity changes that occurred in the inventory event.", + "args": [ + { + "name": "inventoryItemIds", + "description": "The IDs of the inventory items to filter changes by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "locationIds", + "description": "The IDs of the locations to filter changes by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quantityNames", + "description": "The names of the requested inventory quantities.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryChange", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time the inventory adjustment group was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason for the group of adjustments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referenceDocumentUri", + "description": "The reference document URI for the changes. Denotes what's causing the change.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "The staff member associated with the inventory event.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryBulkAdjustQuantityAtLocationPayload", + "description": "Return type for `inventoryBulkAdjustQuantityAtLocation` mutation.", + "fields": [ + { + "name": "inventoryLevels", + "description": "Represents the updated inventory quantities of an inventory item at the location.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryBulkToggleActivationInput", + "description": "The input fields to specify whether the inventory item should be activated or not at the specified location.\n", + "fields": null, + "inputFields": [ + { + "name": "locationId", + "description": "The ID of the location to modify the inventory item's stocked status.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "activate", + "description": "Whether the inventory item can be stocked at the specified location. To deactivate, set the value to false which removes an inventory item's quantities from that location, and turns off inventory at that location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryBulkToggleActivationPayload", + "description": "Return type for `inventoryBulkToggleActivation` mutation.", + "fields": [ + { + "name": "inventoryItem", + "description": "The inventory item that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevels", + "description": "The activated inventory levels.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryBulkToggleActivationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryBulkToggleActivationUserError", + "description": "An error that occurred while setting the activation status of an inventory item.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "InventoryBulkToggleActivationUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "InventoryBulkToggleActivationUserErrorCode", + "description": "Possible error codes that can be returned by `InventoryBulkToggleActivationUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GENERIC_ERROR", + "description": "An error occurred while setting the activation status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DEACTIVATE_FROM_ONLY_LOCATION", + "description": "Cannot unstock an inventory item from the only location at which it is stocked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMMITTED_AND_INCOMING_INVENTORY_AT_LOCATION", + "description": "Cannot unstock this inventory item from this location because it has committed and incoming quantities.", + "isDeprecated": true, + "deprecationReason": "This error code is deprecated. Both INCOMING_INVENTORY_AT_LOCATION and COMMITTED_INVENTORY_AT_LOCATION codes will be returned as individual errors instead." + }, + { + "name": "INCOMING_INVENTORY_AT_LOCATION", + "description": "Cannot unstock this inventory item from this location because it has incoming quantities.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMMITTED_INVENTORY_AT_LOCATION", + "description": "Cannot unstock this inventory item from this location because it has committed quantities.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESERVED_INVENTORY_AT_LOCATION", + "description": "Cannot unstock this inventory item from this location because it has unavailable quantities.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_UNSTOCK_FROM_LOCATION", + "description": "Failed to unstock this inventory item from this location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_MANAGED_BY_3RD_PARTY", + "description": "Cannot stock this inventory item at this location because it is managed by a third-party fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_MANAGED_BY_SHOPIFY", + "description": "Cannot stock this inventory item at this location because it is managed by Shopify.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_STOCK_AT_LOCATION", + "description": "Failed to stock this inventory item at this location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_SKU", + "description": "Cannot stock this inventory item at this location because the variant is missing a SKU.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_NOT_FOUND", + "description": "The location was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_ITEM_NOT_FOUND", + "description": "The inventory item was not found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryChange", + "description": "Represents a change in an inventory quantity of an inventory item at a location.\n", + "fields": [ + { + "name": "delta", + "description": "The amount by which the inventory quantity was changed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "item", + "description": "The inventory item associated with this inventory change.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ledgerDocumentUri", + "description": "The ledger document URI for the change. Denotes who the change is applied to.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location associated with this inventory change.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the inventory quantity that was changed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityAfterChange", + "description": "The quantity of named inventory after the change.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryChangeInput", + "description": "The input fields for the change to be made to an inventory item at a location.\n", + "fields": null, + "inputFields": [ + { + "name": "delta", + "description": "The amount by which the inventory quantity will be changed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "inventoryItemId", + "description": "Specifies the inventory item to which the change will be applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "Specifies the location at which the change will be applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ledgerDocumentUri", + "description": "The ledger document URI to which the quantity change is being applied. Not allowed for 'available' and required for other quantity names.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryDeactivatePayload", + "description": "Return type for `inventoryDeactivate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryItem", + "description": "Represents the goods available to be shipped to a customer.\nIt holds essential information about the goods, including SKU and whether it is tracked.\n", + "fields": [ + { + "name": "countryCodeOfOrigin", + "description": "The ISO 3166-1 alpha-2 country code of where the item originated from.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryHarmonizedSystemCodes", + "description": "A list of country specific harmonized system codes.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CountryHarmonizedSystemCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the inventory item was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duplicateSkuCount", + "description": "The number of inventory items that share the same SKU with this item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "harmonizedSystemCode", + "description": "The harmonized system code of the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryHistoryUrl", + "description": "The URL that points to the inventory history for the item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevel", + "description": "The inventory item's quantities at the specified location.", + "args": [ + { + "name": "locationId", + "description": "ID of the location for which the inventory level is requested.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevels", + "description": "A list of the inventory item's quantities for each location that the inventory item can be stocked at.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `inventory_group_id`\n - `inventory_item_id`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevelConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationsCount", + "description": "The number of locations where this inventory item is stocked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCodeOfOrigin", + "description": "The ISO 3166-2 alpha-2 province code of where the item originated from.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether the inventory item requires shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "Inventory item SKU. Case-sensitive string.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracked", + "description": "Whether inventory levels are tracked for the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackedEditable", + "description": "Whether the value of the `tracked` field for the inventory item can be changed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EditableProperty", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitCost", + "description": "Unit cost associated with the inventory item. Note: the user must have \"View product costs\" permission granted in order to access this field once product granular permissions are enabled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the inventory item was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The variant that owns this inventory item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryItemConnection", + "description": "An auto-generated type for paginating through multiple InventoryItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in InventoryItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryItemEdge", + "description": "An auto-generated type which holds one InventoryItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of InventoryItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryItemInput", + "description": "The input fields for an inventory item.", + "fields": null, + "inputFields": [ + { + "name": "cost", + "description": "Unit cost associated with the inventory item, the currency is the shop's default currency.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tracked", + "description": "Whether the inventory item is tracked.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryItemUpdateInput", + "description": "The input fields for an inventory item.", + "fields": null, + "inputFields": [ + { + "name": "cost", + "description": "Unit cost associated with the inventory item, the currency is the shop's default currency.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tracked", + "description": "Whether the inventory item is tracked. The value must be true to adjust the item's inventory levels.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCodeOfOrigin", + "description": "The ISO 3166-1 alpha-2 country code of where the item originated from.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "provinceCodeOfOrigin", + "description": "The ISO 3166-2 alpha-2 province/state code of where the item originated from.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "harmonizedSystemCode", + "description": "The harmonized system code of the inventory item. This must be a number between 6 and 13 digits.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryHarmonizedSystemCodes", + "description": "List of country-specific harmonized system codes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CountryHarmonizedSystemCodeInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryItemUpdatePayload", + "description": "Return type for `inventoryItemUpdate` mutation.", + "fields": [ + { + "name": "inventoryItem", + "description": "The inventory item that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryLevel", + "description": "The quantities of an inventory item that are related to a specific location.\n", + "fields": [ + { + "name": "available", + "description": "The quantity of inventory items that are available at the inventory level's associated location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `quantities` instead." + }, + { + "name": "canDeactivate", + "description": "Whether the inventory items associated with the inventory level can be deactivated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the inventory level was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deactivationAlert", + "description": "Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deactivationAlertHtml", + "description": "Describes, in HTML with embedded URLs, either the impact of deactivating the inventory level or why the inventory level can't be deactivated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "FormattedString", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `deactivationAlert` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "incoming", + "description": "The quantity of inventory items that are going to the inventory level's associated location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `quantities` instead." + }, + { + "name": "item", + "description": "Inventory item associated with the inventory level.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location associated with the inventory level.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantities", + "description": "Quantities for the requested names.", + "args": [ + { + "name": "names", + "description": "The names of the requested inventory quantities.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryQuantity", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the inventory level was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryLevelConnection", + "description": "An auto-generated type for paginating through multiple InventoryLevels.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevelEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in InventoryLevelEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryLevelEdge", + "description": "An auto-generated type which holds one InventoryLevel and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of InventoryLevelEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryLevelInput", + "description": "The input fields for an inventory level.", + "fields": null, + "inputFields": [ + { + "name": "availableQuantity", + "description": "The available quantity of an inventory item at a location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of a location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantitiesInput", + "description": "The input fields required to move inventory quantities.", + "fields": null, + "inputFields": [ + { + "name": "reason", + "description": "The reason for the quantity changes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "referenceDocumentUri", + "description": "The reference document URI for the changes. Used to denote what's causing the change.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "changes", + "description": "The quantity changes of items at locations to be made.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantityChange", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryMoveQuantitiesPayload", + "description": "Return type for `inventoryMoveQuantities` mutation.", + "fields": [ + { + "name": "inventoryAdjustmentGroup", + "description": "The group of changes made by the operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryAdjustmentGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryMoveQuantitiesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryMoveQuantitiesUserError", + "description": "An error that occurs during the execution of `InventoryMoveQuantities`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "InventoryMoveQuantitiesUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "InventoryMoveQuantitiesUserErrorCode", + "description": "Possible error codes that can be returned by `InventoryMoveQuantitiesUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INTERNAL_LEDGER_DOCUMENT", + "description": "Internal (gid://shopify/) ledger documents are not allowed to be adjusted via API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_AVAILABLE_DOCUMENT", + "description": "A ledger document URI is not allowed when adjusting available.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INVENTORY_ITEM", + "description": "The specified inventory item could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LEDGER_DOCUMENT", + "description": "The specified ledger document is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LOCATION", + "description": "The specified location could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_DOCUMENT", + "description": "A ledger document URI is required except when adjusting available.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_NAME", + "description": "The specified quantity name is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_NEGATIVE", + "description": "The quantity can't be negative.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_TOO_HIGH", + "description": "The quantity can't be higher than 2,000,000,000.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REASON", + "description": "The specified reason is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REFERENCE_DOCUMENT", + "description": "The specified reference document is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MOVE_QUANTITIES_FAILED", + "description": "The quantities couldn't be moved. Try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DIFFERENT_LOCATIONS", + "description": "The quantities can't be moved between different locations.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAME_QUANTITY_NAME", + "description": "The quantity names for each change can't be the same.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_LEDGER_DOCUMENT_URIS", + "description": "Only a maximum of 2 ledger document URIs across all changes is allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_NOT_STOCKED_AT_LOCATION", + "description": "The inventory item is not stocked at the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_MUTABLE_INVENTORY_ITEM", + "description": "The specified inventory item is not allowed to be adjusted via API.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantityChange", + "description": "Represents the change to be made to an inventory item at a location.\nThe change can either involve the same quantity name between different locations,\nor involve different quantity names between the same location.\n", + "fields": null, + "inputFields": [ + { + "name": "inventoryItemId", + "description": "Specifies the inventory item to which the change will be applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The amount by which the inventory quantity will be changed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "from", + "description": "The location, quantity name, and ledger document from where the move will be made.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantityTerminalInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "to", + "description": "The location, quantity name, and ledger document to where the move will be made.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantityTerminalInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantityTerminalInput", + "description": "The input fields representing the change to be made to an inventory item at a location.\n", + "fields": null, + "inputFields": [ + { + "name": "locationId", + "description": "Specifies the location at which the change will be applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The quantity name to be moved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ledgerDocumentUri", + "description": "The ledger document URI for the quantity move. Not allowed for 'available' and required for other quantity names.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryProperties", + "description": "General inventory properties for the shop.", + "fields": [ + { + "name": "quantityNames", + "description": "All the quantity names.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryQuantityName", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryQuantity", + "description": "Represents a quantity of an inventory item at a specific location, for a specific name.\n", + "fields": [ + { + "name": "name", + "description": "The name that identifies the inventory quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity for the quantity name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "When the quantity was last updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventoryQuantityName", + "description": "Details about an individual quantity name.", + "fields": [ + { + "name": "belongsTo", + "description": "List of quantity names that this quantity name belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comprises", + "description": "List of quantity names that comprise this quantity name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The i18n-friendly display name of the quantity.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isInUse", + "description": "Whether the quantity name has been used by the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The quantity name as used by the API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventorySetOnHandQuantitiesInput", + "description": "The input fields required to set inventory on hand quantities.", + "fields": null, + "inputFields": [ + { + "name": "reason", + "description": "The reason for the quantity changes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "referenceDocumentUri", + "description": "The reference document URI for the changes. Used to denote what's causing the change.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "setQuantities", + "description": "The value to which the on hand quantity will be set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventorySetQuantityInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventorySetOnHandQuantitiesPayload", + "description": "Return type for `inventorySetOnHandQuantities` mutation.", + "fields": [ + { + "name": "inventoryAdjustmentGroup", + "description": "The group of changes made by the operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "InventoryAdjustmentGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventorySetOnHandQuantitiesUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InventorySetOnHandQuantitiesUserError", + "description": "An error that occurs during the execution of `InventorySetOnHandQuantities`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "InventorySetOnHandQuantitiesUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "InventorySetOnHandQuantitiesUserErrorCode", + "description": "Possible error codes that can be returned by `InventorySetOnHandQuantitiesUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID_INVENTORY_ITEM", + "description": "The specified inventory item could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LOCATION", + "description": "The specified location could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_NEGATIVE", + "description": "The quantity can't be negative.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REASON", + "description": "The specified reason is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REFERENCE_DOCUMENT", + "description": "The specified reference document is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SET_ON_HAND_QUANTITIES_FAILED", + "description": "The on-hand quantities couldn't be set. Try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_NOT_STOCKED_AT_LOCATION", + "description": "The inventory item is not stocked at the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_MUTABLE_INVENTORY_ITEM", + "description": "The specified inventory item is not allowed to be adjusted via API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY_TOO_HIGH", + "description": "The total quantity can't be higher than 1,000,000,000.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InventorySetQuantityInput", + "description": "The input fields for the quantity to be set for an inventory item at a location.\n", + "fields": null, + "inputFields": [ + { + "name": "inventoryItemId", + "description": "Specifies the inventory item to which the quantity will be set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "Specifies the location at which the quantity will be set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity to which the inventory quantity will be set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "JSON", + "description": "A [JSON](https://www.json.org/json-en.html) object.\n\nExample value:\n`{\n \"product\": {\n \"id\": \"gid://shopify/Product/1346443542550\",\n \"title\": \"White T-shirt\",\n \"options\": [{\n \"name\": \"Size\",\n \"values\": [\"M\", \"L\"]\n }]\n }\n}`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Job", + "description": "A job corresponds to some long running task that the client should poll for status.", + "fields": [ + { + "name": "done", + "description": "This indicates if the job is still queued or has been run.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID that's returned when running an asynchronous mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "query", + "description": "This field will only resolve once the job is done. Can be used to ask for object(s) that have been changed by the job.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "QueryRoot", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "JobResult", + "description": "A job corresponds to some long running task that the client should poll for status.", + "fields": [ + { + "name": "done", + "description": "This indicates if the job is still queued or has been run.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID that's returned when running an asynchronous mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQuery", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "LanguageCode", + "description": "ISO 639-1 language codes supported by Shopify.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AF", + "description": "Afrikaans.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AK", + "description": "Akan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AM", + "description": "Amharic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AR", + "description": "Arabic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AS", + "description": "Assamese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZ", + "description": "Azerbaijani.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BE", + "description": "Belarusian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BG", + "description": "Bulgarian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BM", + "description": "Bambara.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BN", + "description": "Bangla.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BO", + "description": "Tibetan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BR", + "description": "Breton.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BS", + "description": "Bosnian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA", + "description": "Catalan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CE", + "description": "Chechen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CS", + "description": "Czech.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CY", + "description": "Welsh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DA", + "description": "Danish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DE", + "description": "German.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZ", + "description": "Dzongkha.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EE", + "description": "Ewe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EL", + "description": "Greek.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EN", + "description": "English.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EO", + "description": "Esperanto.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ES", + "description": "Spanish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ET", + "description": "Estonian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EU", + "description": "Basque.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FA", + "description": "Persian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FF", + "description": "Fulah.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FI", + "description": "Finnish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FO", + "description": "Faroese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FR", + "description": "French.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FY", + "description": "Western Frisian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GA", + "description": "Irish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GD", + "description": "Scottish Gaelic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GL", + "description": "Galician.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GU", + "description": "Gujarati.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GV", + "description": "Manx.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HA", + "description": "Hausa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HE", + "description": "Hebrew.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HI", + "description": "Hindi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HR", + "description": "Croatian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HU", + "description": "Hungarian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HY", + "description": "Armenian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IA", + "description": "Interlingua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Indonesian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IG", + "description": "Igbo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "II", + "description": "Sichuan Yi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": "Icelandic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IT", + "description": "Italian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JA", + "description": "Japanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JV", + "description": "Javanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KA", + "description": "Georgian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KI", + "description": "Kikuyu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KK", + "description": "Kazakh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KL", + "description": "Kalaallisut.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KM", + "description": "Khmer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KN", + "description": "Kannada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KO", + "description": "Korean.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KS", + "description": "Kashmiri.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KU", + "description": "Kurdish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KW", + "description": "Cornish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KY", + "description": "Kyrgyz.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LB", + "description": "Luxembourgish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LG", + "description": "Ganda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LN", + "description": "Lingala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LO", + "description": "Lao.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LT", + "description": "Lithuanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LU", + "description": "Luba-Katanga.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LV", + "description": "Latvian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "Malagasy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MI", + "description": "Māori.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MK", + "description": "Macedonian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ML", + "description": "Malayalam.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MN", + "description": "Mongolian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MR", + "description": "Marathi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MS", + "description": "Malay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MT", + "description": "Maltese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MY", + "description": "Burmese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NB", + "description": "Norwegian (Bokmål).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ND", + "description": "North Ndebele.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NE", + "description": "Nepali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NL", + "description": "Dutch.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NN", + "description": "Norwegian Nynorsk.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO", + "description": "Norwegian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OM", + "description": "Oromo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OR", + "description": "Odia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OS", + "description": "Ossetic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PA", + "description": "Punjabi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PL", + "description": "Polish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PS", + "description": "Pashto.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT_BR", + "description": "Portuguese (Brazil).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT_PT", + "description": "Portuguese (Portugal).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QU", + "description": "Quechua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RM", + "description": "Romansh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RN", + "description": "Rundi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RO", + "description": "Romanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RU", + "description": "Russian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RW", + "description": "Kinyarwanda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SD", + "description": "Sindhi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SE", + "description": "Northern Sami.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SG", + "description": "Sango.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SI", + "description": "Sinhala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SK", + "description": "Slovak.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SL", + "description": "Slovenian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SN", + "description": "Shona.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SO", + "description": "Somali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SQ", + "description": "Albanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SR", + "description": "Serbian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SU", + "description": "Sundanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SV", + "description": "Swedish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SW", + "description": "Swahili.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TA", + "description": "Tamil.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TE", + "description": "Telugu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TG", + "description": "Tajik.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TH", + "description": "Thai.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TI", + "description": "Tigrinya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TK", + "description": "Turkmen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TO", + "description": "Tongan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TR", + "description": "Turkish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TT", + "description": "Tatar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UG", + "description": "Uyghur.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UK", + "description": "Ukrainian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UR", + "description": "Urdu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZ", + "description": "Uzbek.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VI", + "description": "Vietnamese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WO", + "description": "Wolof.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XH", + "description": "Xhosa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YI", + "description": "Yiddish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YO", + "description": "Yoruba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH_CN", + "description": "Chinese (Simplified).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH_TW", + "description": "Chinese (Traditional).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZU", + "description": "Zulu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH", + "description": "Chinese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT", + "description": "Portuguese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CU", + "description": "Church Slavic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VO", + "description": "Volapük.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "description": "Interoperability metadata for types that directly correspond to a REST Admin API resource.\nFor example, on the Product type, LegacyInteroperability returns metadata for the corresponding [Product object](https://shopify.dev/api/admin-graphql/latest/objects/product) in the REST Admin API.\n", + "fields": [ + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "LengthUnit", + "description": "Units of measurement for length.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MILLIMETERS", + "description": "1000 millimeters equals 1 meter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CENTIMETERS", + "description": "100 centimeters equals 1 meter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METERS", + "description": "Metric system unit of length.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCHES", + "description": "12 inches equals 1 foot.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FEET", + "description": "Imperial system unit of length.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YARDS", + "description": "1 yard equals 3 feet.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LimitedPendingOrderCount", + "description": "The total number of pending orders on a shop if less then a maximum, or that maximum.\nThe atMax field indicates when this maximum has been reached.\n", + "fields": [ + { + "name": "atMax", + "description": "This is set when the number of pending orders has reached the maximum.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "count", + "description": "The number of pendings orders on the shop.\nLimited to a maximum of 10000.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItem", + "description": "Represents individual products and quantities purchased in the associated order.", + "fields": [ + { + "name": "canRestock", + "description": "Whether the line item can be restocked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `restockable` instead." + }, + { + "name": "contract", + "description": "The subscription contract associated with this line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentQuantity", + "description": "The line item's quantity, minus the removed quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated onto the line item by discount applications, not including order edits and refunds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotal", + "description": "The total line price after discounts are applied, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedTotalSet` instead." + }, + { + "name": "discountedTotalSet", + "description": "The total line price after discounts are applied, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPrice", + "description": "The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedUnitPriceSet` instead." + }, + { + "name": "discountedUnitPriceSet", + "description": "The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duties", + "description": "The duties associated with the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Duty", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillableQuantity", + "description": "The total number of units to fulfill.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead." + }, + { + "name": "fulfillmentService", + "description": "The fulfillment service that stocks the product variant belonging to a line item.\n\nThis is a third-party fulfillment service in the following scenarios:\n\n**Scenario 1**\n- The product variant is stocked by a single fulfillment service.\n- The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n\n**Scenario 2**\n- Multiple fulfillment services stock the product variant.\n- The last time that the line item was unfulfilled, it was awaiting fulfillment by a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n\nIf none of the above conditions are met, then the fulfillment service has the `manual` handle.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "\nThe [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked.\n\nIf you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.\n\nAltering the locations which stock a product variant won't change the value of this field for existing orders.\n\nLearn about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states).\n" + }, + { + "name": "fulfillmentStatus", + "description": "The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,\n'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use [FulfillmentOrderLineItem#remainingQuantity](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrderLineItem#field-fulfillmentorderlineitem-remainingquantity) instead" + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated to the line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemGroup", + "description": "The line item group associated to the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "LineItemGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantEditable", + "description": "Whether the line item can be edited or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The title of the product, optionally appended with the title of the variant (if applicable).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nonFulfillableQuantity", + "description": "The total number of units that can't be fulfilled. For example, if items have been refunded, or the item is not something that can be fulfilled, like a tip. Please see the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object for more fulfillment details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotal", + "description": "The total price without discounts applied, in shop currency.\nThis value is based on the unit price of the variant x quantity.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalTotalSet` instead." + }, + { + "name": "originalTotalSet", + "description": "The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPrice", + "description": "The variant unit price without discounts applied, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalUnitPriceSet` instead." + }, + { + "name": "originalUnitPriceSet", + "description": "The variant unit price without discounts applied, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The Product object associated with this line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of variant units ordered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundableQuantity", + "description": "The line item's quantity, minus the removed quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restockable", + "description": "Whether the line item can be restocked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlan", + "description": "The selling plan details associated with the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "LineItemSellingPlan", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The variant SKU number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "Staff attributed to the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The taxes charged for this line item.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product at time of order creation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscount", + "description": "The total amount of the discount allocated to the line item in the shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalDiscountSet` instead." + }, + { + "name": "totalDiscountSet", + "description": "The total amount of the discount that's allocated to the line item, in the shop and presentment currencies. This field must be explicitly set using draft orders, Shopify scripts, or the API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledDiscountedTotal", + "description": "The total discounted value of unfulfilled units, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unfulfilledDiscountedTotalSet` instead." + }, + { + "name": "unfulfilledDiscountedTotalSet", + "description": "The total discounted value of unfulfilled units, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledOriginalTotal", + "description": "The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unfulfilledOriginalTotalSet` instead." + }, + { + "name": "unfulfilledOriginalTotalSet", + "description": "The total price, without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledQuantity", + "description": "The number of units not yet fulfilled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The Variant object associated with this line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The title of the variant at time of order creation.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who made the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemConnection", + "description": "An auto-generated type for paginating through multiple LineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in LineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemEdge", + "description": "An auto-generated type which holds one LineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of LineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemGroup", + "description": "A line item group (bundle) to which a line item belongs to.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Quantity of the line item group on the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Title of the line item group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemMutable", + "description": "Represents a single line item on an order.", + "fields": [ + { + "name": "canRestock", + "description": "Whether the line item can be restocked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `restockable` instead." + }, + { + "name": "customAttributes", + "description": "A list of attributes that represent custom features or special requests.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated onto the line item by discount applications.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotal", + "description": "The total line price after discounts are applied, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedTotalSet` instead." + }, + { + "name": "discountedTotalSet", + "description": "The total line price after discounts are applied, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedUnitPrice", + "description": "The approximate split price of a line item unit, in shop currency. This value doesn't include discounts applied to the entire order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedUnitPriceSet` instead." + }, + { + "name": "discountedUnitPriceSet", + "description": "The approximate split price of a line item unit, in shop and presentment currencies. This value doesn't include discounts applied to the entire order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillableQuantity", + "description": "The total number of units to fulfill.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "The service provider that fulfills the line item.\n\nDeleted fulfillment services will return null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentStatus", + "description": "The line item's fulfillment status. Returns 'fulfilled' if fulfillableQuantity >= quantity,\n'partial' if fulfillableQuantity > 0, and 'unfulfilled' otherwise.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated to the line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantEditable", + "description": "Whether the line item can be edited or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nonFulfillableQuantity", + "description": "The total number of units that can't be fulfilled. For example, if items have been refunded, or the item isn't something that can be fulfilled, like a tip.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotal", + "description": "The total price without any discounts applied, in shop currency. \"\"This value is based on the unit price of the variant x quantity.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalTotalSet` instead." + }, + { + "name": "originalTotalSet", + "description": "The total price in shop and presentment currencies, without discounts applied. This value is based on the unit price of the variant x quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalUnitPrice", + "description": "The variant unit price without discounts applied, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalUnitPriceSet` instead." + }, + { + "name": "originalUnitPriceSet", + "description": "The variant unit price without discounts applied, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The Product object associated with this line item's variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of variant units ordered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundableQuantity", + "description": "The line item's quantity, minus the removed quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restockable", + "description": "Whether the line item can be restocked.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The variant SKU number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "Staff attributed to the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The TaxLine object connected to this line item.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscount", + "description": "The total amount of the discount allocated to the line item in the shop currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalDiscountSet` instead." + }, + { + "name": "totalDiscountSet", + "description": "The total amount of the discount allocated to the line item in the presentment currency. This field must be explicitly set using draft orders, Shopify scripts, or the API. Instead of using this field, Shopify recommends using `discountAllocations`, which provides the same information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledDiscountedTotal", + "description": "The total discounted value of unfulfilled units, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unfulfilledDiscountedTotalSet` instead." + }, + { + "name": "unfulfilledDiscountedTotalSet", + "description": "The total discounted value of unfulfilled units, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledOriginalTotal", + "description": "The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unfulfilledOriginalTotalSet` instead." + }, + { + "name": "unfulfilledOriginalTotalSet", + "description": "The total price without any discounts applied. This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unfulfilledQuantity", + "description": "The number of units not yet fulfilled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The Variant object associated with this line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "The name of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the vendor who made the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemMutableConnection", + "description": "An auto-generated type for paginating through multiple LineItemMutables.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemMutableEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in LineItemMutableEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemMutable", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemMutableEdge", + "description": "An auto-generated type which holds one LineItemMutable and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of LineItemMutableEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemMutable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LineItemSellingPlan", + "description": "Represents the selling plan for a line item.", + "fields": [ + { + "name": "name", + "description": "The name of the selling plan for display purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanId", + "description": "The ID of the selling plan associated with the line item.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Link", + "description": "A link to direct users to.", + "fields": [ + { + "name": "label", + "description": "A context-sensitive label for the link.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL that the link visits.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Locale", + "description": "A locale.", + "fields": [ + { + "name": "isoCode", + "description": "Locale ISO code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Human-readable locale name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocalizableContentType", + "description": "Specifies the type of the underlying localizable content. This can be used to conditionally render different UI elements such as input fields.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "JSON_STRING", + "description": "A JSON string.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JSON", + "description": "A JSON.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST_MULTI_LINE_TEXT_FIELD", + "description": "A list of multi-line texts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST_SINGLE_LINE_TEXT_FIELD", + "description": "A list of single-line texts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST_URL", + "description": "A list of URLs.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTI_LINE_TEXT_FIELD", + "description": "A multi-line text.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RICH_TEXT_FIELD", + "description": "A rich text.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SINGLE_LINE_TEXT_FIELD", + "description": "A single-line text.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRING", + "description": "A string.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "URL", + "description": "A URL.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_REFERENCE", + "description": "A file reference.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST_FILE_REFERENCE", + "description": "A list of file references.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HTML", + "description": "An HTML.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "URI", + "description": "A URI.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INLINE_RICH_TEXT", + "description": "An inline rich text.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocalizationExtension", + "description": "Represents the value captured by a localization extension. Localization extensions are additional fields required by certain countries on international orders. For example, some countries require additional fields for customs information or tax identification numbers.", + "fields": [ + { + "name": "countryCode", + "description": "Country ISO 3166-1 alpha-2 code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The localized extension keys that are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionKey", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purpose", + "description": "The purpose of this localization extension.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionPurpose", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The localized extension title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocalizationExtensionConnection", + "description": "An auto-generated type for paginating through multiple LocalizationExtensions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtensionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in LocalizationExtensionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtension", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocalizationExtensionEdge", + "description": "An auto-generated type which holds one LocalizationExtension and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of LocalizationExtensionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtension", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LocalizationExtensionInput", + "description": "The input fields for a LocalizationExtensionInput.\n", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key for the localization extension.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionKey", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The localization extension value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocalizationExtensionKey", + "description": "The key of a localization extension.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAX_CREDENTIAL_BR", + "description": "Extension key 'tax_credential_br' for country BR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_CREDENTIAL_BR", + "description": "Extension key 'shipping_credential_br' for country BR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_CREDENTIAL_CN", + "description": "Extension key 'shipping_credential_cn' for country CN.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_CREDENTIAL_IT", + "description": "Extension key 'tax_credential_it' for country IT.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_EMAIL_IT", + "description": "Extension key 'tax_email_it' for country IT.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_CREDENTIAL_KR", + "description": "Extension key 'shipping_credential_kr' for country KR.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocalizationExtensionPurpose", + "description": "The purpose of a localization extension.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHIPPING", + "description": "Extensions that are used for shipping purposes, for example, customs clearance.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX", + "description": "Extensions that are used for taxes purposes, for example, invoicing.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Location", + "description": "Represents the location where the physical good resides.\n", + "fields": [ + { + "name": "activatable", + "description": "Whether this location can be reactivated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address", + "description": "The address of this location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addressVerified", + "description": "Whether the location address has been verified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deactivatable", + "description": "Whether this location can be deactivated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deactivatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) that the location was deactivated at. For example, 3:30 pm on September 7, 2019 in the time zone of UTC (Universal Time Coordinated) is represented as `\"2019-09-07T15:50:00Z`\".", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletable", + "description": "Whether this location can be deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "Name of the service provider that fulfills from this location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillsOnlineOrders", + "description": "Whether this location can fulfill online orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasActiveInventory", + "description": "Whether this location has active inventory.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasUnfulfilledOrders", + "description": "Whether this location has orders that need to be fulfilled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevel", + "description": "The quantities of an inventory item at this location.", + "args": [ + { + "name": "inventoryItemId", + "description": "The ID of the inventory item to obtain the inventory level for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevels", + "description": "A list of the quantities of the inventory items that can be stocked at this location.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `inventory_group_id`\n - `inventory_item_id`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryLevelConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isActive", + "description": "Whether the location is active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPrimary", + "description": "Whether the location is your primary location for shipping inventory.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The concept of a primary location is deprecated, shipsInventory can be used to get a fallback location" + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localPickupSettingsV2", + "description": "Local pickup settings for the location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryLocalPickupSettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "shipsInventory", + "description": "Whether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestedAddresses", + "description": "List of suggested addresses for this location (empty if none).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationSuggestedAddress", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationActivatePayload", + "description": "Return type for `locationActivate` mutation.", + "fields": [ + { + "name": "location", + "description": "The location that was activated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationActivateUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationActivateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationActivateUserError", + "description": "An error that occurs while activating a location.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LocationActivateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationActivateUserErrorCode", + "description": "Possible error codes that can be returned by `LocationActivateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "GENERIC_ERROR", + "description": "An error occurred while activating the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_LIMIT", + "description": "Shop has reached its location limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_ONGOING_RELOCATION", + "description": "This location currently cannot be activated as inventory, pending orders or transfers are being relocated from this location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_NOT_FOUND", + "description": "Location not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_NON_UNIQUE_NAME", + "description": "There is already an active location with this name.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LocationAddAddressInput", + "description": "The input fields to use to specify the address while adding a location.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The first line of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The ZIP code or postal code of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The two-letter code of country for the address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "provinceCode", + "description": "The code for the region of the address, such as the state, province, or district.\nFor example CA for California, United States.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LocationAddInput", + "description": "The input fields to use to add a location.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "address", + "description": "The address of the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LocationAddAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fulfillsOnlineOrders", + "description": "Whether inventory at this location is available for sale online.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "metafields", + "description": "Additional customizable information to associate with the location.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationAddPayload", + "description": "Return type for `locationAdd` mutation.", + "fields": [ + { + "name": "location", + "description": "The location that was added.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationAddUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationAddUserError", + "description": "An error that occurs while adding a location.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LocationAddUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationAddUserErrorCode", + "description": "Possible error codes that can be returned by `LocationAddUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_US_ZIPCODE", + "description": "The ZIP code is not a valid US ZIP code.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "An error occurred while adding the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TYPE", + "description": "The type is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE", + "description": "The value is invalid for the metafield type or for the definition options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_NOT_AUTHORIZED", + "description": "ApiPermission metafields can only be created or updated by the app owner.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSTRUCTURED_RESERVED_NAMESPACE", + "description": "Unstructured reserved namespace.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISALLOWED_OWNER_TYPE", + "description": "Owner type can't be used in this mutation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationAddress", + "description": "Represents the address of a location.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The country code of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formatted", + "description": "A formatted version of the address for the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "The latitude coordinates of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude coordinates of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The code for the province, state, or district of the address of the location.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The ZIP code of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationConnection", + "description": "An auto-generated type for paginating through multiple Locations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in LocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationDeactivatePayload", + "description": "Return type for `locationDeactivate` mutation.", + "fields": [ + { + "name": "location", + "description": "The location that was deactivated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationDeactivateUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationDeactivateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationDeactivateUserError", + "description": "The possible errors that can be returned when executing the `locationDeactivate` mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LocationDeactivateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationDeactivateUserErrorCode", + "description": "Possible error codes that can be returned by `LocationDeactivateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LOCATION_NOT_FOUND", + "description": "Location not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERMANENTLY_BLOCKED_FROM_DEACTIVATION_ERROR", + "description": "Location either has a fulfillment service or is the only location with a shipping address.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEMPORARILY_BLOCKED_FROM_DEACTIVATION_ERROR", + "description": "Location has incoming inventory. The location can be deactivated after the inventory has been received.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_ACTIVE_RETAIL_SUBSCRIPTIONS", + "description": "Location needs to be removed from Shopify POS for Retail subscription in Point of Sale channel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESTINATION_LOCATION_IS_THE_SAME_LOCATION", + "description": "Destination location is the same as the location to be deactivated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESTINATION_LOCATION_NOT_FOUND_OR_INACTIVE", + "description": "Destination location is not found or inactive.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_ACTIVE_INVENTORY_ERROR", + "description": "Location could not be deactivated without specifying where to relocate inventory at the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_FULFILLMENT_ORDERS_ERROR", + "description": "Location could not be deactivated because it has pending orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_OPEN_TRANSFERS_ERROR", + "description": "Location could not be deactivated because it has open transfers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_INCOMING_MOVEMENTS_ERROR", + "description": "Location could not be deactivated because it has open Shopify Fulfillment Network transfers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_OPEN_PURCHASE_ORDERS_ERROR", + "description": "Location could not be deactivated because it has open purchase orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_RELOCATE_ACTIVE_INVENTORIES", + "description": "Failed to relocate active inventories to the destination location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_RELOCATE_OPEN_TRANSFERS", + "description": "Failed to relocate open transfers to the destination location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_RELOCATE_OPEN_PURCHASE_ORDERS", + "description": "Failed to relocate open purchase orders to the destination location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_RELOCATE_INCOMING_MOVEMENTS", + "description": "Failed to relocate incoming movements to the destination location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT", + "description": "At least one location must fulfill online orders.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationDeletePayload", + "description": "Return type for `locationDelete` mutation.", + "fields": [ + { + "name": "deletedLocationId", + "description": "The ID of the location that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationDeleteUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationDeleteUserError", + "description": "An error that occurs while deleting a location.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LocationDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `LocationDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LOCATION_NOT_FOUND", + "description": "Location not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_IS_ACTIVE", + "description": "The location cannot be deleted while it is active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "An error occurred while deleting the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_HAS_INVENTORY", + "description": "The location cannot be deleted while it has inventory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_HAS_PENDING_ORDERS", + "description": "The location cannot be deleted while it has pending orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION_HAS_ACTIVE_RETAIL_SUBSCRIPTION", + "description": "The location cannot be deleted while it has any active Retail subscriptions in the Point of Sale channel.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationEdge", + "description": "An auto-generated type which holds one Location and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of LocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LocationEditAddressInput", + "description": "The input fields to use to edit the address of a location.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The first line of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The ZIP code or postal code of the location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The two-letter code of country for the address.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "provinceCode", + "description": "The code for the region of the address, such as the state, province, or district.\nFor example CA for California, United States.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "LocationEditInput", + "description": "The input fields to use to edit a location.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address", + "description": "The address of the location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "LocationEditAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillsOnlineOrders", + "description": "Whether inventory at this location is available for sale online.\n\n**Note:** This can't be disabled for fulfillment service locations.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional customizable information to associate with the location.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationEditPayload", + "description": "Return type for `locationEdit` mutation.", + "fields": [ + { + "name": "location", + "description": "The location that was edited.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationEditUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationEditUserError", + "description": "An error that occurs while editing a location.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LocationEditUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationEditUserErrorCode", + "description": "Possible error codes that can be returned by `LocationEditUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "The record with the ID used as the input value couldn't be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_US_ZIPCODE", + "description": "The ZIP code is not a valid US ZIP code.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "An error occurred while editing the location.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DISABLE_ONLINE_ORDER_FULFILLMENT", + "description": "At least one location must fulfill online orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TYPE", + "description": "The type is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE", + "description": "The value is invalid for the metafield type or for the definition options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_NOT_AUTHORIZED", + "description": "ApiPermission metafields can only be created or updated by the app owner.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSTRUCTURED_RESERVED_NAMESPACE", + "description": "Unstructured reserved namespace.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISALLOWED_OWNER_TYPE", + "description": "Owner type can't be used in this mutation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationLocalPickupDisablePayload", + "description": "Return type for `locationLocalPickupDisable` mutation.", + "fields": [ + { + "name": "locationId", + "description": "The ID of the location for which local pickup was disabled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationLocalPickupSettingsError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationLocalPickupEnablePayload", + "description": "Return type for `locationLocalPickupEnable` mutation.", + "fields": [ + { + "name": "localPickupSettings", + "description": "The local pickup settings that were enabled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryLocalPickupSettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryLocationLocalPickupSettingsError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationSortKeys", + "description": "The set of valid sort keys for the Location query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationSuggestedAddress", + "description": "Represents a suggested address for a location.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The country code of the suggested address.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formatted", + "description": "A formatted version of the suggested address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The code for the province, state, or district of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The ZIP code of the suggested address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddress", + "description": "Represents a customer mailing address.\n\nFor example, a customer's default address and an order's billing address are both mailling addresses.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The name of the customer's company or organization.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "coordinatesValidated", + "description": "Whether the address coordinates are valid.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `countryCodeV2` instead." + }, + { + "name": "countryCodeV2", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formatted", + "description": "A formatted version of the address, customized by the provided arguments.", + "args": [ + { + "name": "withName", + "description": "Whether to include the customer's name in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "withCompany", + "description": "Whether to include the customer's company in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedArea", + "description": "A comma-separated list of the values for city, province, and country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "The latitude coordinate of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude coordinate of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name of the customer, based on firstName and lastName.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\n\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timeZone", + "description": "The time zone of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddressConnection", + "description": "An auto-generated type for paginating through multiple MailingAddresses.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddressEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MailingAddressEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddressEdge", + "description": "An auto-generated type which holds one MailingAddress and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MailingAddressEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "description": "The input fields to create or update a mailing address.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The name of the customer's company or organization.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstName", + "description": "The first name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The last name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "provinceCode", + "description": "The code for the region of the address, such as the province, state, or district.\nFor example QC for Quebec, Canada.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ManualDiscountApplication", + "description": "Manual discount applications capture the intentions of a discount that was manually created for an order.\n\nDiscount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is applied to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the discount application.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "index", + "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Market", + "description": "A market is a group of one or more regions that you want to target for international sales.\nBy creating a market, you can configure a distinct, localized shopping experience for\ncustomers from a specific area of the world. For example, you can\n[change currency](https://shopify.dev/api/admin-graphql/current/mutations/marketCurrencySettingsUpdate),\n[configure international pricing](https://shopify.dev/apps/internationalization/product-price-lists),\nor [add market-specific domains or subfolders](https://shopify.dev/api/admin-graphql/current/objects/MarketWebPresence).\n", + "fields": [ + { + "name": "catalogs", + "description": "The catalogs that belong to the market.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCatalogConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencySettings", + "description": "The market’s currency settings.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCurrencySettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabled", + "description": "Whether the market is enabled to receive visitors and sales. **Note**: Regions in inactive\nmarkets can't be selected on the storefront or in checkout.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A short, human-readable unique identifier for the market. This is changeable by the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the market. Not shown to customers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The market’s price list, which specifies a percentage-based price adjustment as well as\nfixed price overrides for specific variants.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "primary", + "description": "Whether the market is the shop’s primary market.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "regions", + "description": "The regions that comprise the market.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketRegionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPresence", + "description": "The market’s web presence, which defines its SEO strategy. This can be a different domain,\nsubdomain, or subfolders of the primary domain. Each web presence comprises one or more\nlanguage variants. If a market doesn't have its own web presence, then the market is accessible on the\nshop’s primary domain using [country\nselectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketWebPresence", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCatalog", + "description": "A list of products with publishing and pricing information associated with markets.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "markets", + "description": "The markets associated with the catalog.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "operations", + "description": "Most recent catalog operations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The price list associated with the catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "A group of products and collections that's published to a catalog.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CatalogStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the catalog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCatalogConnection", + "description": "An auto-generated type for paginating through multiple MarketCatalogs.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCatalogEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketCatalogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCatalog", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCatalogEdge", + "description": "An auto-generated type which holds one MarketCatalog and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketCatalogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCatalog", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketConnection", + "description": "An auto-generated type for paginating through multiple Markets.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketCreateInput", + "description": "The input fields required to create a market.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the market. Not shown to customers.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "A unique identifier for the market. For example `\"ca\"`.\nIf the handle isn't provided, then the handle is auto-generated based on the country or name.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "Whether the market is enabled to receive visitors and sales. If a\nvalue isn't provided, then the market is enabled by default if all\nincluded regions have shipping rates, and disabled if any regions don't\nhave shipping rates.\n\n**Note**: Regions in inactive markets can't be selected on the\nstorefront or in checkout.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "regions", + "description": "The regions to be included in the market. Each region can only be included in one market at\na time.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketRegionCreateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCreatePayload", + "description": "Return type for `marketCreate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCurrencySettings", + "description": "A market's currency settings.", + "fields": [ + { + "name": "baseCurrency", + "description": "The currency which this market's prices are defined in, and the\ncurrency which its customers must use if local currencies are disabled.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySetting", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localCurrencies", + "description": "Whether or not local currencies are enabled. If enabled, then prices will\nbe converted to give each customer the best experience based on their\nregion. If disabled, then all customers in this market will see prices\nin the market's base currency.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketCurrencySettingsUpdateInput", + "description": "The input fields used to update the currency settings of a market.", + "fields": null, + "inputFields": [ + { + "name": "baseCurrency", + "description": "The currency which this market’s prices are defined in, and the\ncurrency which its customers must use if local currencies are disabled.\n", + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "localCurrencies", + "description": "Whether or not local currencies are enabled. If enabled, then prices will\nbe converted to give each customer the best experience based on their\nregion. If disabled, then all customers in this market will see prices\nin the market's base currency.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCurrencySettingsUpdatePayload", + "description": "Return type for `marketCurrencySettingsUpdate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketCurrencySettingsUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketCurrencySettingsUserError", + "description": "Error codes for failed market multi-currency operations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketCurrencySettingsUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketCurrencySettingsUserErrorCode", + "description": "Possible error codes that can be returned by `MarketCurrencySettingsUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MARKET_NOT_FOUND", + "description": "The specified market wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANAGED_MARKET", + "description": "The currency settings of the given market cannot be changed because the market manager has exclusive control of pricing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTIPLE_CURRENCIES_NOT_SUPPORTED", + "description": "The shop's payment gateway does not support enabling more than one currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_LOCAL_CURRENCIES_ON_SINGLE_COUNTRY_MARKET", + "description": "Can't enable or disable local currencies on a single country market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_CURRENCY", + "description": "The specified currency is not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIMARY_MARKET_USES_SHOP_CURRENCY", + "description": "The primary market must use the shop currency.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketDeletePayload", + "description": "Return type for `marketDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted market.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketEdge", + "description": "An auto-generated type which holds one Market and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizableContent", + "description": "The market localizable content of a resource's field.", + "fields": [ + { + "name": "digest", + "description": "The hash digest representation of the content value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The resource field that's being localized.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The content value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizableResource", + "description": "A resource that has market localizable fields.", + "fields": [ + { + "name": "marketLocalizableContent", + "description": "The market localizable content.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableContent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizations", + "description": "Market localizations for the market localizable content.", + "args": [ + { + "name": "marketId", + "description": "Filters market localizations by market ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalization", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourceId", + "description": "The GID of the resource.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizableResourceConnection", + "description": "An auto-generated type for paginating through multiple MarketLocalizableResources.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableResourceEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketLocalizableResourceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableResource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizableResourceEdge", + "description": "An auto-generated type which holds one MarketLocalizableResource and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketLocalizableResourceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketLocalizableResourceType", + "description": "The type of resources that are market localizable.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "METAFIELD", + "description": "A metafield. Market localizable fields: `value`.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalization", + "description": "The market localization of a field within a resource, which is determined by the market ID.", + "fields": [ + { + "name": "key", + "description": "A reference to the value being localized on the resource that this market localization belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market that the localization is specific to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "outdated", + "description": "Whether the original content has changed since this market localization was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the market localization was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the market localization.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketLocalizationRegisterInput", + "description": "The input fields and values for creating or updating a market localization.", + "fields": null, + "inputFields": [ + { + "name": "marketId", + "description": "The ID of the market that the localization is specific to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "A reference to the value being localized on the resource that this market localization belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the market localization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketLocalizableContentDigest", + "description": "A hash digest representation of the content being localized.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizationsRegisterPayload", + "description": "Return type for `marketLocalizationsRegister` mutation.", + "fields": [ + { + "name": "marketLocalizations", + "description": "The market localizations that were created or updated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalization", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketLocalizationsRemovePayload", + "description": "Return type for `marketLocalizationsRemove` mutation.", + "fields": [ + { + "name": "marketLocalizations", + "description": "The market localizations that were deleted.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalization", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "MarketRegion", + "description": "A geographic region which comprises a market.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the region.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MarketRegionCountry", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MarketRegionConnection", + "description": "An auto-generated type for paginating through multiple MarketRegions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketRegionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketRegionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MarketRegion", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketRegionCountry", + "description": "A country which comprises a market.", + "fields": [ + { + "name": "code", + "description": "The ISO code identifying the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "The currency which this country uses given its market settings.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySetting", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the region.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "MarketRegion", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketRegionCreateInput", + "description": "The input fields for creating a market region with exactly one required option.", + "fields": null, + "inputFields": [ + { + "name": "countryCode", + "description": "A country code for the region.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketRegionDeletePayload", + "description": "Return type for `marketRegionDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted market region.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The parent market object of the deleted region.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketRegionEdge", + "description": "An auto-generated type which holds one MarketRegion and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketRegionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "MarketRegion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketRegionsCreatePayload", + "description": "Return type for `marketRegionsCreate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketUpdateInput", + "description": "The input fields used to update a market.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the market. Not shown to customers.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "A unique identifier for the market. For example `\"ca\"`.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "Whether the market is enabled to receive visitors and sales. **Note**: Regions in\ninactive markets cannot be selected on the storefront or in checkout.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketUpdatePayload", + "description": "Return type for `marketUpdate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketUserError", + "description": "Defines errors encountered while managing a Market.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketUserErrorCode", + "description": "Possible error codes that can be returned by `MarketUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_NOT_FOUND", + "description": "The market wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REGION_NOT_FOUND", + "description": "The market region wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEB_PRESENCE_NOT_FOUND", + "description": "The market web presence wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_ADD_REGIONS_TO_PRIMARY_MARKET", + "description": "Can't add regions to the primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_ONLY_REGION", + "description": "Can't delete the only region in a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRES_EXACTLY_ONE_OPTION", + "description": "Exactly one input option is required.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_PRIMARY_MARKET", + "description": "Can't delete the primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOMAIN_NOT_FOUND", + "description": "Domain was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBFOLDER_SUFFIX_MUST_CONTAIN_ONLY_LETTERS", + "description": "The subfolder suffix must contain only letters.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBFOLDER_SUFFIX_CANNOT_BE_SCRIPT_CODE", + "description": "The subfolder suffix is invalid, please provide a different value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_LANGUAGES", + "description": "No languages selected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_LANGUAGES", + "description": "Duplicates found in languages.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REGION_SPECIFIC_LANGUAGE", + "description": "Cannot add region-specific language.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_HAVE_SUBFOLDER_AND_DOMAIN", + "description": "Can't pass both `subfolderSuffix` and `domainId`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_ADD_WEB_PRESENCE_TO_PRIMARY_MARKET", + "description": "Can't add the web presence to the primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRES_DOMAIN_OR_SUBFOLDER", + "description": "One of `subfolderSuffix` or `domainId` is required.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIMARY_MARKET_MUST_USE_PRIMARY_DOMAIN", + "description": "The primary market must use the primary domain.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_PRIMARY_MARKET_WEB_PRESENCE", + "description": "Can't delete the primary market's web presence.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_REACHED_MARKETS_LIMIT", + "description": "Can't have more than 50 markets.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DISABLE_PRIMARY_MARKET", + "description": "Can't disable the primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNPUBLISHED_LANGUAGE", + "description": "The language isn't published to the store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED_LANGUAGE", + "description": "The language isn't enabled on the store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_SET_DEFAULT_LOCALE_TO_NULL", + "description": "Can't set default locale to null.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_COUNTRY_REGION", + "description": "Can't add unsupported country or region.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_ADD_CUSTOMER_DOMAIN", + "description": "Can't add customer account domain to a market.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresence", + "description": "The market’s web presence, which defines its SEO strategy. This can be a different domain\n(e.g. `example.ca`), subdomain (e.g. `ca.example.com`), or subfolders of the primary\ndomain (e.g. `example.com/en-ca`). Each web presence comprises one or more language\nvariants. If a market does not have its own web presence, it is accessible on the shop’s\nprimary domain via [country\nselectors](https://shopify.dev/themes/internationalization/multiple-currencies-languages#the-country-selector).\n\nNote: while the domain/subfolders defined by a market’s web presence are not applicable to\ncustom storefronts, which must manage their own domains and routing, the languages chosen\nhere do govern [the languages available on the Storefront\nAPI](https://shopify.dev/custom-storefronts/internationalization/multiple-languages) for the countries in\nthis market.\n", + "fields": [ + { + "name": "alternateLocales", + "description": "The ISO codes for the alternate locales. When a domain is used, these locales will be\navailable as language-specific subfolders. For example, if English is an\nalternate locale, and `example.ca` is the market’s domain, then\n`example.ca/en` will load in English.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultLocale", + "description": "The ISO code for the default locale. When a domain is used, this is the locale that will\nbe used when the domain root is accessed. For example, if French is the default locale,\nand `example.ca` is the market’s domian, then `example.ca` will load in French.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "domain", + "description": "The web presence’s domain.\nThis field will be null if `subfolderSuffix` isn't null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The associated market.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rootUrls", + "description": "The list of root URLs for each of the web presence’s locales.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketWebPresenceRootUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subfolderSuffix", + "description": "The market-specific suffix of the subfolders defined by the web presence. Example: in `/en-us` the subfolder suffix is `us`. This field will be null if `domain` isn't null.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketWebPresenceCreateInput", + "description": "The input fields used to create a web presence for a market.", + "fields": null, + "inputFields": [ + { + "name": "domainId", + "description": "The web presence's domain ID. This field must be `null` if the `subfolderSuffix` isn't `null`.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "defaultLocale", + "description": "The default locale for the market’s web presence.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "alternateLocales", + "description": "The alternate locales for the market’s web presence.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "subfolderSuffix", + "description": "The market-specific suffix of the subfolders defined by the web presence.\nFor example: in `/en-us`, the subfolder suffix is `us`.\nOnly ASCII characters are allowed. This field must be `null` if the `domainId` isn't `null`.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresenceCreatePayload", + "description": "Return type for `marketWebPresenceCreate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresenceDeletePayload", + "description": "Return type for `marketWebPresenceDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted web presence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market for which the web presence was deleted.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresenceRootUrl", + "description": "The URL for the homepage of the online store in the context of a particular market and a\nparticular locale.\n", + "fields": [ + { + "name": "locale", + "description": "The locale that the storefront loads in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketWebPresenceUpdateInput", + "description": "The input fields used to update a web presence for a market.", + "fields": null, + "inputFields": [ + { + "name": "domainId", + "description": "The web presence's domain ID. This field must be null if `subfolderSuffix` is not null.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "defaultLocale", + "description": "The default locale for the market’s web presence.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "alternateLocales", + "description": "The alternate locales for the market’s web presence.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "subfolderSuffix", + "description": "The market-specific suffix of the subfolders defined by the web presence.\nExample: in `/en-us` the subfolder suffix is `us`.\nOnly ASCII characters are allowed. This field must be null if `domainId` is not null.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresenceUpdatePayload", + "description": "Return type for `marketWebPresenceUpdate` mutation.", + "fields": [ + { + "name": "market", + "description": "The market object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivity", + "description": "The marketing activity resource represents marketing that a\n merchant created through an app.", + "fields": [ + { + "name": "activityListUrl", + "description": "The URL of the marketing activity listing page in the marketing section.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adSpend", + "description": "The amount spent on the marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "The app which created this marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appErrors", + "description": "The errors generated when an app publishes the marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingActivityExtensionAppErrors", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "budget", + "description": "The allocated budget for the marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingBudget", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the marketing activity was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formData", + "description": "The completed content in the marketing activity creation form.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inMainWorkflowVersion", + "description": "Whether the marketing activity is in the main workflow version of\n the marketing automation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingChannel", + "description": "The available marketing channels for a marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingChannel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingEvent", + "description": "Associated marketing event of this marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceAndMedium", + "description": "A contextual description of the marketing activity based on the platform and tactic used.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current state of the marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusBadgeType", + "description": "The severity of the marketing activity's status.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketingActivityStatusBadgeType", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `statusBadgeTypeV2` instead." + }, + { + "name": "statusBadgeTypeV2", + "description": "The severity of the marketing activity's status.", + "args": [], + "type": { + "kind": "ENUM", + "name": "BadgeType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusLabel", + "description": "The rendered status of the marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusTransitionedAt", + "description": "The [date and time](\n https://help.shopify.com/https://en.wikipedia.org/wiki/ISO_8601\n ) when the activity's status last changed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tactic", + "description": "The method of marketing used for this marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingTactic", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetStatus", + "description": "The status to which the marketing activity is currently transitioning.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The marketing activity's title, which is rendered on the marketing listing page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the marketing activity was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utmParameters", + "description": "The set of [Urchin Tracking Module](\n https://help.shopify.com/https://en.wikipedia.org/wiki/UTM_parameters\n ) used in the URL for tracking this marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UTMParameters", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityBudgetInput", + "description": "The input fields combining budget amount and its marketing budget type.", + "fields": null, + "inputFields": [ + { + "name": "budgetType", + "description": "Budget type for marketing activity.", + "type": { + "kind": "ENUM", + "name": "MarketingBudgetBudgetType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "total", + "description": "Amount of budget for the marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityConnection", + "description": "An auto-generated type for paginating through multiple MarketingActivities.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivityEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketingActivityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityCreateExternalInput", + "description": "The input fields for creating an externally-managed marketing activity.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title of the marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "utm", + "description": "The\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. `UTMInput` is required for all\nmarketing tactics except for the Storefront app marketing tactic.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "budget", + "description": "The budget for this marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityBudgetInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adSpend", + "description": "The amount spent on the marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remoteId", + "description": "The ID of an activity that's hosted outside of Shopify.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remoteUrl", + "description": "URL for viewing and/or managing the activity outside of Shopify.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "remotePreviewImageUrl", + "description": "The URL for a preview image that's used for the marketing activity.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tactic", + "description": "Specifies the settings for the marketing platform and the ad format.\nThe marketing tactic determines which default fields are included\nin the marketing activity.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingTactic", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "channel", + "description": "The channel of your marketing event.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingChannel", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "referringDomain", + "description": "The referring domain.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scheduledStart", + "description": "When the activity is scheduled to start.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scheduledEnd", + "description": "When the activity is scheduled to end.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "start", + "description": "When the activity started.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "end", + "description": "When the activity ended.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityCreateExternalPayload", + "description": "Return type for `marketingActivityCreateExternal` mutation.", + "fields": [ + { + "name": "marketingActivity", + "description": "The external marketing activity that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivityUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityCreateInput", + "description": "The input fields required to create a marketing activity.", + "fields": null, + "inputFields": [ + { + "name": "marketingActivityTitle", + "description": "The title of the marketing activity.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "formData", + "description": "The form data in JSON serialized as a string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketingActivityExtensionId", + "description": "The ID of the marketing activity extension.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "context", + "description": "Encoded context containing marketing campaign id.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "utm", + "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. UTMInput is required for all Marketing\ntactics except Storefront App.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The current state of the marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "budget", + "description": "The budget for this marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityBudgetInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityCreatePayload", + "description": "Return type for `marketingActivityCreate` mutation.", + "fields": [ + { + "name": "marketingActivity", + "description": "The created marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectPath", + "description": "The path to return back to shopify admin from embedded editor.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityEdge", + "description": "An auto-generated type which holds one MarketingActivity and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketingActivityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingActivityExtensionAppErrorCode", + "description": "The error code resulted from the marketing activity extension integration.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_ONBOARDED_ERROR", + "description": "The shop/user must be onboarded to use the app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALIDATION_ERROR", + "description": "The app has returned validation errors.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "API_ERROR", + "description": "The app is either not responding or returning unexpected data.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLATFORM_ERROR", + "description": "The app has returned an error when invoking the platform.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSTALL_REQUIRED_ERROR", + "description": "The app needs to be installed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityExtensionAppErrors", + "description": "Represents errors returned from apps when using the marketing activity extension.", + "fields": [ + { + "name": "code", + "description": "The app error type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingActivityExtensionAppErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors returned by the app.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingActivitySortKeys", + "description": "The set of valid sort keys for the MarketingActivity query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "description": "Status helps to identify if this marketing activity has been completed, queued, failed etc.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "This marketing activity is currently running.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELETED", + "description": "This marketing activity is permanently unavailable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELETED_EXTERNALLY", + "description": "This marketing activity was deleted and it was triggered from outside of Shopify.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCONNECTED", + "description": "This marketing activity is disconnected and no longer editable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT", + "description": "This marketing activity has been edited, but it is not yet created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "This marketing activity is unable to run.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "This marketing activity has completed running.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAUSED", + "description": "This marketing activity is currently not running.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "This marketing activity is pending creation on the app's marketing platform.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "This marketing activity is scheduled to run.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED", + "description": "The marketing activity's status is unknown.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingActivityStatusBadgeType", + "description": "StatusBadgeType helps to identify the color of the status badge.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEFAULT", + "description": "This status badge has type default.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUCCESS", + "description": "This status badge has type success.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTENTION", + "description": "This status badge has type attention.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WARNING", + "description": "This status badge has type warning.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INFO", + "description": "This status badge has type info.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityUpdateExternalInput", + "description": "The input fields required to update an externally managed marketing activity.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title of the marketing activity.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "utm", + "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. UTMInput is required for all marketing\ntactics except the storefront app.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "budget", + "description": "The budget for the marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityBudgetInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adSpend", + "description": "The amount spent on the marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remoteUrl", + "description": "The URL for managing the activity outside of Shopify.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remotePreviewImageUrl", + "description": "The preview image URL for the marketing activity.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tactic", + "description": "The settings for the marketing platform and ad format.\nThe selection of the marketing tactic also determines which default fields are included\nin the marketing activity.\n", + "type": { + "kind": "ENUM", + "name": "MarketingTactic", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "channel", + "description": "The channel that your marketing event will use.", + "type": { + "kind": "ENUM", + "name": "MarketingChannel", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "referringDomain", + "description": "The referring domain.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scheduledStart", + "description": "The date and time when the activity is scheduled to start.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scheduledEnd", + "description": "The date and time when the activity is scheduled to end.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "start", + "description": "The date and time when the activity started.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "end", + "description": "The date and time when the activity ended.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityUpdateExternalPayload", + "description": "Return type for `marketingActivityUpdateExternal` mutation.", + "fields": [ + { + "name": "marketingActivity", + "description": "The updated marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivityUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityUpdateInput", + "description": "The input fields required to update a marketing activity.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketingRecommendationId", + "description": "The ID of the recommendation that the marketing activity was created from, if one exists.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the marketing activity.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "budget", + "description": "The budget for the marketing activity.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityBudgetInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The current state of the marketing activity. Learn more about\n[marketing activities statuses](/api/marketing-activities/statuses).\n", + "type": { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "targetStatus", + "description": "The target state that the marketing activity is transitioning to. Learn more about [marketing activities statuses](/api/marketing-activities/statuses).", + "type": { + "kind": "ENUM", + "name": "MarketingActivityStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "formData", + "description": "The form data of the marketing activity. This is only used if the marketing activity is\n integrated with the external editor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "utm", + "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign. UTMInput is required for all Marketing\ntactics except Storefront App. The utm field can only be set once and never modified.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketedResources", + "description": "A list of the item IDs that were marketed in this marketing activity. Valid types for these items are:\n* `Product`\n* `Shop`\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "errors", + "description": "The error messages that were generated when the app was trying to complete the activity.\nLearn more about the\n[JSON format expected for error messages](/api/marketing-activities/statuses#failed-status).\n", + "type": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityUpdatePayload", + "description": "Return type for `marketingActivityUpdate` mutation.", + "fields": [ + { + "name": "marketingActivity", + "description": "The updated marketing activity.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectPath", + "description": "The redirect path from the embedded editor to the Shopify admin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivityUserError", + "description": "An error that occurs during the execution of a Shopify Marketing mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketingActivityUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingActivityUserErrorCode", + "description": "Possible error codes that can be returned by `MarketingActivityUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingBudget", + "description": "This type combines budget amount and its marketing budget type.\n", + "fields": [ + { + "name": "budgetType", + "description": "The budget type for a marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingBudgetBudgetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The amount of budget for marketing activity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingBudgetBudgetType", + "description": "The budget type for a marketing activity.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DAILY", + "description": "A daily budget.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIFETIME", + "description": "A budget for the lifetime of a marketing activity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingChannel", + "description": "The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SEARCH", + "description": "Paid search.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY", + "description": "Displayed ads.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOCIAL", + "description": "Social media.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMAIL", + "description": "Email.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFERRAL", + "description": "Referral links.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingEngagement", + "description": "Marketing engagement represents customer activity taken on a marketing activity or a marketing channel.", + "fields": [ + { + "name": "adSpend", + "description": "The total ad spend for the day, if the marketing event is a paid ad with a daily spend.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "clicksCount", + "description": "The total number of clicks on the marketing event for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "commentsCount", + "description": "The total number of comments on marketing content for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "complaintsCount", + "description": "The total number of complaints for the day. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "failsCount", + "description": "The total number of fails for the day. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "favoritesCount", + "description": "The total number of favorites, likes, saves, or bookmarks for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fetchedAt", + "description": "The date time at which the data was fetched.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "impressionsCount", + "description": "The total number of impressions for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isCumulative", + "description": "Whether the engagements are reported as lifetime values rather than daily totals.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivity", + "description": "The marketing activity object related to this engagement. This corresponds to the marketingActivityId passed in on creation of the engagement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "occurredOn", + "description": "The date that the engagements occurred on.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sendsCount", + "description": "The total number of marketing emails or messages that were sent for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sharesCount", + "description": "The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uniqueClicksCount", + "description": "The total number of unique clicks on marketing content for the day.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uniqueViewsCount", + "description": "The total number of unique views for the day. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unsubscribesCount", + "description": "The total number of unsubscribes for the day. For social media platforms, this represents the number of unfollows.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utcOffset", + "description": "The UTC Offset that the app is using to determine which date to allocate spend to.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "UtcOffset", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "viewsCount", + "description": "The total number of views for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingEngagementCreatePayload", + "description": "Return type for `marketingEngagementCreate` mutation.", + "fields": [ + { + "name": "marketingEngagement", + "description": "The marketing engagement that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MarketingEngagement", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MarketingEngagementInput", + "description": "The input fields for a marketing engagement.", + "fields": null, + "inputFields": [ + { + "name": "occurredOn", + "description": "The date that the engagements occurred on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "impressionsCount", + "description": "The total number of impressions for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "viewsCount", + "description": "The total number of views for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were opened. For video-based content, this represents the number of times videos were played.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "clicksCount", + "description": "The total number of clicks on the marketing event for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sharesCount", + "description": "The total number of times marketing content was distributed or reposted to either one's own network of followers through a social media platform or other digital channels for the day. For message-based platforms such as email or SMS, this represents the number of times marketing emails or messages were forwarded.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "favoritesCount", + "description": "The total number of favorites, likes, saves, or bookmarks for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "commentsCount", + "description": "The total number of comments on marketing content for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "unsubscribesCount", + "description": "The total number of unsubscribes for the day. For social media platforms, this represents the number of unfollows.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "complaintsCount", + "description": "The total number of complaints for the day. For message-based platforms such as email or SMS, this represents the number of marketing emails or messages that were marked as spam. For social media platforms, this represents the number of dislikes or the number of times marketing content was reported.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "failsCount", + "description": "The total number of fails for the day. For message-based platforms such as email or SMS, this represents the number of bounced marketing emails or messages.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sendsCount", + "description": "The total number of marketing emails or messages that were sent for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uniqueViewsCount", + "description": "The total number of unique views for the day. For message-based platforms such as email or SMS, this represents the number of unique users that opened a marketing email or message. For video-based content, this represents the number of unique users that played video content.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uniqueClicksCount", + "description": "The total number of unique clicks on marketing content for the day.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adSpend", + "description": "The total ad spend for the day, if the marketing event is a paid ad with a daily spend.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "isCumulative", + "description": "Whether the engagements are reported as lifetime values rather than daily totals.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "utcOffset", + "description": "The UTC Offset that the app is using to determine which date to allocate spend to.", + "type": { + "kind": "SCALAR", + "name": "UtcOffset", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fetchedAt", + "description": "The date time at which the data was fetched.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingEvent", + "description": "Represents actions that market a merchant's store or products.", + "fields": [ + { + "name": "app", + "description": "The app that the marketing event is attributed to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channel", + "description": "The marketing channel used by the marketing event.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MarketingChannel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A human-readable description of the marketing event.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endedAt", + "description": "The date and time when the marketing event ended.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manageUrl", + "description": "The URL where the marketing event can be managed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewUrl", + "description": "The URL where the marketing event can be previewed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remoteId", + "description": "An optional ID that helps Shopify validate engagement data.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scheduledToEndAt", + "description": "The date and time when the marketing event is scheduled to end.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceAndMedium", + "description": "Where the `MarketingEvent` occurred and what kind of content was used.\nBecause `utmSource` and `utmMedium` are often used interchangeably, this is\nbased on a combination of `marketingChannel`, `referringDomain`, and `type` to\nprovide a consistent representation for any given piece of marketing\nregardless of the app that created it.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startedAt", + "description": "The date and time when the marketing event started.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetTypeDisplayText", + "description": "The display text for the marketing event type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `sourceAndMedium` instead." + }, + { + "name": "type", + "description": "The marketing event type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketingTactic", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utmCampaign", + "description": "The name of the marketing campaign.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utmMedium", + "description": "The medium that the marketing campaign is using. Example values: `cpc`, `banner`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "utmSource", + "description": "The referrer of the marketing event. Example values: `google`, `newsletter`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingEventConnection", + "description": "An auto-generated type for paginating through multiple MarketingEvents.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingEventEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MarketingEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MarketingEventEdge", + "description": "An auto-generated type which holds one MarketingEvent and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MarketingEventEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingEventSortKeys", + "description": "The set of valid sort keys for the MarketingEvent query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STARTED_AT", + "description": "Sort by the `started_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MarketingTactic", + "description": "The available types of marketing event.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ABANDONED_CART", + "description": "An abandoned cart recovery email.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AD", + "description": "An ad, such as a Facebook ad.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AFFILIATE", + "description": "An affiliate link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LINK", + "description": "A link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOYALTY", + "description": "A loyalty program.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MESSAGE", + "description": "A messaging app, such as Facebook Messenger.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEWSLETTER", + "description": "A newsletter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOTIFICATION", + "description": "A notification in the Shopify admin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POST", + "description": "A blog post.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETARGETING", + "description": "A retargeting ad.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRANSACTIONAL", + "description": "A transactional email.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEO", + "description": "Search engine optimization.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DIRECT", + "description": "A direct visit to the online store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STOREFRONT_APP", + "description": "A popup on the online store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPLAY", + "description": "A display ad.", + "isDeprecated": true, + "deprecationReason": "`DISPLAY` is deprecated. Use `AD` instead." + }, + { + "name": "SEARCH", + "description": "Paid search.", + "isDeprecated": true, + "deprecationReason": "`SEARCH` is deprecated. Use `AD` instead." + }, + { + "name": "FOLLOW_UP", + "description": "A follow-up email.", + "isDeprecated": true, + "deprecationReason": "'FOLLOW_UP' is deprecated. Use 'TRANSACTIONAL' instead." + }, + { + "name": "RECEIPT", + "description": "A promotional receipt.", + "isDeprecated": true, + "deprecationReason": "'RECEIPT' is deprecated. Use 'TRANSACTIONAL' instead." + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Media", + "description": "Represents a media interface.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaErrors", + "description": "Any errors which have occurred on the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaWarnings", + "description": "The warnings attached to the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current status of the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ExternalVideo", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MediaConnection", + "description": "An auto-generated type for paginating through multiple Media.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MediaEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaContentType", + "description": "The possible content types for a media object.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VIDEO", + "description": "A Shopify-hosted video.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO", + "description": "An externally hosted video.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL_3D", + "description": "A 3d model.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "A Shopify-hosted image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaEdge", + "description": "An auto-generated type which holds one Media and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MediaEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaError", + "description": "Represents a media error. This typically occurs when there is an issue with the media itself causing it to fail validation.\nCheck the media before attempting to upload again.\n", + "fields": [ + { + "name": "code", + "description": "Code representing the type of error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "details", + "description": "Additional details regarding the error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Translated error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaErrorCode", + "description": "Error types for media.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNKNOWN", + "description": "Media error has occured for unknown reason.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_SIGNED_URL", + "description": "Media could not be processed because the signed URL was invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE_DOWNLOAD_FAILURE", + "description": "Media could not be processed because the image could not be downloaded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE_PROCESSING_FAILURE", + "description": "Media could not be processed because the image could not be processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_TIMEOUT_ERROR", + "description": "Media timed out because it is currently being modified by another operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_NOT_FOUND", + "description": "Media could not be created because the external video could not be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_UNLISTED", + "description": "Media could not be created because the external video is not listed or is private.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_INVALID_ASPECT_RATIO", + "description": "Media could not be created because the external video has an invalid aspect ratio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_EMBED_DISABLED", + "description": "Media could not be created because embed permissions are disabled for this video.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXTERNAL_VIDEO_EMBED_NOT_FOUND_OR_TRANSCODING", + "description": "Media could not be created because video is either not found or still transcoding.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_FILE_DOWNLOAD_FAILURE", + "description": "File could not be processed because the source could not be downloaded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_FILE_INVALID_SIZE", + "description": "File could not be created because the size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_METADATA_READ_ERROR", + "description": "Media could not be created because the metadata could not be read.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_INVALID_FILETYPE_ERROR", + "description": "Media could not be created because it has an invalid file type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_WIDTH_ERROR", + "description": "Media could not be created because it does not meet the minimum width requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_WIDTH_ERROR", + "description": "Media could not be created because it does not meet the maximum width requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_HEIGHT_ERROR", + "description": "Media could not be created because it does not meet the minimum height requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_HEIGHT_ERROR", + "description": "Media could not be created because it does not meet the maximum height requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MIN_DURATION_ERROR", + "description": "Media could not be created because it does not meet the minimum duration requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_MAX_DURATION_ERROR", + "description": "Media could not be created because it does not meet the maximum duration requirement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_VALIDATION_ERROR", + "description": "Video failed validation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_VALIDATION_ERROR", + "description": "Model failed validation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_THUMBNAIL_GENERATION_ERROR", + "description": "Media could not be created because the model's thumbnail generation failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_THUMBNAIL_REGENERATION_ERROR", + "description": "There was an issue while trying to generate a new thumbnail.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_GLB_TO_USDZ_CONVERSION_ERROR", + "description": "Media could not be created because the model can't be converted to USDZ format.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_GLB_OUTPUT_CREATION_ERROR", + "description": "Media could not be created because the model file failed processing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_PROCESSING_FAILURE", + "description": "Media could not be created because the model file failed processing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_IMAGE_FILE_TYPE", + "description": "Media could not be created because the image is an unsupported file type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_FILE_SIZE", + "description": "Media could not be created because the image size is too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_ASPECT_RATIO", + "description": "Media could not be created because the image has an invalid aspect ratio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_IMAGE_RESOLUTION", + "description": "Media could not be created because the image's resolution exceeds the max limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE_STORAGE_LIMIT_EXCEEDED", + "description": "Media could not be created because the cumulative file storage limit would be exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_FILENAME_ERROR", + "description": "Media could not be created because a file with the same name already exists.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaHost", + "description": "Host for a Media Resource.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "YOUTUBE", + "description": "Host for YouTube embedded videos.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIMEO", + "description": "Host for Vimeo embedded videos.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "description": "An image hosted on Shopify.\n", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileErrors", + "description": "Any errors that have occurred on the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileStatus", + "description": "The status of the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FileStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image for the media. Returns `null` until `status` is `READY`.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaErrors", + "description": "Any errors which have occurred on the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaWarnings", + "description": "The warnings attached to the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The MIME type of the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalSource", + "description": "The original source of the image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaImageOriginalSource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "status", + "description": "Current status of the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "File", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaImageOriginalSource", + "description": "The original source for an image.\n", + "fields": [ + { + "name": "fileSize", + "description": "The size of the original file in bytes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "description": "Represents the preview image for a media.", + "fields": [ + { + "name": "image", + "description": "The preview image for the media. Returns `null` until `status` is `READY`.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current status of the preview image.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaPreviewImageStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaPreviewImageStatus", + "description": "The possible statuses for a media preview image.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UPLOADED", + "description": "Preview image is uploaded but not yet processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING", + "description": "Preview image is being processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY", + "description": "Preview image is ready to be displayed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "Preview image processing has failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaStatus", + "description": "The possible statuses for a media object.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UPLOADED", + "description": "Media has been uploaded but not yet processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING", + "description": "Media is being processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY", + "description": "Media is ready to be displayed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "Media processing has failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaUserError", + "description": "Represents an error that happens during execution of a Media query or mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MediaUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaUserErrorCode", + "description": "Possible error codes that can be returned by `MediaUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_VALIDATION_ERROR", + "description": "Video validation failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_VALIDATION_ERROR", + "description": "Model validation failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO_THROTTLE_EXCEEDED", + "description": "Video creation throttle was exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL3D_THROTTLE_EXCEEDED", + "description": "Model3d creation throttle was exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_MEDIA_LIMIT_EXCEEDED", + "description": "Exceeded the limit of media per product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_MEDIA_LIMIT_EXCEEDED", + "description": "Exceeded the limit of media per shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_DOES_NOT_EXIST", + "description": "Media does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_DOES_NOT_EXIST_ON_PRODUCT", + "description": "Media does not exist on the given product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_MEDIA_PER_INPUT_PAIR", + "description": "Only one mediaId is allowed per variant-media input pair.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_VARIANT_MEDIA_PAIRS_EXCEEDED", + "description": "Exceeded the maximum number of 100 variant-media pairs per mutation call.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_MEDIA_TYPE", + "description": "Invalid media type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_SPECIFIED_MULTIPLE_TIMES", + "description": "Variant specified in more than one pair.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_DOES_NOT_EXIST_ON_PRODUCT", + "description": "Variant does not exist on the given product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_READY_MEDIA", + "description": "Non-ready media are not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_ALREADY_HAS_MEDIA", + "description": "Product variant already has attached media.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_IS_NOT_ATTACHED_TO_VARIANT", + "description": "The specified media is not attached to the specified variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_CANNOT_BE_MODIFIED", + "description": "Media cannot be modified. It is currently being modified by another operation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaWarning", + "description": "Represents a media warning. This occurs when there is a non-blocking concern regarding your media.\nConsider reviewing your media to ensure it is correct and its parameters are as expected.\n", + "fields": [ + { + "name": "code", + "description": "The code representing the type of warning.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaWarningCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Translated warning message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaWarningCode", + "description": "Warning types for media.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MODEL_SMALL_PHYSICAL_SIZE", + "description": "3D model physical size might be invalid. The dimensions of your model are very small. Consider reviewing your model to ensure they are correct.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL_LARGE_PHYSICAL_SIZE", + "description": "3D model physical size might be invalid. The dimensions of your model are very large. Consider reviewing your model to ensure they are correct.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MerchandiseDiscountClass", + "description": "The class of the discount for combining purposes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT", + "description": "Combined as a product discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER", + "description": "Combined as an order discount.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MerchantApprovalSignals", + "description": "Merchant approval for accelerated onboarding to channel integration apps.", + "fields": [ + { + "name": "identityVerified", + "description": "Whether the shop's Shopify Payments account identity is verified. Returns `false` if the identity is unverified or if the shop doesn't have a Shopify Payments account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "verifiedByShopify", + "description": "Whether Shopify has pre-verified the merchant's business for onboarding to channel integration apps. Returns `false` if the shop isn't marked for verification.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "verifiedByShopifyTier", + "description": "Which tier of the Shopify verification was determined for the merchant's business for onboarding to channel integration apps.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Metafield", + "description": "Metafields enable you to attach additional information to a Shopify resource, such as a [Product](https://shopify.dev/api/admin-graphql/latest/objects/product) or a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection).\nFor more information about where you can attach metafields refer to [HasMetafields](https://shopify.dev/api/admin/graphql/reference/common-objects/HasMetafields).\nSome examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers.\nMetafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.\n", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the metafield was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "definition", + "description": "The metafield definition that the metafield belongs to, if any.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the metafield.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The unique identifier for the metafield within its namespace.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield is associated with.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "owner", + "description": "The resource that the metafield is attached to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ownerType", + "description": "The type of resource that the metafield is attached to.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference", + "description": "Returns a reference object if the metafield definition's type is a resource reference.", + "args": [], + "type": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "references", + "description": "A list of reference objects if the metafield's type is a resource reference list.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of data that is stored in the metafield.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the metafield was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldAccess", + "description": "The access settings for this metafield definition.", + "fields": [ + { + "name": "admin", + "description": "The admin access setting used for the metafields under this definition.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldAdminAccess", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldAccessInput", + "description": "The input fields for the access settings for the metafields under the definition.\n", + "fields": null, + "inputFields": [ + { + "name": "admin", + "description": "The admin access setting to use for the metafields under this definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldAdminAccess", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldAdminAccess", + "description": "Possible admin access settings for metafields.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRIVATE", + "description": "Owner gets full access. No one else has access rights.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC_READ", + "description": "Owner gets full access. All applications and the merchant have read-only access.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT_READ", + "description": "Owner gets full access. The merchant has read-only access. No one else has access rights.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT_READ_WRITE", + "description": "Owner gets full access. The merchant has read and write access. No one else has access rights.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldConnection", + "description": "An auto-generated type for paginating through multiple Metafields.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "description": "Metafield definitions enable you to define additional validation constraints for metafields, and enable the\nmerchant to edit metafield values in context.\n", + "fields": [ + { + "name": "access", + "description": "The access settings associated with the metafield definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldAccess", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the metafield definition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The unique identifier for the metafield definition within its namespace.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields that belong to the metafield definition.", + "args": [ + { + "name": "validationStatus", + "description": "Returns the metafields filtered by the validation status.", + "type": { + "kind": "ENUM", + "name": "MetafieldValidationStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldsCount", + "description": "The count of the metafields that belong to the metafield definition.", + "args": [ + { + "name": "validationStatus", + "description": "The current validation status.", + "type": { + "kind": "ENUM", + "name": "MetafieldValidationStatus", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The human-readable name of the metafield definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield definition is associated with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ownerType", + "description": "The resource type that the metafield definition is attached to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pinnedPosition", + "description": "The position of the metafield definition in the pinned list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardTemplate", + "description": "The standard metafield definition template associated with the metafield definition.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of data that each of the metafields that belong to the metafield definition will store.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "useAsCollectionCondition", + "description": "Whether the metafield definition can be used as a collection condition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validationStatus", + "description": "The validation status for the metafields that belong to the metafield definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldDefinitionValidationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validations", + "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionValidation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visibleToStorefrontApi", + "description": "Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "description": "An auto-generated type for paginating through multiple MetafieldDefinitions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionCreatePayload", + "description": "Return type for `metafieldDefinitionCreate` mutation.", + "fields": [ + { + "name": "createdDefinition", + "description": "The metafield definition that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionCreateUserError", + "description": "An error that occurs during the execution of `MetafieldDefinitionCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionCreateUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDefinitionCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_TYPE_LIMIT_EXCEEDED", + "description": "The definition limit per owner type has exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIMIT_EXCEEDED", + "description": "The maximum limit of definitions per owner type has exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_OPTION", + "description": "An invalid option.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_OPTION", + "description": "A duplicate option.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESERVED_NAMESPACE_KEY", + "description": "This namespace and key combination is reserved for standard definitions.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PINNED_LIMIT_REACHED", + "description": "The pinned limit has been reached for the owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSTRUCTURED_ALREADY_EXISTS", + "description": "This namespace and key combination is already in use for a set of your metafields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CHARACTER", + "description": "A field contains an invalid character.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", + "description": "The definition type is not eligible to be used as collection condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS", + "description": "You have reached the maximum allowed definitions for automated collections.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionDeletePayload", + "description": "Return type for `metafieldDefinitionDelete` mutation.", + "fields": [ + { + "name": "deletedDefinitionId", + "description": "The ID of the deleted metafield definition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionDeleteUserError", + "description": "An error that occurs during the execution of `MetafieldDefinitionDelete`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDefinitionDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "Definition not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFERENCE_TYPE_DELETION_ERROR", + "description": "Deleting a reference type metafield definition requires deletion of its associated metafields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METAFIELD_DEFINITION_IN_USE", + "description": "Action cannot proceed. Definition is currently in use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISALLOWED_OWNER_TYPE", + "description": "Owner type can't be used in this mutation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionEdge", + "description": "An auto-generated type which holds one MetafieldDefinition and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionInput", + "description": "The input fields required to create a metafield definition.\n", + "fields": null, + "inputFields": [ + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield definition will be associated with.\n\nMust be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The unique identifier for the metafield definition within its namespace.\n\nMust be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The human-readable name for the metafield definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description for the metafield definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ownerType", + "description": "The resource type that the metafield definition is attached to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of data that each of the metafields that belong to the metafield definition will store.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "validations", + "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionValidationInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "visibleToStorefrontApi", + "description": "Whether metafields for the metafield definition are visible using the Storefront API.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "useAsCollectionCondition", + "description": "Whether the metafield definition can be used as a collection condition.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "pin", + "description": "Whether to [pin](https://help.shopify.com/manual/custom-data/metafields/pinning-metafield-definitions)\nthe metafield definition.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "access", + "description": "The access settings that apply to each of the metafields that belong to the metafield definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetafieldAccessInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionPinPayload", + "description": "Return type for `metafieldDefinitionPin` mutation.", + "fields": [ + { + "name": "pinnedDefinition", + "description": "The metafield definition that was pinned.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionPinUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionPinUserError", + "description": "An error that occurs during the execution of `MetafieldDefinitionPin`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionPinUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDefinitionPinUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "The metafield definition was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PINNED_LIMIT_REACHED", + "description": "The pinned limit has been reached for owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_PINNED", + "description": "The metafield definition is already pinned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISALLOWED_OWNER_TYPE", + "description": "Owner type can't be used in this mutation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "description": "Possible metafield definition pinned statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ANY", + "description": "All metafield definitions.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PINNED", + "description": "Only metafield definitions that are pinned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNPINNED", + "description": "Only metafield definitions that are not pinned.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "description": "The set of valid sort keys for the MetafieldDefinition query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PINNED_POSITION", + "description": "Sort by the `pinned_position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionSupportedValidation", + "description": "The type and name for the optional validation configuration of a metafield.\n\nFor example, a supported validation might consist of a `max` name and a `number_integer` type.\nThis validation can then be used to enforce a maximum character length for a `single_line_text_field` metafield.\n", + "fields": [ + { + "name": "name", + "description": "The name of the metafield definition validation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of input for the validation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionType", + "description": "A metafield definition type provides basic foundation and validation for a metafield.\n", + "fields": [ + { + "name": "category", + "description": "The category associated with the metafield definition type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the type for the metafield definition.\nSee the list of [supported types](https://shopify.dev/apps/metafields/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportedValidations", + "description": "The supported validations for a metafield definition type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionSupportedValidation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportsDefinitionMigrations", + "description": "Whether metafields without a definition can be migrated to a definition of this type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "valueType", + "description": "The value type for a metafield created with this definition type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldValueType", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "`valueType` is deprecated and `name` should be used for type information." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUnpinPayload", + "description": "Return type for `metafieldDefinitionUnpin` mutation.", + "fields": [ + { + "name": "unpinnedDefinition", + "description": "The metafield definition that was unpinned.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionUnpinUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUnpinUserError", + "description": "An error that occurs during the execution of `MetafieldDefinitionUnpin`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionUnpinUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionUnpinUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDefinitionUnpinUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "The metafield definition was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_PINNED", + "description": "The metafield definition isn't pinned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISALLOWED_OWNER_TYPE", + "description": "Owner type can't be used in this mutation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionUpdateInput", + "description": "The input fields required to update a metafield definition.\n", + "fields": null, + "inputFields": [ + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield definition is associated with. Used to help identify\nthe metafield definition, but cannot be updated itself.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The unique identifier for the metafield definition within its namespace. Used to help identify the metafield\ndefinition, but can't be updated itself.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The human-readable name for the metafield definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description for the metafield definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ownerType", + "description": "The resource type that the metafield definition is attached to. Used to help identify the metafield definition,\nbut can't be updated itself.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "validations", + "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe metafields that belong to the metafield definition. For example, for a metafield definition with the\ntype `date`, you can set a minimum date validation so that each of the metafields that belong to it can only\nstore dates after the specified minimum.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionValidationInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "pin", + "description": "Whether to pin the metafield definition.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "visibleToStorefrontApi", + "description": "Whether each of the metafields that belong to the metafield definition are visible from the Storefront API.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "useAsCollectionCondition", + "description": "Whether the metafield definition can be used as a collection condition.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "access", + "description": "The access settings that apply to each of the metafields that belong to the metafield definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetafieldAccessInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUpdatePayload", + "description": "Return type for `metafieldDefinitionUpdate` mutation.", + "fields": [ + { + "name": "updatedDefinition", + "description": "The metafield definition that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validationJob", + "description": "The asynchronous job updating the metafield definition's validation_status.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionUpdateUserError", + "description": "An error that occurs during the execution of `MetafieldDefinitionUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDefinitionUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "The metafield definition wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_INPUT", + "description": "An invalid input.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PINNED_LIMIT_REACHED", + "description": "The pinned limit has been reached for the owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "An internal error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", + "description": "The definition type is not eligible to be used as collection condition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METAFIELD_DEFINITION_IN_USE", + "description": "Action cannot proceed. Definition is currently in use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OWNER_TYPE_LIMIT_EXCEEDED_FOR_AUTOMATED_COLLECTIONS", + "description": "You have reached the maximum allowed definitions for automated collections.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinitionValidation", + "description": "A configured metafield definition validation.\n\nFor example, for a metafield definition of `number_integer` type, you can set a validation with the name `max`\nand a value of `15`. This validation will ensure that the value of the metafield is a number less than or equal to 15.\n\nRefer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).\n", + "fields": [ + { + "name": "name", + "description": "The validation name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The name for the metafield type of this validation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The validation value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionValidationInput", + "description": "The name and value for a metafield definition validation.\n\nFor example, for a metafield definition of `single_line_text_field` type, you can set a validation with the name `min` and a value of `10`.\nThis validation will ensure that the value of the metafield is at least 10 characters.\n\nRefer to the [list of supported validations](https://shopify.dev/api/admin/graphql/reference/common-objects/metafieldDefinitionTypes#examples-Fetch_all_metafield_definition_types).\n", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name for the metafield definition validation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value for the metafield definition validation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDefinitionValidationStatus", + "description": "Possible metafield definition validation statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL_VALID", + "description": "All of this definition's metafields are valid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "Asynchronous validation of this definition's metafields is in progress.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOME_INVALID", + "description": "Some of this definition's metafields are invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldDeleteInput", + "description": "The input fields to delete a metafield.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the metafield to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDeletePayload", + "description": "Return type for `metafieldDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted metafield.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldEdge", + "description": "An auto-generated type which holds one Metafield and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "description": "The input fields to use to create or update a metafield through a mutation on the owning resource.\nAn alternative way to create or update a metafield is by using the\n[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsSet) mutation.\n", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The unique ID of the metafield.\n\nRequired when updating a metafield, but shouldn't be included when creating as it's created automatically.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield is or will be associated with. Used in tandem with\n`key` to lookup a metafield on a resource, preventing conflicts with other metafields with the same `key`.\n\nRequired when creating a metafield, but optional when updating. Used to help identify the metafield when\nupdating, but can't be updated itself.\n\nMust be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The unique identifier for a metafield within its namespace.\n\nRequired when creating a metafield, but optional when updating. Used to help identify the metafield when\nupdating, but can't be updated itself.\n\nMust be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of data that is stored in the metafield.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/types).\n\nRequired when creating a metafield, but optional when updating.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "description": "Possible types of a metafield's owner resource.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "API_PERMISSION", + "description": "The Api Permission metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY", + "description": "The Company metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATION", + "description": "The Company Location metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_CUSTOMIZATION", + "description": "The Payment Customization metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER", + "description": "The Customer metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CUSTOMIZATION", + "description": "The Delivery Customization metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFTORDER", + "description": "The Draft Order metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET", + "description": "The Market metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION", + "description": "The Collection metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIA_IMAGE", + "description": "The Media Image metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTIMAGE", + "description": "The Product Image metafield owner type.", + "isDeprecated": true, + "deprecationReason": "`PRODUCTIMAGE` is deprecated. Use `MEDIA_IMAGE` instead." + }, + { + "name": "PRODUCT", + "description": "The Product metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTVARIANT", + "description": "The Product Variant metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARTICLE", + "description": "The Article metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLOG", + "description": "The Blog metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAGE", + "description": "The Page metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT", + "description": "The Discount metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER", + "description": "The Order metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATION", + "description": "The Location metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP", + "description": "The Shop metafield owner type.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "MetafieldReference", + "description": "The resource referenced by the metafield value.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "description": "An auto-generated type for paginating through multiple MetafieldReferences.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldReferenceEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldReferenceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldReferenceEdge", + "description": "An auto-generated type which holds one MetafieldReference and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldReferenceEdge.", + "args": [], + "type": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "MetafieldReferencer", + "description": "Types of resources that may use metafields to reference other resources.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreArticle", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreBlog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MetafieldRelation", + "description": "Defines a relation between two resources via a reference metafield.\nThe referencer owns the joining field with a given namespace and key,\nwhile the target is referenced by the field.\n", + "fields": [ + { + "name": "key", + "description": "The key of the field making the reference.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the field making the reference.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The namespace of the metafield making the reference, or type of the metaobject.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referencer", + "description": "The resource making the reference.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldReferencer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "target", + "description": "The referenced resource.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldRelationConnection", + "description": "An auto-generated type for paginating through multiple MetafieldRelations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldRelationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldRelationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldRelation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldRelationEdge", + "description": "An auto-generated type which holds one MetafieldRelation and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldRelationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldRelation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "description": "By default, the Storefront API can't read metafields. To make specific metafields visible in the Storefront API,\nyou need to create a `MetafieldStorefrontVisibility` record. A `MetafieldStorefrontVisibility` record is a list\nof the metafields, defined by the `owner_type`, `namespace`, and `key`, to make visible in the Storefront API.\n\nLearn about [exposing metafields in the Storefront API]\n(https://shopify.dev/custom-storefronts/products-collections/metafields)\nfor more details.\n", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the metafield was set to visible in the Storefront API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The key of a metafield to make visible in the Storefront API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The namespace of a metafield to make visible in the Storefront API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ownerType", + "description": "The owner type of a metafield to make visible in the Storefront API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the `MetafieldStorefrontVisilibty` record was updated.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityConnection", + "description": "An auto-generated type for paginating through multiple MetafieldStorefrontVisibilities.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldStorefrontVisibilityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityCreatePayload", + "description": "Return type for `metafieldStorefrontVisibilityCreate` mutation.", + "fields": [ + { + "name": "metafieldStorefrontVisibility", + "description": "The `MetafieldStorefrontVisibility` that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityDeletePayload", + "description": "Return type for `metafieldStorefrontVisibilityDelete` mutation.", + "fields": [ + { + "name": "deletedMetafieldStorefrontVisibilityId", + "description": "The ID of the deleted `MetafieldStorefrontVisibility` record.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityEdge", + "description": "An auto-generated type which holds one MetafieldStorefrontVisibility and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldStorefrontVisibilityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldStorefrontVisibilityInput", + "description": "The input fields to create a MetafieldStorefrontVisibility record.\n", + "fields": null, + "inputFields": [ + { + "name": "namespace", + "description": "The namespace of a metafield to make visible in the Storefront API.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key of a metafield to make visible in the Storefront API.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ownerType", + "description": "The owner type of a metafield to make visible in the Storefront API.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldValidationStatus", + "description": "Possible metafield validation statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ANY", + "description": "Any validation status (valid or invalid).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALID", + "description": "Valid (according to definition).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "Invalid (according to definition).", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldValueType", + "description": "Legacy type information for the stored value.\nReplaced by `type`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STRING", + "description": "A text field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTEGER", + "description": "A whole number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JSON_STRING", + "description": "A JSON string.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOOLEAN", + "description": "A `true` or `false` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldsSetInput", + "description": "The input fields for a metafield value to set.", + "fields": null, + "inputFields": [ + { + "name": "ownerId", + "description": "The unique ID of the resource that the metafield is attached to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield is or will be associated with. Used in tandem\nwith `key` to lookup a metafield on a resource, preventing conflicts with other metafields with the\nsame `key`.\n\nMust be 3-255 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The unique identifier for a metafield within its namespace.\n\nMust be 3-64 characters long and can contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of data that is stored in the metafield.\nThe type must be one of the [supported types](https://shopify.dev/apps/metafields/types).\n\nRequired when there is no corresponding definition for the given `namespace`, `key`, and\nowner resource type (derived from `ownerId`).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldsSetPayload", + "description": "Return type for `metafieldsSet` mutation.", + "fields": [ + { + "name": "metafields", + "description": "The list of metafields that were set.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "description": "An error that occurs during the execution of `MetafieldsSet`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldsSetUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "elementIndex", + "description": "The index of the array element that's causing the error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldsSetUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldsSetUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE", + "description": "The value is invalid for metafield type or for definition options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TYPE", + "description": "The type is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_NOT_AUTHORIZED", + "description": "ApiPermission metafields can only be created or updated by the app owner.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "description": "Provides an object instance represented by a MetaobjectDefinition.", + "fields": [ + { + "name": "capabilities", + "description": "Metaobject capabilities for this Metaobject.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectCapabilityData", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdBy", + "description": "The app used to create the object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "definition", + "description": "The MetaobjectDefinition that models this object type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The preferred display name field value of the metaobject.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The field for an object key, or null if the key has no field definition.", + "args": [ + { + "name": "key", + "description": "The metaobject key to access.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectField", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": "All ordered fields of the metaobject with their definitions and values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectField", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique handle of the object, useful as a custom ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referencedBy", + "description": "List of back references metafields that belong to the resource.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldRelationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "The staff member who created the metaobject.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the metaobject.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "When the object was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectAccess", + "description": "Provides metaobject definition's access configuration.", + "fields": [ + { + "name": "admin", + "description": "Access configuration for Admin API surface areas, including the GraphQL Admin API.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetaobjectAdminAccess", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefront", + "description": "Access configuration for Storefront surface areas, including the GraphQL Storefront API and Liquid.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetaobjectStorefrontAccess", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectAccessInput", + "description": "The input fields for configuring metaobject access controls.", + "fields": null, + "inputFields": [ + { + "name": "admin", + "description": "Access configuration for Admin API surface areas, including the GraphQL Admin API.\n", + "type": { + "kind": "ENUM", + "name": "MetaobjectAdminAccess", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "storefront", + "description": "Access configuration for Storefront API surface areas, including the GraphQL Storefront API and Liquid.\n", + "type": { + "kind": "ENUM", + "name": "MetaobjectStorefrontAccess", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetaobjectAdminAccess", + "description": "Defines how the metaobjects of a definition can be accessed in admin API surface areas.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRIVATE", + "description": "Only the application that owns a metaobject can read and write to it.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT_READ", + "description": "Applications that act on behalf of merchants can read metaobjects.\nOnly the owning application can write metaobjects.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT_READ_WRITE", + "description": "The owning application, as well as applications that act on behalf of merchants can read and write metaobjects.\nNo other applications can read or write metaobjects.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC_READ", + "description": "All applications with the `metaobjects` access scope can read metaobjects.\nOnly the owning application can write metaobjects.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC_READ_WRITE", + "description": "All applications with the `metaobjects` access scope can read and write metaobjects.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectBulkDeletePayload", + "description": "Return type for `metaobjectBulkDelete` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job that deletes the metaobjects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectBulkDeleteWhereCondition", + "description": "Specifies the condition by which metaobjects are deleted.\nExactly one field of input is required.\n", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "Deletes all metaobjects with the specified `type`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "A list of metaobjects IDs to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCapabilities", + "description": "Provides the capabilities of a metaobject definition.", + "fields": [ + { + "name": "publishable", + "description": "Indicate whether a metaobject definition is publishable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectCapabilitiesPublishable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatable", + "description": "Indicate whether a metaobject definition is translatable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectCapabilitiesTranslatable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCapabilitiesPublishable", + "description": "The publishable capability of a metaobject definition.", + "fields": [ + { + "name": "enabled", + "description": "Indicates if the capability is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCapabilitiesTranslatable", + "description": "The translatable capability of a metaobject definition.", + "fields": [ + { + "name": "enabled", + "description": "Indicates if the capability is enabled.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityCreateInput", + "description": "The input fields for creating a metaobject capability.", + "fields": null, + "inputFields": [ + { + "name": "publishable", + "description": "The input for enabling the publishable capability.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityPublishableInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "translatable", + "description": "The input for enabling the translatable capability.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityTranslatableInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCapabilityData", + "description": "Provides the capabilities of a metaobject.", + "fields": [ + { + "name": "publishable", + "description": "The publishable capability for this metaobject.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetaobjectCapabilityDataPublishable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataInput", + "description": "The input fields for metaobject capabilities.", + "fields": null, + "inputFields": [ + { + "name": "publishable", + "description": "Publishable capability input.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataPublishableInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCapabilityDataPublishable", + "description": "The publishable capability for the parent metaobject.", + "fields": [ + { + "name": "status", + "description": "The visibility status of this metaobject across all channels.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetaobjectStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataPublishableInput", + "description": "The input fields for publishable capability to adjust visibility on channels.", + "fields": null, + "inputFields": [ + { + "name": "status", + "description": "The visibility status of this metaobject across all channels.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetaobjectStatus", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityPublishableInput", + "description": "The input fields for enabling and disabling the publishable capability.", + "fields": null, + "inputFields": [ + { + "name": "enabled", + "description": "Indicates whether the capability should be enabled or disabled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityTranslatableInput", + "description": "The input fields for enabling and disabling the translatable capability.", + "fields": null, + "inputFields": [ + { + "name": "enabled", + "description": "Indicates whether the capability should be enabled or disabled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityUpdateInput", + "description": "The input fields for updating a metaobject capability.", + "fields": null, + "inputFields": [ + { + "name": "publishable", + "description": "The input for updating the publishable capability.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityPublishableInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "translatable", + "description": "The input for updating the translatable capability.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityTranslatableInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectConnection", + "description": "An auto-generated type for paginating through multiple Metaobjects.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetaobjectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCreateInput", + "description": "The input fields for creating a metaobject.", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "The type of the metaobject. Must match an existing metaobject definition type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "A unique handle for the metaobject. This value is auto-generated when omitted.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fields", + "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "capabilities", + "description": "Capabilities for the metaobject.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectCreatePayload", + "description": "Return type for `metaobjectCreate` mutation.", + "fields": [ + { + "name": "metaobject", + "description": "The created metaobject.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "description": "Provides the definition of a generic object structure composed of metafields.", + "fields": [ + { + "name": "access", + "description": "Access configuration for the metaobject definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectAccess", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "capabilities", + "description": "The capabilities of the metaobject definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectCapabilities", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The administrative description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayNameKey", + "description": "The key of a field to reference as the display name for each object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldDefinitions", + "description": "The fields defined for this object type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectFieldDefinition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjects", + "description": "A paginated connection to the metaobjects associated with the definition.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectsCount", + "description": "The count of metaobjects created for the definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The human-readable name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the object definition. Defines the namespace of associated metafields.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinitionConnection", + "description": "An auto-generated type for paginating through multiple MetaobjectDefinitions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectDefinitionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetaobjectDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectDefinitionCreateInput", + "description": "The input fields for creating a metaobject definition.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "A human-readable name for the definition. This can be changed at any time.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "An administrative description of the definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of the metaobject definition. This can't be changed.\n\nMust be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fieldDefinitions", + "description": "A set of field definitions to create on this metaobject definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionCreateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "access", + "description": "Access configuration for the metaobjects created with this definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectAccessInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "displayNameKey", + "description": "The key of a field to reference as the display name for metaobjects of this type.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "capabilities", + "description": "The capabilities of the metaobject definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityCreateInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinitionCreatePayload", + "description": "Return type for `metaobjectDefinitionCreate` mutation.", + "fields": [ + { + "name": "metaobjectDefinition", + "description": "The created metaobject definition.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinitionDeletePayload", + "description": "Return type for `metaobjectDefinitionDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted metaobjects definition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinitionEdge", + "description": "An auto-generated type which holds one MetaobjectDefinition and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetaobjectDefinitionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectDefinitionUpdateInput", + "description": "The input fields for updating a metaobject definition.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "A human-readable name for the definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "An administrative description of the definition.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fieldDefinitions", + "description": "A set of operations for modifying field definitions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionOperationInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "access", + "description": "Access configuration for the metaobjects created with this definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectAccessInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "displayNameKey", + "description": "The key of a metafield to reference as the display name for objects of this type.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "resetFieldOrder", + "description": "Whether the field order should be reset while updating.\nIf `true`, then the order is assigned based on submitted fields followed by alphabetized field omissions.\nIf `false`, then no changes are made to the existing field order and new fields are appended at the end.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "capabilities", + "description": "The capabilities of the metaobject definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityUpdateInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinitionUpdatePayload", + "description": "Return type for `metaobjectDefinitionUpdate` mutation.", + "fields": [ + { + "name": "metaobjectDefinition", + "description": "The updated metaobject definition.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDeletePayload", + "description": "Return type for `metaobjectDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted metaobject.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectEdge", + "description": "An auto-generated type which holds one Metaobject and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetaobjectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectField", + "description": "Provides a field definition and the data value assigned to it.", + "fields": [ + { + "name": "definition", + "description": "The field definition for this object key.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectFieldDefinition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The object key of this field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference", + "description": "For resource reference fields, provides the referenced object.", + "args": [], + "type": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "references", + "description": "For resource reference list fields, provides the list of referenced objects.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The assigned field value, always stored as a string regardless of the field type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectFieldDefinition", + "description": "Defines a field for a MetaobjectDefinition with properties\nsuch as the field's data type and validations.\n", + "fields": [ + { + "name": "description", + "description": "The administrative description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "A key name used to identify the field within the metaobject composition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The human-readable name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "Required status of the field within the metaobject composition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of data that the field stores.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validations", + "description": "A list of [validation options](https://shopify.dev/apps/metafields/definitions/validation) for\nthe field. For example, a field with the type `date` can set a minimum date requirement.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionValidation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionCreateInput", + "description": "The input fields for creating a metaobject field definition.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key of the new field definition. This can't be changed.\n\nMust be 3-64 characters long and only contain alphanumeric, hyphen, and underscore characters.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The metafield type applied to values of the field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "A human-readable name for the field. This can be changed at any time.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "An administrative description of the field.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "required", + "description": "Whether metaobjects require a saved value for the field.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "validations", + "description": "Custom validations that apply to values assigned to the field.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionValidationInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionDeleteInput", + "description": "The input fields for deleting a metaobject field definition.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key of the field definition to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionOperationInput", + "description": "The input fields for possible operations for modifying field definitions. Exactly one option is required.\n", + "fields": null, + "inputFields": [ + { + "name": "create", + "description": "The input fields for creating a metaobject field definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionCreateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "update", + "description": "The input fields for updating a metaobject field definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "delete", + "description": "The input fields for deleting a metaobject field definition.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionDeleteInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldDefinitionUpdateInput", + "description": "The input fields for updating a metaobject field definition.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key of the field definition to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "A human-readable name for the field.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "An administrative description of the field.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "required", + "description": "Whether metaobjects require a saved value for the field.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "validations", + "description": "Custom validations that apply to values assigned to the field.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionValidationInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldInput", + "description": "The input fields for a metaobject field value.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key of the field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectHandleInput", + "description": "The input fields for retrieving a metaobject by handle.", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "The type of the metaobject. Must match an existing metaobject definition type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "The handle of the metaobject to create or update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetaobjectStatus", + "description": "Defines visibility status for metaobjects.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DRAFT", + "description": "The metaobjects is an internal record.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACTIVE", + "description": "The metaobjects is active for public use.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetaobjectStorefrontAccess", + "description": "Defines how the metaobjects of a definition can be accessed in Storefront API surface areas, including Liquid and the GraphQL Storefront API.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NONE", + "description": "Metaobjects are not accessible in any Storefront API surface area.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLIC_READ", + "description": "Metaobjects are accessible in the GraphQL Storefront API by any application with the `unauthenticated_read_metaobjects` access scope.\nMetaobjects are accessible in online store Liquid templates.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectUpdateInput", + "description": "The input fields for updating a metaobject.", + "fields": null, + "inputFields": [ + { + "name": "handle", + "description": "A unique handle for the metaobject.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fields", + "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "capabilities", + "description": "Capabilities for the metaobject.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectUpdatePayload", + "description": "Return type for `metaobjectUpdate` mutation.", + "fields": [ + { + "name": "metaobject", + "description": "The updated metaobject.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectUpsertInput", + "description": "The input fields for upserting a metaobject.", + "fields": null, + "inputFields": [ + { + "name": "handle", + "description": "The handle of the metaobject.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fields", + "description": "Values for fields. These are mapped by key to fields of the metaobject definition.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectFieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "capabilities", + "description": "Capabilities for the metaobject.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCapabilityDataInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectUpsertPayload", + "description": "Return type for `metaobjectUpsert` mutation.", + "fields": [ + { + "name": "metaobject", + "description": "The created or updated metaobject.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "description": "Defines errors encountered while managing metaobject resources.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetaobjectUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "elementIndex", + "description": "The index of the failing list element in an array.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "elementKey", + "description": "The key of the failing object element.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetaobjectUserErrorCode", + "description": "Possible error codes that can be returned by `MetaobjectUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TYPE", + "description": "The metafield type is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE", + "description": "The value is invalid for the metafield type or the definition options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_OPTION", + "description": "The value for the metafield definition option was invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_FIELD_INPUT", + "description": "Duplicate inputs were provided for this field key.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED_OBJECT_TYPE", + "description": "No metaobject definition found for this type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNDEFINED_OBJECT_FIELD", + "description": "No field definition found for this key.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT_FIELD_TAKEN", + "description": "The specified field key is already in use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT_FIELD_REQUIRED", + "description": "Missing required fields were found for this object.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECORD_NOT_FOUND", + "description": "The requested record couldn't be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "An unexpected error occurred.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_DEFINITIONS_EXCEEDED", + "description": "The maximum number of metaobjects definitions has been exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_OBJECTS_EXCEEDED", + "description": "The maximum number of metaobjects per shop has been exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMMUTABLE", + "description": "The targeted object cannot be modified.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_AUTHORIZED", + "description": "Not authorized.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESERVED_NAME", + "description": "The provided name is reserved for system use.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAPABILITY_NOT_ENABLED", + "description": "The capability you are using is not enabled.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MethodDefinitionSortKeys", + "description": "The set of valid sort keys for the MethodDefinition query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RATE_PROVIDER_TYPE", + "description": "Sort by the `rate_provider_type` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "description": "Represents a Shopify hosted 3D model.\n", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "boundingBox", + "description": "The 3d model's bounding box information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Model3dBoundingBox", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filename", + "description": "The 3d model's filename.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaErrors", + "description": "Any errors which have occurred on the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaWarnings", + "description": "The warnings attached to the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalSource", + "description": "The 3d model's original source.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Model3dSource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sources", + "description": "The 3d model's sources.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Model3dSource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current status of the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Model3dBoundingBox", + "description": "Bounding box information of a 3d model.\n", + "fields": [ + { + "name": "size", + "description": "Size in meters of the smallest volume which contains the 3d model.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Vector3", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Model3dSource", + "description": "A source for a Shopify-hosted 3d model.\n\nTypes of sources include GLB and USDZ formatted 3d models, where the former\nis an original 3d model and the latter has been converted from the original.\n\nIf the original source is in GLB format and over 15 MBs in size, then both the\noriginal and the USDZ formatted source are optimized to reduce the file size.\n", + "fields": [ + { + "name": "filesize", + "description": "The 3d model source's filesize.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "format", + "description": "The 3d model source's format.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The 3d model source's MIME type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The 3d model source's URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Money", + "description": "A monetary value string without a currency symbol or code. Example value: `\"100.57\"`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoneyBag", + "description": "A collection of monetary values in their respective currencies. Typically used in the context of multi-currency pricing and transactions,\nwhen an amount in the shop's currency is converted to the customer's currency of choice (the presentment currency).\n", + "fields": [ + { + "name": "presentmentMoney", + "description": "Amount in presentment currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopMoney", + "description": "Amount in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "description": "The input fields for a monetary value with currency.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "Decimal money amount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currencyCode", + "description": "Currency of the money.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoneyV2", + "description": "A monetary value with currency.\n", + "fields": [ + { + "name": "amount", + "description": "Decimal money amount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "Currency of the money.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MoveInput", + "description": "The input fields for a single move of an object to a specific position in a set, using a zero-based index.\n", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the object to be moved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newPosition", + "description": "The new position of the object in the set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Mutation", + "description": "The schema's entry point for all mutation operations.", + "fields": [ + { + "name": "abandonmentEmailStateUpdate", + "description": "Updates the email state value for an abandonment.", + "args": [ + { + "name": "id", + "description": "The ID of the abandonment that needs to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "emailState", + "description": "The new email state of the abandonment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AbandonmentEmailState", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "emailSentAt", + "description": "The date and time for when the email was sent, if that is the case.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "emailStateChangeReason", + "description": "The reason why the email was or was not sent.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AbandonmentEmailStateUpdatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `abandonmentUpdateActivitiesDeliveryStatuses` instead." + }, + { + "name": "abandonmentUpdateActivitiesDeliveryStatuses", + "description": "Updates the marketing activities delivery statuses for an abandonment.", + "args": [ + { + "name": "abandonmentId", + "description": "The ID of the abandonment that needs to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketingActivityId", + "description": "The ID of the marketing activity that needs to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deliveryStatus", + "description": "The new delivery status of the marketing activity for this abandonment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "AbandonmentDeliveryState", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deliveredAt", + "description": "The delivery timestamp if the activity delivered.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryStatusChangeReason", + "description": "The reason why the activity was or was not delivered.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AbandonmentUpdateActivitiesDeliveryStatusesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appPurchaseOneTimeCreate", + "description": "Charges a shop for features or services one time.\nThis type of charge is recommended for apps that aren't billed on a recurring basis.\nTest and demo shops aren't charged.\n", + "args": [ + { + "name": "name", + "description": "The name of the one-time purchase from the app.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The amount to be charged to the store for the app one-time purchase.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnUrl", + "description": "The URL where the merchant is redirected after approving the app one-time purchase.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "test", + "description": "Whether the app one-time purchase is a test transaction. The default value is `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "AppPurchaseOneTimeCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appRevenueAttributionRecordCreate", + "description": "Creates a record of the attributed revenue for the app. This mutation should only be used to capture transactions that are not managed by the Billing API.", + "args": [ + { + "name": "appRevenueAttributionRecord", + "description": "The app revenue attribution record to be created.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AppRevenueAttributionRecordInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordCreatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This mutation will be removed in a future version." + }, + { + "name": "appRevenueAttributionRecordDelete", + "description": "Deletes a record of the attributed revenue for the app.", + "args": [ + { + "name": "id", + "description": "The unique identifier of the revenue attribution record.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecordDeletePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This mutation will be removed in a future version." + }, + { + "name": "appSubscriptionCancel", + "description": "Cancels an app subscription on a store.", + "args": [ + { + "name": "id", + "description": "The ID of the app subscription to be cancelled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "prorate", + "description": "Whether to issue prorated credits for the unused portion of the app subscription. There will\nbe a corresponding deduction (based on revenue share) to your Partner account.\nFor example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way\nthrough the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted\nfrom your Partner account.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "AppSubscriptionCancelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appSubscriptionCreate", + "description": "Allows an app to charge a store for features or services on a recurring basis.", + "args": [ + { + "name": "name", + "description": "A descriptive name for the app subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineItems", + "description": "Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AppSubscriptionLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "test", + "description": "Whether the app subscription is a test transaction. The default value is `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "trialDays", + "description": "The number of days of the free trial period, beginning on the day that the merchant approves the app charges.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "returnUrl", + "description": "The URL pointing to the page where the merchant is redirected after approving the app subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "replacementBehavior", + "description": "The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.", + "type": { + "kind": "ENUM", + "name": "AppSubscriptionReplacementBehavior", + "ofType": null + }, + "defaultValue": "STANDARD" + } + ], + "type": { + "kind": "OBJECT", + "name": "AppSubscriptionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appSubscriptionLineItemUpdate", + "description": "Updates the capped amount on the usage pricing plan of an app subscription line item.", + "args": [ + { + "name": "id", + "description": "The ID of the app subscription line item to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cappedAmount", + "description": "The new maximum amount of usage charges that can be incurred within a subscription billing interval.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppSubscriptionLineItemUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appSubscriptionTrialExtend", + "description": "Extends the trial of an app subscription.", + "args": [ + { + "name": "id", + "description": "The ID of the app subscription to extend the trial for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "days", + "description": "The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppSubscriptionTrialExtendPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appUsageRecordCreate", + "description": "Enables an app to charge a store for features or services on a per-use basis.\nThe usage charge value is counted towards the `cappedAmount` limit that was specified in the `appUsagePricingDetails` field when the app subscription was created.\nIf you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then a `Total price exceeds balance remaining` error is returned.\n", + "args": [ + { + "name": "subscriptionLineItemId", + "description": "The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the app usage record.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description of the app usage record.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "idempotencyKey", + "description": "A unique key generated by the client to avoid duplicate charges. Maximum length of 255 characters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppUsageRecordCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bulkOperationCancel", + "description": "Starts the cancelation process of a running bulk operation.\n\nThere may be a short delay from when a cancelation starts until the operation is actually canceled.\n", + "args": [ + { + "name": "id", + "description": "The ID of the bulk operation to cancel.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BulkOperationCancelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bulkOperationRunMutation", + "description": "Creates and runs a bulk operation mutation.\n\nTo learn how to bulk import large volumes of data asynchronously, refer to the\n[bulk import data guide](https://shopify.dev/api/usage/bulk-operations/imports).\n", + "args": [ + { + "name": "mutation", + "description": "The mutation to be executed in bulk.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "stagedUploadPath", + "description": "The staged upload path of the file containing mutation variables.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "clientIdentifier", + "description": "An optional identifier which may be used for querying.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BulkOperationRunMutationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bulkOperationRunQuery", + "description": "Creates and runs a bulk operation query.\n\nSee the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/imports) for more details.\n", + "args": [ + { + "name": "query", + "description": "The query to be executed in bulk.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BulkOperationRunQueryPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bulkProductResourceFeedbackCreate", + "description": "Creates product feedback for multiple products.", + "args": [ + { + "name": "feedbackInput", + "description": "An array of inputs to create the feedback. Limited to 50.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductResourceFeedbackInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BulkProductResourceFeedbackCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartTransformCreate", + "description": "Create a CartTransform function to the Shop.", + "args": [ + { + "name": "functionId", + "description": "The identifier of the Function providing the cart transform.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartTransformCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartTransformDelete", + "description": "Destroy a cart transform function from the Shop.", + "args": [ + { + "name": "id", + "description": "A globally-unique identifier for the cart transform.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartTransformDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogContextUpdate", + "description": "Updates the context of a catalog.", + "args": [ + { + "name": "catalogId", + "description": "The ID of the catalog for which to update the context.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "contextsToAdd", + "description": "The contexts to add to the catalog.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CatalogContextInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "contextsToRemove", + "description": "The contexts to remove from the catalog.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CatalogContextInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CatalogContextUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogCreate", + "description": "Creates a new catalog.", + "args": [ + { + "name": "input", + "description": "The properties of the new catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CatalogCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CatalogCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogDelete", + "description": "Delete a catalog.", + "args": [ + { + "name": "id", + "description": "The ID of the catalog to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deleteDependentResources", + "description": "Whether to also delete the price list and the publication owned by the catalog.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CatalogDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogUpdate", + "description": "Updates an existing catalog.", + "args": [ + { + "name": "id", + "description": "The ID of the catalog to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the updated catalog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CatalogUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CatalogUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionAddProducts", + "description": "Adds products to a collection.", + "args": [ + { + "name": "id", + "description": "The ID of the collection that's being updated. This can't be a smart collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of the products that are being added to the collection.\nIf any of the products is already present in the input collection,\nthen an error is raised and no products are added.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionAddProductsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionAddProductsV2", + "description": "Asynchronously adds a set of products to a given collection. It can take a long time to run. Instead of returning a collection, it returns a job which should be polled.", + "args": [ + { + "name": "id", + "description": "The ID of the collection that's being updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of the products that are being added to the collection. If the collection's sort order is manual, the products will be added in the order in which they are provided.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionAddProductsV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionCreate", + "description": "Creates a collection.\n", + "args": [ + { + "name": "input", + "description": "The properties to use when creating the collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionDelete", + "description": "Deletes a collection.", + "args": [ + { + "name": "input", + "description": "The collection to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionPublish", + "description": "Publishes a collection to a channel.", + "args": [ + { + "name": "input", + "description": "Specify a collection to publish and the sales channels to publish it to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionPublishInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionPublishPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publishablePublish` instead." + }, + { + "name": "collectionRemoveProducts", + "description": "Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). For use with manual collections only.", + "args": [ + { + "name": "id", + "description": "The ID of the collection to remove products from. The ID must reference an existing manual collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of products to remove from the collection. The mutation doesn't validate that the products belong to the collection or whether the products exist.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionRemoveProductsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionReorderProducts", + "description": "Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. Displaced products will have their position altered in a consistent manner, with no gaps.", + "args": [ + { + "name": "id", + "description": "The ID of the collection on which to reorder products.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "moves", + "description": "A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the `newPosition` does not have to be unique.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoveInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionReorderProductsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionUnpublish", + "description": "Unpublishes a collection.", + "args": [ + { + "name": "input", + "description": "Specify a collection to unpublish and the sales channels to remove it from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionUnpublishInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionUnpublishPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publishableUnpublish` instead." + }, + { + "name": "collectionUpdate", + "description": "Updates a collection.", + "args": [ + { + "name": "input", + "description": "The updated properties for the collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CollectionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CollectionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companiesDelete", + "description": "Deletes a list of companies.", + "args": [ + { + "name": "companyIds", + "description": "A list of IDs of companies to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompaniesDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyAddressDelete", + "description": "Deletes a company address.", + "args": [ + { + "name": "addressId", + "description": "The ID of the address to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyAddressDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyAssignCustomerAsContact", + "description": "Assigns the customer as a company contact.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company to assign the contact to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerId", + "description": "The ID of the customer to assign as the contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyAssignCustomerAsContactPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyAssignMainContact", + "description": "Assigns the main contact for the company.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company to assign the main contact to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContactId", + "description": "The ID of the company contact to be assigned as the main contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyAssignMainContactPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactAssignRole", + "description": "Assigns a role to a contact for a location.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the contact to assign a role to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContactRoleId", + "description": "The ID of the role to assign to a contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyLocationId", + "description": "The ID of the location to assign a role to a contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactAssignRolePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactAssignRoles", + "description": "Assigns roles on a company contact.", + "args": [ + { + "name": "companyContactId", + "description": "The contact whose roles are being assigned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "rolesToAssign", + "description": "The new roles to assign.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyContactRoleAssign", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactAssignRolesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactCreate", + "description": "Creates a company contact.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company that the company contact belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The fields to use to create the company contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyContactInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactDelete", + "description": "Deletes a company contact.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the company contact to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactRemoveFromCompany", + "description": "Removes a company contact from a Company.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the company contact to remove from the Company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRemoveFromCompanyPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactRevokeRole", + "description": "Revokes a role on a company contact.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the contact to revoke a role from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContactRoleAssignmentId", + "description": "The ID of the role assignment to revoke from a contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRevokeRolePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactRevokeRoles", + "description": "Revokes roles on a company contact.", + "args": [ + { + "name": "companyContactId", + "description": "The contact whose roles are being revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "roleAssignmentIds", + "description": "The current role assignment IDs to revoke.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "revokeAll", + "description": "Flag to revoke all roles on the contact.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRevokeRolesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactSendWelcomeEmail", + "description": "Sends the company contact a welcome email.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the company contact to send welcome email to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The welcome email fields.", + "type": { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactSendWelcomeEmailPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactUpdate", + "description": "Updates a company contact.", + "args": [ + { + "name": "companyContactId", + "description": "The ID of the company contact to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The fields to use to update the company contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyContactInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactsDelete", + "description": "Deletes one or more company contacts.", + "args": [ + { + "name": "companyContactIds", + "description": "The list of IDs of the company contacts to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactsDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyCreate", + "description": "Creates a company.", + "args": [ + { + "name": "input", + "description": "The fields to use when creating the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyDelete", + "description": "Deletes a company.", + "args": [ + { + "name": "id", + "description": "The ID of the company to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationAssignAddress", + "description": "Updates an address on a company location.", + "args": [ + { + "name": "locationId", + "description": "The ID of the company location to update addresses on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "address", + "description": "The input fields to use to update the address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "addressTypes", + "description": "The list of address types on the location to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompanyAddressType", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationAssignAddressPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationAssignRoles", + "description": "Assigns roles on a company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The location whose roles are being assigned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "rolesToAssign", + "description": "The roles to assign.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationRoleAssign", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationAssignRolesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationAssignTaxExemptions", + "description": "Assigns tax exemptions to the company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The location to which the tax exemptions will be assigned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The tax exemptions that are being assigned to the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationAssignTaxExemptionsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationCreate", + "description": "Creates a company location.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company that the company location belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The fields to use to create the company location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationCreateTaxRegistration", + "description": "Creates a tax registration for a company location.", + "args": [ + { + "name": "locationId", + "description": "The ID of the company location that the tax registration gets assigned to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxId", + "description": "The unique tax id for the tax registration.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationCreateTaxRegistrationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationDelete", + "description": "Deletes a company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The ID of the company location to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationRevokeRoles", + "description": "Revokes roles on a company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The location whose roles are being revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "rolesToRevoke", + "description": "The current roles to revoke.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationRevokeRolesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationRevokeTaxExemptions", + "description": "Revokes tax exemptions from the company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The location from which the tax exemptions will be revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The tax exemptions that are being revoked from the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationRevokeTaxExemptionsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationRevokeTaxRegistration", + "description": "Revokes tax registration on a company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The location whose tax registration is being revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationRevokeTaxRegistrationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationUpdate", + "description": "Updates a company location.", + "args": [ + { + "name": "companyLocationId", + "description": "The ID of the company location to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input fields to update in the company location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyLocationUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocationsDelete", + "description": "Deletes a list of company locations.", + "args": [ + { + "name": "companyLocationIds", + "description": "A list of IDs of company locations to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocationsDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyRevokeMainContact", + "description": "Revokes the main contact from the company.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company to revoke the main contact from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyRevokeMainContactPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyUpdate", + "description": "Updates a company.", + "args": [ + { + "name": "companyId", + "description": "The ID of the company to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input fields to update the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CompanyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddTaxExemptions", + "description": "Add tax exemptions for the customer.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"CA_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddTaxExemptionsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCreate", + "description": "Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", + "args": [ + { + "name": "input", + "description": "The input fields to create a customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerDelete", + "description": "Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", + "args": [ + { + "name": "input", + "description": "Specifies the customer to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerEmailMarketingConsentUpdate", + "description": "Update a customer's email marketing information information.\n", + "args": [ + { + "name": "input", + "description": "Specifies the input fields to update a customer's email marketing consent information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailMarketingConsentUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerEmailMarketingConsentUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerGenerateAccountActivationUrl", + "description": "Generate an account activation URL for a customer.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer that the URL is generated for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerGenerateAccountActivationUrlPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerMerge", + "description": "Merges two customers.", + "args": [ + { + "name": "customerOneId", + "description": "The ID of the first customer that will be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerTwoId", + "description": "The ID of the second customer that will be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "overrideFields", + "description": "The fields to override the default customer merge rules.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerMergeOverrideFields", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerMergePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodCreateFromDuplicationData", + "description": "Creates a vaulted payment method for a customer from duplication data.\n\nThis data must be obtained from another shop within the same organization.\n\nCurrently, this only supports Shop Pay payment methods. This is only available for selected partner apps.\n", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "encryptedDuplicationData", + "description": "The encrypted payment method data.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreateFromDuplicationDataPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodCreditCardCreate", + "description": "Creates a credit card payment method for a customer using a session id.\nThese values are only obtained through card imports happening from a PCI compliant environment.\nPlease use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.\n", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sessionId", + "description": "The Cardserver session ID. Obtained by storing card data with Shopify's Cardsink. Exchanging raw card data for a session ID must be done in a PCI complaint environment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreditCardCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodCreditCardUpdate", + "description": "Updates the credit card payment method for a customer.", + "args": [ + { + "name": "id", + "description": "The ID of the customer payment method.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sessionId", + "description": "The Cardserver session ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodCreditCardUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodGetDuplicationData", + "description": "Returns encrypted data that can be used to duplicate the payment method in another shop within the same organization.\n\nCurrently, this only supports Shop Pay payment methods. This is only available for selected partner apps.\n", + "args": [ + { + "name": "customerPaymentMethodId", + "description": "The payment method to be duplicated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "targetShopId", + "description": "The shop the payment method will be duplicated into.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "targetCustomerId", + "description": "The customer the payment method will be duplicated into.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetDuplicationDataPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodGetUpdateUrl", + "description": "Returns a URL that allows the customer to update a specific payment method.\n\nCurrently, `customerPaymentMethodGetUpdateUrl` only supports Shop Pay.\n", + "args": [ + { + "name": "customerPaymentMethodId", + "description": "The payment method to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodGetUpdateUrlPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodPaypalBillingAgreementCreate", + "description": "Creates a PayPal billing agreement for a customer.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingAgreementId", + "description": "The billing agreement ID from PayPal that starts with 'B-' (for example, `B-1234XXXXX`).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "inactive", + "description": "Whether the PayPal billing agreement is inactive.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodPaypalBillingAgreementCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodPaypalBillingAgreementUpdate", + "description": "Updates a PayPal billing agreement for a customer.", + "args": [ + { + "name": "id", + "description": "The ID of the customer payment method.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodPaypalBillingAgreementUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodRemoteCreate", + "description": "Create a payment method from remote gateway identifiers.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "remoteReference", + "description": "Remote gateway payment method details.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerPaymentMethodRemoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodRemoteCreditCardCreate", + "description": "Create a payment method from a credit card stored by Stripe.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "stripeCustomerId", + "description": "The Stripe Customer ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "stripePaymentMethodId", + "description": "The Stripe Payment Method ID.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRemoteCreditCardCreatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerPaymentMethodRemoteCreate` instead." + }, + { + "name": "customerPaymentMethodRevoke", + "description": "Revokes a customer's payment method.", + "args": [ + { + "name": "customerPaymentMethodId", + "description": "The ID of the customer payment method to be revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodRevokePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethodSendUpdateEmail", + "description": "Sends a link to the customer so they can update a specific payment method.", + "args": [ + { + "name": "customerPaymentMethodId", + "description": "The payment method to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "Specifies the payment method update email fields.", + "type": { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethodSendUpdateEmailPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerRemoveTaxExemptions", + "description": "Remove tax exemptions from a customer.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions to remove for the customer, in the format of an array or a comma-separated list. Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"A_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerRemoveTaxExemptionsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerReplaceTaxExemptions", + "description": "Replace tax exemptions for a customer.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxExemptions", + "description": "The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list.\n Example values: `[\"CA_BC_RESELLER_EXEMPTION\", \"A_STATUS_CARD_EXEMPTION\"]`, `\"CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION\"`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxExemption", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerReplaceTaxExemptionsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSegmentMembersQueryCreate", + "description": "Creates a customer segment members query.", + "args": [ + { + "name": "input", + "description": "The input fields to create a customer segment members query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerSegmentMembersQueryInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQueryCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSmsMarketingConsentUpdate", + "description": "Update a customer's SMS marketing consent information.\n", + "args": [ + { + "name": "input", + "description": "Specifies the input fields to update a customer's SMS marketing consent information.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerSmsMarketingConsentUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerSmsMarketingConsentUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUpdate", + "description": "Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).", + "args": [ + { + "name": "input", + "description": "Provides updated fields for the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUpdateDefaultAddress", + "description": "Updates a customer's default address.", + "args": [ + { + "name": "customerId", + "description": "The ID of the customer whose default address is being updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "addressId", + "description": "The ID of the customer's new default address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerUpdateDefaultAddressPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "delegateAccessTokenCreate", + "description": "Creates a delegate access token.\n\nTo learn more about creating delegate access tokens, refer to\n[Delegate OAuth access tokens to subsystems]\n(https://shopify.dev/apps/auth/oauth/delegate-access-tokens).\n", + "args": [ + { + "name": "input", + "description": "The input fields for creating a delegate access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DelegateAccessTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DelegateAccessTokenCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "delegateAccessTokenDestroy", + "description": "Destroys a delegate access token.", + "args": [ + { + "name": "accessToken", + "description": "Provides the delegate access token to destroy.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DelegateAccessTokenDestroyPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomizationActivation", + "description": "Activates and deactivates delivery customizations.", + "args": [ + { + "name": "ids", + "description": "The global IDs of the delivery customizations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "The enabled status of the delivery customizations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomizationActivationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomizationCreate", + "description": "Creates a delivery customization.", + "args": [ + { + "name": "deliveryCustomization", + "description": "The input data used to create the delivery customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryCustomizationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomizationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomizationDelete", + "description": "Creates a delivery customization.", + "args": [ + { + "name": "id", + "description": "The global ID of the delivery customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomizationDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomizationUpdate", + "description": "Updates a delivery customization.", + "args": [ + { + "name": "id", + "description": "The global ID of the delivery customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deliveryCustomization", + "description": "The input data used to update the delivery customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryCustomizationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomizationUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfileCreate", + "description": "Create a delivery profile.", + "args": [ + { + "name": "profile", + "description": "Specifies the input fields for a delivery profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "deliveryProfileCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfileRemove", + "description": "Enqueue the removal of a delivery profile.", + "args": [ + { + "name": "id", + "description": "The ID of the delivery profile to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "deliveryProfileRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfileUpdate", + "description": "Update a delivery profile.", + "args": [ + { + "name": "id", + "description": "The ID of the delivery profile to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "profile", + "description": "Specifies the input fields for a delivery profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryProfileInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "leaveLegacyModeProfiles", + "description": "Whether this delivery profile should leave legacy mode.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "deliveryProfileUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliverySettingUpdate", + "description": "Set the delivery settings for a shop.", + "args": [ + { + "name": "setting", + "description": "Specifies the input fields for the delivery shop level settings.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliverySettingInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliverySettingUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryShippingOriginAssign", + "description": "Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.\n", + "args": [ + { + "name": "locationId", + "description": "The ID of the location to assign as the shipping origin.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryShippingOriginAssignPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticActivate", + "description": "Activates an automatic discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic discount to activate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticAppCreate", + "description": "Creates an app discount.", + "args": [ + { + "name": "automaticAppDiscount", + "description": "The input data used to create the app discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticAppInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticAppCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticAppUpdate", + "description": "Updates an automatic app discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic app discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "automaticAppDiscount", + "description": "The input fields required to update the automatic app discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticAppInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticAppUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticBasicCreate", + "description": "Creates a basic automatic discount.", + "args": [ + { + "name": "automaticBasicDiscount", + "description": "The input data used to create the automatic discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBasicInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticBasicCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticBasicUpdate", + "description": "Updates a basic automatic discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "automaticBasicDiscount", + "description": "The input data used to update the automatic discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBasicInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticBasicUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticBulkDelete", + "description": "Asynchronously delete automatic discounts in bulk if a `search` or `saved_search_id` argument is provided or if a\nmaximum discount threshold is reached (1,000). Otherwise, deletions will occur inline.\n**Warning:** All automatic discounts will be deleted if a blank `search` argument is provided.\n", + "args": [ + { + "name": "search", + "description": "The search query for filtering automatic discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [AutomaticDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/automaticDiscountNodes#argument-automaticdiscountnodes-query).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search to use for filtering automatic discounts to delete.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the automatic discounts to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticBxgyCreate", + "description": "Creates a BXGY automatic discount.", + "args": [ + { + "name": "automaticBxgyDiscount", + "description": "The input data used to create the automatic discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBxgyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgyCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticBxgyUpdate", + "description": "Updates an existing Buy X, Get Y (BXGY) automatic discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "automaticBxgyDiscount", + "description": "The input data used to update the automatic discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountAutomaticBxgyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgyUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticDeactivate", + "description": "Deactivates an automatic discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic discount to deactivate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticDeactivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAutomaticDelete", + "description": "Deletes an automatic discount.", + "args": [ + { + "name": "id", + "description": "The ID of the automatic discount to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeActivate", + "description": "Activates a code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to activate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeAppCreate", + "description": "Creates a code app discount.", + "args": [ + { + "name": "codeAppDiscount", + "description": "The input data used to create the app discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeAppInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeAppCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeAppUpdate", + "description": "Updates a code app discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code app discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "codeAppDiscount", + "description": "The input fields required to update the code app discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeAppInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeAppUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBasicCreate", + "description": "Creates a basic code discount.", + "args": [ + { + "name": "basicCodeDiscount", + "description": "The input data used to create the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBasicInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBasicCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBasicUpdate", + "description": "Updates a basic code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "basicCodeDiscount", + "description": "The input data used to update the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBasicInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBasicUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBulkActivate", + "description": "Asynchronously activate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", + "args": [ + { + "name": "search", + "description": "The search query for filtering code discounts.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the code discounts to activate.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBulkActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBulkDeactivate", + "description": "Asynchronously deactivate code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", + "args": [ + { + "name": "search", + "description": "The search query for filtering code discounts.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the code discounts to deactivate.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBulkDeactivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBulkDelete", + "description": "Asynchronously delete code discounts in bulk using a search query, a saved search ID, or a list of code discount IDs.\n", + "args": [ + { + "name": "search", + "description": "The search query for filtering code discounts to delete.\n\nFor more information on the list of supported fields and search syntax, refer to the [CodeDiscountNodes query section](https://shopify.dev/api/admin-graphql/latest/queries/codeDiscountNodes#argument-codediscountnodes-query).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search to use for filtering code discounts to delete.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the code discounts to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBxgyCreate", + "description": "Creates a Buy X get Y (BXGY) code discount.", + "args": [ + { + "name": "bxgyCodeDiscount", + "description": "The input data used to create the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBxgyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBxgyCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeBxgyUpdate", + "description": "Updates a Buy X, Get Y (BXGY) code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "bxgyCodeDiscount", + "description": "The input data used to update the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeBxgyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeBxgyUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeDeactivate", + "description": "Deactivates a code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to deactivate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeDeactivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeDelete", + "description": "Deletes a code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeFreeShippingCreate", + "description": "Creates a free shipping code discount.", + "args": [ + { + "name": "freeShippingCodeDiscount", + "description": "The input data used to create the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeFreeShippingInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeFreeShippingCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeFreeShippingUpdate", + "description": "Updates a free shipping code discount.", + "args": [ + { + "name": "id", + "description": "The ID of the code discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "freeShippingCodeDiscount", + "description": "The input data used to update the code discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountCodeFreeShippingInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeFreeShippingUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeRedeemCodeBulkDelete", + "description": "Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a\nsearch query, a saved search ID, or a list of redeem code IDs.\n", + "args": [ + { + "name": "discountId", + "description": "The ID of the redeem code's discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "search", + "description": "The search query for filtering discount redeem codes.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the discount redeem codes to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeRedeemCodeBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountRedeemCodeBulkAdd", + "description": "Asynchronously add discount redeem codes in bulk. Specify the codes to add\nand the discount code ID that the codes will belong to.\n", + "args": [ + { + "name": "discountId", + "description": "The ID of the code discount that the codes will be added to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "codes", + "description": "The list of codes that will be added to the code discount. Maximum 100 codes permitted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DiscountRedeemCodeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disputeEvidenceUpdate", + "description": "Updates a dispute evidence.", + "args": [ + { + "name": "id", + "description": "The ID of the dispute evidence to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The updated properties for a dispute evidence.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeEvidenceUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DisputeEvidenceUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderBulkAddTags", + "description": "Adds tags to multiple draft orders.", + "args": [ + { + "name": "search", + "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the draft order saved search for filtering draft orders on.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the draft orders to add tags to.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "List of tags to be added.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderBulkAddTagsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderBulkDelete", + "description": "Deletes multiple draft orders.", + "args": [ + { + "name": "search", + "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the draft order saved search for filtering draft orders on.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the draft orders to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderBulkRemoveTags", + "description": "Removes tags from multiple draft orders.", + "args": [ + { + "name": "search", + "description": "The conditions for filtering draft orders on.\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax).\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of the draft order saved search for filtering draft orders on.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ids", + "description": "The IDs of the draft orders to remove tags from.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "List of tags to be removed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderBulkRemoveTagsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderCalculate", + "description": "Calculates the properties of a draft order. Useful for determining information\nsuch as total taxes or price without actually creating a draft order.\n", + "args": [ + { + "name": "input", + "description": "The fields for the draft order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderCalculatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderComplete", + "description": "Completes a draft order and creates an order.", + "args": [ + { + "name": "id", + "description": "The draft order to complete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentPending", + "description": "Whether the payment is pending.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "paymentGatewayId", + "description": "The gateway for the completed draft order.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sourceName", + "description": "A channel definition handle used for sales channel attribution.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderCompletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderCreate", + "description": "Creates a draft order.", + "args": [ + { + "name": "input", + "description": "The fields used to create the draft order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderCreateFromOrder", + "description": "Creates a Draft Order from Order.", + "args": [ + { + "name": "orderId", + "description": "Specifies the Order's id that we create the Draft Order from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderCreateFromOrderPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderCreateMerchantCheckout", + "description": "Creates a merchant checkout for the given draft order.", + "args": [ + { + "name": "id", + "description": "Specifies the Draft order's id that we create the checkout for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderCreateMerchantCheckoutPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderDelete", + "description": "Deletes a draft order.", + "args": [ + { + "name": "input", + "description": "Specify the draft order to delete by its ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderDuplicate", + "description": "Duplicates a draft order.", + "args": [ + { + "name": "id", + "description": "The ID of the draft order to duplicate.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderDuplicatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderInvoicePreview", + "description": "Previews a draft order invoice email.", + "args": [ + { + "name": "id", + "description": "Specifies the draft order invoice email to preview.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "Specifies the draft order invoice email fields.", + "type": { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderInvoicePreviewPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderInvoiceSend", + "description": "Sends an email invoice for a draft order.", + "args": [ + { + "name": "id", + "description": "Specifies the draft order to send the invoice for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "Specifies the draft order invoice email fields.", + "type": { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderInvoiceSendPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderUpdate", + "description": "Updates a draft order.\n\nIf a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts\nare created but not immediately completed when opening the merchant credit card modal in the admin, and when a\nbuyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress\nand the draft is updated before the checkout completes. This will not interfere with the checkout and order\ncreation, but if the link from draft to checkout is broken the draft will remain open even after the order is\ncreated.\n", + "args": [ + { + "name": "id", + "description": "Specifies the draft order to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The draft order properties to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DraftOrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eventBridgeServerPixelUpdate", + "description": "Updates the server pixel to connect to an EventBridge endpoint.\nRunning this mutation deletes any previous subscriptions for the server pixel.\n", + "args": [ + { + "name": "arn", + "description": "The ARN for the EventBridge endpoint to which customer events are to be sent.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ARN", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EventBridgeServerPixelUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eventBridgeWebhookSubscriptionCreate", + "description": "Creates a new Amazon EventBridge webhook subscription.\n", + "args": [ + { + "name": "topic", + "description": "The type of event that triggers the webhook.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for an EventBridge webhook subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EventBridgeWebhookSubscriptionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EventBridgeWebhookSubscriptionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eventBridgeWebhookSubscriptionUpdate", + "description": "Updates an Amazon EventBridge webhook subscription.\n", + "args": [ + { + "name": "id", + "description": "The ID of the webhook subscription to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for an EventBridge webhook subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EventBridgeWebhookSubscriptionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EventBridgeWebhookSubscriptionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileAcknowledgeUpdateFailed", + "description": "Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors.", + "args": [ + { + "name": "fileIds", + "description": "Specifies the file(s) to acknowledge the failed updates of.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FileAcknowledgeUpdateFailedPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileCreate", + "description": "Creates file assets using an external URL or for files that were previously uploaded using the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).\nThese files are added to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin.\n", + "args": [ + { + "name": "files", + "description": "List of new files to be created.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FileCreateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FileCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileDelete", + "description": "Deletes existing file assets that were uploaded to Shopify.", + "args": [ + { + "name": "fileIds", + "description": "The IDs of the files to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FileDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileUpdate", + "description": "Updates an existing file asset that was uploaded to Shopify.", + "args": [ + { + "name": "files", + "description": "List of files to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FileUpdateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FileUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "flowTriggerReceive", + "description": "Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers).", + "args": [ + { + "name": "body", + "description": "The payload needed to run the Trigger.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FlowTriggerReceivePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentCancel", + "description": "Cancels a fulfillment.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment to be canceled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentCancelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentCreateV2", + "description": "Creates a fulfillment for one or many fulfillment orders.\nThe fulfillment orders are associated with the same order and are assigned to the same location.\n", + "args": [ + { + "name": "fulfillment", + "description": "The input fields used to create a fulfillment from fulfillment orders.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentV2Input", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional message for the fulfillment request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentCreateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentEventCreate", + "description": "Creates a fulfillment event for a specified fulfillment.", + "args": [ + { + "name": "fulfillmentEvent", + "description": "The input fields used to create a fulfillment event for a fulfillment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentEventInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentEventCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderAcceptCancellationRequest", + "description": "Accept a cancellation request sent to a fulfillment service for a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with the cancellation request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for accepting the cancellation request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderAcceptCancellationRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderAcceptFulfillmentRequest", + "description": "Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with the fulfillment request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for accepting the fulfillment request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderAcceptFulfillmentRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderCancel", + "description": "Marks a fulfillment order as canceled.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order to mark as canceled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderCancelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderClose", + "description": "Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order to mark as incomplete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for marking the fulfillment order as incomplete.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderClosePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderHold", + "description": "Applies a fulfillment hold on an open fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order on which a fulfillment hold is applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentHold", + "description": "The details of the fulfillment hold applied on the fulfillment order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderHoldInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderHoldPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderLineItemsPreparedForPickup", + "description": "Mark line items associated with a fulfillment order as being ready for pickup by a customer.\n\nSends a Ready For Pickup notification to the customer to let them know that their order is ready\nto be picked up.\n", + "args": [ + { + "name": "input", + "description": "The input for marking fulfillment order line items as ready for pickup.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItemsPreparedForPickupPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderMerge", + "description": "Merges a set or multiple sets of fulfillment orders together into one based on\nline item inputs and quantities.\n", + "args": [ + { + "name": "fulfillmentOrderMergeInputs", + "description": "One or more sets of fulfillment orders to be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderMergeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderMergePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderMove", + "description": "Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.\n\nMoving a fulfillment order will fail in the following circumstances:\n\n* The fulfillment order is closed.\n* The destination location has never stocked the requested inventory item.\n* The API client doesn't have the correct permissions.\n\nLine items which have already been fulfilled can't be re-assigned\nand will always remain assigned to the original location.\n\nYou can't change the assigned location while a fulfillment order has a\n[request status](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus)\nof `SUBMITTED`, `ACCEPTED`, `CANCELLATION_REQUESTED`, or `CANCELLATION_REJECTED`.\nThese request statuses mean that a fulfillment order is awaiting action by a fulfillment service\nand can't be re-assigned without first having the fulfillment service accept a cancellation request.\nThis behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.\n\n### How re-assigning line items affects fulfillment orders\n\n**First scenario:** Re-assign all line items belonging to a fulfillment order to a new location.\n\nIn this case, the\n[assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation)\nof the original fulfillment order will be updated to the new location.\n\n**Second scenario:** Re-assign a subset of the line items belonging to a fulfillment order to a new location.\nYou can specify a subset of line items using the `fulfillmentOrderLineItems` parameter\n(available as of the `2023-04` API version),\nor specify that the original fulfillment order contains line items which have already been fulfilled.\n\nIf the new location is already assigned to another active fulfillment order, on the same order,\nthen the line items are moved to the existing fulfillment order.\nOtherwise, a new fulfillment order is created for the new location, and the line items are moved to the new location.\n", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order to be moved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newLocationId", + "description": "The ID of the location where the fulfillment order will be moved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be moved.\nIf left blank, all unfulfilled line items belonging to the fulfillment order are moved.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderMovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderOpen", + "description": "Marks a scheduled fulfillment order as open.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order to mark as open.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderOpenPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderRejectCancellationRequest", + "description": "Rejects a cancellation request sent to a fulfillment service for a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with the cancellation request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for rejecting the cancellation request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderRejectCancellationRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderRejectFulfillmentRequest", + "description": "Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with the fulfillment request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "reason", + "description": "The reason for the fulfillment order rejection.", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderRejectionReason", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for rejecting the fulfillment request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lineItems", + "description": "An optional array of line item rejection details. If none are provided, all line items will be assumed to be unfulfillable.\n\n**Note**: After the fulfillment request has been rejected, none of the line items will be able to be fulfilled. This field documents which line items specifically were unable to be fulfilled and why.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "IncomingRequestLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderRejectFulfillmentRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderReleaseHold", + "description": "Releases the fulfillment hold on a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order for which to release the fulfillment hold.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "externalId", + "description": "A configurable ID used to track the automation system releasing this hold.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderReleaseHoldPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderReschedule", + "description": "Reschedules a scheduled fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order to reschedule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fulfillAt", + "description": "The new fulfill at date of the fulfillment order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderReschedulePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderSplit", + "description": "Splits a fulfillment order or orders based on line item inputs and quantities.", + "args": [ + { + "name": "fulfillmentOrderSplits", + "description": "The fulfillment orders, line items and quantities to be split into new fulfillment orders.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderSplitInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderSplitPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderSubmitCancellationRequest", + "description": "Sends a cancellation request to the fulfillment service of a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with the cancellation request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional reason for the cancellation request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderSubmitCancellationRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrderSubmitFulfillmentRequest", + "description": "Sends a fulfillment request to the fulfillment service of a fulfillment order.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment order associated with fulfillment request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "message", + "description": "An optional message for the fulfillment request.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "Whether the customer should be notified when fulfillments are created for this fulfillment order.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrderLineItems", + "description": "The fulfillment order line items to be requested for fulfillment.\nIf left blank, all line items of the fulfillment order are requested for fulfillment.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentOrderLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "shippingMethod", + "description": "A reference to the [ShippingMethod](https://shopify.dev/api/admin-graphql/latest/objects/shippingmethod) code, such as `FREE_SHIPPING`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrderSubmitFulfillmentRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrdersReleaseHolds", + "description": "Releases the fulfillment holds on a list of fulfillment orders.", + "args": [ + { + "name": "ids", + "description": "The IDs of the fulfillment orders for which to release the fulfillment holds.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "externalId", + "description": "A configurable ID used to track the automation system releasing these holds.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrdersReleaseHoldsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrdersSetFulfillmentDeadline", + "description": "Sets the latest date and time by which the fulfillment orders need to be fulfilled.", + "args": [ + { + "name": "fulfillmentOrderIds", + "description": "The IDs of the fulfillment orders for which the deadline is being set.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentDeadline", + "description": "The new fulfillment deadline of the fulfillment orders.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrdersSetFulfillmentDeadlinePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentServiceCreate", + "description": "Creates a fulfillment service.\n\n## Fulfillment service location\n\nWhen creating a fulfillment service, a new location will be automatically created on the shop\nand will be associated with this fulfillment service.\nThis location will be named after the fulfillment service and inherit the shop's address.\n\nIf you are using API version `2023-10` or later, and you need to specify custom attributes for the fulfillment service location\n(for example, to change its address to a country different from the shop's country),\nuse the\n[LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit)\nmutation after creating the fulfillment service.\n", + "args": [ + { + "name": "name", + "description": "The name of the fulfillment service.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "callbackUrl", + "description": "The URL to send requests for the fulfillment service. The following considerations apply:\n\n- Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the callback_url/fulfillment_order_notification endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "trackingSupport", + "description": "Whether the fulfillment service provides tracking numbers for packages.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "fulfillmentOrdersOptIn", + "description": "Whether the fulfillment service uses the [fulfillment order based workflow](\n https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments\n) for managing fulfillments.\n\n[As of 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation),\nthe fulfillment order based workflow is the only way to manage fulfillments,\nand `fulfillmentOrdersOptIn` must be set to `true`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "permitsSkuSharing", + "description": "Whether the fulfillment service can stock inventory alongside other locations.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "inventoryManagement", + "description": "Whether the fulfillment service manages product inventory and provides updates to Shopify.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentServiceCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentServiceDelete", + "description": "Deletes a fulfillment service.", + "args": [ + { + "name": "id", + "description": "The ID of the fulfillment service to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationLocationId", + "description": "The ID of the location where inventory and commitments will be relocated\nafter the fulfillment service is deleted.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentServiceDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentServiceUpdate", + "description": "Updates a fulfillment service.\n\nIf you are using API version `2023-10` or later,\nand you need to update the location managed by the fulfillment service\n(for example, to change the address of a fulfillment service),\nuse the\n[LocationEdit](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit)\nmutation.\n", + "args": [ + { + "name": "id", + "description": "The id of the fulfillment service.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the fulfillment service.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "callbackUrl", + "description": "The URL to send requests for the fulfillment service. The following considerations apply:\n\n- Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers\n for orders, if `trackingSupport` is set to `true`.\n- Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels,\n if `inventoryManagement` is set to `true`.\n- Shopify uses the callback_url/fulfillment_order_notification endpoint to send\n [fulfillment and cancellation requests](https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments#step-2-receive-fulfillment-requests-and-cancellations).\n", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "trackingSupport", + "description": "Whether the fulfillment service provides tracking numbers for packages.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillmentOrdersOptIn", + "description": "Whether the fulfillment service uses the [fulfillment order based workflow](\n https://shopify.dev/apps/fulfillment/fulfillment-service-apps/manage-fulfillments\n) for managing fulfillments.\n\n[As of 2022-07 API version](https://shopify.dev/changelog/legacy-fulfillment-api-deprecation),\nthe fulfillment order based workflow is the only way to manage fulfillments,\nand `true` is the only valid value for `fulfillmentOrdersOptIn`.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "permitsSkuSharing", + "description": "Whether the fulfillment service can stock inventory alongside other locations.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentServiceUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentTrackingInfoUpdateV2", + "description": "Updates tracking information for a fulfillment.", + "args": [ + { + "name": "fulfillmentId", + "description": "The ID of the fulfillment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "trackingInfoInput", + "description": "The tracking input for the mutation, including tracking URL, number, and company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FulfillmentTrackingInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "Whether the customer will be notified of this update and future updates for the fulfillment.\nIf this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfoUpdateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardCreate", + "description": "Create a gift card.", + "args": [ + { + "name": "input", + "description": "The input fields to create a gift card.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftCardCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCardCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardDisable", + "description": "Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled.\n", + "args": [ + { + "name": "id", + "description": "The ID of the gift card to disable.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCardDisablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardUpdate", + "description": "Update a gift card.", + "args": [ + { + "name": "id", + "description": "The ID of the gift card to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input fields to update the gift card.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GiftCardUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCardUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryActivate", + "description": "Activate an inventory item at a location.", + "args": [ + { + "name": "inventoryItemId", + "description": "The ID of the inventory item to activate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the location of the inventory item being activated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "available", + "description": "The initial available quantity of the inventory item being activated at the location.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "onHand", + "description": "The initial on_hand quantity of the inventory item being activated at the location.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryAdjustQuantities", + "description": "Apply changes to inventory quantities.", + "args": [ + { + "name": "input", + "description": "The information required to adjust inventory quantities.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustQuantitiesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryAdjustQuantitiesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryAdjustQuantity", + "description": "Adjusts the inventory by a certain quantity.", + "args": [ + { + "name": "input", + "description": "Provides the input fields required to update an inventory level.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustQuantityInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryAdjustQuantityPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `inventoryAdjustQuantities` instead." + }, + { + "name": "inventoryBulkAdjustQuantityAtLocation", + "description": "Adjusts the inventory at a location for multiple inventory items.", + "args": [ + { + "name": "inventoryItemAdjustments", + "description": "Specifies adjustments for items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryAdjustItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "Specifies where the item should be adjusted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryBulkAdjustQuantityAtLocationPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `inventoryAdjustQuantities` instead." + }, + { + "name": "inventoryBulkToggleActivation", + "description": "Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item's quantities and turns off the inventory item from that location.", + "args": [ + { + "name": "inventoryItemId", + "description": "The ID of the inventory item to modify the activation status locations for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "inventoryItemUpdates", + "description": "A list of pairs of locations and activate status to update for the specified inventory item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryBulkToggleActivationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryBulkToggleActivationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryDeactivate", + "description": "Removes an inventory item's quantities from a location, and turns off inventory at the location.", + "args": [ + { + "name": "inventoryLevelId", + "description": "The ID of the inventory level to deactivate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryDeactivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItemUpdate", + "description": "Updates an inventory item.", + "args": [ + { + "name": "id", + "description": "The ID of the inventory item to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input fields that update an [`inventoryItem`](https://shopify.dev/api/admin-graphql/latest/queries/inventoryitem).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryItemUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryItemUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryMoveQuantities", + "description": "Moves inventory between inventory quantity names at a single location.", + "args": [ + { + "name": "input", + "description": "The information required to move inventory quantities.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryMoveQuantitiesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryMoveQuantitiesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventorySetOnHandQuantities", + "description": "Set inventory on-hand quantities using absolute values.", + "args": [ + { + "name": "input", + "description": "The information required to set inventory on hand quantities.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventorySetOnHandQuantitiesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventorySetOnHandQuantitiesPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationActivate", + "description": "Activates a location.", + "args": [ + { + "name": "locationId", + "description": "The ID of a location to activate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationAdd", + "description": "Adds a new location.", + "args": [ + { + "name": "input", + "description": "The properties of the location to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LocationAddInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationDeactivate", + "description": "Deactivates a location and moves inventory, pending orders, and moving transfers to a destination location.", + "args": [ + { + "name": "locationId", + "description": "The ID of a location to deactivate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destinationLocationId", + "description": "The ID of a destination location to which inventory, pending orders and moving transfers will be moved from the location to deactivate.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationDeactivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationDelete", + "description": "Deletes a location.", + "args": [ + { + "name": "locationId", + "description": "The ID of a location to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationEdit", + "description": "Edits an existing location.\n\n[As of the 2023-10 API version](https://shopify.dev/changelog/apps-can-now-change-the-name-and-address-of-their-fulfillment-service-locations), apps can change the name and address of their fulfillment service locations.\n", + "args": [ + { + "name": "id", + "description": "The ID of a location to edit.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The updated properties for the location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LocationEditInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationEditPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationLocalPickupDisable", + "description": "Disables local pickup for a location.", + "args": [ + { + "name": "locationId", + "description": "The ID of the location to disable local pickup for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationLocalPickupDisablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationLocalPickupEnable", + "description": "Enables local pickup for a location.", + "args": [ + { + "name": "localPickupSettings", + "description": "The settings required to enable local pickup for a location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryLocationLocalPickupEnableInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "LocationLocalPickupEnablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketCreate", + "description": "Creates a new market.", + "args": [ + { + "name": "input", + "description": "The properties of the new market.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketCurrencySettingsUpdate", + "description": "Updates currency settings of a market.", + "args": [ + { + "name": "marketId", + "description": "The ID of the market definition to target.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Properties to update for the market currency settings.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketCurrencySettingsUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketCurrencySettingsUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketDelete", + "description": "Deletes a market definition.", + "args": [ + { + "name": "id", + "description": "The ID of the market to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizationsRegister", + "description": "Creates or updates market localizations.", + "args": [ + { + "name": "resourceId", + "description": "The ID of the resource that is being localized within the context of a market.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketLocalizations", + "description": "The input fields for a market localization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketLocalizationRegisterInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketLocalizationsRegisterPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizationsRemove", + "description": "Deletes market localizations.", + "args": [ + { + "name": "resourceId", + "description": "The ID of the resource for which market localizations are being deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketLocalizationKeys", + "description": "The list of market localization keys.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "marketIds", + "description": "The list of market IDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketLocalizationsRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketRegionDelete", + "description": "Deletes a market region.", + "args": [ + { + "name": "id", + "description": "The ID of the market region to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketRegionDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketRegionsCreate", + "description": "Creates regions that belong to an existing market.", + "args": [ + { + "name": "marketId", + "description": "The ID of the market to add the regions to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "regions", + "description": "The regions to be created.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketRegionCreateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketRegionsCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketUpdate", + "description": "Updates the properties of a market.", + "args": [ + { + "name": "id", + "description": "The ID of the market to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketWebPresenceCreate", + "description": "Creates a web presence for a market.", + "args": [ + { + "name": "marketId", + "description": "The ID of the market for which to create a web presence.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webPresence", + "description": "The details of the web presence to be created.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketWebPresenceCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketWebPresenceCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketWebPresenceDelete", + "description": "Deletes a market web presence.", + "args": [ + { + "name": "marketId", + "description": "The ID of the market for which to delete the web presence.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketWebPresenceDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketWebPresenceUpdate", + "description": "Updates a market web presence.", + "args": [ + { + "name": "marketId", + "description": "The ID of the market for which to update the web presence.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webPresence", + "description": "The web_presence fields used to update the market's web presence.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketWebPresenceUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketWebPresenceUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivityCreate", + "description": "Create new marketing activity.", + "args": [ + { + "name": "input", + "description": "The Input of marketing activity create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingActivityCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivityCreateExternal", + "description": "Creates a new external marketing activity.", + "args": [ + { + "name": "input", + "description": "The input field for creating a external marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityCreateExternalInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingActivityCreateExternalPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivityUpdate", + "description": "Updates a marketing activity with the latest information.", + "args": [ + { + "name": "input", + "description": "The Input of the marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingActivityUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivityUpdateExternal", + "description": "Update an external marketing activity.", + "args": [ + { + "name": "input", + "description": "The input to update the external marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketingActivityUpdateExternalInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketingActivityId", + "description": "The ID of the marketing activity. You must provide one of the following values: marketing activity ID, remote ID, or UTM must be provided.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remoteId", + "description": "The remote ID of the marketing event associated with the marketing activity. You must provide one of the following values: marketing activity ID, remote ID, or UTM must be provided.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "utm", + "description": "The UTM parameters associated with marketing activities to filter by.You must provide one of the following values: marketing activity ID, remote ID, or UTM must be provided.", + "type": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingActivityUpdateExternalPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingEngagementCreate", + "description": "Creates a new marketing event engagement for a marketing activity or a marketing channel.", + "args": [ + { + "name": "marketingActivityId", + "description": "The ID of the marketing activity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketingEngagement", + "description": "The marketing engagement's attributes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MarketingEngagementInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingEngagementCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionCreate", + "description": "Creates a metafield definition.\n", + "args": [ + { + "name": "definition", + "description": "Specifies the input fields for a metafield definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinitionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionDelete", + "description": "Delete a metafield definition.\nOptionally deletes all associated metafields asynchronously when specified.\n", + "args": [ + { + "name": "id", + "description": "The id of the metafield definition to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deleteAllAssociatedMetafields", + "description": "Whether to delete all associated metafields.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinitionDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionPin", + "description": "You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.\nThe order of your pinned metafield definitions determines the order in which your metafields are displayed\non the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.\n", + "args": [ + { + "name": "definitionId", + "description": "The ID of the metafield definition to pin.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinitionPinPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionUnpin", + "description": "You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.\nThe order of your pinned metafield definitions determines the order in which your metafields are displayed\non the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.\n", + "args": [ + { + "name": "definitionId", + "description": "The ID of the metafield definition to unpin.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinitionUnpinPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionUpdate", + "description": "Updates a metafield definition.\n", + "args": [ + { + "name": "definition", + "description": "The input fields for the metafield definition update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDefinitionUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinitionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDelete", + "description": "Deletes a metafield.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldStorefrontVisibilityCreate", + "description": "Creates a `MetafieldStorefrontVisibility` record to make all metafields that belong to the specified resource\nand have the established `namespace` and `key` combination visible in the Storefront API.\n", + "args": [ + { + "name": "input", + "description": "Specifies the input fields for a `MetafieldStorefrontVisibility` record.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldStorefrontVisibilityInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldStorefrontVisibilityDelete", + "description": "Deletes a `MetafieldStorefrontVisibility` record. All metafields that belongs to the specified record will no\nlonger be visible in the Storefront API.\n", + "args": [ + { + "name": "id", + "description": "The ID of the `MetafieldStorefrontVisibility` record to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldsSet", + "description": "Sets metafield values. Metafield values will be set regardless if they were previously created or not.\n\nAllows a maximum of 25 metafields to be set at a time.\n\nNote that this operation is atomic as of `2023-01`, meaning no changes are persisted if any error is\nencountered.\n", + "args": [ + { + "name": "metafields", + "description": "The list of metafield values to set. Maximum of 25.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldsSetInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldsSetPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectBulkDelete", + "description": "Asynchronously delete metaobjects and their associated metafields in bulk.", + "args": [ + { + "name": "where", + "description": "Specifies the condition by which metaobjects are deleted.\nExactly one field of input is required.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectBulkDeleteWhereCondition", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectCreate", + "description": "Creates a new metaobject.", + "args": [ + { + "name": "metaobject", + "description": "The parameters for the metaobject to create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinitionCreate", + "description": "Creates a new metaobject definition.", + "args": [ + { + "name": "definition", + "description": "The input fields for creating a metaobject definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectDefinitionCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinitionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinitionDelete", + "description": "Deletes the specified metaobject definition.\nAlso deletes all related metafield definitions, metaobjects, and metafields asynchronously.\n", + "args": [ + { + "name": "id", + "description": "The ID of the metaobjects definition to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinitionDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinitionUpdate", + "description": "Updates a metaobject definition with new settings and metafield definitions.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject definition to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "definition", + "description": "The input fields for updating a metaobject definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectDefinitionUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinitionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDelete", + "description": "Deletes the specified metaobject and its associated metafields.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectUpdate", + "description": "Updates an existing metaobject.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "metaobject", + "description": "Specifies parameters to update on the metaobject.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectUpsert", + "description": "Retrieves a metaobject by handle, then updates it with the provided input values.\nIf no matching metaobject is found, a new metaobject is created with the provided input values.\n", + "args": [ + { + "name": "handle", + "description": "The identifier of the metaobject to upsert.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectHandleInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "metaobject", + "description": "The parameters to upsert the metaobject.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectUpsertInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectUpsertPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCapture", + "description": "Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization.", + "args": [ + { + "name": "input", + "description": "The input for the mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderCaptureInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderCapturePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderClose", + "description": "Closes an open order.\n", + "args": [ + { + "name": "input", + "description": "The input for the mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderCloseInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderClosePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCreateMandatePayment", + "description": "Creates a payment for an order by mandate.", + "args": [ + { + "name": "id", + "description": "The ID of the order to collect the balance for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentScheduleId", + "description": "The ID of the payment schedule to collect the balance for.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "idempotencyKey", + "description": "A unique key to identify the payment request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mandateId", + "description": "The mandate ID used for payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "autoCapture", + "description": "Whether the payment should be authorized or captured. If `false`, then the authorization of\n the payment is triggered.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderCreateMandatePaymentPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditAddCustomItem", + "description": "Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", + "args": [ + { + "name": "id", + "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto which the custom item is added.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The name of the custom item to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the retail [location](https://shopify.dev/api/admin-graphql/latest/objects/location)\n(if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The unit price of the custom item. This value can't be negative.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the custom item. This value must be greater than zero.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "taxable", + "description": "Whether the custom item is taxable. Defaults to `true`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requiresShipping", + "description": "Whether the custom item requires shipping. Defaults to `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditAddCustomItemPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditAddLineItemDiscount", + "description": "Adds a discount to a newly added line item on the current order edit. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", + "args": [ + { + "name": "id", + "description": "The ID of the calculated order to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineItemId", + "description": "The ID of a newly added calculated line item to add the discount to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discount", + "description": "The discount to add to the line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderEditAppliedDiscountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditAddLineItemDiscountPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditAddVariant", + "description": "Adds a line item from an existing product variant.", + "args": [ + { + "name": "id", + "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nto edit.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantId", + "description": "The ID of the variant to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the [location](https://shopify.dev/api/admin-graphql/latest/objects/location)\nto check for inventory availability. A default location ID is chosen automatically if none is provided.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the item to add to the order. Must be a positive value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "allowDuplicates", + "description": "Whether the mutation can create a line item for a variant that's already on the calculated order.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditAddVariantPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditBegin", + "description": "Starts editing an order. Mutations are operating on `OrderEdit`.\nAll order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`.\n", + "args": [ + { + "name": "id", + "description": "The ID of the order to begin editing.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditBeginPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditCommit", + "description": "Applies and saves staged changes to an order. Mutations are operating on `OrderEdit`.\nAll order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`.\n", + "args": [ + { + "name": "id", + "description": "The ID of the calculated order that will have its changes applied to the order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "Whether to notify the customer or not.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "staffNote", + "description": "Note for staff members.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditCommitPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditRemoveLineItemDiscount", + "description": "Removes a line item discount that was applied as part of an order edit.", + "args": [ + { + "name": "id", + "description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to remove the discount.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discountApplicationId", + "description": "The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication)\nto remove.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditRemoveLineItemDiscountPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderEditSetQuantity", + "description": "Sets the quantity of a line item on an order that is being edited. More information on how to use the GraphQL Admin API to edit an existing order, refer to [Edit existing orders](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).", + "args": [ + { + "name": "id", + "description": "The ID of the calculated order to edit. The edit changes the quantity on the line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineItemId", + "description": "The ID of the line item to edit.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The new quantity to set for the line item. This value cannot be negative.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "restock", + "description": "Whether or not to restock the line item when the updated quantity is less than the original quantity.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderEditSetQuantityPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderInvoiceSend", + "description": "Sends an email invoice for an order.", + "args": [ + { + "name": "id", + "description": "The order associated with the invoice.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email input fields for the order invoice. The `bcc` and `from` fields should be store or staff account emails.", + "type": { + "kind": "INPUT_OBJECT", + "name": "EmailInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderInvoiceSendPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderMarkAsPaid", + "description": "Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.\n", + "args": [ + { + "name": "input", + "description": "The input for the mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderMarkAsPaidInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderMarkAsPaidPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderOpen", + "description": "Opens a closed order.\n", + "args": [ + { + "name": "input", + "description": "The input for the mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderOpenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderOpenPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderUpdate", + "description": "Updates the fields of an order.", + "args": [ + { + "name": "input", + "description": "The input for the mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomizationActivation", + "description": "Activates and deactivates payment customizations.", + "args": [ + { + "name": "ids", + "description": "The global IDs of the payment customizations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "The enabled status of the payment customizations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomizationActivationPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomizationCreate", + "description": "Creates a payment customization.", + "args": [ + { + "name": "paymentCustomization", + "description": "The input data used to create the payment customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentCustomizationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomizationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomizationDelete", + "description": "Deletes a payment customization.", + "args": [ + { + "name": "id", + "description": "The global ID of the payment customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomizationDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomizationUpdate", + "description": "Updates a payment customization.", + "args": [ + { + "name": "id", + "description": "The global ID of the payment customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentCustomization", + "description": "The input data used to update the payment customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentCustomizationInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomizationUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentReminderSend", + "description": "Sends an email payment reminder for a payment schedule.", + "args": [ + { + "name": "paymentScheduleId", + "description": "The payment schedule id associated with the reminder.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentReminderSendPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsCreate", + "description": "Create payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", + "args": [ + { + "name": "referenceId", + "description": "Specifies the reference orderId to add the payment terms for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentTermsAttributes", + "description": "The attributes used to create the payment terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentTermsCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsDelete", + "description": "Delete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", + "args": [ + { + "name": "input", + "description": "The input fields used to delete the payment terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentTermsDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsUpdate", + "description": "Update payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the `DraftOrderInput`.", + "args": [ + { + "name": "input", + "description": "The input fields used to update the payment terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentTermsUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListCreate", + "description": "Creates a price list. You can use the `priceListCreate` mutation to create a new price list for a country. This enables you to sell your products with international pricing.", + "args": [ + { + "name": "input", + "description": "The properties of the new price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListDelete", + "description": "Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.", + "args": [ + { + "name": "id", + "description": "The ID of the price list to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListFixedPricesAdd", + "description": "Creates or updates fixed prices on a price list. You can use the `priceListFixedPricesAdd` mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten.", + "args": [ + { + "name": "priceListId", + "description": "The ID of the price list to which the fixed prices will be added or updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "prices", + "description": "The list of fixed prices to add or update in the price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListPriceInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListFixedPricesAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListFixedPricesByProductUpdate", + "description": "Updates the fixed prices for all variants for a product on a price list. You can use the `priceListFixedPricesByProductUpdate` mutation to set or remove a fixed price for all variants of a product associated with the price list.", + "args": [ + { + "name": "pricesToAdd", + "description": "A list of `PriceListProductPriceInput` that identifies which products to update the fixed prices for.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListProductPriceInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "pricesToDeleteByProductIds", + "description": "A list of product IDs that identifies which products to remove the fixed prices for.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "priceListId", + "description": "The price list to update the prices for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListFixedPricesByProductUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListFixedPricesDelete", + "description": "Deletes specific fixed prices from a price list using a product variant ID. You can use the `priceListFixedPricesDelete` mutation to delete a set of fixed prices from a price list. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment.", + "args": [ + { + "name": "priceListId", + "description": "The ID of the price list from which the fixed prices will be removed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantIds", + "description": "A list of product variant IDs whose fixed prices will be removed from the price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListFixedPricesDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListFixedPricesUpdate", + "description": "Updates fixed prices on a price list. You can use the `priceListFixedPricesUpdate` mutation to set a fixed price for specific product variants or to delete prices for variants associated with the price list.", + "args": [ + { + "name": "priceListId", + "description": "The price list that the prices will be updated against.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pricesToAdd", + "description": "The fixed prices to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListPriceInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "variantIdsToDelete", + "description": "A list of product variant IDs to remove from the price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListFixedPricesUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceListUpdate", + "description": "Updates a price list.\nIf you modify the currency, then any fixed prices set on the price list will be deleted.\n", + "args": [ + { + "name": "id", + "description": "The ID of the price list to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input data used to update the price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceListUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleActivate", + "description": "Activate a price rule.", + "args": [ + { + "name": "id", + "description": "ID of the price rule to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleActivatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeActivate` instead." + }, + { + "name": "priceRuleCreate", + "description": "Create a price rule using the input.", + "args": [ + { + "name": "priceRule", + "description": "The input fields to create a price rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The input fields to create a discount code for the price rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleDiscountCodeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleCreatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeBasicCreate` instead." + }, + { + "name": "priceRuleDeactivate", + "description": "Deactivate a price rule.", + "args": [ + { + "name": "id", + "description": "ID of the price rule to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDeactivatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeDeactivate` instead." + }, + { + "name": "priceRuleDelete", + "description": "Delete a price rule.", + "args": [ + { + "name": "id", + "description": "The ID of the price rule object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDeletePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeDelete` instead." + }, + { + "name": "priceRuleDiscountCodeCreate", + "description": "Create a discount code for a price rule.", + "args": [ + { + "name": "priceRuleId", + "description": "The ID of the price rule object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code to create for the price rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeCreatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountRedeemCodeBulkAdd` instead." + }, + { + "name": "priceRuleDiscountCodeUpdate", + "description": "Update a discount code for a price rule.", + "args": [ + { + "name": "priceRuleId", + "description": "The ID of the price rule object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The new code of a price rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeUpdatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeBasicUpdate` instead." + }, + { + "name": "priceRuleUpdate", + "description": "Updates a price rule using its ID and an input.", + "args": [ + { + "name": "id", + "description": "ID of the price rule to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "priceRule", + "description": "The input fields to update a price rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The input fields to update the discount code of the price rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleDiscountCodeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRuleUpdatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `discountCodeBasicUpdate` instead." + }, + { + "name": "privateMetafieldDelete", + "description": "Deletes a private metafield.\nPrivate metafields are automatically deleted when the app that created them is uninstalled.\n", + "args": [ + { + "name": "input", + "description": "The input fields for the private metafield to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafieldDeletePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafieldUpsert", + "description": "Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps.\nPrivate metafields are accessible only by the application that created them and only from the GraphQL Admin API.\n\nAn application can create a maximum of 10 private metafields per shop resource.\n", + "args": [ + { + "name": "input", + "description": "Specifies the input fields for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafieldUpsertPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "productAppendImages", + "description": "Appends images to a product.", + "args": [ + { + "name": "input", + "description": "Specifies the new images and the product that they're being added to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductAppendImagesInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductAppendImagesPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `productCreateMedia` instead." + }, + { + "name": "productChangeStatus", + "description": "Changes the status of a product. This allows you to set the availability of the product across all channels.", + "args": [ + { + "name": "productId", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status to be assigned to the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductStatus", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductChangeStatusPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCreate", + "description": "Creates a product.\n\nIf you need to create a product with many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nespecially with a lot of\n[collections](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-collectionstojoin)\nand\n[tags](https://shopify.dev/api/admin-graphql/latest/mutations/productCreate#field-productinput-tags),\nthen you should first create the product with just the variants.\n\nAfter the product is created, you can activate the variants at locations\nand add the other related objects to the product. This reduces the size of each mutation and increases the likelihood that it will\ncomplete before the operation times out.\n\nThe following example shows how you might break up product creation and object association into multiple steps:\n\n1. Create the product with variants. Don't specify any tags or collections on the product, and don't specify\n[inventory quantities](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput#field-productvariantinput-inventoryquantities)\nfor each variant.\n\n2. After the product is created, add tags to the product using the\n[tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsAdd) mutation, and add collections using the\n[collectionsAddProducts](https://shopify.dev/api/admin-graphql/latest/mutations/collectionAddProducts) mutation.\n\n3. Use the [inventoryBulkToggleActivation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkToggleActivation) mutation\non each [inventory item](https://shopify.dev/api/admin-graphql/latest/objects/InventoryItem) to activate it at the appropriate locations.\n\n4. After activating the variants at the locations, adjust inventory quantities at each location using the\n[inventoryBulkAdjustQuantityAtLocation](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryBulkAdjustQuantityAtLocation) mutation.\n", + "args": [ + { + "name": "input", + "description": "The properties of the new product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "List of new media to be added to the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCreateMedia", + "description": "Creates media for a product.", + "args": [ + { + "name": "productId", + "description": "Specifies the product associated with the media.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "List of new media to be added to a product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCreateMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDelete", + "description": "Deletes a product, including all associated variants and media.\n\nAs of API version `2023-01`, if you need to delete a large product, such as one that has many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nyou may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous\n[ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync)\nmutation.\n", + "args": [ + { + "name": "input", + "description": "Specifies the product to delete by its ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDeleteAsync", + "description": "Deletes a product asynchronously, including all associated variants and media.\n", + "args": [ + { + "name": "productId", + "description": "The ID of the product to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDeleteAsyncPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDeleteImages", + "description": "Removes product images from the product.", + "args": [ + { + "name": "id", + "description": "This is the ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "imageIds", + "description": "This is the array of image IDs to delete from the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDeleteImagesPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `productDeleteMedia` instead." + }, + { + "name": "productDeleteMedia", + "description": "Deletes media for a product.", + "args": [ + { + "name": "productId", + "description": "Specifies the product ID from which the media will be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mediaIds", + "description": "The media IDs to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDeleteMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDuplicate", + "description": "Duplicates a product.\n\nAs of API version `2023-01`, if you need to duplicate a large product, such as one that has many\n[variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput)\nthat are active at several\n[locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput),\nyou may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous\n[ProductDuplicateAsyncV2](https://shopify.dev/api/admin-graphql/latest/mutations/productDuplicateAsyncV2)\nmutation.\n", + "args": [ + { + "name": "productId", + "description": "The ID of the product to be duplicated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newTitle", + "description": "The new title of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newStatus", + "description": "The new status of the product. If no value is provided the status will be inherited from the original product.", + "type": { + "kind": "ENUM", + "name": "ProductStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeImages", + "description": "Specifies whether or not to duplicate images.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDuplicatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDuplicateAsync", + "description": "Asynchronously duplicate a single product.\n", + "args": [ + { + "name": "input", + "description": "The params for duplicating the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductDuplicateAsyncInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDuplicateAsyncPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `productDuplicateAsyncV2` instead." + }, + { + "name": "productDuplicateAsyncV2", + "description": "Asynchronously duplicate a single product.\n", + "args": [ + { + "name": "input", + "description": "The params for duplicating the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductDuplicateAsyncInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductDuplicateAsyncV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFeedCreate", + "description": "Creates a product feed for a specific publication.", + "args": [ + { + "name": "input", + "description": "The properties of the new product feed.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductFeedInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductFeedCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFeedDelete", + "description": "Deletes a product feed for a specific publication.", + "args": [ + { + "name": "id", + "description": "The ID of the product feed to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductFeedDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFullSync", + "description": "Runs the full product sync for a given shop.", + "args": [ + { + "name": "beforeUpdatedAt", + "description": "Syncs only products that haven't changed since the specified timestamp.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The product feed which needs syncing.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "updatedAtSince", + "description": "Syncs only products that have changed since the specified timestamp.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductFullSyncPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productImageUpdate", + "description": "Updates an image of a product.", + "args": [ + { + "name": "productId", + "description": "The ID of the product on which to update the image.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "image", + "description": "Image to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ImageInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductImageUpdatePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `productUpdateMedia` instead." + }, + { + "name": "productJoinSellingPlanGroups", + "description": "Adds multiple selling plan groups to a product.\n", + "args": [ + { + "name": "id", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupIds", + "description": "The IDs of the selling plan groups to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductJoinSellingPlanGroupsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productLeaveSellingPlanGroups", + "description": "Removes multiple groups from a product.\n", + "args": [ + { + "name": "id", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupIds", + "description": "The IDs of the selling plan groups to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductLeaveSellingPlanGroupsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productPublish", + "description": "Publishes a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be published on online stores.", + "args": [ + { + "name": "input", + "description": "Specifies the product to publish and the channels to publish it to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductPublishInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductPublishPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publishablePublish` instead." + }, + { + "name": "productReorderImages", + "description": "Asynchronously reorders a set of images for a given product.", + "args": [ + { + "name": "id", + "description": "The ID of the product on which to reorder images.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "moves", + "description": "A list of moves to perform which will be evaluated in order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoveInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductReorderImagesPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `productReorderMedia` instead." + }, + { + "name": "productReorderMedia", + "description": "Asynchronously reorders the media attached to a product.", + "args": [ + { + "name": "id", + "description": "The ID of the product on which to reorder medias.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "moves", + "description": "A list of moves to perform which will be evaluated in order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoveInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductReorderMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productUnpublish", + "description": "Unpublishes a product.", + "args": [ + { + "name": "input", + "description": "Specifies the product to unpublish and the channel to unpublish it from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductUnpublishInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductUnpublishPayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publishableUnpublish` instead." + }, + { + "name": "productUpdate", + "description": "Updates a product. If you update a product and only include some variants in the update,\nthen any variants not included will be deleted. To safely manage variants without the risk of\ndeleting excluded variants, use\n[productVariantsBulkUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantsbulkupdate).\nIf you want to update a single variant, then use\n[productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate).\n", + "args": [ + { + "name": "input", + "description": "The updated properties for a product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "List of new media to be added to the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productUpdateMedia", + "description": "Updates media for a product.", + "args": [ + { + "name": "productId", + "description": "Specifies the product on which media will be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "A list of media updates.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateMediaInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductUpdateMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantAppendMedia", + "description": "Appends media from a product to variants of the product.", + "args": [ + { + "name": "productId", + "description": "Specifies the product associated to the media.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantMedia", + "description": "A list of pairs of variants and media to be attached to the variants.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantAppendMediaInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantAppendMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantCreate", + "description": "Creates a product variant.", + "args": [ + { + "name": "input", + "description": "The properties for the new product variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantDelete", + "description": "Deletes a product variant.", + "args": [ + { + "name": "id", + "description": "The ID of the product variant to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantDetachMedia", + "description": "Detaches media from product variants.", + "args": [ + { + "name": "productId", + "description": "Specifies the product to which the variants and media are associated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantMedia", + "description": "A list of pairs of variants and media to be deleted from the variants.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantDetachMediaInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantDetachMediaPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantJoinSellingPlanGroups", + "description": "Adds multiple selling plan groups to a product variant.\n", + "args": [ + { + "name": "id", + "description": "The ID of the product variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupIds", + "description": "The IDs of the selling plan groups to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantJoinSellingPlanGroupsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantLeaveSellingPlanGroups", + "description": "Remove multiple groups from a product variant.\n", + "args": [ + { + "name": "id", + "description": "The ID of the product variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanGroupIds", + "description": "The IDs of the selling plan groups to leave.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantLeaveSellingPlanGroupsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantRelationshipBulkUpdate", + "description": "Creates new bundles, updates existing bundles, and removes bundle components for one or multiple bundles.", + "args": [ + { + "name": "input", + "description": "The input options for the product variant being updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantRelationshipUpdateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantRelationshipBulkUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantUpdate", + "description": "Updates a product variant.", + "args": [ + { + "name": "input", + "description": "The updated properties for the product variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantsBulkCreate", + "description": "Creates product variants in bulk. If you want to create a single variant, then use\n[productVariantCreate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantcreate).\n", + "args": [ + { + "name": "variants", + "description": "An array of product variants to be created.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantsBulkInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The ID of the product on which to create the variants.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "List of new media to be added to the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantsBulkCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantsBulkDelete", + "description": "Deletes product variants in bulk. If you want to delete a single variant, then use\n[productVariantDelete](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantdelete).\n", + "args": [ + { + "name": "variantsIds", + "description": "An array of product variants IDs to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The ID of the product with the variants to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantsBulkDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantsBulkReorder", + "description": "Reorder product variants in bulk.", + "args": [ + { + "name": "productId", + "description": "The product ID of the variants to be reordered.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "positions", + "description": "An array of variant positions.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantPositionInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantsBulkReorderPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantsBulkUpdate", + "description": "Updates product variants in bulk. If you want to update a single variant, then use\n[productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate).\n", + "args": [ + { + "name": "variants", + "description": "An array of product variants to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantsBulkInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The ID of the product associated with the variants to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "media", + "description": "List of new media to be added to the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateMediaInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "allowPartialUpdates", + "description": "When partial updates are allowed, valid variant changes may be persisted even if some of\nthe variants updated have invalid data and cannot be persisted.\nWhen partial updates are not allowed, any error will prevent all variants from updating.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pubSubServerPixelUpdate", + "description": "Updates the server pixel to connect to a Google PubSub endpoint.\nRunning this mutation deletes any previous subscriptions for the server pixel.\n", + "args": [ + { + "name": "pubSubProject", + "description": "The Google PubSub project ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pubSubTopic", + "description": "The Google PubSub topic ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PubSubServerPixelUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pubSubWebhookSubscriptionCreate", + "description": "Creates a new Google Cloud Pub/Sub webhook subscription.", + "args": [ + { + "name": "topic", + "description": "The type of event that triggers the webhook.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PubSubWebhookSubscriptionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pubSubWebhookSubscriptionUpdate", + "description": "Updates a Google Cloud Pub/Sub webhook subscription.", + "args": [ + { + "name": "id", + "description": "The ID of the webhook subscription to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for a Google Cloud Pub/Sub webhook subscription.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PubSubWebhookSubscriptionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationCreate", + "description": "Creates a publication.\n", + "args": [ + { + "name": "input", + "description": "The input fields to use when creating the publication.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PublicationCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublicationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationDelete", + "description": "Deletes a publication.\n", + "args": [ + { + "name": "id", + "description": "The ID of the publication to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublicationDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationUpdate", + "description": "Updates a publication.\n", + "args": [ + { + "name": "id", + "description": "The ID of the publication to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The input fields to use when updating the publication.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PublicationUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublicationUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishablePublish", + "description": "Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores.", + "args": [ + { + "name": "id", + "description": "The resource to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Specifies the input fields required to publish a resource.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublishablePublishPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishablePublishToCurrentChannel", + "description": "Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can be published only on online stores.", + "args": [ + { + "name": "id", + "description": "The resource to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublishablePublishToCurrentChannelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishableUnpublish", + "description": "Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is `active`.", + "args": [ + { + "name": "id", + "description": "The resource to delete or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Specifies the input fields required to unpublish a resource.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublishableUnpublishPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishableUnpublishToCurrentChannel", + "description": "Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is `active`.", + "args": [ + { + "name": "id", + "description": "The resource to delete or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublishableUnpublishToCurrentChannelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityRulesAdd", + "description": "Creates or updates existing quantity rules on a price list.\nYou can use the `quantityRulesAdd` mutation to set order level minimums, maximumums and increments for specific product variants.\n", + "args": [ + { + "name": "priceListId", + "description": "The ID of the price list to which the quantity rules will be added or updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantityRules", + "description": "The list of quantity rules to add or update in the price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "QuantityRuleInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "QuantityRulesAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityRulesDelete", + "description": "Deletes specific quantity rules from a price list using a product variant ID.\nYou can use the `quantityRulesDelete` mutation to delete a set of quantity rules from a price list.\n", + "args": [ + { + "name": "priceListId", + "description": "The ID of the price list from which the quantity rules will be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantIds", + "description": "A list of product variant IDs whose quantity rules will be removed from the price list.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "QuantityRulesDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundCreate", + "description": "Creates a refund.", + "args": [ + { + "name": "input", + "description": "The input fields that are used in the mutation for creating a refund.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RefundCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnApproveRequest", + "description": "Approves a customer's return request.\nIf this mutation is successful, then the `Return.status` field of the\napproved return is set to `OPEN`.\n", + "args": [ + { + "name": "input", + "description": "The input fields to approve a return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnApproveRequestInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnApproveRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnCancel", + "description": "Cancels a return and restores the items back to being fulfilled.\nCanceling a return is only available before any work has been done\non the return (such as an inspection or refund).\n", + "args": [ + { + "name": "id", + "description": "The ID of the return to cancel.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "Whether the customer receives an email notification regarding the canceled return.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnCancelPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnClose", + "description": "Indicates a return is complete, either when a refund has been made and items restocked,\nor simply when it has been marked as returned in the system.\n", + "args": [ + { + "name": "id", + "description": "The ID of the return to close.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnClosePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnCreate", + "description": "Creates a return.", + "args": [ + { + "name": "returnInput", + "description": "Specifies the input fields for a return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnDeclineRequest", + "description": "Declines a return on an order.\nWhen a return is declined, each `ReturnLineItem.fulfillmentLineItem` can be associated to a new return.\nUse the `ReturnCreate` or `ReturnRequest` mutation to initiate a new return.\n", + "args": [ + { + "name": "input", + "description": "The input fields for declining a customer's return request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnDeclineRequestInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnDeclineRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnRefund", + "description": "Refunds a return and associates it with the related return request.", + "args": [ + { + "name": "returnRefundInput", + "description": "The input fields to refund a return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnRefundPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnReopen", + "description": "Reopens a closed return.", + "args": [ + { + "name": "id", + "description": "The ID of the return to reopen.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnReopenPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnRequest", + "description": "A customer's return request that hasn't been approved or declined.\nThis mutation sets the value of the `Return.status` field to `REQUESTED`.\nTo create a return that has the `Return.status` field set to `OPEN`, use the `returnCreate` mutation.\n", + "args": [ + { + "name": "input", + "description": "The input fields for requesting a return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRequestInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnRequestPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDeliveryCreateWithShipping", + "description": "Creates a new reverse delivery with associated external shipping information.", + "args": [ + { + "name": "reverseFulfillmentOrderId", + "description": "The ID of the reverse fulfillment order that's associated to the reverse delivery.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "reverseDeliveryLineItems", + "description": "The reverse delivery line items to be created. If an empty array is provided, then this mutation\n will create a reverse delivery line item for each reverse fulfillment order line item, with its quantity equal\n to the reverse fulfillment order line item total quantity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "trackingInput", + "description": "The tracking information for the reverse delivery.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryTrackingInput", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "labelInput", + "description": "The return label file information for the reverse delivery.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryLabelInput", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "notifyCustomer", + "description": "When `true` the customer is notified with delivery instructions if the `ReverseFulfillmentOrder.order.email` is present.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseDeliveryCreateWithShippingPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDeliveryDispose", + "description": "Disposes reverse delivery line items for a reverse delivery on the same shop.\n", + "args": [ + { + "name": "dispositionInputs", + "description": "The input parameters required to dispose reverse delivery line items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryDisposeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseDeliveryDisposePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDeliveryShippingUpdate", + "description": "Updates a reverse delivery with associated external shipping information.", + "args": [ + { + "name": "reverseDeliveryId", + "description": "The ID of the reverse delivery to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "trackingInput", + "description": "The tracking information for the reverse delivery.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryTrackingInput", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "labelInput", + "description": "The return label file information for the reverse delivery.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryLabelInput", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "notifyCustomer", + "description": "If `true` and an email address exists on the `ReverseFulfillmentOrder.order`, then the customer is notified with the updated delivery instructions.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseDeliveryShippingUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseFulfillmentOrderDispose", + "description": "Disposes reverse fulfillment order line items.\n", + "args": [ + { + "name": "dispositionInputs", + "description": "The input parameters required to dispose reverse fulfillment order line items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReverseFulfillmentOrderDisposeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "savedSearchCreate", + "description": "Creates a saved search.", + "args": [ + { + "name": "input", + "description": "Specifies the input fields for a saved search.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SavedSearchCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SavedSearchCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "savedSearchDelete", + "description": "Delete a saved search.", + "args": [ + { + "name": "input", + "description": "The input fields to delete a saved search.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SavedSearchDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SavedSearchDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "savedSearchUpdate", + "description": "Updates a saved search.", + "args": [ + { + "name": "input", + "description": "The input fields to update a saved search.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SavedSearchUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SavedSearchUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scriptTagCreate", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nCreates a new script tag.\n", + "args": [ + { + "name": "input", + "description": "The input fields for a script tag.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ScriptTagInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ScriptTagCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scriptTagDelete", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nDeletes a script tag.\n", + "args": [ + { + "name": "id", + "description": "The ID of the script tag to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ScriptTagDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scriptTagUpdate", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nUpdates a script tag.\n", + "args": [ + { + "name": "id", + "description": "The ID of the script tag to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Specifies the input fields for a script tag.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ScriptTagInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ScriptTagUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentCreate", + "description": "Creates a segment.", + "args": [ + { + "name": "name", + "description": "The name of the segment to be created. Segment names must be unique.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "query", + "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SegmentCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentDelete", + "description": "Deletes a segment.", + "args": [ + { + "name": "id", + "description": "Specifies the segment to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SegmentDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentUpdate", + "description": "Updates a segment.", + "args": [ + { + "name": "id", + "description": "Specifies the segment to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The new name for the segment.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SegmentUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupAddProductVariants", + "description": "Adds multiple product variants to a selling plan group.\n", + "args": [ + { + "name": "id", + "description": "The ID of the selling plan group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productVariantIds", + "description": "The IDs of the product variants to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupAddProductVariantsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupAddProducts", + "description": "Adds multiple products to a selling plan group.\n", + "args": [ + { + "name": "id", + "description": "The ID of the selling plan group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of the products to add.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupAddProductsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupCreate", + "description": "Creates a Selling Plan Group.", + "args": [ + { + "name": "input", + "description": "The properties of the new Selling Plan Group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanGroupInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "resources", + "description": "The resources this Selling Plan Group should be applied to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanGroupResourceInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupDelete", + "description": "Delete a Selling Plan Group.", + "args": [ + { + "name": "id", + "description": "The id of the selling plan group to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupRemoveProductVariants", + "description": "Removes multiple product variants from a selling plan group.\n", + "args": [ + { + "name": "id", + "description": "The ID of the selling plan group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productVariantIds", + "description": "The IDs of the product variants to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupRemoveProductVariantsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupRemoveProducts", + "description": "Removes multiple products from a selling plan group.\n", + "args": [ + { + "name": "id", + "description": "The ID of the selling plan group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of the products to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupRemoveProductsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupUpdate", + "description": "Update a Selling Plan Group.", + "args": [ + { + "name": "id", + "description": "The Selling Plan Group to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the Selling Plan Group to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanGroupInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroupUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serverPixelCreate", + "description": "Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixelCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serverPixelDelete", + "description": "Deletes the Server Pixel associated with the current app & shop.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixelDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingPackageDelete", + "description": "Deletes a shipping package.", + "args": [ + { + "name": "id", + "description": "The ID of the shipping package to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShippingPackageDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingPackageMakeDefault", + "description": "Set a shipping package as the default.\nThe default shipping package is the one used to calculate shipping costs on checkout.\n", + "args": [ + { + "name": "id", + "description": "The ID of the shipping package to set as the default.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShippingPackageMakeDefaultPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingPackageUpdate", + "description": "Updates a shipping package.", + "args": [ + { + "name": "id", + "description": "The ID of the shipping package to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shippingPackage", + "description": "Specifies the input fields for a shipping package.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomShippingPackageInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShippingPackageUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopLocaleDisable", + "description": "Deletes a locale for a shop. This also deletes all translations of this locale.", + "args": [ + { + "name": "locale", + "description": "ISO code of the locale to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopLocaleDisablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopLocaleEnable", + "description": "Adds a locale for a shop. The newly added locale is in the unpublished state.", + "args": [ + { + "name": "locale", + "description": "ISO code of the locale to enable.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketWebPresenceIds", + "description": "The list of markets web presences to add the locale to.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopLocaleEnablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopLocaleUpdate", + "description": "Updates a locale for a shop.", + "args": [ + { + "name": "locale", + "description": "ISO code of the locale to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shopLocale", + "description": "Specifies the input fields for a shop locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShopLocaleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopLocaleUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopPolicyUpdate", + "description": "Updates a shop policy.", + "args": [ + { + "name": "shopPolicy", + "description": "The properties to use when updating the shop policy.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShopPolicyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopPolicyUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopResourceFeedbackCreate", + "description": "The `ResourceFeedback` object lets your app report the status of shops and their resources. For example, if\nyour app is a marketplace channel, then you can use resource feedback to alert merchants that they need to connect their marketplace account by signing in.\n\nResource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app.\n\nThis resource should be used only in cases where you're describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don't use resource feedback to let merchants know about them.\n\n## Sending feedback on a shop\n\nYou can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: `requires_action` or `success`. You need to send a `requires_action` feedback request for each step that the merchant is required to complete.\n\nIf there are multiple set-up steps that require merchant action, then send feedback with a state of `requires_action` as merchants complete prior steps. And to remove the feedback message from the Shopify admin, send a `success` feedback request.\n\n#### Important\nSending feedback replaces previously sent feedback for the shop. Send a new `shopResourceFeedbackCreate` mutation to push the latest state of a shop or its resources to Shopify.\n", + "args": [ + { + "name": "input", + "description": "The fields required to create shop feedback.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ResourceFeedbackCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopResourceFeedbackCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stagedUploadTargetGenerate", + "description": "Generates the URL and signed paramaters needed to upload an asset to Shopify.", + "args": [ + { + "name": "input", + "description": "The input fields for generating a staged upload.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "StagedUploadTargetGenerateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StagedUploadTargetGeneratePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `stagedUploadsCreate` instead." + }, + { + "name": "stagedUploadTargetsGenerate", + "description": "Uploads multiple images.", + "args": [ + { + "name": "input", + "description": "The input fields for generating staged uploads.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "StageImageInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StagedUploadTargetsGeneratePayload", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `stagedUploadsCreate` instead." + }, + { + "name": "stagedUploadsCreate", + "description": "Creates staged upload targets for each input. This is the first step in the upload process.\nThe returned staged upload targets' URL and parameter fields can be used to send a request\nto upload the file described in the corresponding input.\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", + "args": [ + { + "name": "input", + "description": "The information required to generate staged upload targets.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "StagedUploadInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StagedUploadsCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardMetafieldDefinitionEnable", + "description": "Activates the specified standard metafield definition from its template.\n\nRefer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions).\n", + "args": [ + { + "name": "ownerType", + "description": "The resource type that the metafield definition is scoped to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The ID of the standard metafield definition template to enable.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The namespace of the standard metafield to enable. Used in combination with `key`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key of the standard metafield to enable. Used in combination with `namespace`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pin", + "description": "Whether to pin the metafield definition.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + }, + { + "name": "visibleToStorefrontApi", + "description": "Whether metafields for the definition are visible using the Storefront API.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "useAsCollectionCondition", + "description": "Whether the metafield definition can be used as a collection condition.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionEnablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardMetaobjectDefinitionEnable", + "description": "Enables the specified standard metaobject definition from its template.\n", + "args": [ + { + "name": "type", + "description": "The type of the metaobject definition to enable.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StandardMetaobjectDefinitionEnablePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontAccessTokenCreate", + "description": "Creates a storefront access token. An app can have a maximum of 100 active storefront access tokens for each shop.", + "args": [ + { + "name": "input", + "description": "Provides the input fields for creating a storefront access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "StorefrontAccessTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StorefrontAccessTokenCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontAccessTokenDelete", + "description": "Deletes a storefront access token.", + "args": [ + { + "name": "input", + "description": "Provides the input fields required to delete a storefront access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "StorefrontAccessTokenDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StorefrontAccessTokenDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingAttemptCreate", + "description": "Creates a new subscription billing attempt. For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt).\n", + "args": [ + { + "name": "subscriptionContractId", + "description": "The ID of the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "subscriptionBillingAttemptInput", + "description": "The information to apply as a billing attempt.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingAttemptInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleContractDraftCommit", + "description": "Commits the updates of a Subscription Billing Cycle Contract draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to commit.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractDraftCommitPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleContractDraftConcatenate", + "description": "Concatenates a contract to a Subscription Draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "concatenatedBillingCycleContracts", + "description": "An array of Subscription Contracts with their selected billing cycles to concatenate to the subscription draft.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractDraftConcatenatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleContractEdit", + "description": "Edit the contents of a subscription contract for the specified billing cycle.", + "args": [ + { + "name": "billingCycleInput", + "description": "Input object for selecting and using billing cycles.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractEditPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleEditDelete", + "description": "Delete the schedule and contract edits of the selected subscription billing cycle.", + "args": [ + { + "name": "billingCycleInput", + "description": "Input object used to select and use billing cycles.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleEditsDelete", + "description": "Delete the current and future schedule and contract edits of a list of subscription billing cycles.", + "args": [ + { + "name": "contractId", + "description": "The globally-unique identifier of the subscription contract that the billing cycle belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "targetSelection", + "description": "Select billing cycles to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesTargetSelection", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditsDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycleScheduleEdit", + "description": "Modify the schedule of a specific billing cycle.", + "args": [ + { + "name": "billingCycleInput", + "description": "Input object for selecting and using billing cycles.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Data used to create or modify billing cycle schedule edit.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleScheduleEditInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleScheduleEditPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContractAtomicCreate", + "description": "Creates a Subscription Contract.", + "args": [ + { + "name": "input", + "description": "The properties of the new Subscription Contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractAtomicCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContractAtomicCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContractCreate", + "description": "Creates a Subscription Contract.", + "args": [ + { + "name": "input", + "description": "The properties of the new Subscription Contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContractCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContractProductChange", + "description": "Allows for the easy change of a Product in a Contract or a Product price change.", + "args": [ + { + "name": "subscriptionContractId", + "description": "The ID of the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineId", + "description": "The gid of the Subscription Line to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the Product changes.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractProductChangeInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContractProductChangePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContractSetNextBillingDate", + "description": "Sets the next billing date of a Subscription Contract.", + "args": [ + { + "name": "contractId", + "description": "The gid of the Subscription Contract to set the next billing date for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "date", + "description": "The next billing date.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContractSetNextBillingDatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContractUpdate", + "description": "Updates a Subscription Contract.", + "args": [ + { + "name": "contractId", + "description": "The gid of the Subscription Contract to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContractUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftCommit", + "description": "Commits the updates of a Subscription Contract draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to commit.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftCommitPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftDiscountAdd", + "description": "Adds a subscription discount to a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The ID of the Subscription Contract draft to add a subscription discount to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the new Subscription Discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftDiscountCodeApply", + "description": "Applies a code discount on the subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the subscription contract draft to apply a subscription code discount on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "redeemCode", + "description": "Code discount redeem code.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountCodeApplyPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftDiscountRemove", + "description": "Removes a subscription discount from a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the subscription contract draft to remove a subscription discount from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discountId", + "description": "The gid of the subscription draft discount to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftDiscountUpdate", + "description": "Updates a subscription discount on a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The ID of the Subscription Contract draft to update a subscription discount on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discountId", + "description": "The gid of the Subscription Discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties to update on the Subscription Discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftFreeShippingDiscountAdd", + "description": "Adds a subscription free shipping discount to a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The ID of the subscription contract draft to add a subscription free shipping discount to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the new subscription free shipping discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionFreeShippingDiscountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftFreeShippingDiscountAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftFreeShippingDiscountUpdate", + "description": "Updates a subscription free shipping discount on a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The ID of the Subscription Contract draft to update a subscription discount on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discountId", + "description": "The gid of the Subscription Discount to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties to update on the Subscription Free Shipping Discount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionFreeShippingDiscountInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftFreeShippingDiscountUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftLineAdd", + "description": "Adds a subscription line to a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to add a subscription line to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the new Subscription Line.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionLineInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftLineAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftLineRemove", + "description": "Removes a subscription line from a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to remove a subscription line from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineId", + "description": "The gid of the Subscription Line to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftLineRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftLineUpdate", + "description": "Updates a subscription line on a subscription draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Contract draft to update a subscription line from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineId", + "description": "The gid of the Subscription Line to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the new Subscription Line.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionLineUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftLineUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraftUpdate", + "description": "Updates a Subscription Draft.", + "args": [ + { + "name": "draftId", + "description": "The gid of the Subscription Draft to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The properties of the new Subscription Contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDraftInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraftUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tagsAdd", + "description": "Add tags to an order, a draft order, a customer, a product, or an online store article.", + "args": [ + { + "name": "id", + "description": "The ID of a resource to add tags to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TagsAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tagsRemove", + "description": "Remove tags from an order, a draft order, a customer, a product, or an online store article.", + "args": [ + { + "name": "id", + "description": "The ID of the resource to remove tags from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A list of tags to remove from the resource in the form of an array of strings. Example value: `[\"tag1\", \"tag2\", \"tag3\"]`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TagsRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxAppConfigure", + "description": "Allows tax app configurations for tax partners.\n", + "args": [ + { + "name": "ready", + "description": "Configures whether the tax app is correctly configured and ready to be used.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TaxAppConfigurePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translationsRegister", + "description": "Creates or updates translations.", + "args": [ + { + "name": "resourceId", + "description": "ID of the resource that is being translated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "translations", + "description": "Specifies the input fields for a translation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "TranslationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TranslationsRegisterPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translationsRemove", + "description": "Deletes translations.", + "args": [ + { + "name": "resourceId", + "description": "ID of the translatable resource for which translations are being deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "translationKeys", + "description": "The list of translation keys.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "locales", + "description": "The list of translation locales. Only locales returned in `shopLocales` are valid.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "marketIds", + "description": "The list of market IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TranslationsRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectBulkDeleteAll", + "description": "Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteAllPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectBulkDeleteByIds", + "description": "Asynchronously delete [URLRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) \nobjects in bulk by IDs.\nLearn more about [URLRedirect](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect) \nobjects.\n", + "args": [ + { + "name": "ids", + "description": "A list of [`URLRedirect`](\n https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect\n ) object IDs to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteByIdsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectBulkDeleteBySavedSearch", + "description": "Asynchronously delete redirects in bulk.", + "args": [ + { + "name": "savedSearchId", + "description": "The ID of the URL redirect saved search for filtering.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySavedSearchPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectBulkDeleteBySearch", + "description": "Asynchronously delete redirects in bulk.", + "args": [ + { + "name": "search", + "description": "Search query for filtering redirects on (both Redirect from and Redirect to fields).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySearchPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectCreate", + "description": "Creates a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.\n", + "args": [ + { + "name": "urlRedirect", + "description": "The fields to use when creating the redirect.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UrlRedirectInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectDelete", + "description": "Deletes a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.\n", + "args": [ + { + "name": "id", + "description": "The ID of the redirect to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectImportCreate", + "description": "Creates a [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object.\n\nAfter creating the `UrlRedirectImport` object, the `UrlRedirectImport` request can be performed using the [`urlRedirectImportSubmit`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportSubmit) mutation.\n", + "args": [ + { + "name": "url", + "description": "The staged upload URL of the CSV file.\nYou can download [a sample URL redirect CSV file](https://help.shopify.com/csv/sample-redirect-template.csv)).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectImportCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectImportSubmit", + "description": "Submits a `UrlRedirectImport` request to be processed.\n\nThe `UrlRedirectImport` request is first created with the [`urlRedirectImportCreate`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate) mutation.\n", + "args": [ + { + "name": "id", + "description": "The ID of the [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectImportSubmitPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectUpdate", + "description": "Updates a URL redirect.\n", + "args": [ + { + "name": "id", + "description": "The ID of the URL redirect to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "urlRedirect", + "description": "The input fields required to update the URL redirect.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UrlRedirectInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixelCreate", + "description": "Creates a new web pixel settings.", + "args": [ + { + "name": "webPixel", + "description": "The web pixel settings in JSON format.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WebPixelInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebPixelCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixelDelete", + "description": "Deletes the web pixel shop settings.", + "args": [ + { + "name": "id", + "description": "The ID of the web pixel to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebPixelDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixelUpdate", + "description": "Updates the web pixel settings.", + "args": [ + { + "name": "id", + "description": "The ID of the web pixel to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webPixel", + "description": "The web pixel settings in JSON format.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WebPixelInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebPixelUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscriptionCreate", + "description": "Creates a new webhook subscription.\n", + "args": [ + { + "name": "topic", + "description": "The type of event that triggers the webhook.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for a webhook subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WebhookSubscriptionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscriptionCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscriptionDelete", + "description": "Deletes a webhook subscription.\n", + "args": [ + { + "name": "id", + "description": "The ID of the webhook subscription to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscriptionDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscriptionUpdate", + "description": "Updates a webhook subscription.\n", + "args": [ + { + "name": "id", + "description": "The ID of the webhook subscription to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "webhookSubscription", + "description": "Specifies the input fields for a webhook subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "WebhookSubscriptionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscriptionUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MutationsStagedUploadTargetGenerateUploadParameter", + "description": "A signed upload parameter for uploading an asset to Shopify.\n\nDeprecated in favor of\n[StagedUploadParameter](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadParameter),\nwhich is used in\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget)\nand returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", + "fields": [ + { + "name": "name", + "description": "The upload parameter name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The upload parameter value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "description": "A default cursor that you can use in queries to paginate your results. Each edge in a connection can\nreturn a cursor, which is a reference to the edge's position in the connection. You can use an edge's cursor as\nthe starting point to retrieve the nodes before or after it in a connection.\n\nTo learn more about using cursor-based pagination, refer to\n[Paginating results with GraphQL](https://shopify.dev/api/usage/pagination-graphql).\n", + "fields": [ + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AbandonedCheckout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreArticle", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "NavigationItem", + "description": "A navigation item, holding basic link attributes.", + "fields": [ + { + "name": "id", + "description": "The unique identifier of the navigation item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the navigation item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the page that the navigation item links to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "description": "An object with an ID field to support global identification, in accordance with the\n[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).\nThis interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)\nand [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AbandonedCheckout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Abandonment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AddAllProductsOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AdditionalFee", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppCatalog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppCredit", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppPurchaseOneTime", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppRevenueAttributionRecord", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppSubscription", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AppUsageRecord", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BasicEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BulkOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartTransform", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CatalogCsvOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ChannelDefinition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ChannelInformation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProfile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CommentEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyContactRoleAssignment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CompanyLocationCatalog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQuery", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerVisit", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCondition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCountry", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryLocationGroup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethod", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryMethodDefinition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryParticipant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProfileItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryProvince", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryRateDefinition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DeliveryZone", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticBxgy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DraftOrderTag", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Duty", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ExchangeV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ExternalVideo", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderDestination", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentOrderMerchantRequest", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryAdjustmentGroup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "LineItemMutable", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketCatalog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketRegionCountry", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketWebPresence", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreArticle", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreBlog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderDisputeSummary", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentMandate", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentSchedule", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsTemplate", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductFeed", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductTaxonomyNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantComponent", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PublicationResourceOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReturnLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposition", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SaleAdditionalFee", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ServerPixel", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsAccount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEvidence", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFulfillment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerification", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplate", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessToken", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TenderTransaction", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TransactionFee", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImport", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "WebPixel", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "ObjectDimensionsInput", + "description": "The input fields for dimensions of an object.", + "fields": null, + "inputFields": [ + { + "name": "length", + "description": "The length in `unit`s.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width in `unit`s.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "height", + "description": "The height in `unit`s.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "unit", + "description": "Unit of measurement for `length`, `width`, and `height`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LengthUnit", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreArticle", + "description": "An article in the blogging system. You can query articles from\n[the REST API](https://shopify.dev/api/admin-rest/latest/resources/article)\nif you need to access more information about an article. Currently, `OnlineStoreArticle` is\nonly useful to pass an article `id` to the `tagsAdd` mutation. For more information, refer to\nthe [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd) mutation.\n", + "fields": [ + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OnlineStoreBlog", + "description": "Shopify stores come with a built-in blogging engine, allowing a shop to have one or more blogs. Blogs are meant\nto be used as a type of magazine or newsletter for the shop, with content that changes over time.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OnlineStorePage", + "description": "A custom page on the Online Store.", + "fields": [ + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePreviewable", + "description": "Online Store preview URL of the object.", + "fields": [ + { + "name": "onlineStorePreviewUrl", + "description": "The online store preview URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Order", + "description": "An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the `Order` object.\nLearn more about\n[editing an existing order with the GraphQL Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).\n\nOnly the last 60 days' worth of orders from a store are accessible from the `Order` object by default. If you want to access older orders,\nthen you need to [request access to all orders](https://shopify.dev/api/usage/access-scopes#orders-permissions). If your app is granted\naccess, then you can add the `read_all_orders` scope to your app along with `read_orders` or `write_orders`.\n[Private apps](https://shopify.dev/apps/auth/basic-http) are not affected by this change and are automatically granted the scope.\n\n**Caution:** Only use this data if it's required for your app's functionality. Shopify will restrict [access to scopes](https://shopify.dev/api/usage/access-scopes) for apps that don't have a legitimate use for the associated data.\n", + "fields": [ + { + "name": "additionalFees", + "description": "A list of addtional fees applied to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AdditionalFee", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "agreements", + "description": "A list of sales agreements associated with the order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `happened_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesAgreementConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alerts", + "description": "A list of messages that appear on the order page in the Shopify admin.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourceAlert", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "The application that created the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddress", + "description": "The billing address of the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddressMatchesShippingAddress", + "description": "Whether the billing address matches the shipping address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canMarkAsPaid", + "description": "Whether the order can be manually marked as paid.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canNotifyCustomer", + "description": "Whether a customer email exists for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelReason", + "description": "The reason provided when the order was canceled.\nReturns `null` if the order wasn't canceled.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderCancelReason", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelledAt", + "description": "The date and time when the order was canceled.\nReturns `null` if the order wasn't canceled.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "capturable", + "description": "Whether payment for the order can be captured.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartDiscountAmount", + "description": "The total order-level discount amount, before returns, in shop currency.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `cartDiscountAmountSet` instead." + }, + { + "name": "cartDiscountAmountSet", + "description": "The total order-level discount amount, before returns, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channel", + "description": "The channel that created the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publication` instead." + }, + { + "name": "channelInformation", + "description": "Details about the channel that created the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ChannelInformation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "clientIp", + "description": "The IP address of the API client that created the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "closed", + "description": "Whether the order is closed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "closedAt", + "description": "The date and time when the order was closed.\nReturns `null` if the order isn't closed.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmationNumber", + "description": "A randomly generated alpha-numeric identifier for the order that may be shown to the customer\ninstead of the sequential order name. For example, \"XPAV284CT\", \"R50KELTJP\" or \"35PKUN0UJ\".\nThis value isn't guaranteed to be unique.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "confirmed", + "description": "Whether inventory has been reserved for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "Date and time when the order was created in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The shop currency when the order was placed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentCartDiscountAmountSet", + "description": "The current order-level discount amount after all order updates, in shop and presentment currencies.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentSubtotalLineItemsQuantity", + "description": "The sum of the quantities for all line items that contribute to the order's current subtotal price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentSubtotalPriceSet", + "description": "The sum of the prices for all line items after discounts and returns, in shop and presentment currencies.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTaxLines", + "description": "A list of all tax lines applied to line items on the order, after returns.\nTax line prices represent the total price for all tax lines with the same `rate` and `title`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalAdditionalFeesSet", + "description": "The total amount of additional fees after returns, in shop and presentment currencies.\nReturns `null` if there are no additional fees for the order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalDiscountsSet", + "description": "The total amount discounted on the order after returns, in shop and presentment currencies.\nThis includes both order and line level discounts.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalDutiesSet", + "description": "The total amount of duties after returns, in shop and presentment currencies.\nReturns `null` if duties aren't applicable.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalPriceSet", + "description": "The total price of the order, after returns, in shop and presentment currencies.\nThis includes taxes and discounts.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalTaxSet", + "description": "The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalWeight", + "description": "The total weight of the order after returns, in grams.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes added to the order.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer that placed the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAcceptsMarketing", + "description": "Whether the customer agreed to receive marketing materials.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerJourney", + "description": "The customer's visits and interactions with the online store before placing the order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerJourney", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary` instead." + }, + { + "name": "customerJourneySummary", + "description": "The customer's visits and interactions with the online store before placing the order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerJourneySummary", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerLocale", + "description": "A two-letter or three-letter language code, optionally followed by a region modifier.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplications", + "description": "A list of discounts that are applied to the order, not including order edits and refunds.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountApplicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCode", + "description": "The discount code used for the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodes", + "description": "The discount codes used for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayAddress", + "description": "The primary address of the customer.\nReturns `null` if neither the shipping address nor the billing address was provided.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayFinancialStatus", + "description": "The financial status of the order that can be shown to the merchant.\nThis field doesn't capture all the details of an order's financial state. It should only be used for display summary purposes.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderDisplayFinancialStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayFulfillmentStatus", + "description": "The fulfillment status for the order that can be shown to the merchant.\nThis field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderDisplayFulfillmentStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disputes", + "description": "A list of the disputes associated with the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderDisputeSummary", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "edited", + "description": "Whether the order has had any edits applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address associated with the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedTaxes", + "description": "Whether taxes on the order are estimated.\nThis field returns `false` when taxes on the order are finalized and aren't subject to any changes.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "events", + "description": "A list of events associated with the order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exchangeV2s", + "description": "A list of ExchangeV2s for the order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `completed_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ExchangeV2Connection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillable", + "description": "Whether there are line items that can be fulfilled.\nThis field returns `false` when the order has no fulfillable line items.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrders", + "description": "A list of fulfillment orders for a specific order.\n\n[FulfillmentOrder API access scopes](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder#api-access-scopes)\ngovern which fulfillments orders are returned.\nAn API client will only receive a subset of the fulfillment orders which belong to an order\nif they don't have the necessary access scopes to view all of the fulfillment orders.\nIn the case that an API client does not have the access scopes necessary to view\nany of the fulfillment orders that belong to an order, an empty array will be returned.\n", + "args": [ + { + "name": "displayable", + "description": "Whether fulfillment orders that are hidden from the merchant are included.\nFor example, fulfillment orders that were closed after being combined or moved are hidden.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `assigned_location_id`\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillments", + "description": "List of shipments for the order.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullyPaid", + "description": "Whether the order has been paid in full.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Whether the merchant added a timeline comment to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "landingPageDisplayText", + "description": "The URL of the first page of the online store that the customer visited before they submitted the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary.lastVisit.landingPageHtml` instead" + }, + { + "name": "landingPageUrl", + "description": "The first page of the online store that the customer visited before they submitted the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary.lastVisit.landingPage` instead" + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "A list of the order's line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemsMutable", + "description": "A list of the order's line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemMutableConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `lineItems` instead." + }, + { + "name": "localizationExtensions", + "description": "List of localization extensions for the resource.", + "args": [ + { + "name": "countryCodes", + "description": "The country codes of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "purposes", + "description": "The purpose of the extensions.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizationExtensionPurpose", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocalizationExtensionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The fulfillment location that was assigned when the order was created.\nOrders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.location` field will only point to one of these locations.\nUse the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder)\nobject for up-to-date fulfillment location information.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `physicalLocation` instead." + }, + { + "name": "merchantEditable", + "description": "Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantEditableErrors", + "description": "A list of reasons why the order can't be edited. For example, \"Canceled orders can’t be edited\".\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantOfRecordApp", + "description": "The application acting as the Merchant of Record for the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderApp", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The unique identifier for the order that appears on the order page in the Shopify admin and the order status page.\nFor example, \"#1001\", \"EN1001\", or \"1001-A\".\nThis value isn't unique across multiple stores.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "netPayment", + "description": "The net payment for the order, based on the total amount received minus the total amount refunded, in shop currency.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `netPaymentSet` instead." + }, + { + "name": "netPaymentSet", + "description": "The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nonFulfillableLineItems", + "description": "A list of line items that can't be fulfilled.\nFor example, tips and fully refunded line items can't be fulfilled.\nFor a more granular view of the fulfillment status, refer to the [FulfillmentOrder](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentOrder) object.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The contents of the note associated with the order.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalAdditionalFeesSet", + "description": "The total amount of additional fees after returns, in shop and presentment currencies.\nReturns `null` if there are no additional fees for the order.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalDutiesSet", + "description": "The total amount of duties before returns, in shop and presentment currencies.\nReturns `null` if duties aren't applicable.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalPriceSet", + "description": "The total price of the order at the time of order creation, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCollectionDetails", + "description": "The payment collection details for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderPaymentCollectionDetails", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentGatewayNames", + "description": "A list of the names of all payment gateways used for the order.\nFor example, \"Shopify Payments\" and \"Cash on Delivery (COD)\".\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTerms", + "description": "The payment terms associated with the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number associated with the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "physicalLocation", + "description": "The fulfillment location that was assigned when the order was created.\nOrders can have multiple fulfillment orders. These fulfillment orders can each be assigned to a different location which is responsible for fulfilling a subset of the items in an order. The `Order.physicalLocation` field will only point to one of these locations.\nUse the [`FulfillmentOrder`](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder)\nobject for up to date fulfillment location information.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "poNumber", + "description": "The PO number associated with the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentCurrencyCode", + "description": "The payment `CurrencyCode` of the customer for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "processedAt", + "description": "The date and time when the order was processed.\nThis date and time might not match the date and time when the order was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "The publication that the order was created from.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "purchasingEntity", + "description": "The purchasing entity for the order.", + "args": [], + "type": { + "kind": "UNION", + "name": "PurchasingEntity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referralCode", + "description": "The marketing referral code from the link that the customer clicked to visit the store.\nSupports the following URL attributes: \"ref\", \"source\", or \"r\".\nFor example, if the URL is `{shop}.myshopify.com/products/slide?ref=j2tj1tn2`, then this value is `j2tj1tn2`.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary.lastVisit.referralCode` instead" + }, + { + "name": "referrerDisplayText", + "description": "A web domain or short description of the source that sent the customer to your online store. For example, \"shopify.com\" or \"email\".\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary.lastVisit.referralInfoHtml` instead" + }, + { + "name": "referrerUrl", + "description": "The URL of the webpage where the customer clicked a link that sent them to your online store.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `customerJourneySummary.lastVisit.referrerUrl` instead" + }, + { + "name": "refundDiscrepancySet", + "description": "The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundable", + "description": "Whether the order can be refunded.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refunds", + "description": "A list of refunds that have been applied to the order.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "registeredSourceUrl", + "description": "The URL of the source that the order originated from, if found in the domain registry.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether the order has shipping lines or at least one line item on the order that requires shipping.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restockable", + "description": "Whether any line item on the order can be restocked.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnStatus", + "description": "The order's aggregated return status for display purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderReturnStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returns", + "description": "A list of returns for the order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "riskLevel", + "description": "The fraud risk level of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderRiskLevel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "risks", + "description": "A list of risks associated with the order.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderRisk", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The mailing address of the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLine", + "description": "A summary of all shipping costs on the order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLines", + "description": "A list of the order's shipping lines.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceIdentifier", + "description": "A unique POS or third party order identifier.\nFor example, \"1234-12-1000\" or \"111-98567-54\". The `receipt_number` field is derived from this value for POS orders.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalLineItemsQuantity", + "description": "The sum of the quantities for all line items that contribute to the order's subtotal price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPrice", + "description": "The sum of the prices for all line items after discounts and before returns, in shop currency.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `subtotalPriceSet` instead." + }, + { + "name": "subtotalPriceSet", + "description": "The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies.\nIf `taxesIncluded` is `true`, then the subtotal also includes tax.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestedRefund", + "description": "A suggested refund for the order.", + "args": [ + { + "name": "shippingAmount", + "description": "The amount to refund for shipping. Overrides the `refundShipping` argument.\nUse the `shippingAmountV2` argument for multi-currency orders.\n", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundShipping", + "description": "Whether to refund the full shipping amount.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundLineItems", + "description": "The line items from the order to include in the refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "refundDuties", + "description": "The duties from the order to include in the refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundDutyInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "suggestFullRefund", + "description": "Whether the suggested refund should be created from all refundable line items on the order.\nIf `true`, the `refundLineItems` argument will be ignored.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "SuggestedRefund", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A comma separated list of tags associated with the order. Updating `tags` overwrites\nany existing tags that were previously added to the order. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxExempt", + "description": "Whether taxes are exempt on the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "A list of all tax lines applied to line items on the order, before returns.\nTax line prices represent the total price for all tax lines with the same `rate` and `title`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxesIncluded", + "description": "Whether taxes are included in the subtotal price of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the order is a test.\nTest orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.\nA test order can't be converted into a real order and vice versa.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCapturable", + "description": "The authorized amount that's uncaptured or undercaptured, in shop currency.\nThis amount isn't adjusted for returns.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalCapturableSet` instead." + }, + { + "name": "totalCapturableSet", + "description": "The authorized amount that's uncaptured or undercaptured, in shop and presentment currencies.\nThis amount isn't adjusted for returns.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscounts", + "description": "The total amount discounted on the order before returns, in shop currency.\nThis includes both order and line level discounts.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `totalDiscountsSet` instead." + }, + { + "name": "totalDiscountsSet", + "description": "The total amount discounted on the order before returns, in shop and presentment currencies.\nThis includes both order and line level discounts.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalOutstandingSet", + "description": "The total amount not yet transacted for the order, in shop and presentment currencies.\nA positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPrice", + "description": "The total price of the order, before returns, in shop currency.\nThis includes taxes and discounts.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalPriceSet` instead." + }, + { + "name": "totalPriceSet", + "description": "The total price of the order, before returns, in shop and presentment currencies.\nThis includes taxes and discounts.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalReceived", + "description": "The total amount received from the customer before returns, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalReceivedSet` instead." + }, + { + "name": "totalReceivedSet", + "description": "The total amount received from the customer before returns, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalRefunded", + "description": "The total amount that was refunded, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalRefundedSet` instead." + }, + { + "name": "totalRefundedSet", + "description": "The total amount that was refunded, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalRefundedShippingSet", + "description": "The total amount of shipping that was refunded, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPrice", + "description": "The total shipping amount before discounts and returns, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalShippingPriceSet` instead." + }, + { + "name": "totalShippingPriceSet", + "description": "The total shipping amount before discounts and returns, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTax", + "description": "The total tax amount before returns, in shop currency.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTaxSet` instead." + }, + { + "name": "totalTaxSet", + "description": "The total tax amount before returns, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTipReceived", + "description": "The sum of all tip amounts for the order, in shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTipReceivedSet` instead." + }, + { + "name": "totalTipReceivedSet", + "description": "The sum of all tip amounts for the order, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalWeight", + "description": "The total weight of the order before returns, in grams.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactions", + "description": "A list of transactions associated with the order.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "capturable", + "description": "Filter transactions by whether they are capturable.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "manuallyResolvable", + "description": "Filter transactions by whether they can be resolved manually.\nFor example, fully captured or voided transactions aren't manually resolvable.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unpaid", + "description": "Whether no payments have been made for the order.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the order was modified last.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasLocalizationExtensions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderActionType", + "description": "The possible order action types for a\n[sales agreement](https://shopify.dev/api/admin-graphql/latest/interfaces/salesagreement).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER", + "description": "An order with a purchase or charge.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_EDIT", + "description": "An edit to the order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUND", + "description": "A refund on the order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "An unknown agreement action. Represents new actions that may be added in future versions.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderAgreement", + "description": "An agreement associated with an order placement.", + "fields": [ + { + "name": "app", + "description": "The application that created the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "happenedAt", + "description": "The date and time at which the agreement occured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the agremeent was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales", + "description": "The sales associated with the agreement.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The staff member associated with the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SalesAgreement", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderApp", + "description": "The [application](https://shopify.dev/apps) that created the order.\n", + "fields": [ + { + "name": "icon", + "description": "The application icon.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The application ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderCancelReason", + "description": "Represents the reason for the order's cancellation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER", + "description": "The customer wanted to cancel the order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "Payment was declined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAUD", + "description": "The order was fraudulent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY", + "description": "There was insufficient inventory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The order was canceled for an unlisted reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderCaptureInput", + "description": "The input fields for the authorized transaction to capture and the total amount to capture from it.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the order to capture.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parentTransactionId", + "description": "The ID of the authorized transaction to capture.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "amount", + "description": "The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currency", + "description": "The currency (in ISO format) that's used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.", + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderCapturePayload", + "description": "Return type for `orderCapture` mutation.", + "fields": [ + { + "name": "transaction", + "description": "The created capture transaction.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderCloseInput", + "description": "The input fields for specifying an open order to close.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the order to close.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderClosePayload", + "description": "Return type for `orderClose` mutation.", + "fields": [ + { + "name": "order", + "description": "The closed order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderConnection", + "description": "An auto-generated type for paginating through multiple Orders.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in OrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderCreateMandatePaymentPayload", + "description": "Return type for `orderCreateMandatePayment` mutation.", + "fields": [ + { + "name": "job", + "description": "The async job used for charging the payment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentReferenceId", + "description": "The Unique ID for the created payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderCreateMandatePaymentUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderCreateMandatePaymentUserError", + "description": "An error that occurs during the execution of `OrderCreateMandatePayment`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderCreateMandatePaymentUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderCreateMandatePaymentUserErrorCode", + "description": "Possible error codes that can be returned by `OrderCreateMandatePaymentUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER_MANDATE_PAYMENT_ERROR_CODE", + "description": "Errors for mandate payment on order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderDisplayFinancialStatus", + "description": "Represents the order's current financial status.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Displayed as **Pending**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "Displayed as **Authorized**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_PAID", + "description": "Displayed as **Partially paid**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_REFUNDED", + "description": "Displayed as **Partially refunded**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VOIDED", + "description": "Displayed as **Voided**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAID", + "description": "Displayed as **Paid**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUNDED", + "description": "Displayed as **Refunded**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "Displayed as **Expired**.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderDisplayFulfillmentStatus", + "description": "Represents the order's aggregated fulfillment status for display purposes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNFULFILLED", + "description": "Displayed as **Unfulfilled**. None of the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_FULFILLED", + "description": "Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLED", + "description": "Displayed as **Fulfilled**. All the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESTOCKED", + "description": "Displayed as **Restocked**. All the items in the order have been restocked. Replaced by the \"UNFULFILLED\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING_FULFILLMENT", + "description": "Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by the \"IN_PROGRESS\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by \"UNFULFILLED\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ON_HOLD", + "description": "Displayed as **On hold**. All of the unfulfilled items in this order are on hold.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderDisputeSummary", + "description": "A summary of the important details for a dispute on an order.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "initiatedAs", + "description": "The type that the dispute was initiated as.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DisputeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the dispute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DisputeStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEdge", + "description": "An auto-generated type which holds one Order and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of OrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditAddCustomItemPayload", + "description": "Return type for `orderEditAddCustomItem` mutation.", + "fields": [ + { + "name": "calculatedLineItem", + "description": "The custom line item that will be added to the order based on the current edits.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedOrder", + "description": "An order with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditAddLineItemDiscountPayload", + "description": "Return type for `orderEditAddLineItemDiscount` mutation.", + "fields": [ + { + "name": "addedDiscountStagedChange", + "description": "The discount applied to a line item during this order edit.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderStagedChangeAddLineItemDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedLineItem", + "description": "The line item with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedOrder", + "description": "An order with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditAddVariantPayload", + "description": "Return type for `orderEditAddVariant` mutation.", + "fields": [ + { + "name": "calculatedLineItem", + "description": "The [calculated line item](https://shopify.dev/api/admin-graphql/latest/objects/calculatedlineitem)\nthat's added during this order edit.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedOrder", + "description": "The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nwith the edits applied but not saved.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditAgreement", + "description": "An agreement associated with an edit to the order.", + "fields": [ + { + "name": "app", + "description": "The application that created the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "happenedAt", + "description": "The date and time at which the agreement occured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the agremeent was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales", + "description": "The sales associated with the agreement.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The staff member associated with the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SalesAgreement", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderEditAppliedDiscountInput", + "description": "The input fields used to add a discount during an order edit.", + "fields": null, + "inputFields": [ + { + "name": "description", + "description": "The description of the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedValue", + "description": "The value of the discount as a fixed amount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "percentValue", + "description": "The value of the discount as a percentage.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditBeginPayload", + "description": "Return type for `orderEditBegin` mutation.", + "fields": [ + { + "name": "calculatedOrder", + "description": "The order that will be edited.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditCommitPayload", + "description": "Return type for `orderEditCommit` mutation.", + "fields": [ + { + "name": "order", + "description": "The order with changes applied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditRemoveLineItemDiscountPayload", + "description": "Return type for `orderEditRemoveLineItemDiscount` mutation.", + "fields": [ + { + "name": "calculatedLineItem", + "description": "The calculated line item after removal of the discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedOrder", + "description": "An order with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEditSetQuantityPayload", + "description": "Return type for `orderEditSetQuantity` mutation.", + "fields": [ + { + "name": "calculatedLineItem", + "description": "The calculated line item with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedLineItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatedOrder", + "description": "The calculated order with the edits applied but not saved.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CalculatedOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderInput", + "description": "The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the order to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "A new customer email address for the order. Overwrites the existing email address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The new contents for the note associated with the order. Overwrites the existing note.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A new list of tags for the order. Overwrites the existing tags.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "shippingAddress", + "description": "The new shipping address for the order. Overwrites the existing shipping address.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "A new list of custom attributes for the order. Overwrites the existing custom attributes.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "A list of new metafields to add to the existing metafields for the order.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "localizationExtensions", + "description": "A list of new [localization extensions](https://shopify.dev/api/admin-graphql/latest/objects/localizationextension) to add to the existing list of localization extensions for the order.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "LocalizationExtensionInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "poNumber", + "description": "The new purchase order number for the order.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderInvoiceSendPayload", + "description": "Return type for `orderInvoiceSend` mutation.", + "fields": [ + { + "name": "order", + "description": "The order associated with the invoice email.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderInvoiceSendUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderInvoiceSendUserError", + "description": "An error that occurs during the execution of `OrderInvoiceSend`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderInvoiceSendUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderInvoiceSendUserErrorCode", + "description": "Possible error codes that can be returned by `OrderInvoiceSendUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER_INVOICE_SEND_UNSUCCESSFUL", + "description": "An error occurred while sending the invoice.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderMarkAsPaidInput", + "description": "The input fields for specifying the order to mark as paid.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the order to mark as paid.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderMarkAsPaidPayload", + "description": "Return type for `orderMarkAsPaid` mutation.", + "fields": [ + { + "name": "order", + "description": "The order marked as paid.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderOpenInput", + "description": "The input fields for specifying a closed order to open.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the order to open.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderOpenPayload", + "description": "Return type for `orderOpen` mutation.", + "fields": [ + { + "name": "order", + "description": "The opened order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentCollectionDetails", + "description": "The payment collection details for an order that requires additional payment following an edit to the order.", + "fields": [ + { + "name": "additionalPaymentCollectionUrl", + "description": "The URL to use for collecting an additional payment on the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vaultedPaymentMethods", + "description": "The list of vaulted payment methods for the order with their permissions.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentMandate", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentStatus", + "description": "The status of a customer's payment for an order.", + "fields": [ + { + "name": "errorMessage", + "description": "A message describing an error during the asynchronous processing of a payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentReferenceId", + "description": "The ID of the payment, initially returned by an `orderCreateMandatePayment` or `orderCreatePayment` mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the payment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderPaymentStatusResult", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatedErrorMessage", + "description": "A translated message describing an error during the asynchronous processing of a payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderPaymentStatusResult", + "description": "The type of a payment status.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUCCESS", + "description": "The payment succeeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "The payment is authorized.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VOIDED", + "description": "The payment is voided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUNDED", + "description": "The payment is refunded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAPTURED", + "description": "The payment is captured.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PURCHASED", + "description": "The payment is in purchased status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": "There was an error initiating the payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING", + "description": "The payment is still being processed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDIRECT_REQUIRED", + "description": "Redirect required.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETRYABLE", + "description": "Payment can be retried.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "Status is unknown.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderReturnStatus", + "description": "The order's aggregated return status that's used for display purposes.\nAn order might have multiple returns, so this field communicates the prioritized return status.\nThe `OrderReturnStatus` enum is a supported filter parameter in the [`orders` query](https://shopify.dev/api/admin-graphql/latest/queries/orders#:~:text=reference_location_id-,return_status,-risk_level).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IN_PROGRESS", + "description": "Some items in the order are being returned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSPECTION_COMPLETE", + "description": "All return shipments from a return in this order were inspected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_RETURN", + "description": "No items in the order were returned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNED", + "description": "Some items in the order were returned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURN_FAILED", + "description": "Some returns in the order were not completed successfully.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURN_REQUESTED", + "description": "A return was requested for some items in the order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderRisk", + "description": "Represents a fraud check on an order.", + "fields": [ + { + "name": "display", + "description": "Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "The likelihood that an order is fraudulent, based on this order risk.\n\nThe level can be set by Shopify risk analysis or by an app.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderRiskLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The risk message that's shown to the merchant in the Shopify admin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderRiskLevel", + "description": "The likelihood that an order is fraudulent.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LOW", + "description": "There is a low level of risk that this order is fraudulent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MEDIUM", + "description": "There is a medium level of risk that this order is fraudulent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIGH", + "description": "There is a high level of risk that this order is fraudulent.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderSortKeys", + "description": "The set of valid sort keys for the Order query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_NAME", + "description": "Sort by the `customer_name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESTINATION", + "description": "Sort orders by their shipping address country and city.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FINANCIAL_STATUS", + "description": "Sort by the `financial_status` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_STATUS", + "description": "Sort by the `fulfillment_status` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_NUMBER", + "description": "Sort by the `order_number` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSED_AT", + "description": "Sort by the `processed_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_ITEMS_QUANTITY", + "description": "Sort orders by the total quantity of all line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_PRICE", + "description": "Sort by the `total_price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PO_NUMBER", + "description": "Sort orders by their purchase order number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "OrderStagedChange", + "description": "A change that has been applied to an order.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddCustomItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddLineItemDiscount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddShippingLine", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeDecrementItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeIncrementItem", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddCustomItem", + "description": "A change to the order representing the addition of a\ncustom line item. For example, you might want to add gift wrapping service\nas a custom line item.\n", + "fields": [ + { + "name": "originalUnitPrice", + "description": "The price of an individual item without any discounts applied. This value can't be negative.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the custom item to add to the order. This value must be greater than zero.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the custom item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddLineItemDiscount", + "description": "The discount applied to an item that was added during the current order edit.\n", + "fields": [ + { + "name": "description", + "description": "The description of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The pricing value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddShippingLine", + "description": "A new [shipping line](https://shopify.dev/api/admin-graphql/latest/objects/shippingline)\nadded as part of an order edit.\n", + "fields": [ + { + "name": "phone", + "description": "The phone number at the shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The shipping line's title that's shown to the buyer.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price that applies to the shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the shipping line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeAddVariant", + "description": "A change to the order representing the addition of an existing product variant.\n", + "fields": [ + { + "name": "quantity", + "description": "The quantity of the product variant that was added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant that was added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeConnection", + "description": "An auto-generated type for paginating through multiple OrderStagedChanges.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderStagedChangeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in OrderStagedChangeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "OrderStagedChange", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeDecrementItem", + "description": "An removal of items from an existing line item on the order.\n", + "fields": [ + { + "name": "delta", + "description": "The number of items removed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The original line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restock", + "description": "The intention to restock the removed items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeEdge", + "description": "An auto-generated type which holds one OrderStagedChange and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of OrderStagedChangeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "OrderStagedChange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStagedChangeIncrementItem", + "description": "An addition of items to an existing line item on the order.\n", + "fields": [ + { + "name": "delta", + "description": "The number of items added.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The original line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTransaction", + "description": "A payment transaction in the context of an order.\n", + "fields": [ + { + "name": "accountNumber", + "description": "The masked account number associated with the payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amount", + "description": "The amount of money.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountSet` instead." + }, + { + "name": "amountSet", + "description": "The amount and currency of the transaction in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountV2", + "description": "The amount and currency of the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountSet` instead." + }, + { + "name": "authorizationCode", + "description": "Authorization code associated with the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "authorizationExpiresAt", + "description": "The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "Date and time when the transaction was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorCode", + "description": "A standardized error code, independent of the payment provider.", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderTransactionErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fees", + "description": "The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TransactionFee", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedGateway", + "description": "The human-readable payment gateway name used to process the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gateway", + "description": "The payment gateway used to process the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": "The kind of transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderTransactionKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manuallyCapturable", + "description": "Whether the transaction can be manually captured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumRefundable", + "description": "Specifies the available amount to refund on the gateway.\nThis value is only available for transactions of type `SuggestedRefund`.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `maximumRefundableV2` instead." + }, + { + "name": "maximumRefundableV2", + "description": "Specifies the available amount with currency to refund on the gateway.\nThis value is only available for transactions of type `SuggestedRefund`.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The associated order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentTransaction", + "description": "The associated parent transaction, for example the authorization of a capture.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentDetails", + "description": "The payment details for the transaction.", + "args": [], + "type": { + "kind": "UNION", + "name": "PaymentDetails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentIcon", + "description": "The payment icon to display for the transaction.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentId", + "description": "The payment ID associated with the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentMethod", + "description": "The payment method used for the transaction. This value is `null` if the payment method is unknown.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentMethods", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `paymentIcon` instead." + }, + { + "name": "processedAt", + "description": "Date and time when the transaction was processed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "receipt", + "description": "The transaction receipt that the payment gateway attaches to the transaction.\nThe value of this field depends on which payment gateway processed the transaction.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `receiptJson` instead." + }, + { + "name": "receiptJson", + "description": "The transaction receipt that the payment gateway attaches to the transaction.\nThe value of this field depends on which payment gateway processed the transaction.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "settlementCurrency", + "description": "The settlement currency.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "settlementCurrencyRate", + "description": "The rate used when converting the transaction amount to settlement currency.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPaymentsSet", + "description": "Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsTransactionSet", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderTransactionStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the transaction is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalUnsettled", + "description": "Specifies the available amount to capture on the gateway.\nOnly available when an amount is capturable or manually mark as paid.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `totalUnsettledSet` instead." + }, + { + "name": "totalUnsettledSet", + "description": "Specifies the available amount with currency to capture on the gateway in shop and presentment currencies.\nOnly available when an amount is capturable or manually mark as paid.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalUnsettledV2", + "description": "Specifies the available amount with currency to capture on the gateway.\nOnly available when an amount is capturable or manually mark as paid.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `totalUnsettledSet` instead." + }, + { + "name": "user", + "description": "Staff member who was logged into the Shopify POS device when the transaction was processed.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTransactionConnection", + "description": "An auto-generated type for paginating through multiple OrderTransactions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransactionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in OrderTransactionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTransactionEdge", + "description": "An auto-generated type which holds one OrderTransaction and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of OrderTransactionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderTransactionErrorCode", + "description": "A standardized error code, independent of the payment provider.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INCORRECT_NUMBER", + "description": "The card number is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_NUMBER", + "description": "The format of the card number is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_EXPIRY_DATE", + "description": "The format of the expiry date is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CVC", + "description": "The format of the CVC is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED_CARD", + "description": "The card is expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_CVC", + "description": "The CVC does not match the card number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_ZIP", + "description": "The ZIP or postal code does not match the card number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_ADDRESS", + "description": "The address does not match the card number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_PIN", + "description": "The entered PIN is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CARD_DECLINED", + "description": "The card was declined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING_ERROR", + "description": "There was an error while processing the payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CALL_ISSUER", + "description": "Call the card issuer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICK_UP_CARD", + "description": "The card has been reported as lost or stolen, and the card issuer has requested that the merchant keep the card and call the number on the back.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONFIG_ERROR", + "description": "There is an error in the gateway or merchant configuration.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEST_MODE_LIVE_CARD", + "description": "A real card was used but the gateway was in test mode.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_FEATURE", + "description": "The gateway or merchant configuration doesn't support a feature, such as network tokenization.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "There was an unknown error with processing the payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_COUNTRY", + "description": "The payment method is not available in the customer's country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_AMOUNT", + "description": "The amount is either too high or too low for the provider.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_METHOD_UNAVAILABLE", + "description": "The payment method is momentarily unavailable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_INVALID_PAYMENT_METHOD", + "description": "The payment method was invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_MAX_AMOUNT_CHARGED", + "description": "The maximum amount has been captured.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_MAX_AMOUNT_REFUNDED", + "description": "The maximum amount has been refunded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_MAX_AUTHORIZATIONS_CAPTURED", + "description": "The maximum of 10 authorizations has been captured for an order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_MAX_REFUNDS_PROCESSED", + "description": "The maximum of 10 refunds has been processed for an order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_ORDER_REFERENCE_CANCELED", + "description": "The order was canceled, which canceled all open authorizations.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMAZON_PAYMENTS_STALE", + "description": "The order was not confirmed within three hours.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "OrderTransactionInput", + "description": "The input fields for the information needed to create an order transaction.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The amount of money for this transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "gateway", + "description": "The payment gateway to use for this transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "kind", + "description": "The kind of transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderTransactionKind", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "orderId", + "description": "The ID of the order associated with the transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parentId", + "description": "The ID of the optional parent transaction, for example the authorization of a capture.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderTransactionKind", + "description": "The different kinds of order transactions.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SALE", + "description": "An authorization and capture performed together in a single step.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAPTURE", + "description": "A transfer of the money that was reserved by an authorization.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZATION", + "description": "An amount reserved against the cardholder's funding source.\nMoney does not change hands until the authorization is captured.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VOID", + "description": "A cancelation of an authorization transaction.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUND", + "description": "A partial or full return of captured funds to the cardholder.\nA refund can happen only after a capture is processed.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHANGE", + "description": "The money returned to the customer when they've paid too much during a cash transaction.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMV_AUTHORIZATION", + "description": "An authorization for a payment taken with an EMV credit card reader.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUGGESTED_REFUND", + "description": "A suggested refund transaction that can be used to create a refund.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderTransactionStatus", + "description": "The different states that an `OrderTransaction` can have.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUCCESS", + "description": "The transaction succeeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "The transaction failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The transaction is pending.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": "There was an error while processing the transaction.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWAITING_RESPONSE", + "description": "Awaiting a response.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "The transaction status is unknown.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderUpdatePayload", + "description": "Return type for `orderUpdate` mutation.", + "fields": [ + { + "name": "order", + "description": "The updated order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PageInfo", + "description": "Returns information about pagination in a connection, in accordance with the\n[Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).\nFor more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql).\n", + "fields": [ + { + "name": "endCursor", + "description": "The cursor corresponding to the last node in edges.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasNextPage", + "description": "Whether there are more pages to fetch following the current page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasPreviousPage", + "description": "Whether there are any pages prior to the current page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startCursor", + "description": "The cursor corresponding to the first node in edges.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ParseError", + "description": "A ShopifyQL parsing error.", + "fields": [ + { + "name": "code", + "description": "An error code for the error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ParseErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The description of the parsing error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "range", + "description": "The start and end range for the error.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ParseErrorRange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ParseErrorCode", + "description": "ShopifyQL parsing errors.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SYNTAX_NOT_RECOGNIZED", + "description": "Syntax not recognized.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEMANTICALLY_INVALID", + "description": "Semantically invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TABLE_NOT_FOUND", + "description": "Table not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLUMN_NOT_FOUND", + "description": "Column not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALUE_NOT_PARSABLE", + "description": "Value isn't parsable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE_NOT_PARSABLE", + "description": "Date isn't parsable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE_TIME_NOT_PARSABLE", + "description": "Datetime value isn't parsable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE_INTERVAL_NOT_FOUND", + "description": "Date interval not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAMED_DATE_NOT_FOUND", + "description": "Named date not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SORT_FIELD_NOT_FOUND", + "description": "Sort field not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIMIT_INVALID", + "description": "Limit is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUALIZE_CHART_TYPE_NOT_FOUND", + "description": "The type of visualization is invalid. Acceptable types: bar, line.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_MODIFIER_NOT_FOUND", + "description": "Function does not have any valid modifiers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_ARGUMENTS_NOT_FOUND", + "description": "Function is missing required argument(s).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_EXCESS_ARGUMENTS", + "description": "Function has too many arguments.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FROM_NOT_FOUND", + "description": "Keyword `FROM` not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENTMENT_NOT_FOUND", + "description": "Query is missing `SHOW` or `VISUALIZE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCESS_PRESENTMENTS", + "description": "Use the correct syntax for either `SHOW` or `VISUALIZE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_INCOMPATIBLE_TYPES", + "description": "Function has incompatible types.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUALIZE_EXCESS_PROJECTIONS", + "description": "Visualize has too many projections.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "Unknown error.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPERATOR_INCOMPATIBLE_TYPES", + "description": "Invalid arguments for operator.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUALIZE_INCOMPATIBLE_TYPES", + "description": "Function `VISUALIZE` contains a data type which cannot be plotted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUALIZE_GROUP_BY_NOT_FOUND", + "description": "Function `VISUALIZE` requires `GROUP BY`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VISUALIZE_GROUP_BY_MIXED_BACKFILL", + "description": "Function `VISUALIZE` can only use `GROUP BY` or `GROUP BY` with the `ALL` modifier, not both.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MIXED_AGGREGATE_AND_NON_AGGREGATE", + "description": "Mixing an aggregate expression and a non-aggregate expression is not allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_NESTED_AGGREGATE", + "description": "An aggregate function received a nested aggregate argument, which is not allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TIME_FUNCTION_NOT_FOUND", + "description": "Time function is incompatible in a `GROUP BY` clause with the `ALL` modifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST_MIXED_ARGUMENT_TYPES", + "description": "Mixing of `IN` list arguments of different data types is not allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCESS_PERIODS", + "description": "Mixing of `SINCE` and/or `UNTIL` with `DURING` is not allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_INVALID_TOKEN", + "description": "Invalid entry.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_NO_VIABLE_ALTERNATIVE", + "description": "Identifier after `SHOW` is not valid in its current position.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPARE_TO_INVALID_PERIOD", + "description": "Invalid `COMPARE TO` period specified. Make sure it's not the same as the `DURING` clause.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPARE_TO_INCOMPATIBLE_PERIOD", + "description": "The time period for `COMPARE TO` must be the same length as `DURING`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNBACKFILLED_TIME_GROUP_BY_COMPARISON", + "description": "When using `COMPARE TO` with a time-based `GROUP BY`, `ALL` must be used.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPARISON_WITH_NON_AGGREGATE_FIELDS", + "description": "Comparison queries must only contain aggregated fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED_GROUP_BY_NOT_FOUND", + "description": "Column must include `GROUP BY` arg1.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_INPUT_MISMATCH", + "description": "Identifier or function out of place.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_UNWANTED_TOKEN", + "description": "Identifier or function out of place.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_MISSING_TOKEN", + "description": "Query is incomplete.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_NOT_FOUND", + "description": "Function not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DATE_RANGE", + "description": "The `SINCE` date must be before or the same as the `UNTIL` date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCESS_BACKFILL_DIMENSIONS", + "description": "The `GROUP BY` function is limited to one parameter with the `ALL` modifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BACKFILL_DATE_RANGE_NOT_FOUND", + "description": "When using `GROUP BY` with the `ALL` modifier, `SINCE` or `DURING` must be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPARE_TO_MISSING_PERIOD", + "description": "Cannot use a `COMPARE TO` clause without `DURING` or `SINCE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCESS_DIMENSIONS", + "description": "The `GROUP BY` function has too many parameters.\nWhen using `VISUALIZE` with `COMPARE TO` use only one `GROUP BY` parameter.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYNTAX_FAILED_PREDICATE", + "description": "A semantic predicate failed during validation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ParseErrorRange", + "description": "A range of ShopifyQL parsing errors.", + "fields": [ + { + "name": "end", + "description": "The ending position of the error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorPosition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "start", + "description": "The starting position of the error.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorPosition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomization", + "description": "A payment customization.", + "fields": [ + { + "name": "enabled", + "description": "The enabled status of the payment customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorHistory", + "description": "The error history on the most recent version of the payment customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FunctionsErrorHistory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "functionId", + "description": "The ID of the Shopify Function implementing the payment customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "shopifyFunction", + "description": "The Shopify Function implementing the payment customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the payment customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationActivationPayload", + "description": "Return type for `paymentCustomizationActivation` mutation.", + "fields": [ + { + "name": "ids", + "description": "The IDs of the updated payment customizations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationConnection", + "description": "An auto-generated type for paginating through multiple PaymentCustomizations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PaymentCustomizationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationCreatePayload", + "description": "Return type for `paymentCustomizationCreate` mutation.", + "fields": [ + { + "name": "paymentCustomization", + "description": "Returns the created payment customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationDeletePayload", + "description": "Return type for `paymentCustomizationDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "Returns the deleted payment customization ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationEdge", + "description": "An auto-generated type which holds one PaymentCustomization and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PaymentCustomizationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "description": "An error that occurs during the execution of a payment customization mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentCustomizationErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentCustomizationErrorCode", + "description": "Possible error codes that can be returned by `PaymentCustomizationError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOM_APP_FUNCTION_NOT_ELIGIBLE", + "description": "Shop plan not eligible to use Functions from a custom app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_DOES_NOT_IMPLEMENT", + "description": "Function does not implement the required interface.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_NOT_FOUND", + "description": "Function not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_PENDING_DELETION", + "description": "Function is pending deletion.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_CUSTOMIZATION_NOT_FOUND", + "description": "Payment customization not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_CUSTOMIZATION_FUNCTION_NOT_ELIGIBLE", + "description": "Shop must be on a Shopify Plus plan to activate payment customizations from a custom app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_ACTIVE_PAYMENT_CUSTOMIZATIONS", + "description": "Maximum payment customizations are already enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRED_INPUT_FIELD", + "description": "Required input field must be present.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_METAFIELDS", + "description": "Could not create or update metafields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FUNCTION_ID_CANNOT_BE_CHANGED", + "description": "Function ID cannot be changed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentCustomizationInput", + "description": "The input fields to create and update a payment customization.", + "fields": null, + "inputFields": [ + { + "name": "functionId", + "description": "The ID of the function providing the payment customization.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the payment customization.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "enabled", + "description": "The enabled status of the payment customization.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional metafields to associate to the payment customization.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentCustomizationUpdatePayload", + "description": "Return type for `paymentCustomizationUpdate` mutation.", + "fields": [ + { + "name": "paymentCustomization", + "description": "Returns the updated payment customization.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PaymentDetails", + "description": "Payment details related to a transaction.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CardPaymentDetails", + "ofType": null + } + ] + }, + { + "kind": "UNION", + "name": "PaymentInstrument", + "description": "All possible instrument outputs for Payment Mandates.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "VaultCreditCard", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VaultPaypalBillingAgreement", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PaymentMandate", + "description": "A payment instrument and the permission\nthe owner of the instrument gives to the merchant to debit it.\n", + "fields": [ + { + "name": "id", + "description": "The unique ID of a payment mandate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentInstrument", + "description": "The outputs details of the payment instrument.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PaymentInstrument", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentMethods", + "description": "Some of the payment methods used in Shopify.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VISA", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MASTERCARD", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOVER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMERICAN_EXPRESS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DINERS_CLUB", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JCB", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNIONPAY", + "description": "The payment method for UnionPay payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ELO", + "description": "The payment method for Elo payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DANKORT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAESTRO", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FORBRUGSFORENINGEN", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYPAL", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOGUS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BITCOIN", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LITECOIN", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOGECOIN", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERAC", + "description": "The payment method for Interac payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EFTPOS", + "description": "The payment method for eftpos_au payment.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentReminderSendPayload", + "description": "Return type for `paymentReminderSend` mutation.", + "fields": [ + { + "name": "success", + "description": "Whether the payment reminder email was successfully sent.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentReminderSendUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentReminderSendUserError", + "description": "An error that occurs during the execution of `PaymentReminderSend`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentReminderSendUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentReminderSendUserErrorCode", + "description": "Possible error codes that can be returned by `PaymentReminderSendUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_REMINDER_SEND_UNSUCCESSFUL", + "description": "An error occurred while sending the payment reminder.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSchedule", + "description": "Represents the payment schedule for a single payment defined in the payment terms.", + "fields": [ + { + "name": "amount", + "description": "Amount owed for this payment schedule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completedAt", + "description": "Date and time when the payment schedule is paid or fulfilled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dueAt", + "description": "Date and time when the payment schedule is due.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "issuedAt", + "description": "Date and time when the invoice is sent.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTerms", + "description": "The payment terms the payment schedule belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentScheduleConnection", + "description": "An auto-generated type for paginating through multiple PaymentSchedules.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentScheduleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PaymentScheduleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSchedule", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentScheduleEdge", + "description": "An auto-generated type which holds one PaymentSchedule and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PaymentScheduleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSchedule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentScheduleInput", + "description": "The input fields used to create a payment schedule for payment terms.", + "fields": null, + "inputFields": [ + { + "name": "issuedAt", + "description": "Specifies the date and time that the payment schedule was issued. This field must be provided for net type payment terms.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dueAt", + "description": "Specifies the date and time when the payment schedule is due. This field must be provided for fixed type payment terms.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSettings", + "description": "Settings related to payments.", + "fields": [ + { + "name": "supportedDigitalWallets", + "description": "List of the digital wallets which the shop supports.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DigitalWallet", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTerms", + "description": "Represents the payment terms for an order or draft order.", + "fields": [ + { + "name": "draftOrder", + "description": "The draft order associated with the payment terms.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dueInDays", + "description": "Duration of payment terms in days based on the payment terms template used to create the payment terms.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the payment terms.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "overdue", + "description": "Whether the payment terms have overdue payment schedules.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentSchedules", + "description": "List of schedules for the payment terms.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentScheduleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsName", + "description": "The name of the payment terms template used to create the payment terms.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsType", + "description": "The payment terms template type used to create the payment terms.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentTermsType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatedName", + "description": "The payment terms name, translated into the shop admin's preferred language.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsCreateInput", + "description": "The input fields used to create a payment terms.", + "fields": null, + "inputFields": [ + { + "name": "paymentTermsTemplateId", + "description": "Specifies the payment terms template ID used to generate payment terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentSchedules", + "description": "Specifies the payment schedules for the payment terms.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentScheduleInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsCreatePayload", + "description": "Return type for `paymentTermsCreate` mutation.", + "fields": [ + { + "name": "paymentTerms", + "description": "The created payment terms.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentTermsCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsCreateUserError", + "description": "An error that occurs during the execution of `PaymentTermsCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentTermsCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTermsCreateUserErrorCode", + "description": "Possible error codes that can be returned by `PaymentTermsCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_TERMS_CREATION_UNSUCCESSFUL", + "description": "An error occurred while creating payment terms.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsDeleteInput", + "description": "The input fields used to delete the payment terms.", + "fields": null, + "inputFields": [ + { + "name": "paymentTermsId", + "description": "The ID of the payment terms being deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsDeletePayload", + "description": "Return type for `paymentTermsDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The deleted payment terms ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentTermsDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsDeleteUserError", + "description": "An error that occurs during the execution of `PaymentTermsDelete`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentTermsDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTermsDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `PaymentTermsDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_TERMS_DELETE_UNSUCCESSFUL", + "description": "An error occurred while deleting payment terms.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsInput", + "description": "The input fields to create payment terms. Payment terms set the date that payment is due.", + "fields": null, + "inputFields": [ + { + "name": "paymentTermsTemplateId", + "description": "Specifies the ID of the payment terms template.\n Payment terms templates provide preset configurations to create common payment terms.\n Refer to the\n [PaymentTermsTemplate](https://shopify.dev/api/admin-graphql/latest/objects/paymenttermstemplate)\n object for more details.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentSchedules", + "description": "Specifies the payment schedules for the payment terms.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentScheduleInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsTemplate", + "description": "Represents the payment terms template object.", + "fields": [ + { + "name": "description", + "description": "The description of the payment terms template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dueInDays", + "description": "The number of days between the issued date and due date if this is the net type of payment terms.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the payment terms template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsType", + "description": "The type of the payment terms template.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentTermsType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatedName", + "description": "The translated payment terms template name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTermsType", + "description": "The type of a payment terms or a payment terms template.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RECEIPT", + "description": "The payment terms or payment terms template is due on receipt.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NET", + "description": "The payment terms or payment terms template is a net type. It's due a number of days after issue.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIXED", + "description": "The payment terms or payment terms template is a fixed type. It's due on a specified date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT", + "description": "The payment terms or payment terms template is due on fulfillment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "The type of the payment terms or payment terms template is unknown.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsUpdateInput", + "description": "The input fields used to update the payment terms.", + "fields": null, + "inputFields": [ + { + "name": "paymentTermsId", + "description": "The ID of the payment terms being updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentTermsAttributes", + "description": "The attributes used to update the payment terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentTermsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsUpdatePayload", + "description": "Return type for `paymentTermsUpdate` mutation.", + "fields": [ + { + "name": "paymentTerms", + "description": "The updated payment terms.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PaymentTerms", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentTermsUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentTermsUpdateUserError", + "description": "An error that occurs during the execution of `PaymentTermsUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PaymentTermsUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTermsUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `PaymentTermsUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_TERMS_UPDATE_UNSUCCESSFUL", + "description": "An error occurred while updating payment terms.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaypalExpressSubscriptionsGatewayStatus", + "description": "Represents a valid PayPal Express subscriptions gateway status.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ENABLED", + "description": "The status is enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED", + "description": "The status is disabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The status is pending.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PolarisVizDataPoint", + "description": "A PolarisViz data point structure for ShopifyQL query.", + "fields": [ + { + "name": "key", + "description": "The data key. Typically a category, dimension, or other qualitative data.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The data value is numeric and quantitative.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PolarisVizDataSeries", + "description": "The data series used for PolarisViz visualization.", + "fields": [ + { + "name": "data", + "description": "An array of data points.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PolarisVizDataPoint", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isComparison", + "description": "Whether the series represents comparison data.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the series.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PolarisVizResponse", + "description": "A PolarisViz response to a ShopifyQL query.", + "fields": [ + { + "name": "data", + "description": "The PolarisViz visualization of data.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PolarisVizDataSeries", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parseErrors", + "description": "A list of parse errors, if parsing fails.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ParseError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tableData", + "description": "The result in a tabular format with schema and row data.\n It's always present even if query has a `VISUALIZE` keyword.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "TableData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vizType", + "description": "The type of visualization. For example, a line chart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "VisualizationType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShopifyqlResponse", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PreparedFulfillmentOrderLineItemsInput", + "description": "The input fields used to include the line items of a specified fulfillment order that should be marked as prepared for pickup by a customer.\n", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentOrderId", + "description": "The ID of the fulfillment order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceCalculationType", + "description": "How to caluclate the parent product variant's price while bulk updating variant relationships.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COMPONENTS_SUM", + "description": "The price of the parent will be the sum of the components price times their quantity.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIXED", + "description": "The price of the parent will be set to the price provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NONE", + "description": "The price of the parent will not be adjusted.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceInput", + "description": "The input fields for updating the price of a parent product variant.", + "fields": null, + "inputFields": [ + { + "name": "calculation", + "description": "The specific type of calculation done to determine the price of the parent variant.\nThe price is calculated during Bundle creation. Updating a component variant won't recalculate the price.\n", + "type": { + "kind": "ENUM", + "name": "PriceCalculationType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the parent product variant. This will be be used if calcualtion is set to 'FIXED'.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceList", + "description": "Represents a price list, including information about related prices and eligibility rules.\nYou can use price lists to specify either fixed prices or adjusted relative prices that\noverride initial product variant prices. Price lists are applied to customers\nusing context rules, which determine price list eligibility.\n\n For more information on price lists, refer to\n [Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).\n", + "fields": [ + { + "name": "catalog", + "description": "The catalog that the price list is associated with.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "The currency for fixed prices associated with this price list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fixedPricesCount", + "description": "The number of fixed prices on the price list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The unique name of the price list, used as a human-readable identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent", + "description": "Relative adjustments to other prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceListParent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "A list of prices associated with the price list.", + "args": [ + { + "name": "originType", + "description": "The origin of this price, either fixed (defined on the price list)\n or relative (calculated using an adjustment via a price list parent configuration).", + "type": { + "kind": "ENUM", + "name": "PriceListPriceOriginType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPriceConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityRules", + "description": "A list of quantity rules associated with the price list, ordered by product variants.", + "args": [ + { + "name": "originType", + "description": "Whether the quantity rule is fixed (defined on the price list) or relative\n(the default quantity rule for the shop).\n", + "type": { + "kind": "ENUM", + "name": "QuantityRuleOriginType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRuleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListAdjustment", + "description": "The type and value of a price list adjustment.\n\nFor more information on price lists, refer to\n[Support different pricing models](https://shopify.dev/apps/internationalization/product-price-lists).\n", + "fields": [ + { + "name": "type", + "description": "The type of price adjustment, such as percentage increase or decrease.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceListAdjustmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of price adjustment, where positive numbers reduce the prices and negative numbers\nincrease them.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentInput", + "description": "The input fields to set a price list adjustment.", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The value of the price adjustment as specified by the `type`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of price adjustment, such as percentage increase or decrease.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceListAdjustmentType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListAdjustmentSettings", + "description": "Represents the settings of price list adjustments.", + "fields": [ + { + "name": "compareAtMode", + "description": "The type of price list adjustment setting for compare at price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceListCompareAtMode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentSettingsInput", + "description": "The input fields to set a price list's adjustment settings.", + "fields": null, + "inputFields": [ + { + "name": "compareAtMode", + "description": "Determines how adjustments are applied to compare at prices.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceListCompareAtMode", + "ofType": null + } + }, + "defaultValue": "ADJUSTED" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListAdjustmentType", + "description": "Represents a percentage price adjustment type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERCENTAGE_DECREASE", + "description": "Percentage decrease type. Prices will have a lower value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PERCENTAGE_INCREASE", + "description": "Percentage increase type. Prices will have a higher value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListCompareAtMode", + "description": "Represents how the compare at price will be determined for a price list.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ADJUSTED", + "description": "The compare at price is adjusted based on percentage specified in price list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NULLIFY", + "description": "The compare at prices are set to `null` unless explicitly defined by a fixed price value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListConnection", + "description": "An auto-generated type for paginating through multiple PriceLists.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PriceListEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListCreateInput", + "description": "The input fields to create a price list.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The unique name of the price list, used as a human-readable identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currency", + "description": "Three letter currency code for fixed prices associated with this price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent", + "description": "Relative adjustments to other prices.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListParentCreateInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "catalogId", + "description": "The ID of the catalog to associate with this price list.If the catalog was already associated with another price list then it will be unlinked.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListCreatePayload", + "description": "Return type for `priceListCreate` mutation.", + "fields": [ + { + "name": "priceList", + "description": "The newly created price list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListDeletePayload", + "description": "Return type for `priceListDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted price list.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListEdge", + "description": "An auto-generated type which holds one PriceList and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PriceListEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesAddPayload", + "description": "Return type for `priceListFixedPricesAdd` mutation.", + "fields": [ + { + "name": "prices", + "description": "The list of fixed prices that were added to or updated in the price list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPrice", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPriceUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesByProductBulkUpdateUserError", + "description": "Error codes for failed price list fixed prices by product bulk update operations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceListFixedPricesByProductBulkUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListFixedPricesByProductBulkUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `PriceListFixedPricesByProductBulkUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NO_UPDATE_OPERATIONS_SPECIFIED", + "description": "No update operations specified.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICES_TO_ADD_CURRENCY_MISMATCH", + "description": "The currency specified does not match the price list's currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_DOES_NOT_EXIST", + "description": "Price list does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_ID_IN_INPUT", + "description": "Duplicate ID in input.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID_MUST_BE_MUTUALLY_EXCLUSIVE", + "description": "IDs must be mutually exclusive across add or delete operations.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIMIT_EXCEEDED", + "description": "Exceeded the 10000 prices to add limit.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesByProductUpdatePayload", + "description": "Return type for `priceListFixedPricesByProductUpdate` mutation.", + "fields": [ + { + "name": "priceList", + "description": "The price list for which the fixed prices were modified.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricesToAddProducts", + "description": "The product for which the fixed prices were added.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricesToDeleteProducts", + "description": "The product for which the fixed prices were deleted.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListFixedPricesByProductBulkUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesDeletePayload", + "description": "Return type for `priceListFixedPricesDelete` mutation.", + "fields": [ + { + "name": "deletedFixedPriceVariantIds", + "description": "A list of product variant IDs whose fixed prices were removed from the price list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPriceUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListFixedPricesUpdatePayload", + "description": "Return type for `priceListFixedPricesUpdate` mutation.", + "fields": [ + { + "name": "deletedFixedPriceVariantIds", + "description": "A list of deleted variant IDs for prices.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "The price list for which the fixed prices were modified.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricesAdded", + "description": "The prices that were added to the price list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPrice", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPriceUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListParent", + "description": "Represents relative adjustments from one price list to other prices.\n You can use a `PriceListParent` to specify an adjusted relative price using a percentage-based\n adjustment. Adjusted prices work in conjunction with exchange rules and rounding.\n\n [Adjustment types](https://shopify.dev/api/admin-graphql/latest/enums/pricelistadjustmenttype)\n support both percentage increases and decreases.\n", + "fields": [ + { + "name": "adjustment", + "description": "A price list adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListAdjustment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "settings", + "description": "A price list's settings for adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListAdjustmentSettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListParentCreateInput", + "description": "The input fields to create a price list adjustment.", + "fields": null, + "inputFields": [ + { + "name": "adjustment", + "description": "The relative adjustments to other prices.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "settings", + "description": "The price list adjustment settings.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentSettingsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListParentUpdateInput", + "description": "The input fields used to update a price list's adjustment.", + "fields": null, + "inputFields": [ + { + "name": "adjustment", + "description": "The relative adjustments to other prices..", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "settings", + "description": "The price list adjustment settings.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceListAdjustmentSettingsInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListPrice", + "description": "Represents information about pricing for a product variant\n as defined on a price list, such as the price, compare at price, and origin type. You can use a PriceListPrice to specify a fixed price for a specific product variant.", + "fields": [ + { + "name": "compareAtPrice", + "description": "The compare-at price of the product variant on this price list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originType", + "description": "The origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceListPriceOriginType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the product variant on this price list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant associated with this price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListPriceConnection", + "description": "An auto-generated type for paginating through multiple PriceListPrices.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPriceEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PriceListPriceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPrice", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListPriceEdge", + "description": "An auto-generated type which holds one PriceListPrice and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PriceListPriceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListPrice", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListPriceInput", + "description": "The input fields for providing the fields and values to use when creating or updating a fixed price list price.\n", + "fields": null, + "inputFields": [ + { + "name": "variantId", + "description": "The product variant ID associated with the price list price.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the product variant on this price list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "compareAtPrice", + "description": "The compare-at price of the product variant on this price list.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListPriceOriginType", + "description": "Represents the origin of a price, either fixed (defined on the price list) or relative (calculated using a price list adjustment configuration).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED", + "description": "The price is defined on the price list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELATIVE", + "description": "The price is relative to the adjustment type and value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListPriceUserError", + "description": "An error for a failed price list price operation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceListPriceUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListPriceUserErrorCode", + "description": "Possible error codes that can be returned by `PriceListPriceUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_NOT_FOUND", + "description": "The price list doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_CURRENCY_MISMATCH", + "description": "The specified currency doesn't match the price list's currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_NOT_FOUND", + "description": "A fixed price for the specified product variant doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_NOT_FIXED", + "description": "Only fixed prices can be deleted.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListProductPriceInput", + "description": "The input fields representing the price for all variants of a product.", + "fields": null, + "inputFields": [ + { + "name": "productId", + "description": "Specifies the ID of the product to update its variants for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the product to use for all variants with its currency.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListSortKeys", + "description": "The set of valid sort keys for the PriceList query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceListUpdateInput", + "description": "The input fields used to update a price list.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The unique name of the price list, used as a human-readable identifier.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "currency", + "description": "The three-letter currency code for fixed prices associated with this price list.", + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parent", + "description": "Relative adjustments to other prices.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceListParentUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "catalogId", + "description": "The ID of the catalog to associate with this price list.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListUpdatePayload", + "description": "Return type for `priceListUpdate` mutation.", + "fields": [ + { + "name": "priceList", + "description": "The updated price list.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceListUserError", + "description": "Error codes for failed contextual pricing operations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceListUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceListUserErrorCode", + "description": "Possible error codes that can be returned by `PriceListUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_NOT_FOUND", + "description": "The specified price list doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_LOCKED", + "description": "The price list is currently being modified. Please try again later.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_RULE_LIMIT_REACHED", + "description": "Cannot save the price list with context rule because the limit of context rules per shop was reached.", + "isDeprecated": true, + "deprecationReason": "The limit is removed." + }, + { + "name": "CONTEXT_RULE_COUNTRIES_LIMIT", + "description": "A price list context rule cannot have more than one country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CURRENCY_COUNTRY_MISMATCH", + "description": "A price list’s currency must be of the pricing rule’s country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COUNTRY_CURRENCY_MISMATCH", + "description": "A country in a context rule must use a valid currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CURRENCY_MARKET_MISMATCH", + "description": "A price list’s currency must be the market currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_CURRENCY_MISMATCH", + "description": "The context rule's market does not use the price list currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ADJUSTMENT_VALUE", + "description": "The adjustment value must be a positive value and not be greater than 100% for `type` `PERCENTAGE_DECREASE` and not be greater than 1000% for `type` `PERCENTAGE_INCREASE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ADJUSTMENT_MIN_VALUE", + "description": "The adjustment value must not be greater than 100% for `type` `PERCENTAGE_DECREASE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ADJUSTMENT_MAX_VALUE", + "description": "The adjustment value must not be greater than 1000% for `type` `PERCENTAGE_INCREASE`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_RULE_COUNTRY_TAKEN", + "description": "A price list for this country is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", + "description": "Quantity rules can be associated only with company location catalogs.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_RULE_LIMIT_ONE_OPTION", + "description": "Only one context rule option may be specified.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_RULE_MARKET_NOT_FOUND", + "description": "The specified market wasn't found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTEXT_RULE_MARKET_TAKEN", + "description": "A price list for this market is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CURRENCY_NOT_SUPPORTED", + "description": "The price list currency is not supported by the shop's payment gateway.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_NOT_ALLOWED_FOR_PRIMARY_MARKET", + "description": "Cannot create price list for a primary market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_ASSIGNMENT_NOT_ALLOWED", + "description": "Cannot assign a catalog to a price list that also has context rules.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_DOES_NOT_EXIST", + "description": "The specified catalog does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_CANNOT_CHANGE_CONTEXT_TYPE", + "description": "The context type of a catalog cannot be changed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_MARKET_AND_PRICE_LIST_CURRENCY_MISMATCH", + "description": "The price list currency must match the market catalog currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_TAKEN", + "description": "Catalog has a price list already assigned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COUNTRY_PRICE_LIST_ASSIGNMENT", + "description": "A country catalog cannot be assigned to a price list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_CATALOG_PRICE_LIST_ASSIGNMENT", + "description": "An app catalog cannot be assigned to a price list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "Something went wrong when trying to save the price list. Please try again.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRule", + "description": "Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.\n\nWe recommend using the types and queries detailed at [Getting started with discounts](https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started) instead. These will replace the GraphQL `PriceRule` object and REST Admin `PriceRule` and `DiscountCode` resources.\n", + "fields": [ + { + "name": "allocationLimit", + "description": "The maximum number of times that the price rule can be allocated onto an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allocationMethod", + "description": "The method by which the price rule's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "The application that created the price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCombinesWith", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the price rule was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSelection", + "description": "The customers that can use this price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleCustomerSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountClass", + "description": "The class of the discount for combining purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountClass", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodes", + "description": "List of the price rule's discount codes.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodesCount", + "description": "How many discount codes associated with the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endsAt", + "description": "The date and time when the price rule ends. For open-ended price rules, use `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "entitlementToPrerequisiteQuantityRatio", + "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleEntitlementToPrerequisiteQuantityRatio", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `prerequisiteToEntitlementQuantityRatio` instead." + }, + { + "name": "events", + "description": "The paginated list of events associated with the price rule.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "EventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `comments`\n - `created_at`\n - `subject_type`\n - `verb`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "features", + "description": "A list of the price rule's features.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleFeature", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasTimelineComment", + "description": "Indicates whether there are any timeline comments on the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "itemEntitlements", + "description": "The items to which the price rule applies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleItemEntitlements", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "itemPrerequisites", + "description": "The items required for the price rule to be applicable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleLineItemPrerequisites", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "oncePerCustomer", + "description": "Whether the price rule can be applied only once per customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteQuantityRange", + "description": "The number of the entitled items must fall within this range for the price rule to be applicable.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleQuantityRange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteShippingPriceRange", + "description": "The shipping cost must fall within this range for the price rule to be applicable.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleMoneyRange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteSubtotalRange", + "description": "The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleMoneyRange", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteToEntitlementQuantityRatio", + "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRulePrerequisiteToEntitlementQuantityRatio", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareableUrls", + "description": "URLs that can be used to share the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleShareableUrl", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingEntitlements", + "description": "The shipping lines to which the price rule applies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleShippingLineEntitlements", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "The date and time when the price rule starts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A detailed summary of the price rule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "target", + "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleTarget", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalSales", + "description": "The total sales from orders where the price rule was used.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "traits", + "description": "A list of the price rule's features.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleTrait", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `features` instead." + }, + { + "name": "usageCount", + "description": "The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the price rule can be used in total.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validityPeriod", + "description": "A time period during which a price rule is applicable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleValidityPeriod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PriceRuleValue", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `valueV2` instead." + }, + { + "name": "valueV2", + "description": "The value of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CommentEventSubject", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasEvents", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleActivatePayload", + "description": "Return type for `priceRuleActivate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The activated price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleAllocationMethod", + "description": "The method by which the price rule's value is allocated to its entitled items.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "EACH", + "description": "The value will be applied to each of the entitled items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACROSS", + "description": "The value will be applied once across the entitled items.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleConnection", + "description": "An auto-generated type for paginating through multiple PriceRules.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PriceRuleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleCreatePayload", + "description": "Return type for `priceRuleCreate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The newly created price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The newly created discount code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleCustomerSelection", + "description": "A selection of customers for whom the price rule applies.", + "fields": [ + { + "name": "customers", + "description": "List of customers to whom the price rule applies.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CustomerSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `accepts_marketing`\n - `country`\n - `customer_date`\n - `email`\n - `last_abandoned_order_date`\n - `order_date`\n - `orders_count`\n - `phone`\n - `state`\n - `tag`\n - `tag_not`\n - `total_spent`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "forAllCustomers", + "description": "Whether the price rule applies to all customers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segments", + "description": "A list of customer segments that contain the customers who can use the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleCustomerSelectionInput", + "description": "The input fields to update a price rule customer selection.", + "fields": null, + "inputFields": [ + { + "name": "forAllCustomers", + "description": "Whether the price rule applies to all customers.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "segmentIds", + "description": "List of customer segments that contain the customers to whom the price rule applies. No single customer IDs may be present.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "customerIdsToAdd", + "description": "List of customers to add to the current list of customers to whom the price rule applies. `savedSearchIds` must be empty.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "customerIdsToRemove", + "description": "A list of customers to remove from the current list of customers to whom the price rule applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDeactivatePayload", + "description": "Return type for `priceRuleDeactivate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The deactivated price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDeletePayload", + "description": "Return type for `priceRuleDelete` mutation.", + "fields": [ + { + "name": "deletedPriceRuleId", + "description": "The ID price of the deleted price rule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop of the deleted price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "description": "A discount code of a price rule.", + "fields": [ + { + "name": "app", + "description": "The application that created the discount code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The code to apply the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageCount", + "description": "The number of times that the price rule has been used. This value is updated asynchronously and can be different than the actual usage count.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeConnection", + "description": "An auto-generated type for paginating through multiple PriceRuleDiscountCodes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PriceRuleDiscountCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeCreatePayload", + "description": "Return type for `priceRuleDiscountCodeCreate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The updated price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The newly created discount code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeEdge", + "description": "An auto-generated type which holds one PriceRuleDiscountCode and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PriceRuleDiscountCodeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleDiscountCodeInput", + "description": "The input fields to manipulate a discount code.", + "fields": null, + "inputFields": [ + { + "name": "code", + "description": "The code to use the discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleDiscountCodeUpdatePayload", + "description": "Return type for `priceRuleDiscountCodeUpdate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The updated price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The updated discount code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleEdge", + "description": "An auto-generated type which holds one PriceRule and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PriceRuleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleEntitlementToPrerequisiteQuantityRatio", + "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "fields": [ + { + "name": "entitlementQuantity", + "description": "The quantity of entitled items in the ratio.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteQuantity", + "description": "The quantity of prerequisite items in the ratio.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleEntitlementToPrerequisiteQuantityRatioInput", + "description": "Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "fields": null, + "inputFields": [ + { + "name": "entitlementQuantity", + "description": "The quantity of entitled items in the ratio.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteQuantity", + "description": "The quantity of prerequisite items in the ratio.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleErrorCode", + "description": "Possible error codes that could be returned by a price rule mutation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EQUAL_TO", + "description": "The input value should be equal to the value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_ARGUMENTS", + "description": "Too many arguments provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_ARGUMENT", + "description": "Missing a required argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCEEDED_MAX", + "description": "Can't exceed the maximum number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RULE_ALLOCATION_LIMIT_ON_NON_BOGO", + "description": "The allocation limit can only be set on Buy x, get y (BXGY) discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RULE_ALLOCATION_LIMIT_IS_ZERO", + "description": "The allocation limit must be a non-zero positive number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RULE_EXCEEDED_MAX_DISCOUNT_CODE", + "description": "The number of discount codes in the shop has reached its limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_EXCEEDED_MAX_PRICE_RULES", + "description": "The number of discounts in the shop has reached its limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "END_DATE_BEFORE_START_DATE", + "description": "The discount end date must be after the start date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RULE_PERCENTAGE_VALUE_OUTSIDE_RANGE", + "description": "The percentage value must be between 0 and -100.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PREREQUISITE_SUBTOTAL_AND_QUANTITY_RANGE_BOTH_PRESENT", + "description": "Only one of the minimum subtotal or minimum quantity condition can be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALLOCATION_METHOD_MUST_BE_ACROSS_FOR_GIVEN_TARGET_SELECTION", + "description": "The allocation method must be `ACROSS` for the provided target selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPLIES_ON_NOTHING", + "description": "The discount must apply on either one-time purchase or subscription items, or both.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MULTIPLE_RECURRING_CYCLE_LIMIT_FOR_NON_SUBSCRIPTION_ITEMS", + "description": "The recurring cycle limit must be 1 when a discount doesn't apply on subscription items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOGO_INVALID_TARGET_SELECTION", + "description": "Invalid BOGO target selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOGO_INVALID_TARGET_TYPE", + "description": "Invalid BOGO target type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOGO_INVALID_VALUE_TYPE", + "description": "Invalid BOGO value type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_CODE_DUPLICATE", + "description": "A duplicate discount code exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTH_CUSTOMER_AND_SAVED_SEARCH_PREREQUISITES_SELECTED", + "description": "Can't use both prerequisite customers and saved search.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SAVED_SEARCH_DUPLICATE", + "description": "A duplicate customer saved search exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SAVED_SEARCH_EXCEEDED_MAX", + "description": "The customer saved search exceeded the maximum number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SAVED_SEARCH_INVALID", + "description": "Invalid customer saved search.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PREREQUISITES_EXCEEDED_MAX", + "description": "The customer prerequisites exceeded the maximum number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PREREQUISITES_INVALID_SELECTION", + "description": "Invalid customer prerequisites selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PREREQUISITE_DUPLICATE", + "description": "A duplicate customer prerequisite ID exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PREREQUISITES_MISSING", + "description": "Customer prerequisites are missing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTH_CUSTOMER_AND_SEGMENT_PREREQUISITES_SELECTED", + "description": "Can't have both prerequisite customers and prerequisite segments.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTH_SAVED_SEARCH_AND_SEGMENT_PREREQUISITES_SELECTED", + "description": "Can't have both saved searches and segments prerequisites.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SEGMENT_EXCEEDED_MAX", + "description": "The customer segment prerequisites exceeded the maximum number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SEGMENT_INVALID", + "description": "The customer segment prerequisite ID is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_SEGMENT_PREREQUISITE_DUPLICATE", + "description": "A duplicate customer segment prerequisite ID exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_PREREQUISITE_COLLECTION_WITH_PRODUCT_OR_VARIANTS", + "description": "Can't use collections as a prequisite in combination with product variants or products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_DUPLICATE_COLLECTION", + "description": "Can't add the same collection twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_DUPLICATE_PRODUCT", + "description": "Can't add the same product twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_DUPLICATE_VARIANT", + "description": "Can't add the same variant twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_EXCEEDED_MAX", + "description": "Can't exceed the maximum number of item prerequisites.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_INVALID_COLLECTION", + "description": "Invalid collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_INVALID_TYPE", + "description": "Invalid type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_INVALID_PRODUCT", + "description": "Invalid product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_INVALID_VARIANT", + "description": "Invalid variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_MUST_BE_EMPTY", + "description": "Item prerequisites must be empty if the prerequisite quantity ratio isn't defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_PREREQUISITES_MISSING", + "description": "Item prerequisites must have at least one item prerequisite if the prerequisite quantity ratio is defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_ENTITLE_COLLECTIONS_WITH_PRODUCTS_OR_VARIANTS", + "description": "Can't entitle collections in combination with product variants or products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_DUPLICATE_COLLECTION", + "description": "Can't add the same collection twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_DUPLICATE_PRODUCT", + "description": "Can't add the same product twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_DUPLICATE_VARIANT", + "description": "Can't add the same collection twice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_COLLECTION", + "description": "Can't exceed the maximum number of collection entitlements.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_PRODUCT", + "description": "Can't exceed the maximum number of product entitlements.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_EXCEEDED_MAX_VARIANT", + "description": "Can't exceed the maximum number of variant entitlements.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENT_INVALID_TYPE", + "description": "Invalid entitlement type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_INVALID_COLLECTION", + "description": "Invalid collection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_INVALID_PRODUCT", + "description": "Invalid product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_INVALID_VARIANT", + "description": "Invalid variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION", + "description": "Invalid combination of target type and selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ITEM_ENTITLEMENTS_MISSING", + "description": "Entitlements are missing.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_ALREADY_ENTITLED_THROUGH_PRODUCT", + "description": "The variant is already entitled through a product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_DUPLICATE_COUNTRY", + "description": "A duplicate country code exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_EXCEEDED_MAX", + "description": "Can't exceed the maximum number of entitlements.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_INVALID_COUNTRY", + "description": "The country is unknown.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_INVALID_TARGET_TYPE_OR_SELECTION", + "description": "Invalid target type or selection.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_MISSING", + "description": "Missing entitlements.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ENTITLEMENTS_UNSUPPORTED_DESTINATION_TYPE", + "description": "Unsupported destination type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TARGET_TYPE_PREREQUISITE_SHIPPING_PRICE_RANGE", + "description": "The target type is invalid when defining a prerequisite shipping price range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_COMBINES_WITH_FOR_DISCOUNT_CLASS", + "description": "The `combinesWith` settings are invalid for the discount class.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DISCOUNT_CLASS_FOR_PRICE_RULE", + "description": "The discountClass is invalid for the price rule.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleFeature", + "description": "The list of features that can be supported by a price rule.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BUY_ONE_GET_ONE", + "description": "The price rule supports Buy X, Get Y (BXGY) discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT", + "description": "The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BULK", + "description": "The price rule supports bulk discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SPECIFIC_CUSTOMERS", + "description": "The price rule targets specific customers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QUANTITY_DISCOUNTS", + "description": "The price rule supports discounts that require a quantity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleFixedAmountValue", + "description": "The value of a fixed amount price rule.", + "fields": [ + { + "name": "amount", + "description": "The monetary value of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleInput", + "description": "The input fields to manipulate a price rule.", + "fields": null, + "inputFields": [ + { + "name": "combinesWith", + "description": "Determines which discount classes the discount can combine with.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DiscountCombinesWithInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "validityPeriod", + "description": "PriceRuleValidityPeriod for the price rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleValidityPeriodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "oncePerCustomer", + "description": "Whether the price rule can be applied only once per customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "customerSelection", + "description": "The customers that can use this price rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleCustomerSelectionInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "usageLimit", + "description": "The maximum number of times that the price rule can be used in total.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "Title of the price rule.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "allocationLimit", + "description": "The maximum number of times that the price rule can be allocated onto an order.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "allocationMethod", + "description": "The method by which the price rule's value is allocated to its entitled items.", + "type": { + "kind": "ENUM", + "name": "PriceRuleAllocationMethod", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the price rule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "target", + "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", + "type": { + "kind": "ENUM", + "name": "PriceRuleTarget", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteSubtotalRange", + "description": "The sum of the entitled items subtotal prices must fall within this range for the price rule to be applicable.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleMoneyRangeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteQuantityRange", + "description": "The number of the entitled items must fall within this range for the price rule to be applicable.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleQuantityRangeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteShippingPriceRange", + "description": "The shipping cost must fall within this range for the price rule to be applicable.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleMoneyRangeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "itemEntitlements", + "description": "The items to which the price rule applies.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleItemEntitlementsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "itemPrerequisites", + "description": "The items required for the price rule to be applicable.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleItemPrerequisitesInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingEntitlements", + "description": "The shipping lines to which the price rule applies.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRuleShippingEntitlementsInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteToEntitlementQuantityRatio", + "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRulePrerequisiteToEntitlementQuantityRatioInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleItemEntitlements", + "description": "The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned.", + "fields": [ + { + "name": "collections", + "description": "The collections to which the price rule applies.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The product variants to which the price rule applies.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The products to which the price rule applies.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetAllLineItems", + "description": "Whether the price rule applies to all line items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleItemEntitlementsInput", + "description": "The input fields to update a price rule line item entitlement.", + "fields": null, + "inputFields": [ + { + "name": "targetAllLineItems", + "description": "Whether the price rule applies to all items.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "productIds", + "description": "The products to which the price rule applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantIds", + "description": "The product variants to which the price rule applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "collectionIds", + "description": "The collections to which the price rule applies.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleItemPrerequisitesInput", + "description": "The input fields to update a price rule's item prerequisites.", + "fields": null, + "inputFields": [ + { + "name": "productIds", + "description": "The products needed for the price rule to be applied.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantIds", + "description": "The product variants needed for the price rule to be applied.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "collectionIds", + "description": "The collections needed for the price rule to be applied.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleLineItemPrerequisites", + "description": "Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination.", + "fields": [ + { + "name": "collections", + "description": "The collections required for the price rule to be applicable.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The product variants required for the price rule to be applicable.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The products required for the price rule to be applicable.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleMoneyRange", + "description": "A money range within which the price rule is applicable.", + "fields": [ + { + "name": "greaterThan", + "description": "The lower bound of the money range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "greaterThanOrEqualTo", + "description": "The lower bound or equal of the money range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lessThan", + "description": "The upper bound of the money range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lessThanOrEqualTo", + "description": "The upper bound or equal of the money range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleMoneyRangeInput", + "description": "The input fields to update the money range within which the price rule is applicable.\n", + "fields": null, + "inputFields": [ + { + "name": "lessThan", + "description": "The upper bound of the money range.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lessThanOrEqualTo", + "description": "The upper or equal bound of the money range.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "greaterThan", + "description": "The lower bound of the money range.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "greaterThanOrEqualTo", + "description": "The lower or equal bound of the money range.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRulePercentValue", + "description": "The value of a percent price rule.", + "fields": [ + { + "name": "percentage", + "description": "The percent value of the price rule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRulePrerequisiteToEntitlementQuantityRatio", + "description": "Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "fields": [ + { + "name": "entitlementQuantity", + "description": "The quantity of entitled items in the ratio.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prerequisiteQuantity", + "description": "The quantity of prerequisite items in the ratio.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRulePrerequisiteToEntitlementQuantityRatioInput", + "description": "Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.", + "fields": null, + "inputFields": [ + { + "name": "entitlementQuantity", + "description": "The quantity of entitled items in the ratio.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prerequisiteQuantity", + "description": "The quantity of prerequisite items in the ratio.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleQuantityRange", + "description": "A quantity range within which the price rule is applicable.", + "fields": [ + { + "name": "greaterThan", + "description": "The lower bound of the quantity range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "greaterThanOrEqualTo", + "description": "The lower bound or equal of the quantity range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lessThan", + "description": "The upper bound of the quantity range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lessThanOrEqualTo", + "description": "The upper bound or equal of the quantity range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleQuantityRangeInput", + "description": "The input fields to update the quantity range within which the price rule is applicable.\n", + "fields": null, + "inputFields": [ + { + "name": "lessThan", + "description": "The upper bound of the quantity range.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lessThanOrEqualTo", + "description": "The upper or equal bound of the quantity range.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "greaterThan", + "description": "The lower bound of the quantity range.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "greaterThanOrEqualTo", + "description": "The lower or equal bound of the quantity range.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleShareableUrl", + "description": "Shareable URL for the discount code associated with the price rule.", + "fields": [ + { + "name": "targetItemImage", + "description": "The image URL of the item (product or collection) to which the discount applies.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of page that's associated with the URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PriceRuleShareableUrlTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the page that's associated with the URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL for the discount code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleShareableUrlTargetType", + "description": "The type of page where a shareable price rule URL lands.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "HOME", + "description": "The URL lands on a home page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "The URL lands on a product page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION", + "description": "The URL lands on a collection page.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleShippingEntitlementsInput", + "description": "The input fields to update a price rule shipping entitlement.", + "fields": null, + "inputFields": [ + { + "name": "targetAllShippingLines", + "description": "Whether the price rule applies to all shipping lines.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "countryCodes", + "description": "The codes for the countries to which the price rule applies to.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "includeRestOfWorld", + "description": "Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleShippingLineEntitlements", + "description": "The shipping lines to which the price rule applies to.", + "fields": [ + { + "name": "countryCodes", + "description": "The codes for the countries to which the price rule applies to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "includeRestOfWorld", + "description": "Whether the price rule is applicable to countries that haven't been defined in the shop's shipping zones.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetAllShippingLines", + "description": "Whether the price rule applies to all shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleSortKeys", + "description": "The set of valid sort keys for the PriceRule query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STARTS_AT", + "description": "Sort by the `starts_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENDS_AT", + "description": "Sort by the `ends_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleStatus", + "description": "The status of the price rule.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The price rule is active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The price rule is expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "The price rule is scheduled.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleTarget", + "description": "The type of lines (line_item or shipping_line) to which the price rule applies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LINE_ITEM", + "description": "The price rule applies to line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_LINE", + "description": "The price rule applies to shipping lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PriceRuleTrait", + "description": "The list of features that can be supported by a price rule.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BUY_ONE_GET_ONE", + "description": "The price rule supports Buy X, Get Y (BXGY) discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUY_ONE_GET_ONE_WITH_ALLOCATION_LIMIT", + "description": "The price rule supports Buy X, Get Y (BXGY) discounts that specify a custom allocation limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BULK", + "description": "The price rule supports bulk discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SPECIFIC_CUSTOMERS", + "description": "The price rule targets specific customers.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QUANTITY_DISCOUNTS", + "description": "The price rule supports discounts that require a quantity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleUpdatePayload", + "description": "Return type for `priceRuleUpdate` mutation.", + "fields": [ + { + "name": "priceRule", + "description": "The updated price rule.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleDiscountCode", + "description": "The updated discount code.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PriceRuleDiscountCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceRuleUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleUserError", + "description": "Represents an error that happens during execution of a price rule mutation.", + "fields": [ + { + "name": "code", + "description": "Error code to uniquely identify the error.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PriceRuleErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRuleValidityPeriod", + "description": "A time period during which a price rule is applicable.", + "fields": [ + { + "name": "end", + "description": "The time after which the price rule becomes invalid.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "start", + "description": "The time after which the price rule is valid.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleValidityPeriodInput", + "description": "The input fields to update the validity period of a price rule.", + "fields": null, + "inputFields": [ + { + "name": "start", + "description": "The time after which the price rule is valid.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "end", + "description": "The time after which the price rule becomes invalid.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PriceRuleValue", + "description": "The type of the price rule value. The price rule value might be a percentage value, or a fixed amount.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "PriceRuleFixedAmountValue", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PriceRulePercentValue", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRuleValueInput", + "description": "The input fields to update a price rule.", + "fields": null, + "inputFields": [ + { + "name": "percentageValue", + "description": "The percentage value of the price rule.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedAmountValue", + "description": "The fixed amount value of the price rule.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PricingPercentageValue", + "description": "One type of value given to a customer when a discount is applied to an order.\nThe application of a discount with this value gives the customer the specified percentage off a specified item.\n", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the object. This is a number between -100 (free) and 0 (no discount).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PricingValue", + "description": "The type of value given to a customer when a discount is applied to an order. For example, the application of the discount might give the customer a percentage off a specified item. Alternatively, the application of the discount might give the customer a monetary value in a given currency off an order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PricingPercentageValue", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PrivateMetafield", + "description": "Private metafields represent custom metadata that is attached to a resource.\nPrivate metafields are accessible only by the application that created them and only from the GraphQL Admin API.\n\nAn application can create a maximum of 10 private metafields per shop resource.\n", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the private metafield was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the private metafield.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The key name of the private metafield.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The namespace of the private metafield.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the private metafield was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of a private metafield.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "valueType", + "description": "Represents the private metafield value type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PrivateMetafieldValueType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "description": "An auto-generated type for paginating through multiple PrivateMetafields.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PrivateMetafieldEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldDeleteInput", + "description": "The input fields for the private metafield to delete.\n", + "fields": null, + "inputFields": [ + { + "name": "owner", + "description": "The ID of the resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The namespace of the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key of the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PrivateMetafieldDeletePayload", + "description": "Return type for `privateMetafieldDelete` mutation.", + "fields": [ + { + "name": "deletedPrivateMetafieldId", + "description": "The ID of private metafield that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PrivateMetafieldEdge", + "description": "An auto-generated type which holds one PrivateMetafield and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PrivateMetafieldEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldInput", + "description": "The input fields for a private metafield.\n", + "fields": null, + "inputFields": [ + { + "name": "owner", + "description": "The resource that owns the metafield. If the field is blank, then the `Shop` resource owns the metafield.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The namespace of the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key of the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "valueInput", + "description": "The `value` and `valueType` of the private metafield, wrapped in a `ValueInput` object.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldValueInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PrivateMetafieldUpsertPayload", + "description": "Return type for `privateMetafieldUpsert` mutation.", + "fields": [ + { + "name": "privateMetafield", + "description": "The private metafield that was created or updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PrivateMetafieldValueInput", + "description": "The input fields for the value and value type of the private metafield.\n", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The value of a private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "valueType", + "description": "Represents the private metafield value type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PrivateMetafieldValueType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PrivateMetafieldValueType", + "description": "Supported private metafield value types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "STRING", + "description": "A string metafield.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTEGER", + "description": "An integer metafield.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JSON_STRING", + "description": "A JSON string metafield.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Product", + "description": "The Product resource lets you manage products in a merchant’s store. You can use [ProductVariants](https://shopify.dev/api/admin-graphql/latest/objects/productvariant) to create or update different versions of the same product. You can also add or update product [Media](https://shopify.dev/api/admin-graphql/latest/interfaces/media). Products can be organized by grouping them into a [Collection](https://shopify.dev/api/admin-graphql/latest/objects/collection).", + "fields": [ + { + "name": "availablePublicationCount", + "description": "The number of publications a resource is published to without feedback errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bodyHtml", + "description": "The description of the product, complete with HTML formatting.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `descriptionHtml` instead." + }, + { + "name": "collections", + "description": "A list of the collections that include the product.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CollectionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `collection_type`\n - `product_publication_status`\n - `publishable_status`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contextualPricing", + "description": "The pricing that applies for a customer in a given context.", + "args": [ + { + "name": "context", + "description": "The context used to generate contextual pricing for the variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ContextualPricingContext", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductContextualPricing", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customProductType", + "description": "The custom product type specified by the merchant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Deprecated in API version 2022-10. Use `productType` instead." + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A stripped description of the product, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "descriptionHtml", + "description": "The description of the product, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "descriptionPlainSummary", + "description": "Stripped description of the product, single line with HTML tags removed.\nTruncated to 60 characters.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `description` instead." + }, + { + "name": "featuredImage", + "description": "The featured image for the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "featuredMedia", + "description": "The featured media for the product.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "feedback", + "description": "Information about the product that's provided through resource feedback.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ResourceFeedback", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardTemplateSuffix", + "description": "The theme template used when viewing the gift card in a store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A unique human-friendly string of the product's title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasOnlyDefaultVariant", + "description": "Whether the product has only a single variant with the default option and value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasOutOfStockVariants", + "description": "Whether the product has out of stock variants.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "The images associated with the product.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductImageSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inCollection", + "description": "Whether the product is in a given collection.", + "args": [ + { + "name": "id", + "description": "The ID of the collection to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isGiftCard", + "description": "Whether the product is a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media", + "description": "The media associated with the product. This can include images, 3D models, or videos.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductMediaSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaCount", + "description": "Total count of media belonging to a product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStorePreviewUrl", + "description": "The online store preview URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The online store URL for the product.\nA value of `null` indicates that the product isn't published to the Online Store sales channel.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "A list of product options. The limit is specified by Shop.resourceLimits.maxProductOptions.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRange", + "description": "The price range of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPriceRange", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Deprecated in API version 2020-10. Use `priceRangeV2` instead." + }, + { + "name": "priceRangeV2", + "description": "The price range of the product with prices formatted as decimals.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPriceRangeV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "productCategory", + "description": "The product category specified by the merchant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductCategory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productPublications", + "description": "A list of the channels where the product is published.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublicationConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `resourcePublications` instead." + }, + { + "name": "productType", + "description": "The product type specified by the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationCount", + "description": "The number of publications a resource is published on.", + "args": [ + { + "name": "onlyPublished", + "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publications", + "description": "A list of the channels where the product is published.", + "args": [ + { + "name": "onlyPublished", + "description": "Return only the publications that are published. If false, then return all publications.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublicationConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `resourcePublications` instead." + }, + { + "name": "publishedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the product was published to the Online Store.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedInContext", + "description": "Whether or not the product is published for a customer in the given context.", + "args": [ + { + "name": "context", + "description": "The context used to determine publication status.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ContextualPublicationContext", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedOnChannel", + "description": "Check to see whether the resource is published to a given channel.", + "args": [ + { + "name": "channelId", + "description": "The ID of the channel to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnPublication` instead." + }, + { + "name": "publishedOnCurrentChannel", + "description": "Check to see whether the resource is published to the calling app's channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnCurrentPublication` instead." + }, + { + "name": "publishedOnCurrentPublication", + "description": "Check to see whether the resource is published to the calling app's publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedOnPublication", + "description": "Check to see whether the resource is published to a given publication.", + "args": [ + { + "name": "publicationId", + "description": "The ID of the publication to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresSellingPlan", + "description": "Whether the product can only be purchased with a selling plan (subscription). Products that are sold on subscription (`requiresSellingPlan: true`) can be updated only for online stores. If you update a product to be subscription only, then the product is unpublished from all channels except the online store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublicationOnCurrentPublication", + "description": "The resource that's either published or staged to be published to the calling app's publication. Requires the `read_product_listings` scope.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ResourcePublicationV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublications", + "description": "The list of resources that are published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublicationsV2", + "description": "The list of resources that are either published or staged to be published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "catalogType", + "description": "Filter publications by catalog type.", + "type": { + "kind": "ENUM", + "name": "CatalogType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2Connection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupCount", + "description": "Count of selling plan groups associated with the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroups", + "description": "A list of all selling plan groups defined in the current shop associated with the product either directly or through any of its variants.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "SEO information of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardizedProductType", + "description": "The standardized product type in the Shopify product taxonomy.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StandardizedProductType", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Deprecated in API version 2022-10. Use `productCategory` instead." + }, + { + "name": "status", + "description": "The product status. This controls visibility across all channels.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontId", + "description": "The Storefront GraphQL API ID of the `Product`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "StorefrontID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `id` instead." + }, + { + "name": "tags", + "description": "A comma separated list of tags associated with the product. Updating `tags` overwrites\nany existing tags that were previously added to the product. To add new tags without overwriting\nexisting tags, use the [tagsAdd](https://shopify.dev/api/admin-graphql/latest/mutations/tagsadd)\nmutation.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "templateSuffix", + "description": "The theme template used when viewing the product in a store.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalInventory", + "description": "The quantity of inventory in stock.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalVariants", + "description": "The number of variants that are associated with the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracksInventory", + "description": "Whether inventory tracking has been enabled for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unpublishedChannels", + "description": "The list of channels that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unpublishedPublications` instead." + }, + { + "name": "unpublishedPublications", + "description": "The list of publications that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the product was last modified.\nA product's `updatedAt` value can change for different reasons. For example, if an order\nis placed for a product that has inventory tracking set up, then the inventory adjustment\nis counted as an update.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variants", + "description": "A list of variants associated with the product.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The name of the product's vendor.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePreviewable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductAppendImagesInput", + "description": "The input fields for specifying product images to append.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "images", + "description": "A list of images to be appended to the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ImageInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductAppendImagesPayload", + "description": "Return type for `productAppendImages` mutation.", + "fields": [ + { + "name": "newImages", + "description": "List of new images appended to the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCategory", + "description": "The details of a specific product category within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt).", + "fields": [ + { + "name": "productTaxonomyNode", + "description": "The product taxonomy node associated with the product category.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductTaxonomyNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductCategoryInput", + "description": "The input fields to use when adding a product category to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values.", + "fields": null, + "inputFields": [ + { + "name": "productTaxonomyNodeId", + "description": "The ID of the node in the Shopify taxonomy that represents the product category.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductChangeStatusPayload", + "description": "Return type for `productChangeStatus` mutation.", + "fields": [ + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductChangeStatusUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductChangeStatusUserError", + "description": "An error that occurs during the execution of `ProductChangeStatus`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductChangeStatusUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductChangeStatusUserErrorCode", + "description": "Possible error codes that can be returned by `ProductChangeStatusUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_NOT_FOUND", + "description": "Product could not be found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductCollectionSortKeys", + "description": "The set of valid sort keys for the ProductCollection query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "Sort by the `price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BEST_SELLING", + "description": "Sort by the `best-selling` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED", + "description": "Sort by the `created` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "Sort by the `manual` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_DEFAULT", + "description": "Sort by the `collection-default` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductConnection", + "description": "An auto-generated type for paginating through multiple Products.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductContextualPricing", + "description": "The price of a product in a specific country.\nPrices vary between countries.\n", + "fields": [ + { + "name": "fixedQuantityRulesCount", + "description": "The number of fixed quantity rules for the product's variants on the price list.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxVariantPricing", + "description": "The pricing of the variant with the highest price in the given context.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariantContextualPricing", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minVariantPricing", + "description": "The pricing of the variant with the lowest price in the given context.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariantContextualPricing", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRange", + "description": "The price range of the product with prices formatted as decimals.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPriceRangeV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCreateMediaPayload", + "description": "Return type for `productCreateMedia` mutation.", + "fields": [ + { + "name": "media", + "description": "The newly created media.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product associated with the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `mediaUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCreatePayload", + "description": "Return type for `productCreate` mutation.", + "fields": [ + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDeleteAsyncPayload", + "description": "Return type for `productDeleteAsync` mutation.", + "fields": [ + { + "name": "deleteProductId", + "description": "The ID of the product that was requested to be deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job", + "description": "The background job that will delete the product and its associated variants and media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDeleteImagesPayload", + "description": "Return type for `productDeleteImages` mutation.", + "fields": [ + { + "name": "deletedImageIds", + "description": "The array of image IDs to delete.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductDeleteInput", + "description": "The input fields for specifying the product to delete.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDeleteMediaPayload", + "description": "Return type for `productDeleteMedia` mutation.", + "fields": [ + { + "name": "deletedMediaIds", + "description": "List of media IDs which were deleted.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletedProductImageIds", + "description": "List of product image IDs which were deleted.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product associated with the deleted media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `mediaUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDeletePayload", + "description": "Return type for `productDelete` mutation.", + "fields": [ + { + "name": "deletedProductId", + "description": "The ID of the deleted product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDeleteUserError", + "description": "An error that occurred while setting the activation status of an inventory item.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `ProductDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "Something went wrong, please try again.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductDuplicateAsyncInput", + "description": "The input fields for the product async duplicate mutation.", + "fields": null, + "inputFields": [ + { + "name": "productId", + "description": "The ID of the product to be duplicated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newTitle", + "description": "The new title of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newStatus", + "description": "The new status of the product. If no value is provided the status will be inherited from the original product.", + "type": { + "kind": "ENUM", + "name": "ProductStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeImages", + "description": "Specifies whether or not to duplicate images.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicateAsyncPayload", + "description": "Return type for `productDuplicateAsync` mutation.", + "fields": [ + { + "name": "duplicatedProductId", + "description": "The duplicated product ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job", + "description": "The asynchronous job for duplicating the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductDuplicateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicateAsyncV2Payload", + "description": "Return type for `productDuplicateAsyncV2` mutation.", + "fields": [ + { + "name": "duplicatedProductId", + "description": "The duplicated product ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDuplicateJobId", + "description": "The asynchronous job for duplicating the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductDuplicateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicateJob", + "description": "Represents a product duplication job.", + "fields": [ + { + "name": "done", + "description": "This indicates if the job is still queued or has been run.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID that's returned when running an asynchronous mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicatePayload", + "description": "Return type for `productDuplicate` mutation.", + "fields": [ + { + "name": "imageJob", + "description": "The asynchronous job that duplicates the product images.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newProduct", + "description": "The duplicated product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductDuplicateUserError", + "description": "An error that occurred while duplicating the product.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductDuplicateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductDuplicateUserErrorCode", + "description": "Possible error codes that can be returned by `ProductDuplicateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "The product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMPTY_VARIANT", + "description": "Cannot duplicate a product which has no variants.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMPTY_TITLE", + "description": "The title cannot be empty.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUNDLES_ERROR", + "description": "Cannot duplicate a bundle product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "Something went wrong, please try again.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_SAVE", + "description": "Something went wrong when saving the product, please try again.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductEdge", + "description": "An auto-generated type which holds one Product and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeed", + "description": "A product feed.", + "fields": [ + { + "name": "country", + "description": "The country of the product feed.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "language", + "description": "The language of the product feed.", + "args": [], + "type": { + "kind": "ENUM", + "name": "LanguageCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the product feed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductFeedStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedConnection", + "description": "An auto-generated type for paginating through multiple ProductFeeds.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeedEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductFeedEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeed", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedCreatePayload", + "description": "Return type for `productFeedCreate` mutation.", + "fields": [ + { + "name": "productFeed", + "description": "The newly created product feed.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductFeed", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeedCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedCreateUserError", + "description": "An error that occurs during the execution of `ProductFeedCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductFeedCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductFeedCreateUserErrorCode", + "description": "Possible error codes that can be returned by `ProductFeedCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedDeletePayload", + "description": "Return type for `productFeedDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the product feed that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeedDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedDeleteUserError", + "description": "An error that occurs during the execution of `ProductFeedDelete`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductFeedDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductFeedDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `ProductFeedDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFeedEdge", + "description": "An auto-generated type which holds one ProductFeed and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductFeedEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeed", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFeedInput", + "description": "The input fields required to create a product feed.", + "fields": null, + "inputFields": [ + { + "name": "language", + "description": "The language of the product feed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LanguageCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "country", + "description": "The country of the product feed.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductFeedStatus", + "description": "The valid values for the status of product feed.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The product feed is active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INACTIVE", + "description": "The product feed is inactive.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFullSyncPayload", + "description": "Return type for `productFullSync` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFullSyncUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductFullSyncUserError", + "description": "An error that occurs during the execution of `ProductFullSync`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductFullSyncUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductFullSyncUserErrorCode", + "description": "Possible error codes that can be returned by `ProductFullSyncUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductImageSortKeys", + "description": "The set of valid sort keys for the ProductImage query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductImageUpdatePayload", + "description": "Return type for `productImageUpdate` mutation.", + "fields": [ + { + "name": "image", + "description": "The image that has been updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductInput", + "description": "The input fields required to create a product.", + "fields": null, + "inputFields": [ + { + "name": "descriptionHtml", + "description": "The description of the product, complete with HTML formatting.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "A unique, human-friendly string for the product.\nAutomatically generated from the product's title unless otherwise specified.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "redirectNewHandle", + "description": "Whether a redirect is required after a new handle has been provided.\nIf true, then the old handle is redirected to the new one automatically.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "seo", + "description": "The SEO information associated with the product.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SEOInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productType", + "description": "The product type specified by the merchant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "standardizedProductType", + "description": "The standardized product type in the Shopify product taxonomy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "StandardizedProductTypeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productCategory", + "description": "The product category in the Shopify product taxonomy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ProductCategoryInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customProductType", + "description": "The custom product type specified by the merchant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tags", + "description": "A comma separated list of tags that have been added to the product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "templateSuffix", + "description": "The theme template used when viewing the product in a store.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "giftCard", + "description": "Whether the product is a gift card.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "giftCardTemplateSuffix", + "description": "The theme template used when viewing the gift card in a store.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "The title of the product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "vendor", + "description": "The name of the product's vendor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "collectionsToJoin", + "description": "The IDs of the collections that this product will be added to.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "collectionsToLeave", + "description": "The IDs of collections that will no longer include the existing product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "Specifies the product to update in productUpdate or creates a new product if absent in productCreate.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "The metafields to associate with this product.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "options", + "description": "List of custom product options (maximum of 3 per product).", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "variants", + "description": "A list of variants associated with the product.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "status", + "description": "The status of the product.", + "type": { + "kind": "ENUM", + "name": "ProductStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requiresSellingPlan", + "description": "Whether the product can only be purchased with a selling plan (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to `true` on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductJoinSellingPlanGroupsPayload", + "description": "Return type for `productJoinSellingPlanGroups` mutation.", + "fields": [ + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductLeaveSellingPlanGroupsPayload", + "description": "Return type for `productLeaveSellingPlanGroups` mutation.", + "fields": [ + { + "name": "product", + "description": "The product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductMediaSortKeys", + "description": "The set of valid sort keys for the ProductMedia query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "description": "The product property names. For example, \"Size\", \"Color\", and \"Material\".\nVariants are selected based on permutations of these options.\nThe limit for each product property name is 255 characters.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product option’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The product option's position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The corresponding value to the product option name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPriceRange", + "description": "The price range of the product.", + "fields": [ + { + "name": "maxVariantPrice", + "description": "The highest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minVariantPrice", + "description": "The lowest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPriceRangeV2", + "description": "The price range of the product.", + "fields": [ + { + "name": "maxVariantPrice", + "description": "The highest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minVariantPrice", + "description": "The lowest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPublication", + "description": "Represents the channels where a product is published.", + "fields": [ + { + "name": "channel", + "description": "The channel where the product was or is published.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPublished", + "description": "Whether the publication is published or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product that was or is going to be published on the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishDate", + "description": "The date that the product was or is going to be published on the channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPublicationConnection", + "description": "An auto-generated type for paginating through multiple ProductPublications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductPublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPublicationEdge", + "description": "An auto-generated type which holds one ProductPublication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductPublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductPublicationInput", + "description": "The input fields for specifying a publication to which a product will be published.", + "fields": null, + "inputFields": [ + { + "name": "publicationId", + "description": "ID of the publication.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "publishDate", + "description": "The date and time that the product was (or will be) published.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductPublishInput", + "description": "The input fields for specifying a product to publish and the channels to publish it to.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The product to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productPublications", + "description": "The publication that the product is published to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductPublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPublishPayload", + "description": "Return type for `productPublish` mutation.", + "fields": [ + { + "name": "product", + "description": "The product that has been published.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productPublications", + "description": "The channels where the product is published.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPublication", + "ofType": null + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use Product.publications instead." + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReorderImagesPayload", + "description": "Return type for `productReorderImages` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job which reorders the images.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductReorderMediaPayload", + "description": "Return type for `productReorderMedia` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job which reorders the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `mediaUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductResourceFeedback", + "description": "Reports the status of product for a Sales Channel or Storefront API.\nThis might include why a product is not available in a Sales Channel\nand how a merchant might fix this.\n", + "fields": [ + { + "name": "feedbackGeneratedAt", + "description": "The time when the feedback was generated. Used to help determine whether\nincoming feedback is outdated compared to existing feedback.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "messages", + "description": "The feedback messages presented to the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "The ID of the product associated with the feedback.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productUpdatedAt", + "description": "The timestamp of the product associated with the feedback.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "Conveys the state of the feedback and whether it requires merchant action or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceFeedbackState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductResourceFeedbackInput", + "description": "The input fields used to create a product feedback.", + "fields": null, + "inputFields": [ + { + "name": "productId", + "description": "The ID of the product that the feedback was created on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "state", + "description": "Whether the merchant needs to take action on the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceFeedbackState", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "feedbackGeneratedAt", + "description": "The date and time when the payload is constructed.\nUsed to help determine whether incoming feedback is outdated compared to feedback already received, and if it should be ignored upon arrival.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productUpdatedAt", + "description": "The timestamp of the product associated with the feedback.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "messages", + "description": "A concise set of copy strings to be displayed to merchants. Used to guide merchants in resolving problems that your app encounters when trying to make use of their products.\nYou can specify up to four messages. Each message is limited to 100 characters.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductSale", + "description": "A sale associated with a product.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The line item for the associated sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductSortKeys", + "description": "The set of valid sort keys for the Product query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "Sort by the `product_type` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VENDOR", + "description": "Sort by the `vendor` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_TOTAL", + "description": "Sort by the `inventory_total` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLISHED_AT", + "description": "Sort by the `published_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\nPagination isn't supported when using this sort key.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductStatus", + "description": "The possible product statuses.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The product is ready to sell and can be published to sales channels and apps. Products with an active status aren't automatically published to sales channels, such as the online store, or apps. By default, existing products are set to active.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARCHIVED", + "description": "The product is no longer being sold and isn't available to customers on sales channels and apps.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT", + "description": "The product isn't ready to sell and is unavailable to customers on sales channels and apps. By default, duplicated and unarchived products are set to draft.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductTaxonomyNode", + "description": "Represents a [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) node.", + "fields": [ + { + "name": "fullName", + "description": "The full name of the product taxonomy node. For example, Animals & Pet Supplies > Pet Supplies > Dog Supplies > Dog Beds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the product taxonomy node.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isLeaf", + "description": "Whether the node is a leaf node.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRoot", + "description": "Whether the node is a root node.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product taxonomy node. For example, Dog Beds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductUnpublishInput", + "description": "The input fields for specifying a product to unpublish from a channel and the sales channels to unpublish it from.\n", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the product to create or update publications for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productPublications", + "description": "The channels to unpublish the product from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductPublicationInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductUnpublishPayload", + "description": "Return type for `productUnpublish` mutation.", + "fields": [ + { + "name": "product", + "description": "The product that has been unpublished.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductUpdateMediaPayload", + "description": "Return type for `productUpdateMedia` mutation.", + "fields": [ + { + "name": "media", + "description": "The updated media object.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product on which media was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `mediaUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductUpdatePayload", + "description": "Return type for `productUpdate` mutation.", + "fields": [ + { + "name": "product", + "description": "The updated product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "description": "Represents a product variant.", + "fields": [ + { + "name": "availableForSale", + "description": "Whether the product variant is available for sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "barcode", + "description": "The value of the barcode associated with the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtPrice", + "description": "The compare-at price of the variant in the default shop currency.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contextualPricing", + "description": "The pricing that applies for a customer in a given context.", + "args": [ + { + "name": "context", + "description": "The context used to generate contextual pricing for the variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ContextualPricingContext", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantContextualPricing", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the variant was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCursor", + "description": "A default cursor that returns the single next record, sorted ascending by ID.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfile", + "description": "The delivery profile for the variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "Display name of the variant, based on product's title + variant's title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "The fulfillment service that stocks a product variant.\n\nThis is a third-party fulfillment service if the following conditions are met:\n- The product variant is stocked by a single fulfillment service.\n- The [FulfillmentService](/api/admin-graphql/latest/objects/FulfillmentService) is a third-party fulfillment service. Third-party fulfillment services don't have a handle with the value `manual`.\n- The fulfillment service hasn't [opted into SKU sharing](/api/admin-graphql/latest/objects/FulfillmentService#field-fulfillmentservice-permitsskusharing).\n\nIf the conditions aren't met, then the fulfillment service has the `manual` handle.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "\nThe [relationship between a product variant and a fulfillment service was changed in the `2022-07` API version](/changelog/fulfillment-service-sku-sharing). A [ProductVariant](/api/admin-graphql/latest/objects/ProductVariant) can be stocked by multiple fulfillment services. As a result, we recommend that you use the [inventoryItem field](/api/admin-graphql/latest/objects/ProductVariant#field-productvariant-inventoryitem) if you need to determine where a product variant is stocked.\n\nIf you need to determine whether a product is a gift card, then you should continue to use this field until an alternative is available.\n\nLearn more about [managing inventory quantities and states](/apps/fulfillment/inventory-management-apps/quantities-states).\n" + }, + { + "name": "fulfillmentServiceEditable", + "description": "Whether changes to the fulfillment service for the product variant are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EditableProperty", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "harmonizedSystemCode", + "description": "The Harmonized System Code (or HS Tariff Code) for the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `InventoryItem.harmonizedSystemCode` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The featured image for the variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItem", + "description": "The inventory item, which is used to query for inventory information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryManagement", + "description": "The fulfillment service that tracks the number of items in stock for the product variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductVariantInventoryManagement", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use tracked attribute on `inventoryItem` instead." + }, + { + "name": "inventoryPolicy", + "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductVariantInventoryPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryQuantity", + "description": "The total sellable quantity of the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media", + "description": "The media associated with the product variant.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "namespace", + "description": "Filter metafield definitions by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter by the definition's pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentPrices", + "description": "List of prices and compare-at prices in the presentment currencies for this shop.", + "args": [ + { + "name": "presentmentCurrencies", + "description": "The presentment currencies prices should return in.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantPricePairConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `contextualPricing` instead." + }, + { + "name": "price", + "description": "The price of the product variant in the default shop currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "product", + "description": "The product that this variant belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantComponents", + "description": "A list of the product variant components.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantComponentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresComponents", + "description": "Whether a product variant requires components. The default value is `false`.\nIf `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted\nfrom channels that don't support bundles.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `InventoryItem.requiresShipping` instead." + }, + { + "name": "selectedOptions", + "description": "List of product options applied to the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellableOnlineQuantity", + "description": "The total sellable quantity of the variant for online channels.\nThis doesn't represent the total available inventory or capture\n[limitations based on customer location](https://help.shopify.com/manual/markets/inventory_and_fulfillment).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroupCount", + "description": "Count of selling plan groups associated with the product variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroups", + "description": "A list of all selling plan groups defined in the current shop associated with the product variant.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "A case-sensitive identifier for the product variant in the shop.\nRequired in order to connect to a fulfillment service.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontId", + "description": "The Storefront GraphQL API ID of the `ProductVariant`.\n\nAs of the `2022-04` version release, the Storefront GraphQL API will no longer return Base64 encoded IDs to match the behavior of the Admin GraphQL API. Therefore, you can safely use the `id` field's value instead.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "StorefrontID", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `id` instead." + }, + { + "name": "taxCode", + "description": "The tax code for the product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether a tax is charged when the product variant is sold.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time (ISO 8601 format) when the product variant was last modified.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The weight of the product variant in the unit system specified with weight_unit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weightUnit", + "description": "The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied. Valid values: `g`, `kg`, `oz`, `lb`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafieldDefinitions", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Navigable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantAppendMediaInput", + "description": "The input fields required to append media to a single variant.", + "fields": null, + "inputFields": [ + { + "name": "variantId", + "description": "Specifies the variant to which media will be appended.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mediaIds", + "description": "Specifies the media to append to the variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantAppendMediaPayload", + "description": "Return type for `productVariantAppendMedia` mutation.", + "fields": [ + { + "name": "product", + "description": "The product associated with the variants and media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The product variants that were updated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantComponent", + "description": "A product variant component associated with a product variant.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariant", + "description": "The product variant associated with the component.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The required quantity of the component.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantComponentConnection", + "description": "An auto-generated type for paginating through multiple ProductVariantComponents.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantComponentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductVariantComponentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantComponent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantComponentEdge", + "description": "An auto-generated type which holds one ProductVariantComponent and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductVariantComponentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantComponent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "description": "An auto-generated type for paginating through multiple ProductVariants.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductVariantEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantContextualPricing", + "description": "The price of a product variant in a specific country.\nPrices vary between countries.\n", + "fields": [ + { + "name": "compareAtPrice", + "description": "The final compare-at price after all adjustments are applied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The final price after all adjustments are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityRule", + "description": "The quantity rule applied for a given context.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantCreatePayload", + "description": "Return type for `productVariantCreate` mutation.", + "fields": [ + { + "name": "product", + "description": "The product associated with the variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariant", + "description": "The successfully created variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantDeletePayload", + "description": "Return type for `productVariantDelete` mutation.", + "fields": [ + { + "name": "deletedProductVariantId", + "description": "The ID of the deleted product variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "The product associated with the deleted product variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantDetachMediaInput", + "description": "The input fields required to detach media from a single variant.", + "fields": null, + "inputFields": [ + { + "name": "variantId", + "description": "Specifies the variant from which media will be detached.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mediaIds", + "description": "Specifies the media to detach from the variant.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantDetachMediaPayload", + "description": "Return type for `productVariantDetachMedia` mutation.", + "fields": [ + { + "name": "product", + "description": "The product associated with the variants and media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The product variants that were updated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantEdge", + "description": "An auto-generated type which holds one ProductVariant and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductVariantEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantGroupRelationshipInput", + "description": "The input fields for the bundle components for core.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the product variant that's a component of the bundle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The number of units of the product variant required to construct one unit of the bundle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantInput", + "description": "The input fields for specifying a product variant to create or update.", + "fields": null, + "inputFields": [ + { + "name": "requiresComponents", + "description": "Whether a product variant requires components. The default value is `false`.\nIf `true`, then the product variant can only be purchased as a parent bundle with components and it will be omitted\nfrom channels that don't support bundles.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "barcode", + "description": "The value of the barcode associated with the product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "compareAtPrice", + "description": "The compare-at price of the variant.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "harmonizedSystemCode", + "description": "The Harmonized System code (or HS Tariff code) for the variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "Specifies the product variant to update or create a new variant if absent.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mediaId", + "description": "The ID of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the IDs being created on the product. This field only accepts one value.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mediaSrc", + "description": "The URL of the media to associate with the variant. This field can only be used in mutations that create media images and must match one of the URLs being created on the product. This field only accepts one value.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "inventoryPolicy", + "description": "Whether customers are allowed to place an order for the product variant when it's out of stock.", + "type": { + "kind": "ENUM", + "name": "ProductVariantInventoryPolicy", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "inventoryQuantities", + "description": "The inventory quantities at each location where the variant is stocked.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryLevelInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "inventoryItem", + "description": "The inventory item associated with the variant. Used for unit cost.", + "type": { + "kind": "INPUT_OBJECT", + "name": "InventoryItemInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "Additional customizable information about the product variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "options", + "description": "The custom properties that a shop owner uses to define product variants.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "position", + "description": "The order of the product variant in the list of product variants. The first position in the list is 1.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the variant.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The product to create the variant for. Used as input only to the `productVariantCreate` mutation.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requiresShipping", + "description": "Whether the variant requires shipping.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU for the variant. Case-sensitive string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxCode", + "description": "The tax code associated with the variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weight", + "description": "The weight of the variant.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weightUnit", + "description": "The unit of weight that's used to measure the variant.", + "type": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantInventoryManagement", + "description": "The valid values for the method of inventory tracking for a product variant.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHOPIFY", + "description": "This product variant's inventory is tracked by Shopify. Inventory can be tracked by store location(s) and/or third-party fulfillment service(s).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_MANAGED", + "description": "This product variant's inventory is not tracked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_SERVICE", + "description": "This product variant's inventory is tracked by a third-party fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantInventoryPolicy", + "description": "The valid values for the inventory policy of a product variant once it is out of stock.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DENY", + "description": "Customers can't buy this product variant after it's out of stock.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTINUE", + "description": "Customers can buy this product variant after it's out of stock.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantJoinSellingPlanGroupsPayload", + "description": "Return type for `productVariantJoinSellingPlanGroups` mutation.", + "fields": [ + { + "name": "productVariant", + "description": "The product variant object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantLeaveSellingPlanGroupsPayload", + "description": "Return type for `productVariantLeaveSellingPlanGroups` mutation.", + "fields": [ + { + "name": "productVariant", + "description": "The product variant object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantPositionInput", + "description": "The input fields representing a product variant position.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "Specifies the ID of the product variant to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "position", + "description": "The order of the product variant in the list of product variants. The first position in the list is 1.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantPricePair", + "description": "The compare-at price and price of a variant sharing a currency.\n", + "fields": [ + { + "name": "compareAtPrice", + "description": "The compare-at price of the variant with associated currency.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the variant with associated currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantPricePairConnection", + "description": "An auto-generated type for paginating through multiple ProductVariantPricePairs.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantPricePairEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductVariantPricePairEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantPricePair", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantPricePairEdge", + "description": "An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductVariantPricePairEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantPricePair", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantRelationshipBulkUpdatePayload", + "description": "Return type for `productVariantRelationshipBulkUpdate` mutation.", + "fields": [ + { + "name": "parentProductVariants", + "description": "The product variants with successfully updated product variant relationships.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantRelationshipBulkUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantRelationshipBulkUpdateUserError", + "description": "An error that occurs during the execution of `ProductVariantRelationshipBulkUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductVariantRelationshipBulkUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantRelationshipBulkUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `ProductVariantRelationshipBulkUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PARENT_REQUIRED", + "description": "A parent product variant ID or product ID must be provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_CREATE", + "description": "Unable to create parent product variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANTS_NOT_FOUND", + "description": "The product variants were not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CIRCULAR_REFERENCE", + "description": "A parent product variant cannot contain itself as a component.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NESTED_PARENT_PRODUCT_VARIANT", + "description": "Nested parent product variants aren't supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUANTITY", + "description": "Product variant relationships must have a quantity greater than 0.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_PRODUCT_VARIANT_RELATIONSHIP", + "description": "A parent product variant must not contain duplicate product variant relationships.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCEEDED_PRODUCT_VARIANT_RELATIONSHIP_LIMIT", + "description": "Exceeded the maximum allowable product variant relationships in a parent product variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_RELATIONSHIP_TYPE_CONFLICT", + "description": "A Core type relationship cannot be added to a composite product variant with SFN type relationships.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNEXPECTED_ERROR", + "description": "Unexpected error.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_REMOVE", + "description": "Unable to remove product variant relationships.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUST_SPECIFY_COMPONENTS", + "description": "The product variant relationships to remove must be specified if all the parent product variant's components aren't being removed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_UPDATE", + "description": "Unable to update product variant relationships.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED_TO_UPDATE_PARENT_PRODUCT_VARIANT_PRICE", + "description": "Unable to update parent product variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATE_PARENT_VARIANT_PRICE_REQUIRED", + "description": "A price must be provided for a parent product variant if the price calucation is set to fixed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANTS_NOT_COMPONENTS", + "description": "Some of the provided product variants are not components of the specified parent product variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_EXPANDER_APP_OWNERSHIP_ALREADY_EXISTS", + "description": "The products for these product variants are already owned by another App.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_MULTIPACK_RELATIONSHIP", + "description": "Multipack bundles are not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARENT_PRODUCT_VARIANT_CANNOT_BE_GIFT_CARD", + "description": "Gift cards cannot be parent product variants.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARENT_PRODUCT_VARIANT_CANNOT_REQUIRE_SELLING_PLAN", + "description": "Parent product variants cannot require a selling plan.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantRelationshipUpdateInput", + "description": "The input fields for updating a composite product variant.", + "fields": null, + "inputFields": [ + { + "name": "parentProductVariantId", + "description": "The product variant ID representing that which contains the relationships with other variants.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "parentProductId", + "description": "A product ID which contains product variants that have relationships with other variants.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productVariantRelationshipsToCreate", + "description": "The product variants and associated quantitites to add to the product variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantGroupRelationshipInput", + "ofType": null + } + } + }, + "defaultValue": "null" + }, + { + "name": "productVariantRelationshipsToUpdate", + "description": "The product variants and associated quantitites to update in specified product variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductVariantGroupRelationshipInput", + "ofType": null + } + } + }, + "defaultValue": "null" + }, + { + "name": "productVariantRelationshipsToRemove", + "description": "The bundle component product variants to be removed from the product variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": "null" + }, + { + "name": "removeAllProductVariantRelationships", + "description": "Whether to remove all components from the product variant. The default value is `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "priceInput", + "description": "Method in which to update the price of the parent product variant.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceInput", + "ofType": null + }, + "defaultValue": "null" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "description": "The set of valid sort keys for the ProductVariant query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SKU", + "description": "Sort by the `sku` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_QUANTITY", + "description": "Sort by the `inventory_quantity` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_MANAGEMENT", + "description": "Sort by the `inventory_management` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_LEVELS_AVAILABLE", + "description": "Sort by available inventory quantity in the location specified by the `query:\"location_id:\"` argument.\nDon't use this sort key when no `location_id` in query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_POLICY", + "description": "Sort by the `inventory_policy` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULL_TITLE", + "description": "Sort by the `full_title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POPULAR", + "description": "Sort by the `popular` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantUpdatePayload", + "description": "Return type for `productVariantUpdate` mutation.", + "fields": [ + { + "name": "product", + "description": "The product associated with the variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariant", + "description": "The updated variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkCreatePayload", + "description": "Return type for `productVariantsBulkCreate` mutation.", + "fields": [ + { + "name": "product", + "description": "The updated product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The newly created variants.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantsBulkCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkCreateUserError", + "description": "Error codes for failed product variant bulk create mutations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductVariantsBulkCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantsBulkCreateUserErrorCode", + "description": "Possible error codes that can be returned by `ProductVariantsBulkCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_KEY_ON_CREATE", + "description": "On create, this key cannot be used.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_ALREADY_EXISTS", + "description": "Variant already exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "Variant price must be greater than or equal to zero.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEED_TO_ADD_OPTION_VALUES", + "description": "Variant options are not enough.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS", + "description": "Variant options are more than the product options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_INVENTORY_LOCATIONS", + "description": "Inventory locations cannot exceed the allowed resource limit or 10.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_VIOLATION", + "description": "You reached the limit of available SKUs in your current plan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_ALREADY_EXISTS_CHANGE_OPTION_VALUE", + "description": "Variant options already exist. Please change the variant option(s).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRACKED_VARIANT_LOCATION_NOT_FOUND", + "description": "Quantity could not be set. The location was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUST_BE_FOR_THIS_PRODUCT", + "description": "Input must be for this product.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_DEFINED_FOR_SHOP", + "description": "Input is not defined for this shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "Invalid input detected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEGATIVE_PRICE_VALUE", + "description": "Price cannot take a negative value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkDeletePayload", + "description": "Return type for `productVariantsBulkDelete` mutation.", + "fields": [ + { + "name": "product", + "description": "The updated product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantsBulkDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkDeleteUserError", + "description": "Error codes for failed bulk variant delete mutations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductVariantsBulkDeleteUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantsBulkDeleteUserErrorCode", + "description": "Possible error codes that can be returned by `ProductVariantsBulkDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_DELETE_LAST_VARIANT", + "description": "Cannot delete default variant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AT_LEAST_ONE_VARIANT_DOES_NOT_BELONG_TO_THE_PRODUCT", + "description": "The variant does not exist.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductVariantsBulkInput", + "description": "The input fields for specifying a product variant to create as part of a variant bulk mutation.", + "fields": null, + "inputFields": [ + { + "name": "barcode", + "description": "The value of the barcode associated with the product variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "compareAtPrice", + "description": "The compare-at price of the variant.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "harmonizedSystemCode", + "description": "The Harmonized System code (or HS Tariff code) for the variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "Specifies the product variant to update or delete.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mediaSrc", + "description": "The URL of the media to associate with the variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "inventoryPolicy", + "description": "Whether customers are allowed to place an order for the variant when it's out of stock.", + "type": { + "kind": "ENUM", + "name": "ProductVariantInventoryPolicy", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "inventoryQuantities", + "description": "The inventory quantities at each location where the variant is stocked. The number of elements\nin the array of inventory quantities can't exceed the amount specified for the plan.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InventoryLevelInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "inventoryItem", + "description": "The inventory item associated with the variant, used for unit cost.", + "type": { + "kind": "INPUT_OBJECT", + "name": "InventoryItemInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mediaId", + "description": "The ID of the media that's associated with the variant.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "The additional customizable information about the product variant.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "options", + "description": "The custom properties that a shop owner uses to define product variants.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "price", + "description": "The price of the variant.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "requiresShipping", + "description": "Whether the variant requires shipping.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The SKU for the variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "taxCode", + "description": "The tax code associated with the variant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weight", + "description": "The weight of the variant.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "weightUnit", + "description": "The unit of weight that's used to measure the variant.", + "type": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkReorderPayload", + "description": "Return type for `productVariantsBulkReorder` mutation.", + "fields": [ + { + "name": "product", + "description": "The updated product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantsBulkReorderUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkReorderUserError", + "description": "Error codes for failed bulk product variants reorder operation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductVariantsBulkReorderUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantsBulkReorderUserErrorCode", + "description": "Possible error codes that can be returned by `ProductVariantsBulkReorderUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_VARIANT", + "description": "Product variant does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_POSITION", + "description": "Product variant position cannot be zero or negative number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATED_VARIANT_ID", + "description": "Product variant IDs must be unique.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdatePayload", + "description": "Return type for `productVariantsBulkUpdate` mutation.", + "fields": [ + { + "name": "product", + "description": "The updated product object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "The updated variants.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantsBulkUpdateUserError", + "description": "Error codes for failed variant bulk update mutations.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductVariantsBulkUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantsBulkUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `ProductVariantsBulkUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_ID_MISSING", + "description": "Product variant is missing ID attribute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", + "description": "Product variant does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_INVENTORY_QUANTITIES_ON_VARIANTS_UPDATE", + "description": "Inventory quantities cannot be updated with variants API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_ALREADY_EXISTS", + "description": "The variant already exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The price of the variant must be greater than or equal to zero.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEED_TO_ADD_OPTION_VALUES", + "description": "Variant options are not enough.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTION_VALUES_FOR_NUMBER_OF_UNKNOWN_OPTIONS", + "description": "Variant options are more than the product options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_VIOLATION", + "description": "You reached the limit of available SKUs in your current plan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_INVENTORY_QUANTITES_DURING_UPDATE", + "description": "Inventory quantities cannot be provided during update.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEGATIVE_PRICE_VALUE", + "description": "Price cannot take a negative value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProfileItemSortKeys", + "description": "The set of valid sort keys for the ProfileItem query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "Sort by the `product_type` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VENDOR", + "description": "Sort by the `vendor` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_TOTAL", + "description": "Sort by the `inventory_total` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLISHED_AT", + "description": "Sort by the `published_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PubSubServerPixelUpdatePayload", + "description": "Return type for `pubSubServerPixelUpdate` mutation.", + "fields": [ + { + "name": "serverPixel", + "description": "The server pixel as configured by the mutation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionCreatePayload", + "description": "Return type for `pubSubWebhookSubscriptionCreate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionCreateUserError", + "description": "An error that occurs during the execution of `PubSubWebhookSubscriptionCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PubSubWebhookSubscriptionCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PubSubWebhookSubscriptionCreateUserErrorCode", + "description": "Possible error codes that can be returned by `PubSubWebhookSubscriptionCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID_PARAMETERS", + "description": "Invalid parameters provided.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PubSubWebhookSubscriptionInput", + "description": "The input fields for a PubSub webhook subscription.\n", + "fields": null, + "inputFields": [ + { + "name": "pubSubProject", + "description": "The Pub/Sub project ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pubSubTopic", + "description": "The Pub/Sub topic ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "format", + "description": "The format in which the webhook subscription should send the data.", + "type": { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeFields", + "description": "The list of fields to be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "metafieldNamespaces", + "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionUpdatePayload", + "description": "Return type for `pubSubWebhookSubscriptionUpdate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionUpdateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PubSubWebhookSubscriptionUpdateUserError", + "description": "An error that occurs during the execution of `PubSubWebhookSubscriptionUpdate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PubSubWebhookSubscriptionUpdateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PubSubWebhookSubscriptionUpdateUserErrorCode", + "description": "Possible error codes that can be returned by `PubSubWebhookSubscriptionUpdateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID_PARAMETERS", + "description": "Invalid parameters provided.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Publication", + "description": "A publication is a group of products and collections that is published to an app.\n", + "fields": [ + { + "name": "app", + "description": "The app associated with the publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use [AppCatalog.apps](https://shopify.dev/api/admin-graphql/unstable/objects/AppCatalog#connection-appcatalog-apps) instead." + }, + { + "name": "autoPublish", + "description": "Whether new products are automatically published to this publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalog", + "description": "The catalog associated with the publication.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionPublicationsV3", + "description": "The collection publications for the list of collections published to the publication.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collections", + "description": "The list of collections published to the publication.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasCollection", + "description": "Whether the collection is available to the publication.", + "args": [ + { + "name": "id", + "description": "Collection ID to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use [Catalog.title](https://shopify.dev/api/admin-graphql/unstable/interfaces/Catalog#field-catalog-title) instead." + }, + { + "name": "operation", + "description": "A background operation associated with this publication.", + "args": [], + "type": { + "kind": "UNION", + "name": "PublicationOperation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productPublicationsV3", + "description": "The product publications for the list of products published to the publication.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products published to the publication.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportsFuturePublishing", + "description": "Whether the publication supports future publishing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationConnection", + "description": "An auto-generated type for paginating through multiple Publications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PublicationCreateInput", + "description": "The input fields for creating a publication.", + "fields": null, + "inputFields": [ + { + "name": "catalogId", + "description": "The ID of the catalog.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "defaultState", + "description": "Whether to create an empty publication or prepopulate it with all products.", + "type": { + "kind": "ENUM", + "name": "PublicationCreateInputPublicationDefaultState", + "ofType": null + }, + "defaultValue": "EMPTY" + }, + { + "name": "autoPublish", + "description": "Whether to automatically add newly created products to this publication.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PublicationCreateInputPublicationDefaultState", + "description": "The input fields for the possible values for the default state of a publication.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "EMPTY", + "description": "The publication is empty.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL_PRODUCTS", + "description": "The publication is populated with all products.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationCreatePayload", + "description": "Return type for `publicationCreate` mutation.", + "fields": [ + { + "name": "publication", + "description": "The publication that's been created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationDeletePayload", + "description": "Return type for `publicationDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the publication that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationEdge", + "description": "An auto-generated type which holds one Publication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PublicationInput", + "description": "The input fields required to publish a resource.", + "fields": null, + "inputFields": [ + { + "name": "publicationId", + "description": "ID of the publication.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "publishDate", + "description": "The date and time that the resource was published. Setting this to a date in the future will schedule the resource to be published. Only online store channels support future publishing. This field has no effect if you include it in the `publishableUnpublish` mutation.\n", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PublicationOperation", + "description": "The possible types of publication operations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AddAllProductsOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CatalogCsvOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PublicationResourceOperation", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PublicationResourceOperation", + "description": "A bulk update operation on a publication.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedRowCount", + "description": "The count of processed rows, summing imported, failed, and skipped rows.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rowCount", + "description": "Represents a rows objects within this background operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RowCount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceOperationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PublicationUpdateInput", + "description": "The input fields for updating a publication.", + "fields": null, + "inputFields": [ + { + "name": "publishablesToAdd", + "description": "A list of publishable IDs to add. The maximum number of publishables to update simultaneously is 50.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": "[]" + }, + { + "name": "publishablesToRemove", + "description": "A list of publishable IDs to remove. The maximum number of publishables to update simultaneously is 50.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": "[]" + }, + { + "name": "autoPublish", + "description": "Whether new products should be automatically published to the publication.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationUpdatePayload", + "description": "Return type for `publicationUpdate` mutation.", + "fields": [ + { + "name": "publication", + "description": "The publication that's been updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublicationUserError", + "description": "Defines errors encountered while managing a publication.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PublicationUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PublicationUserErrorCode", + "description": "Possible error codes that can be returned by `PublicationUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNSUPPORTED_PUBLICATION_ACTION", + "description": "Can't perform this action on a publication.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLICATION_NOT_FOUND", + "description": "Publication not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLICATION_LOCKED", + "description": "The publication is currently being modified. Please try again later.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSUPPORTED_PUBLISHABLE_TYPE", + "description": "A catalog publication can only contain products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PUBLISHABLE_ID", + "description": "Publishable ID not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_NOT_FOUND", + "description": "Market does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_NOT_FOUND", + "description": "Catalog does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_APP_CATALOG_PUBLICATION", + "description": "Can't modify a publication that belongs to an app catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_MARKET_CATALOG_PUBLICATION", + "description": "Can't modify a publication that belongs to a market catalog.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_APP_CATALOG", + "description": "Cannot modify a catalog for an app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANNOT_MODIFY_MARKET_CATALOG", + "description": "Cannot modify a catalog for a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE_INCOMPATIBLE_WITH_CATALOG_TYPE", + "description": "A product publication cannot be created because the catalog type associated with this publication does not permit publications of this product type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLICATION_UPDATE_LIMIT_EXCEEDED", + "description": "The limit for simultaneous publication updates has been exceeded.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Publishable", + "description": "Represents a resource that can be published to a channel.\nA publishable resource can be either a Product or Collection.\n", + "fields": [ + { + "name": "availablePublicationCount", + "description": "The number of publications a resource is published to without feedback errors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicationCount", + "description": "The number of publications a resource is published on.", + "args": [ + { + "name": "onlyPublished", + "description": "Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedOnChannel", + "description": "Check to see whether the resource is published to a given channel.", + "args": [ + { + "name": "channelId", + "description": "The ID of the channel to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnPublication` instead." + }, + { + "name": "publishedOnCurrentChannel", + "description": "Check to see whether the resource is published to the calling app's channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publishedOnCurrentPublication` instead." + }, + { + "name": "publishedOnCurrentPublication", + "description": "Check to see whether the resource is published to the calling app's publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedOnPublication", + "description": "Check to see whether the resource is published to a given publication.", + "args": [ + { + "name": "publicationId", + "description": "The ID of the publication to check.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublications", + "description": "The list of resources that are published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourcePublicationsV2", + "description": "The list of resources that are either published or staged to be published to a publication.", + "args": [ + { + "name": "onlyPublished", + "description": "Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "catalogType", + "description": "Filter publications by catalog type.", + "type": { + "kind": "ENUM", + "name": "CatalogType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2Connection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unpublishedChannels", + "description": "The list of channels that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `unpublishedPublications` instead." + }, + { + "name": "unpublishedPublications", + "description": "The list of publications that the resource is not published to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "PublishablePublishPayload", + "description": "Return type for `publishablePublish` mutation.", + "fields": [ + { + "name": "publishable", + "description": "Resource that has been published.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublishablePublishToCurrentChannelPayload", + "description": "Return type for `publishablePublishToCurrentChannel` mutation.", + "fields": [ + { + "name": "publishable", + "description": "Resource that has been published.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublishableUnpublishPayload", + "description": "Return type for `publishableUnpublish` mutation.", + "fields": [ + { + "name": "publishable", + "description": "Resource that has been unpublished.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PublishableUnpublishToCurrentChannelPayload", + "description": "Return type for `publishableUnpublishToCurrentChannel` mutation.", + "fields": [ + { + "name": "publishable", + "description": "Resource that has been unpublished.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PurchasingCompany", + "description": "Represents information about the purchasing company for the order or draft order.\n", + "fields": [ + { + "name": "company", + "description": "The company associated to the order or draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contact", + "description": "The company contact associated to the order or draft order.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The company location associated to the order or draft order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PurchasingCompanyInput", + "description": "The input fields for a purchasing company, which is a combination of company, company contact, and company location.\n", + "fields": null, + "inputFields": [ + { + "name": "companyId", + "description": "ID of the company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyContactId", + "description": "ID of the company contact.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "companyLocationId", + "description": "ID of the company location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PurchasingEntity", + "description": "Represents information about the purchasing entity for the order or draft order.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PurchasingCompany", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "PurchasingEntityInput", + "description": "The input fields for a purchasing entity. Can either be a customer or a purchasing company.", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "Represents a customer. Null if there's a purchasing company.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "purchasingCompany", + "description": "Represents a purchasing company. Null if there's a customer.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PurchasingCompanyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRule", + "description": "The quantity rule for the product variant in a given context.\n", + "fields": [ + { + "name": "increment", + "description": "The value that specifies the quantity increment between minimum and maximum of the rule.\nOnly quantities divisible by this value will be considered valid.\n\nThe increment must be lower than or equal to the minimum and the maximum, and both minimum and maximum\nmust be divisible by this value.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDefault", + "description": "Whether the quantity rule fields match one increment, one minimum and no maximum.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximum", + "description": "An optional value that defines the highest allowed quantity purchased by the customer.\nIf defined, maximum must be lower than or equal to the minimum and must be a multiple of the increment.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimum", + "description": "The value that defines the lowest allowed quantity purchased by the customer.\nThe minimum must be a multiple of the quantity rule's increment.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originType", + "description": "Whether the values of the quantity rule were explicitly set.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "QuantityRuleOriginType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariant", + "description": "The product variant for which the quantity rule is applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRuleConnection", + "description": "An auto-generated type for paginating through multiple QuantityRules.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRuleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in QuantityRuleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRule", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total count of QuantityRules. Note: The maximum count limit is 10000.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRuleEdge", + "description": "An auto-generated type which holds one QuantityRule and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of QuantityRuleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "QuantityRuleInput", + "description": "The input fields for the per-order quantity rule to be applied on the product variant.\n", + "fields": null, + "inputFields": [ + { + "name": "increment", + "description": "The quantity increment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "maximum", + "description": "The maximum quantity.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "minimum", + "description": "The minimum quantity.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantId", + "description": "Product variant on which to apply the quantity rule.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "QuantityRuleOriginType", + "description": "The origin of quantity rule on a price list.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FIXED", + "description": "Quantity rule is explicitly defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELATIVE", + "description": "Quantity rule falls back to the relative rule.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRuleUserError", + "description": "An error for a failed quantity rule operation.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "QuantityRuleUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "QuantityRuleUserErrorCode", + "description": "Possible error codes that can be returned by `QuantityRuleUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", + "description": "Product variant ID does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_LIST_DOES_NOT_EXIST", + "description": "Price list does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANT_QUANTITY_RULE_DOES_NOT_EXIST", + "description": "Quantity rule for variant associated with the price list provided does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MINIMUM_IS_GREATER_THAN_MAXIMUM", + "description": "Minimum must be lower than or equal to the maximum.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCREMENT_IS_GREATER_THAN_MINIMUM", + "description": "Increment must be lower than or equal to the minimum.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "Value must be greater than or equal to 1.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_NOT_MULTIPLE_OF_INCREMENT", + "description": "The maximum must be a multiple of the increment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MINIMUM_NOT_MULTIPLE_OF_INCREMENT", + "description": "The minimum must be a multiple of the increment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG_CONTEXT_DOES_NOT_SUPPORT_QUANTITY_RULES", + "description": "Quantity rules can be associated only with company location catalogs.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERIC_ERROR", + "description": "Something went wrong when trying to save the quantity rule. Please try again later.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRulesAddPayload", + "description": "Return type for `quantityRulesAdd` mutation.", + "fields": [ + { + "name": "quantityRules", + "description": "The list of quantity rules that were added to or updated in the price list.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRule", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QuantityRulesDeletePayload", + "description": "Return type for `quantityRulesDelete` mutation.", + "fields": [ + { + "name": "deletedQuantityRulesVariantIds", + "description": "A list of product variant IDs whose quantity rules were removed from the price list.\n", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "QuantityRuleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QueryRoot", + "description": "The schema's entry-point for queries. This acts as the public, top-level API from which all queries must start.", + "fields": [ + { + "name": "abandonment", + "description": "Returns an abandonment by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Abandonment to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Abandonment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "abandonmentByAbandonedCheckoutId", + "description": "Returns an Abandonment by the Abandoned Checkout ID.", + "args": [ + { + "name": "abandonedCheckoutId", + "description": "The ID of the Abandoned Checkout ID to query by.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Abandonment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "Lookup an App by ID or return the currently authenticated App.", + "args": [ + { + "name": "id", + "description": "The ID to lookup the App by.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appByHandle", + "description": "Fetches app by handle.\nReturns null if the app doesn't exist.\n", + "args": [ + { + "name": "handle", + "description": "Handle of the App.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appByKey", + "description": "Fetches an app by its client ID.\nReturns null if the app doesn't exist.\n", + "args": [ + { + "name": "apiKey", + "description": "Client ID of the app.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appDiscountType", + "description": "An app discount type.\n", + "args": [ + { + "name": "functionId", + "description": "The ID for the function providing the app discount type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppDiscountType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appDiscountTypes", + "description": "A list of app discount types installed by apps.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppDiscountType", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appInstallation", + "description": "Lookup an AppInstallation by ID or return the AppInstallation for the currently authenticated App.", + "args": [ + { + "name": "id", + "description": "ID used to lookup AppInstallation.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appInstallations", + "description": "List of app installations. Requires the `read_apps` access scope.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AppInstallationSortKeys", + "ofType": null + }, + "defaultValue": "INSTALLED_AT" + }, + { + "name": "category", + "description": "The category of app installations to fetch.", + "type": { + "kind": "ENUM", + "name": "AppInstallationCategory", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "privacy", + "description": "The privacy level of app installations to fetch.", + "type": { + "kind": "ENUM", + "name": "AppInstallationPrivacy", + "ofType": null + }, + "defaultValue": "PUBLIC" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppInstallationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "automaticDiscount", + "description": "Returns an automatic discount resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DiscountAutomatic to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "UNION", + "name": "DiscountAutomatic", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `automaticDiscountNode` instead." + }, + { + "name": "automaticDiscountNode", + "description": "Returns an automatic discount resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DiscountAutomaticNode to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountAutomaticNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "automaticDiscountNodes", + "description": "List of automatic discounts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AutomaticDiscountSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `status`\n - `type`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticNodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "automaticDiscountSavedSearches", + "description": "List of the shop's automatic discount saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "automaticDiscounts", + "description": "List of automatic discounts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "AutomaticDiscountSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `status`\n - `type`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAutomaticConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `automaticDiscountNodes` instead." + }, + { + "name": "availableCarrierServices", + "description": "Returns a list of activated carrier services and associated shop locations that support them.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCarrierServiceAndLocations", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableLocales", + "description": "A list of available locales.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Locale", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "carrierService", + "description": "Returns a `DeliveryCarrierService` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DeliveryCarrierService to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartTransforms", + "description": "List of Cart transform objects owned by the current API client.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartTransformConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalog", + "description": "Returns a Catalog resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Catalog to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "Catalog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogOperations", + "description": "Returns the most recent catalog operations for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "ResourceOperation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogs", + "description": "The catalogs belonging to the shop.", + "args": [ + { + "name": "type", + "description": "The type of the catalogs to be returned.", + "type": { + "kind": "ENUM", + "name": "CatalogType", + "ofType": null + }, + "defaultValue": "null" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CatalogSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `app_id`\n - `company_id`\n - `company_location_id`\n - `managed_country_id`\n - `market_id`\n - `status`\n - `title`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CatalogConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channel", + "description": "Lookup a channel by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Channel to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `publication` instead." + }, + { + "name": "channels", + "description": "List of the active sales channels.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publications` instead." + }, + { + "name": "checkoutProfile", + "description": "A checkout profile on a shop.", + "args": [ + { + "name": "id", + "description": "The ID of the checkout profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutProfiles", + "description": "List of checkout profiles on a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CheckoutProfileSortKeys", + "ofType": null + }, + "defaultValue": "UPDATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `is_published`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProfileConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeDiscountNode", + "description": "Returns a code discount resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DiscountCodeNode to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeDiscountNodeByCode", + "description": "Returns a code discount identified by its discount code.", + "args": [ + { + "name": "code", + "description": "The case-insensitive code of the `DiscountCodeNode` to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountCodeNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeDiscountNodes", + "description": "List of code discounts. Special fields for query params:\n * status: active, expired, scheduled\n * discount_type: bogo, fixed_amount, free_shipping, percentage.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CodeDiscountSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `combines_with`\n - `created_at`\n - `discount_type`\n - `ends_at`\n - `starts_at`\n - `status`\n - `times_used`\n - `title`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountCodeNodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "codeDiscountSavedSearches", + "description": "List of the shop's code discount saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collection", + "description": "Returns a Collection resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Collection to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionByHandle", + "description": "Return a collection by its handle.\n", + "args": [ + { + "name": "handle", + "description": "The handle of the collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionRulesConditions", + "description": "Lists all rules that can be used to create smart collections.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionRuleConditions", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionSavedSearches", + "description": "Returns a list of the shop's collection saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collections", + "description": "Returns a list of collections.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CollectionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `collection_type`\n - `product_publication_status`\n - `publishable_status`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companies", + "description": "Returns the list of companies in the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanySortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `active_customers_count`\n - `created_at`\n - `external_id`\n - `name`\n - `since_date`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "Returns a `Company` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Company to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Company", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContact", + "description": "Returns a `CompanyContact` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the CompanyContact to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContact", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyContactRole", + "description": "Returns a `CompanyContactRole` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the CompanyContactRole to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyContactRole", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyCount", + "description": "The number of companies for a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocation", + "description": "Returns a `CompanyLocation` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the CompanyLocation to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompanyLocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyLocations", + "description": "Returns the list of company locations in the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CompanyLocationSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `company_id`\n - `created_at`\n - `external_id`\n - `ids`\n - `name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyLocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentAppInstallation", + "description": "Return the AppInstallation for the currently authenticated App.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppInstallation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentBulkOperation", + "description": "Returns the current app's most recent BulkOperation. Apps can run one bulk query and one bulk mutation operation at a time, by shop.", + "args": [ + { + "name": "type", + "description": "The current bulk operation's type.", + "type": { + "kind": "ENUM", + "name": "BulkOperationType", + "ofType": null + }, + "defaultValue": "QUERY" + } + ], + "type": { + "kind": "OBJECT", + "name": "BulkOperation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "Returns a Customer resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Customer to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerMergeJobStatus", + "description": "Returns the status of a customer merge request job.", + "args": [ + { + "name": "jobId", + "description": "The ID of the job performing the customer merge request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerMergeRequest", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerMergePreview", + "description": "Returns a preview of a customer merge request.", + "args": [ + { + "name": "customerOneId", + "description": "The ID of the first customer that will be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerTwoId", + "description": "The ID of the second customer that will be merged.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "overrideFields", + "description": "The fields to override the default customer merge rules.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerMergeOverrideFields", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerMergePreview", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethod", + "description": "Returns a CustomerPaymentMethod resource by its ID.", + "args": [ + { + "name": "id", + "description": "The ID of the CustomerPaymentMethod to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSegmentMembers", + "description": "The list of members, such as customers, that's associated with an individual segment.", + "args": [ + { + "name": "segmentId", + "description": "The ID of the segment.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as `email_subscription_status = 'SUBSCRIBED'` with [this syntax](https://shopify.dev/api/shopifyql/segment-query-language-reference).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "queryId", + "description": "The ID of the segment members query.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "timezone", + "description": "The timezone that's used to interpret relative date arguments. The timezone defaults to UTC if the timezone isn't provided.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the list. The sorting behaviour defaults to ascending order.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the list by a given key.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerSegmentMemberConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSegmentMembersQuery", + "description": "Returns a segment members query resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the CustomerSegmentMembersQuery to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerSegmentMembersQuery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSegmentMembership", + "description": "Whether a member, which is a customer, belongs to a segment.", + "args": [ + { + "name": "segmentIds", + "description": "The segments to evaluate for the given customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "customerId", + "description": "The ID of the customer that has the membership.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMembershipResponse", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customers", + "description": "List of customers.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CustomerSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `accepts_marketing`\n - `country`\n - `customer_date`\n - `email`\n - `last_abandoned_order_date`\n - `order_date`\n - `orders_count`\n - `phone`\n - `state`\n - `tag`\n - `tag_not`\n - `total_spent`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletionEvents", + "description": "The paginated list of deletion events.", + "args": [ + { + "name": "subjectTypes", + "description": "List of subject types to filter by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeletionEventSubjectType", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DeletionEventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `occurred_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeletionEventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomization", + "description": "The delivery customization.", + "args": [ + { + "name": "id", + "description": "The ID of the delivery customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCustomizations", + "description": "The delivery customizations.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `enabled`\n - `function_id`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryCustomizationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfile", + "description": "Returns a Delivery Profile resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DeliveryProfile to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfiles", + "description": "Returns a list of saved delivery profiles.", + "args": [ + { + "name": "merchantOwnedOnly", + "description": "If `true`, returns only delivery profiles that were created by the merchant.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DeliveryProfileConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliverySettings", + "description": "Returns the shop-wide shipping settings.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliverySetting", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodeCount", + "description": "The total number of discount codes for the shop.", + "args": [ + { + "name": "query", + "description": "Supported filter parameters:\n * times_used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountNode", + "description": "Returns a discount resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DiscountNode to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountNodes", + "description": "List of discounts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `combines_with`\n - Acceptable Values:\n - `PRODUCT_DISCOUNTS`\n - `ORDER_DISCOUNTS`\n - `SHIPPING_DISCOUNTS`\n - `discount_class`\n - Acceptable Values:\n - `PRODUCT`\n - `ORDER`\n - `SHIPPING`\n - `discount_type`\n - `method`\n - `starts_at`\n - `status`\n - `times_used`\n - `title`\n - `type`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountNodeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountRedeemCodeBulkCreation", + "description": "Returns a bulk code creation resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DiscountRedeemCodeBulkCreation to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DiscountRedeemCodeBulkCreation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountRedeemCodeSavedSearches", + "description": "List of the shop's redeemed discount code saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DiscountCodeSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `times_used`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dispute", + "description": "Returns dispute details based on ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ShopifyPaymentsDispute to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disputeEvidence", + "description": "Returns dispute evidence details based on ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ShopifyPaymentsDisputeEvidence to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEvidence", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "domain", + "description": "Lookup a Domain by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Domain to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrder", + "description": "Returns a DraftOrder resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DraftOrder to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderSavedSearches", + "description": "List of the shop's draft order saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrderTag", + "description": "Returns a DraftOrderTag resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the DraftOrderTag to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DraftOrderTag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "List of saved draft orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `source`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileSavedSearches", + "description": "A list of the shop's file saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "files", + "description": "Returns a paginated list of files that have been uploaded to Shopify.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "FileSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `filename`\n - `media_type`\n - `original_upload_size`\n - `status`\n - `updated_at`\n - `used_in`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillment", + "description": "Returns a Fulfillment resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Fulfillment to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrder", + "description": "Returns a Fulfillment order resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the FulfillmentOrder to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrders", + "description": "The paginated list of all fulfillment orders.\nThe returned fulfillment orders are filtered according to the\n[fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes)\ngranted to the app.\n\nUse this query to retrieve fulfillment orders assigned to merchant-managed locations,\nthird-party fulfillment service locations, or all kinds of locations together.\n\nFor fetching only the fulfillment orders assigned to the app's locations, use the\n[Shop.assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/latest/objects/Shop#connection-shop-assignedfulfillmentorders)\nconnection.\n", + "args": [ + { + "name": "includeClosed", + "description": "Whether to include closed fulfillment orders.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `assigned_location_id`\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentService", + "description": "Returns a FulfillmentService resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the FulfillmentService to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCard", + "description": "Returns a gift card resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the GiftCard to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GiftCard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCards", + "description": "Returns a list of gift cards.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "GiftCardSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `balance_status`\n - `created_at`\n - `expires_on`\n - `initial_value`\n - `source`\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "GiftCardConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCardsCount", + "description": "The total number of gift cards issued for the shop.", + "args": [ + { + "name": "enabled", + "description": "Whether to count enabled or disabled or all gift cards.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItem", + "description": "Returns an `InventoryItem` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the InventoryItem to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryItem", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItems", + "description": "Returns a list of inventory items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `id`\n - `sku`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryLevel", + "description": "Returns an `InventoryLevel` object by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the InventoryLevel to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "InventoryLevel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryProperties", + "description": "General inventory properties for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryProperties", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "job", + "description": "Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.\n", + "args": [ + { + "name": "id", + "description": "ID of the job to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "Returns an inventory Location resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the location to return. If no ID is provided, the primary location of the Shop is returned.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "Returns a list of active inventory locations.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "LocationSortKeys", + "ofType": null + }, + "defaultValue": "NAME" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `active`\n - `address1`\n - `address2`\n - `city`\n - `country`\n - `legacy`\n - `name`\n - `province`\n - `zip`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeLegacy", + "description": "If true, also include the legacy locations of fulfillment services.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "includeInactive", + "description": "If true, also include the locations that are deactivated.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locationsAvailableForDeliveryProfiles", + "description": "Returns a list of all origin locations available for a delivery profile.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locationsAvailableForDeliveryProfilesConnection` instead." + }, + { + "name": "locationsAvailableForDeliveryProfilesConnection", + "description": "Returns a list of all origin locations available for a delivery profile.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "manualHoldsFulfillmentOrders", + "description": "Returns a list of fulfillment orders that are on hold.", + "args": [ + { + "name": "query", + "description": "The query conditions used to filter fulfillment orders. Only fulfillment orders corresponding to orders matching the query will be counted.\nSupported filter parameters:\n - `order_financial_status`\n - `order_risk_level`\n - `shipping_address_coordinates_validated`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "Returns a market resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Market to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketByGeography", + "description": "Returns the applicable market for a customer based on where they are in the world.", + "args": [ + { + "name": "countryCode", + "description": "The code for the country where the customer is.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizableResource", + "description": "A resource that can have localized values for different markets.", + "args": [ + { + "name": "resourceId", + "description": "Find a market localizable resource by ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketLocalizableResource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizableResources", + "description": "Resources that can have localized values for different markets.", + "args": [ + { + "name": "resourceType", + "description": "Return only resources of a type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MarketLocalizableResourceType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableResourceConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketLocalizableResourcesByIds", + "description": "Resources that can have localized values for different markets.", + "args": [ + { + "name": "resourceIds", + "description": "Return only resources for given IDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketLocalizableResourceConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivities", + "description": "A list of marketing activities associated with the marketing app.", + "args": [ + { + "name": "marketingActivityIds", + "description": "The list of marketing activity IDs to filter by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": "[]" + }, + { + "name": "remoteIds", + "description": "The list of remote IDs associated with marketing activities to filter by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": "[]" + }, + { + "name": "utm", + "description": "The UTM parameters associated with marketing activities to filter by.", + "type": { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MarketingActivitySortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `app_id`\n - `app_name`\n - `created_at`\n - `marketing_campaign_id`\n - `scheduled_to_end_at`\n - `scheduled_to_start_at`\n - `tactic`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingActivityConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingActivity", + "description": "Returns a MarketingActivity resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the MarketingActivity to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingActivity", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingEvent", + "description": "Returns a MarketingEvent resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the MarketingEvent to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MarketingEvent", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketingEvents", + "description": "A list of marketing events associated with the marketing app.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MarketingEventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `app_id`\n - `description`\n - `started_at`\n - `type`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingEventConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "markets", + "description": "The markets configured for the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Metafield to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinition", + "description": "Returns a metafield definition by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the MetafieldDefinition to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitionTypes", + "description": "Each metafield definition has a type, which defines the type of information that it can store.\nThis type is enforced across every instance of the resource that owns the metafield definition.\n\nRefer to the [list of supported metafield types](https://shopify.dev/apps/metafields/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionType", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldDefinitions", + "description": "List of metafield definitions.", + "args": [ + { + "name": "key", + "description": "Filter metafield definition by key.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "Filter metafield definition by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ownerType", + "description": "Filter the metafield definition by the specific owner type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pinnedStatus", + "description": "Filter the metafield definition by the pinned status.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionPinnedStatus", + "ofType": null + }, + "defaultValue": "ANY" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MetafieldDefinitionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `key`\n - `namespace`\n - `owner_type`\n - `type`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldStorefrontVisibilities", + "description": "List of the `MetafieldStorefrontVisibility` records.", + "args": [ + { + "name": "namespace", + "description": "Filter the visible metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibilityConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldStorefrontVisibility", + "description": "Returns a `MetafieldStorefrontVisibility` record by ID. A `MetafieldStorefrontVisibility` record lists the\nmetafields to make visible in the Storefront API.\n", + "args": [ + { + "name": "id", + "description": "The ID of the MetafieldStorefrontVisibility to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldStorefrontVisibility", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobject", + "description": "Retrieves a metaobject by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectByHandle", + "description": "Retrieves a metaobject by handle.", + "args": [ + { + "name": "handle", + "description": "The identifier of the metaobject to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectHandleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinition", + "description": "Retrieves a metaobject definition by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinitionByType", + "description": "Finds a metaobject definition by type.", + "args": [ + { + "name": "type", + "description": "The type of the metaobject definition to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjectDefinitions", + "description": "All metaobject definitions.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectDefinitionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjects", + "description": "All metaobjects for the shop.", + "args": [ + { + "name": "type", + "description": "The type of the metaobjects to query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "The key of a field to sort with. Supports \"id\", \"type\", \"updated_at\", and \"display_name\".\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `display_name`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "Returns a specific node (any object that implements the\n[Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node)\ninterface) by ID, in accordance with the\n[Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification).\nThis field is commonly used for refetching an object.\n", + "args": [ + { + "name": "id", + "description": "The ID of the Node to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "Returns the list of nodes (any objects that implement the\n[Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node)\ninterface) with the given IDs, in accordance with the\n[Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification).\n", + "args": [ + { + "name": "ids", + "description": "The IDs of the Nodes to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Returns an Order resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Order to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderPaymentStatus", + "description": "Returns a payment status by payment reference ID. Used to check the status of a deferred payment.", + "args": [ + { + "name": "paymentReferenceId", + "description": "Unique identifier returned by orderCreatePayment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "orderId", + "description": "ID of the order for which the payment was initiated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderPaymentStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderSavedSearches", + "description": "List of the shop's order saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "Returns a list of orders placed.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "PROCESSED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `cart_token`\n - `channel`\n - `channel_id`\n - `chargeback_status`\n - `checkout_token`\n - `confirmation_number`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `delivery_method`\n - `discount_code`\n - `earliest_fulfill_by`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_location_id`\n - `fulfillment_status`\n - `gateway`\n - `location_id`\n - `name`\n - `payment_id`\n - `payment_provider_id`\n - `po_number`\n - `processed_at`\n - `reference_location_id`\n - `return_status`\n - `risk_level`\n - `sales_channel`\n - `sku`\n - `source_identifier`\n - `source_name`\n - `status`\n - `tag`\n - `tag_not`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomization", + "description": "The payment customization.", + "args": [ + { + "name": "id", + "description": "The ID of the payment customization.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PaymentCustomization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentCustomizations", + "description": "The payment customizations.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `enabled`\n - `function_id`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentCustomizationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentTermsTemplates", + "description": "The list of payment terms templates eligible for all shops and users.", + "args": [ + { + "name": "paymentTermsType", + "description": "The payment terms type to filter the payment terms templates list.", + "type": { + "kind": "ENUM", + "name": "PaymentTermsType", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentTermsTemplate", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceList", + "description": "Returns a price list resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the `PriceList` to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceLists", + "description": "All price lists for a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "PriceListSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceListConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRule", + "description": "Returns a code price rule resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the PriceRule to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PriceRule", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `codeDiscountNode` instead." + }, + { + "name": "priceRuleSavedSearches", + "description": "List of the shop's price rule saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRules", + "description": "Returns a list of price rule resources that have at least one associated discount code.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "PriceRuleSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `combines_with`\n - `created_at`\n - `discount_type`\n - `ends_at`\n - `starts_at`\n - `status`\n - `times_used`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `codeDiscountNodes` instead." + }, + { + "name": "primaryMarket", + "description": "The primary market of the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by ID.\nPrivate metafields are accessible only by the application that created them.\n", + "args": [ + { + "name": "id", + "description": "The ID of the PrivateMetafield to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "Returns a list of private metafields associated to a resource.\n", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "owner", + "description": "Retrieve the private metafields of a certain resource, specified by the resource ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "product", + "description": "Returns a Product resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Product to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productByHandle", + "description": "Return a product by its handle.\n", + "args": [ + { + "name": "handle", + "description": "A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: `-`. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called `Potion`, then their handles would be `potion` and `potion-1`. After a product has been created, changing the product title doesn't update the handle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDuplicateJob", + "description": "Returns the product duplicate job.", + "args": [ + { + "name": "id", + "description": "An ID of a product duplicate job to fetch.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductDuplicateJob", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFeed", + "description": "Returns a ProductFeed resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ProductFeed to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductFeed", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFeeds", + "description": "The product feeds for the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductFeedConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productResourceFeedback", + "description": "Returns the product resource feedback for the currently authenticated app.\n", + "args": [ + { + "name": "id", + "description": "The product associated with the resource feedback.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductResourceFeedback", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSavedSearches", + "description": "Returns a list of the shop's product saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariant", + "description": "Returns a ProductVariant resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ProductVariant to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "List of the product variants.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `barcode`\n - `collection`\n - `delivery_profile_id`\n - `exclude_composite`\n - `exclude_variants_with_components`\n - `gift_card`\n - `inventory_quantity`\n - `location_id`\n - `managed`\n - `managed_by`\n - `option1`\n - `option2`\n - `option3`\n - `product_id`\n - `product_ids`\n - `product_publication_status`\n - `product_status`\n - `product_type`\n - `publishable_status`\n - `published_status`\n - `requires_components`\n - `sku`\n - `tag`\n - `tag_not`\n - `taxable`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "List of products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `barcode`\n - `bundles`\n - `created_at`\n - `delivery_profile_id`\n - `error_feedback`\n - `gift_card`\n - `has_only_composites`\n - `has_only_default_variant`\n - `has_variant_with_components`\n - `id`\n - `inventory_total`\n - `is_price_reduced`\n - `out_of_stock_somewhere`\n - `price`\n - `product_configuration_owner`\n - `product_publication_status`\n - `product_type`\n - `publishable_status`\n - `published_status`\n - `sku`\n - `status`\n - `tag`\n - `tag_not`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicApiVersions", + "description": "The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ApiVersion", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "Lookup a publication by ID.\n", + "args": [ + { + "name": "id", + "description": "The ID of the Publication to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publications", + "description": "List of publications.", + "args": [ + { + "name": "catalogType", + "description": "Filter publications by catalog type.", + "type": { + "kind": "ENUM", + "name": "CatalogType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refund", + "description": "Returns a Refund resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Refund to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "return", + "description": "Returns a Return resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Return to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnableFulfillment", + "description": "Lookup a returnable fulfillment by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ReturnableFulfillment to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReturnableFulfillment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnableFulfillments", + "description": "List of returnable fulfillments.", + "args": [ + { + "name": "orderId", + "description": "Order ID that will scope all returnable fulfillments.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDelivery", + "description": "Lookup a reverse delivery by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the ReverseDelivery to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseFulfillmentOrder", + "description": "Lookup a reverse fulfillment order by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the reverse fulfillment order to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scriptTag", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nLookup a script tag resource by ID.\n", + "args": [ + { + "name": "id", + "description": "The ID of the ScriptTag to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scriptTags", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nA list of script tags.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "src", + "description": "The source URL of the script tag to filter by.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ScriptTagConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segment", + "description": "The Customer Segment.", + "args": [ + { + "name": "id", + "description": "Find a segment by ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentCount", + "description": "The number of segments for a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentFilterSuggestions", + "description": "A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.", + "args": [ + { + "name": "search", + "description": "Returns the elements of a list by keyword or term.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentFilterConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentFilters", + "description": "A list of filters.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentFilterConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentMigrations", + "description": "A list of a shop's segment migrations.", + "args": [ + { + "name": "savedSearchId", + "description": "Search a segment migration by its saved search ID.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMigrationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentValueSuggestions", + "description": "The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.", + "args": [ + { + "name": "search", + "description": "Returns the elements of a list by keyword or term.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "filterQueryName", + "description": "Returns the elements of a list by filter handle.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "functionParameterQueryName", + "description": "Returns the elements of a list by filter parameter name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentValueConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segments", + "description": "A list of a shop's segments.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SegmentSortKeys", + "ofType": null + }, + "defaultValue": "CREATION_DATE" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `name`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroup", + "description": "Returns a Selling Plan Group resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the SellingPlanGroup to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroups", + "description": "List Selling Plan Groups.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SellingPlanGroupSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `app_id`\n - Acceptable Values:\n - `CURRENT`\n - `ALL`\n - `App ID number`\n - Default Value: `CURRENT`\n - `category`\n - Acceptable Values:\n - `SUBSCRIPTION`\n - `PRE_ORDER`\n - `TRY_BEFORE_YOU_BUY`\n - `OTHER`\n - `created_at`\n - `delivery_frequency`\n - `name`\n - `percentage_off`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serverPixel", + "description": "The server pixel configured by the app.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains\nbusiness and store management settings for the shop.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopBillingPreferences", + "description": "The shop's billing preferences.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopBillingPreferences", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopLocales", + "description": "A list of locales available on a shop.", + "args": [ + { + "name": "published", + "description": "Return only published locales.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopLocale", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyFunction", + "description": "The Shopify Function.", + "args": [ + { + "name": "id", + "description": "The ID of the Shopify Function.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShopifyFunction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyFunctions", + "description": "Returns the Shopify Functions for apps installed on the shop.", + "args": [ + { + "name": "apiType", + "description": "Filter the functions by the API type.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "useCreationUi", + "description": "Filter the functions by whether or not the function uses the creation UI in the Admin.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunctionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPaymentsAccount", + "description": "Shopify Payments account information, including balances and payouts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsAccount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyqlQuery", + "description": "Returns the results of a ShopifyQL query. Refer to the [ShopifyQL documentation](https://shopify.dev/api/shopifyql) for more information.", + "args": [ + { + "name": "query", + "description": "A ShopifyQL query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "ShopifyqlResponse", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "The StaffMember resource, by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the staff member to return. If no ID is provided, then the staff member making the query (if any) is returned.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardMetafieldDefinitionTemplates", + "description": "Standard metafield definitions are intended for specific, common use cases. Their namespace and keys reflect these use cases and are reserved.\n\nRefer to all available [`Standard Metafield Definition Templates`](https://shopify.dev/api/admin-graphql/latest/objects/StandardMetafieldDefinitionTemplate).\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplateConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingAttempt", + "description": "Returns a SubscriptionBillingAttempt by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the SubscriptionBillingAttempt to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingAttempts", + "description": "Returns subscription billing attempts on a store.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingAttemptsSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `error_code`\n - `error_message`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycle", + "description": "Returns a subscription billing cycle found either by cycle index or date.", + "args": [ + { + "name": "billingCycleInput", + "description": "Input object used to select and use billing cycles.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionBillingCycles", + "description": "Returns subscription billing cycles for a contract ID.", + "args": [ + { + "name": "contractId", + "description": "The ID of the subscription contract to retrieve billing cycles for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingCyclesDateRangeSelector", + "description": "Select subscription billing cycles within a date range.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCyclesDateRangeSelector", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingCyclesIndexRangeSelector", + "description": "Select subscription billing cycles within an index range.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCyclesIndexRangeSelector", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesSortKeys", + "ofType": null + }, + "defaultValue": "CYCLE_INDEX" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContract", + "description": "Returns a Subscription Contract resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Subscription Contract to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContracts", + "description": "List Subscription Contracts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContractConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionDraft", + "description": "Returns a Subscription Draft resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Subscription Draft to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tenderTransactions", + "description": "Returns a list of TenderTransactions associated with the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `point_of_sale_device_id`\n - `processed_at`\n - `test`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TenderTransactionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatableResource", + "description": "A resource that can have localized values for different languages.", + "args": [ + { + "name": "resourceId", + "description": "Find a translatable resource by ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TranslatableResource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatableResources", + "description": "Resources that can have localized values for different languages.", + "args": [ + { + "name": "resourceType", + "description": "Return only resources of a type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TranslatableResourceType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableResourceConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatableResourcesByIds", + "description": "Resources that can have localized values for different languages.", + "args": [ + { + "name": "resourceIds", + "description": "Return only resources for given IDs.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableResourceConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirect", + "description": "Returns a redirect resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the UrlRedirect to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectImport", + "description": "Returns a redirect import resource by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the UrlRedirectImport to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectImport", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirectSavedSearches", + "description": "A list of the shop's URL redirect saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirects", + "description": "A list of redirects for a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "UrlRedirectSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `path`\n - `target`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixel", + "description": "The web pixel configured by the app.", + "args": [ + { + "name": "id", + "description": "Returns a web pixel by ID.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "Returns a webhook subscription by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the WebhookSubscription to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscriptions", + "description": "Returns a list of webhook subscriptions.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "WebhookSubscriptionSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "callbackUrl", + "description": "Callback URL to filter by.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "format", + "description": "Response format to filter by.", + "type": { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "topics", + "description": "List of webhook subscription topics to filter by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WebhookSubscriptionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Refund", + "description": "The record of the line items and transactions that were refunded to a customer, along with restocking instructions for refunded line items.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the refund was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duties", + "description": "A list of the refunded duties as part of this refund.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundDuty", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The optional note associated with the refund.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the refund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundLineItems", + "description": "The `RefundLineItem` resources attached to the refund.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "return", + "description": "The return associated with the refund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "staffMember", + "description": "The staff member who created the refund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalRefunded", + "description": "The total amount across all transactions for the refund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalRefundedSet` instead." + }, + { + "name": "totalRefundedSet", + "description": "The total amount across all transactions for the refund, in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactions", + "description": "The transactions associated with the refund.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTransactionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the refund was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundAgreement", + "description": "An agreement between the merchant and customer to refund all or a portion of the order.", + "fields": [ + { + "name": "app", + "description": "The application that created the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "happenedAt", + "description": "The date and time at which the agreement occured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the agremeent was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refund", + "description": "The refund associated with the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales", + "description": "The sales associated with the agreement.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The staff member associated with the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SalesAgreement", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundConnection", + "description": "An auto-generated type for paginating through multiple Refunds.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in RefundEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundCreatePayload", + "description": "Return type for `refundCreate` mutation.", + "fields": [ + { + "name": "order", + "description": "The order associated with the created refund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refund", + "description": "The created refund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundDuty", + "description": "Represents a refunded duty.", + "fields": [ + { + "name": "amountSet", + "description": "The amount of a refunded duty in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalDuty", + "description": "The duty associated with this refunded duty.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Duty", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RefundDutyInput", + "description": "The input fields required to reimburse duties on a refund.", + "fields": null, + "inputFields": [ + { + "name": "dutyId", + "description": "The ID of the duty in the refund.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "refundType", + "description": "The type of refund for this duty.", + "type": { + "kind": "ENUM", + "name": "RefundDutyRefundType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RefundDutyRefundType", + "description": "The type of refund to perform for a particular refund duty.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PROPORTIONAL", + "description": "The duty is proportionally refunded based on the quantity of the refunded line item.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULL", + "description": "The duty is fully refunded.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundEdge", + "description": "An auto-generated type which holds one Refund and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of RefundEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RefundInput", + "description": "The input fields to create a refund.", + "fields": null, + "inputFields": [ + { + "name": "currency", + "description": "The currency that is used to refund the order. This must be the presentment currency, which is the currency used by the customer. This is a required field for orders where the currency and presentment currency differ.", + "type": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "orderId", + "description": "The ID of the order that's being refunded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "An optional note that's attached to the refund.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "notify", + "description": "Whether to send a refund notification to the customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shipping", + "description": "The input fields that are required to reimburse shipping costs.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShippingRefundInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundLineItems", + "description": "A list of line items to refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "refundDuties", + "description": "A list of duties to refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundDutyInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "transactions", + "description": "A list of transactions involved in the refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OrderTransactionInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundLineItem", + "description": "A line item that's included in a refund.", + "fields": [ + { + "name": "lineItem", + "description": "The `LineItem` resource associated to the refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The inventory restock location.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of a refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceSet` instead." + }, + { + "name": "priceSet", + "description": "The price of a refunded line item in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of a refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restockType", + "description": "The type of restock for the refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "RefundLineItemRestockType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "restocked", + "description": "Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The subtotal price of a refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `subtotalSet` instead." + }, + { + "name": "subtotalSet", + "description": "The subtotal price of a refunded line item in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTax", + "description": "The total tax charged on a refunded line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTaxSet` instead." + }, + { + "name": "totalTaxSet", + "description": "The total tax charged on a refunded line item in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundLineItemConnection", + "description": "An auto-generated type for paginating through multiple RefundLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in RefundLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RefundLineItemEdge", + "description": "An auto-generated type which holds one RefundLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of RefundLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RefundLineItemInput", + "description": "The input fields required to reimburse line items on a refund.", + "fields": null, + "inputFields": [ + { + "name": "lineItemId", + "description": "The ID of the line item in the refund.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the associated line item to be refunded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "restockType", + "description": "The type of restock for this line item.", + "type": { + "kind": "ENUM", + "name": "RefundLineItemRestockType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The intended location for restocking. If the `restockType` is set to `NO_RESTOCK`, then this value is empty.`", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "RefundLineItemRestockType", + "description": "The type of restock performed for a particular refund line item.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RETURN", + "description": "The refund line item was returned. Use this when restocking line items that were fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL", + "description": "The refund line item was canceled. Use this when restocking unfulfilled line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEGACY_RESTOCK", + "description": "Deprecated. The refund line item was restocked, without specifically beingidentified as a return or cancelation. This value is not accepted when creating new refunds.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_RESTOCK", + "description": "Refund line item was not restocked.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RefundShippingInput", + "description": "The input fields for the shipping cost to refund.", + "fields": null, + "inputFields": [ + { + "name": "shippingRefundAmount", + "description": "The input fields required to refund shipping cost, in the presentment currency of the order.\nThis overrides the `fullRefund` argument.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fullRefund", + "description": "Whether to refund the full shipping amount.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoteAuthorizeNetCustomerPaymentProfileInput", + "description": "The input fields for a remote Authorize.net customer payment profile.\n", + "fields": null, + "inputFields": [ + { + "name": "customerProfileId", + "description": "The customerProfileId value from the Authorize.net API.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerPaymentProfileId", + "description": "The customerPaymentProfileId value from the Authorize.net API.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoteBraintreePaymentMethodInput", + "description": "The input fields for a remote Braintree customer payment profile.\n", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The `customer_id` value from the Braintree API.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentMethodToken", + "description": "The `payment_method_token` value from the Braintree API.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RemoteStripePaymentMethodInput", + "description": "The input fields for a remote stripe payment method.\n", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The customer_id value from the Stripe API.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentMethodId", + "description": "The payment_method_id value from the Stripe API.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourceAlert", + "description": "An alert message that appears in the Shopify admin about a problem with a store resource, with 1 or more actions to take. For example, you could use an alert to indicate that you're not charging taxes on some product variants.\nThey can optionally have a specific icon and be dismissed by merchants.\n", + "fields": [ + { + "name": "actions", + "description": "Buttons in the alert that link to related information.\nFor example, _Edit variants_.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourceAlertAction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content", + "description": "The secondary text in the alert that includes further information or instructions about how to solve a problem.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dismissibleHandle", + "description": "Unique identifier that appears when an alert is manually closed by the merchant.\nMost alerts can't be manually closed.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "icon", + "description": "An icon that's optionally displayed with the alert.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ResourceAlertIcon", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "severity", + "description": "Indication of how important the alert is.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceAlertSeverity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The primary text in the alert that includes information or describes the problem.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourceAlertAction", + "description": "An action associated to a resource alert, such as editing variants.", + "fields": [ + { + "name": "primary", + "description": "Whether the action appears as a button or as a link.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "show", + "description": "Resource for the action to show.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The text for the button in the alert. For example, _Edit variants_.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The target URL that the button links to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ResourceAlertIcon", + "description": "The available icons for resource alerts.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CHECKMARK_CIRCLE", + "description": "A checkmark inside a circle.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INFORMATION_CIRCLE", + "description": "A lowercase `i` inside a circle.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ResourceAlertSeverity", + "description": "The possible severity levels for a resource alert.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEFAULT", + "description": "Indicates a neutral alert. For example, an accepted dispute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INFO", + "description": "Indicates an informative alert. For example, an escalated dispute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WARNING", + "description": "Indicates an informative alert. For example, a new dispute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUCCESS", + "description": "Indicates a success alert. For example, a winning a dispute.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CRITICAL", + "description": "Indicates a critical alert. For example, a blocked app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": null, + "isDeprecated": true, + "deprecationReason": "`ERROR` severity is being deprecated in favour of `WARNING` or `CRITICAL` instead." + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourceFeedback", + "description": "Represents feedback from apps about a resource, and the steps required to set up the apps on the shop.\n", + "fields": [ + { + "name": "appFeedback", + "description": "Feedback from an app about the steps a merchant needs to take to set up the app on their store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppFeedback", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `details` instead." + }, + { + "name": "details", + "description": "List of AppFeedback detailing issues regarding a resource.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppFeedback", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "Summary of resource feedback pertaining to the resource.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ResourceFeedbackCreateInput", + "description": "The input fields for a resource feedback object.", + "fields": null, + "inputFields": [ + { + "name": "feedbackGeneratedAt", + "description": "The date and time when the feedback was generated. Used to help determine whether\nincoming feedback is outdated compared to existing feedback.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "messages", + "description": "If the feedback state is `requires_action`, then you can send a string message that communicates the action to be taken by the merchant.\nThe string must be a single message up to 100 characters long and must end with a period.\nYou need to adhere to the message formatting rules or your requests will fail:\n- `[Explanation of the problem]. [Suggested action].`\n\n**Examples:**\n- `[Your app name]` isn't connected. Connect your account to use this sales channel. `[Learn more]`\n- `[Your app name]` isn't configured. Agree to the terms and conditions to use this app. `[Learn more]`\nBoth `Your app name` and `Learn more` (a button which directs merchants to your app) are automatically populated in the Shopify admin.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "state", + "description": "The state of the feedback and whether it requires merchant action.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceFeedbackState", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ResourceFeedbackState", + "description": "The state of the resource feedback.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCEPTED", + "description": "No action required from merchant.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUIRES_ACTION", + "description": "The merchant needs to resolve an issue with the resource.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourceLimit", + "description": "A resource limit represents the limits that the resource has.", + "fields": [ + { + "name": "available", + "description": "Whether the resource is available.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityAvailable", + "description": "Quantity available. If null the quantity available is unlimited.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityLimit", + "description": "Quantity limit of the resource. If null the quantity is unlimited.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityUsed", + "description": "Quantity used of the resource. If null the quantity used can't be retrieved.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ResourceOperation", + "description": "Represents a merchandising background operation interface.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedRowCount", + "description": "The count of processed rows, summing imported, failed, and skipped rows.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rowCount", + "description": "Represents a rows objects within this background operation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RowCount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of this operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ResourceOperationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AddAllProductsOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CatalogCsvOperation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PublicationResourceOperation", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "ResourceOperationStatus", + "description": "Represents the state of this catalog operation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED", + "description": "Operation has been created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACTIVE", + "description": "Operation is currently running.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPLETE", + "description": "Operation is complete.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublication", + "description": "A resource publication represents information about the publication of a resource.\nAn instance of `ResourcePublication`, unlike `ResourcePublicationV2`, can be neither published or scheduled to be published.\n\nSee [ResourcePublicationV2](/api/admin-graphql/latest/objects/ResourcePublicationV2) for more context.\n", + "fields": [ + { + "name": "channel", + "description": "The channel the resource publication is published to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Channel", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publication` instead." + }, + { + "name": "isPublished", + "description": "Whether the resource publication is published. Also returns true if the resource publication is scheduled to be published.\nIf false, then the resource publication is neither published nor scheduled to be published.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "The publication the resource publication is published to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishDate", + "description": "The date that the resource publication was or is going to be published to the publication.\nIf the product isn't published, then this field returns an epoch timestamp.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishable", + "description": "The resource published to the publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublicationConnection", + "description": "An auto-generated type for paginating through multiple ResourcePublications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ResourcePublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublicationEdge", + "description": "An auto-generated type which holds one ResourcePublication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ResourcePublicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublicationV2", + "description": "A resource publication represents information about the publication of a resource.\nUnlike `ResourcePublication`, an instance of `ResourcePublicationV2` can't be unpublished. It must either be published or scheduled to be published.\n\nSee [ResourcePublication](/api/admin-graphql/latest/objects/ResourcePublication) for more context.\n", + "fields": [ + { + "name": "isPublished", + "description": "Whether the resource publication is published. If true, then the resource publication is published to the publication.\nIf false, then the resource publication is staged to be published to the publication.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publication", + "description": "The publication the resource publication is published to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Publication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishDate", + "description": "The date that the resource publication was or is going to be published to the publication.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishable", + "description": "The resource published to the publication.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Publishable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublicationV2Connection", + "description": "An auto-generated type for paginating through multiple ResourcePublicationV2s.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2Edge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ResourcePublicationV2Edge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ResourcePublicationV2Edge", + "description": "An auto-generated type which holds one ResourcePublicationV2 and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ResourcePublicationV2Edge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourcePublicationV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Return", + "description": "Represents a return.", + "fields": [ + { + "name": "decline", + "description": "Additional information about the declined return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReturnDecline", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the return.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order that the return belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refunds", + "description": "The list of refunds associated with the return.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnLineItems", + "description": "The return line items attached to the return.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseFulfillmentOrders", + "description": "The list of reverse fulfillment orders for the return.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the return.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestedRefund", + "description": "A suggested refund for the return.", + "args": [ + { + "name": "returnRefundLineItems", + "description": "The line items from the return to include in the refund.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "refundShipping", + "description": "The shipping amount from the associated order to include in the refund.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RefundShippingInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundDuties", + "description": "The duties from to associated order to include in the refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundDutyInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SuggestedReturnRefund", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalQuantity", + "description": "The sum of all line item quantities for the return.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnApproveRequestInput", + "description": "The input fields for approving a customer's return request.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the return that's being approved.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnApproveRequestPayload", + "description": "Return type for `returnApproveRequest` mutation.", + "fields": [ + { + "name": "return", + "description": "The approved return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnCancelPayload", + "description": "Return type for `returnCancel` mutation.", + "fields": [ + { + "name": "return", + "description": "The canceled return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnClosePayload", + "description": "Return type for `returnClose` mutation.", + "fields": [ + { + "name": "return", + "description": "The closed return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnConnection", + "description": "An auto-generated type for paginating through multiple Returns.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReturnEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnCreatePayload", + "description": "Return type for `returnCreate` mutation.", + "fields": [ + { + "name": "return", + "description": "The created return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnDecline", + "description": "Additional information about why a merchant declined the customer's return request.", + "fields": [ + { + "name": "note", + "description": "The notification message sent to the customer about their declined return request.\nMaximum length: 500 characters.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the customer's return request was declined.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnDeclineReason", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnDeclineReason", + "description": "The reason why the merchant declined a customer's return request.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RETURN_PERIOD_ENDED", + "description": "The return period has ended.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FINAL_SALE", + "description": "The return contains final sale items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The return is declined for another reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnDeclineRequestInput", + "description": "The input fields for declining a customer's return request.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the return that's being declined.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "declineReason", + "description": "The reason why the merchant declined the customer's return request.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnDeclineReason", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnDeclineRequestPayload", + "description": "Return type for `returnDeclineRequest` mutation.", + "fields": [ + { + "name": "return", + "description": "The declined return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnEdge", + "description": "An auto-generated type which holds one Return and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReturnEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnErrorCode", + "description": "Possible error codes that can be returned by `ReturnUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INTERNAL_ERROR", + "description": "Unexpected internal error happened.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_ARGUMENTS", + "description": "Too many arguments provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EQUAL_TO", + "description": "The input value should be equal to the value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_A_NUMBER", + "description": "The input value is not a number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_BIG", + "description": "The input value is too big.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WRONG_LENGTH", + "description": "The input value is the wrong length.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_EXISTS", + "description": "The requested resource already exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATION_FAILED", + "description": "A requested resource could not be created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FEATURE_NOT_ENABLED", + "description": "A required feature is not enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_STATE", + "description": "A resource was not in the correct state for the operation to succeed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOTIFICATION_FAILED", + "description": "A requested notification could not be sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_EDITABLE", + "description": "A requested item is not editable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "A requested item could not be found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnInput", + "description": "The input fields for a return.", + "fields": null, + "inputFields": [ + { + "name": "orderId", + "description": "The ID of the order to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnLineItems", + "description": "The return line items list to be handled.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "notifyCustomer", + "description": "When `true` the customer will receive a notification if there's an `Order.email` present.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "requestedAt", + "description": "The UTC date and time when the return was first solicited by the customer.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnLineItem", + "description": "A return line item.", + "fields": [ + { + "name": "customerNote", + "description": "A note from the customer that describes the item to be returned. Maximum length: 300 characters.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentLineItem", + "description": "The fulfillment line item from which items are returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity being returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundableQuantity", + "description": "The quantity that can be refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundedQuantity", + "description": "The quantity that was refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnReason", + "description": "The reason for returning the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnReason", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnReasonNote", + "description": "Additional information about the reason for the return. Maximum length: 255 characters.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalWeight", + "description": "The total weight of the item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Weight", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "withCodeDiscountedTotalPriceSet", + "description": "The total line price after all discounts on the line item, including both line item level discounts and code-based line item discounts, are applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnLineItemConnection", + "description": "An auto-generated type for paginating through multiple ReturnLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReturnLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnLineItemEdge", + "description": "An auto-generated type which holds one ReturnLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReturnLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnLineItemInput", + "description": "The input fields for a return line item.", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentLineItemId", + "description": "The ID of the fulfillment line item to be returned.\nSpecifically, this field expects a `FulfillmentLineItem.id`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the item to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnReason", + "description": "The reason for the item to be returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnReason", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnReasonNote", + "description": "A note about the reason that the item is being returned.\nMaximum length: 255 characters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"\"" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnReason", + "description": "The reason for returning the return line item.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SIZE_TOO_SMALL", + "description": "The item is returned because the size was too small.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SIZE_TOO_LARGE", + "description": "The item is returned because the size was too large.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNWANTED", + "description": "The item is returned because the customer changed their mind.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_AS_DESCRIBED", + "description": "The item is returned because it was not as described.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WRONG_ITEM", + "description": "The item is returned because the customer received the wrong one.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DEFECTIVE", + "description": "The item is returned because it is damaged or defective.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STYLE", + "description": "The item is returned because the buyer did not like the style.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLOR", + "description": "The item is returned because the buyer did not like the color.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The item is returned for another reason. For this value, a return reason note is also provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "The item is returned because of an unknown reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundInput", + "description": "The input fields to refund a return.", + "fields": null, + "inputFields": [ + { + "name": "returnId", + "description": "The ID of the return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnRefundLineItems", + "description": "A list of return line items to refund.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "refundShipping", + "description": "The shipping amount to refund.", + "type": { + "kind": "INPUT_OBJECT", + "name": "RefundShippingInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundDuties", + "description": "A list of duties to refund.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RefundDutyInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "orderTransactions", + "description": "A list of transactions involved in refunding the return.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundOrderTransactionInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + }, + { + "name": "notifyCustomer", + "description": "Whether to send a refund notification to the customer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundLineItemInput", + "description": "The input fields for a return refund line item.", + "fields": null, + "inputFields": [ + { + "name": "returnLineItemId", + "description": "The ID of the return line item to be refunded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the return line item to be refunded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnRefundOrderTransactionInput", + "description": "The input fields to create order transactions when refunding a return.", + "fields": null, + "inputFields": [ + { + "name": "transactionAmount", + "description": "The amount of money for the transaction in the presentment currency of the order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parentId", + "description": "The ID of the parent order transaction. The transaction must be of kind `CAPTURE` or a `SALE`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnRefundPayload", + "description": "Return type for `returnRefund` mutation.", + "fields": [ + { + "name": "refund", + "description": "The created refund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Refund", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnReopenPayload", + "description": "Return type for `returnReopen` mutation.", + "fields": [ + { + "name": "return", + "description": "The reopened return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnRequestInput", + "description": "The input fields for requesting a return.", + "fields": null, + "inputFields": [ + { + "name": "orderId", + "description": "The ID of the order that's being returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnLineItems", + "description": "The line items that are being handled in the return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReturnRequestLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReturnRequestLineItemInput", + "description": "The input fields for a return line item.", + "fields": null, + "inputFields": [ + { + "name": "fulfillmentLineItemId", + "description": "The ID of the fulfillment line item to be returned.\nSpecifically, this field expects a `FulfillmentLineItem.id`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the item that's being returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "returnReason", + "description": "The reason why the line item is being returned.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReturnReason", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerNote", + "description": "A note from the customer that describes the item to be returned.\nFor example, the note can communicate issues with the item to the merchant.\nMaximum length: 300 characters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnRequestPayload", + "description": "Return type for `returnRequest` mutation.", + "fields": [ + { + "name": "return", + "description": "The requested return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Return", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReturnStatus", + "description": "The status of a return.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CANCELED", + "description": "The return has been canceled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "The return has been completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "The return is in progress.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REQUESTED", + "description": "The return was requested.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "The return was declined.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnUserError", + "description": "An error that occurs during the execution of a return mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ReturnErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillment", + "description": "A returnable fulfillment, which is an order that has been delivered\nand is eligible to be returned to the merchant.\n", + "fields": [ + { + "name": "fulfillment", + "description": "The fulfillment that the returnable fulfillment refers to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID of the Returnable Fulfillment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnableFulfillmentLineItems", + "description": "The list of returnable fulfillment line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillmentConnection", + "description": "An auto-generated type for paginating through multiple ReturnableFulfillments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReturnableFulfillmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillmentEdge", + "description": "An auto-generated type which holds one ReturnableFulfillment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReturnableFulfillmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItem", + "description": "A returnable fulfillment line item.", + "fields": [ + { + "name": "fulfillmentLineItem", + "description": "The fulfillment line item that can be returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity available to be returned.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItemConnection", + "description": "An auto-generated type for paginating through multiple ReturnableFulfillmentLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReturnableFulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItemEdge", + "description": "An auto-generated type which holds one ReturnableFulfillmentLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReturnableFulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnableFulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDelivery", + "description": "A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant.\nFor example, a buyer requests a return, and a merchant sends the buyer a shipping label.\nThe reverse delivery contains the context of the items sent back, how they're being sent back\n(for example, a shipping label), and the current state of the delivery (tracking information).\n", + "fields": [ + { + "name": "deliverable", + "description": "The deliverable associated with the reverse delivery.", + "args": [], + "type": { + "kind": "UNION", + "name": "ReverseDeliveryDeliverable", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the reverse delivery.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDeliveryLineItems", + "description": "The reverse delivery line items attached to the reverse delivery.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseFulfillmentOrder", + "description": "The `ReverseFulfillmentOrder` associated with the reverse delivery.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryConnection", + "description": "An auto-generated type for paginating through multiple ReverseDeliveries.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReverseDeliveryEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryCreateWithShippingPayload", + "description": "Return type for `reverseDeliveryCreateWithShipping` mutation.", + "fields": [ + { + "name": "reverseDelivery", + "description": "The created reverse delivery.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "ReverseDeliveryDeliverable", + "description": "The delivery method and artifacts associated with a reverse delivery.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ReverseDeliveryShippingDeliverable", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryDisposeInput", + "description": "The input fields to dispose a reverse delivery line item.", + "fields": null, + "inputFields": [ + { + "name": "reverseDeliveryLineItemId", + "description": "The ID of the reverse delivery line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the reverse delivery line item to dispose.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "dispositionType", + "description": "The final arrangement for the reverse delivery line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderDispositionType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the location where the reverse delivery line item is to be disposed. This is required\n when the disposition type is RESTOCKED.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryDisposePayload", + "description": "Return type for `reverseDeliveryDispose` mutation.", + "fields": [ + { + "name": "reverseDeliveryLineItems", + "description": "The disposed reverse delivery line items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItem", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryEdge", + "description": "An auto-generated type which holds one ReverseDelivery and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReverseDeliveryEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryLabelInput", + "description": "The input fields for a reverse label.", + "fields": null, + "inputFields": [ + { + "name": "fileUrl", + "description": "The URL of the label file. If a label file was uploaded to be attached to the delivery, then provide the temporary staged URL.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryLabelV2", + "description": "The return label file information for a reverse delivery.", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the reverse delivery label was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicFileUrl", + "description": "A public link that can be used to download the label image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the reverse delivery label was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItem", + "description": "The details about a reverse delivery line item.", + "fields": [ + { + "name": "dispositions", + "description": "The dispositions of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The expected number of units.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseFulfillmentOrderLineItem", + "description": "The corresponding reverse fulfillment order line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItemConnection", + "description": "An auto-generated type for paginating through multiple ReverseDeliveryLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReverseDeliveryLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItemEdge", + "description": "An auto-generated type which holds one ReverseDeliveryLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReverseDeliveryLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryLineItemInput", + "description": "The input fields for a reverse delivery line item.", + "fields": null, + "inputFields": [ + { + "name": "reverseFulfillmentOrderLineItemId", + "description": "The ID of the related reverse fulfillment order line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the item to be included in the delivery.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryShippingDeliverable", + "description": "A reverse shipping deliverable that may include a label and tracking information.", + "fields": [ + { + "name": "label", + "description": "The return label attached to the reverse delivery.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReverseDeliveryLabelV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tracking", + "description": "The information to track the reverse delivery.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReverseDeliveryTrackingV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryShippingUpdatePayload", + "description": "Return type for `reverseDeliveryShippingUpdate` mutation.", + "fields": [ + { + "name": "reverseDelivery", + "description": "The updated reverse delivery.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReverseDelivery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReverseDeliveryTrackingInput", + "description": "The input fields for tracking information about a return delivery.", + "fields": null, + "inputFields": [ + { + "name": "number", + "description": "The tracking number for the label.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url", + "description": "The tracking URL for the carrier. If the carrier isn't supported by Shopify, then provide the tracking URL of the delivery.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseDeliveryTrackingV2", + "description": "Represents the information used to track a reverse delivery.", + "fields": [ + { + "name": "carrierName", + "description": "The provider of the tracking information, in a human-readable format for display purposes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The identifier used by the courier to identify the shipment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL to track a shipment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "description": "A group of one or more items in a return that will be processed at a fulfillment service.\nThere can be more than one reverse fulfillment order for a return at a given location.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "The list of reverse fulfillment order line items for the reverse fulfillment order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order associated with the reverse fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reverseDeliveries", + "description": "The list of reverse deliveries for the reverse fulfillment order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseDeliveryConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the reverse fulfillment order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "thirdPartyConfirmation", + "description": "The current confirmation for the reverse fulfillment order from a third-party logistics service. \nIf no third-party service is involved, then this value is `nil`.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderThirdPartyConfirmation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderConnection", + "description": "An auto-generated type for paginating through multiple ReverseFulfillmentOrders.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReverseFulfillmentOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReverseFulfillmentOrderDisposeInput", + "description": "The input fields to dispose a reverse fulfillment order line item.", + "fields": null, + "inputFields": [ + { + "name": "reverseFulfillmentOrderLineItemId", + "description": "The ID of the reverse fulfillment order line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the reverse fulfillment order line item to dispose.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the location where the reverse fulfillment order line item is to be disposed.\n This is required when the disposition type is RESTOCKED.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dispositionType", + "description": "The final arrangement for the reverse fulfillment order line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderDispositionType", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposePayload", + "description": "Return type for `reverseFulfillmentOrderDispose` mutation.", + "fields": [ + { + "name": "reverseFulfillmentOrderLineItems", + "description": "The disposed reverse fulfillment order line items.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReturnUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposition", + "description": "The details of the arrangement of an item.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location where the disposition occurred.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of disposed units.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The final arrangement of an item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderDispositionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderDispositionType", + "description": "The final arrangement of an item from a reverse fulfillment order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RESTOCKED", + "description": "An item that was restocked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROCESSING_REQUIRED", + "description": "An item that requires further processing before being restocked or discarded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_RESTOCKED", + "description": "An item that wasn't restocked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING", + "description": "An item that was expected but absent.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderEdge", + "description": "An auto-generated type which holds one ReverseFulfillmentOrder and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReverseFulfillmentOrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "description": "The details about a reverse fulfillment order line item.\n", + "fields": [ + { + "name": "dispositions", + "description": "The dispositions of the item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderDisposition", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentLineItem", + "description": "The corresponding fulfillment line item for a reverse fulfillment order line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalQuantity", + "description": "The total number of units to be processed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItemConnection", + "description": "An auto-generated type for paginating through multiple ReverseFulfillmentOrderLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ReverseFulfillmentOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItemEdge", + "description": "An auto-generated type which holds one ReverseFulfillmentOrderLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ReverseFulfillmentOrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderStatus", + "description": "The status of a reverse fulfillment order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CANCELED", + "description": "The reverse fulfillment order has been canceled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "The reverse fulfillment order has been completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "The reverse fulfillment order is in progress.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ReverseFulfillmentOrderThirdPartyConfirmation", + "description": "The third-party confirmation of a reverse fulfillment order.", + "fields": [ + { + "name": "status", + "description": "The status of the reverse fulfillment order third-party confirmation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderThirdPartyConfirmationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ReverseFulfillmentOrderThirdPartyConfirmationStatus", + "description": "The status of a reverse fulfillment order third-party confirmation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACCEPTED", + "description": "The reverse fulfillment order was accepted by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL_ACCEPTED", + "description": "The reverse fulfillment order cancelation was accepted by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCEL_REJECTED", + "description": "The reverse fulfillment order cancelation was rejected by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING_ACCEPTANCE", + "description": "The reverse fulfillment order is awaiting acceptance by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING_CANCELATION", + "description": "The reverse fulfillment order is awaiting cancelation by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REJECTED", + "description": "The reverse fulfillment order was rejected by the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RowCount", + "description": "A row count represents rows on background operation.", + "fields": [ + { + "name": "count", + "description": "Estimated number of rows contained within this background operation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exceedsMax", + "description": "Whether the operation exceeds max number of reportable rows.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SEO", + "description": "SEO information.", + "fields": [ + { + "name": "description", + "description": "SEO Description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "SEO Title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SEOInput", + "description": "The input fields for SEO information.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "SEO title of the product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "SEO description of the product.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Sale", + "description": "An individual sale record associated with a sales agreement. Every money value in an order's sales data is represented in the currency's smallest unit. When amounts are divided across multiple line items, such as taxes or order discounts, the amounts might not divide evenly across all of the line items on the order. To address this, the remaining currency units that couldn't be divided evenly are allocated one at a time, starting with the first line item, until they are all accounted for. In aggregate, the values sum up correctly. In isolation, one line item might have a different tax or discount amount than another line item of the same price, before taxes and discounts. This is because the amount could not be divided evenly across the items. The allocation of currency units across line items is immutable. After they are allocated, currency units are never reallocated or redistributed among the line items.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AdditionalFeeSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "AdjustmentSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DutySale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GiftCardSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShippingLineSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TipSale", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UnknownSale", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "SaleActionType", + "description": "The possible order action types for a sale.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ORDER", + "description": "A purchase or charge.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURN", + "description": "A removal or return.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATE", + "description": "A change to the price, taxes, or discounts for a prior purchase.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "An unknown order action. Represents new actions that may be added in future versions.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SaleAdditionalFee", + "description": "The additional fee details for a line item.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "A list of taxes charged on the additional fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SaleConnection", + "description": "An auto-generated type for paginating through multiple Sales.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SaleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SaleEdge", + "description": "An auto-generated type which holds one Sale and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SaleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SaleLineType", + "description": "The possible line types for a sale record. One of the possible order line types for a sale is an adjustment. Sales adjustments occur when a refund is issued for a line item that is either more or less than the total value of the line item. Examples are restocking fees and goodwill payments. When this happens, Shopify produces a sales agreement with sale records for each line item that is returned or refunded and an additional sale record for the adjustment (for example, a restocking fee). The sales records for the returned or refunded items represent the reversal of the original line item sale value. The additional adjustment sale record represents the difference between the original total value of all line items that were refunded, and the actual amount refunded.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT", + "description": "A product purchased, returned or exchanged.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TIP", + "description": "A tip added by the customer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD", + "description": "A gift card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING", + "description": "A shipping cost.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUTY", + "description": "A duty charge.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ADDITIONAL_FEE", + "description": "An additional fee.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "An unknown sale line. Represents new types that may be added in future versions.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ADJUSTMENT", + "description": "A sale adjustment.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SaleTax", + "description": "The tax allocated to a sale from a single tax line.", + "fields": [ + { + "name": "amount", + "description": "The portion of the total tax amount on the related sale that comes from the associated tax line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLine", + "description": "The tax line associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "SalesAgreement", + "description": "A contract between a merchant and a customer to do business. Shopify creates a sales agreement whenever an order is placed, edited, or refunded. A sales agreement has one or more sales records, which provide itemized details about the initial agreement or subsequent changes made to the order. For example, when a customer places an order, Shopify creates the order, generates a sales agreement, and records a sale for each line item purchased in the order. A sale record is specific to a type of order line. Order lines can represent different things such as a purchased product, a tip added by a customer, shipping costs collected at checkout, and more.", + "fields": [ + { + "name": "app", + "description": "The application that created the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "happenedAt", + "description": "The date and time at which the agreement occured.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the agreement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason the agremeent was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sales", + "description": "The sales associated with the agreement.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The staff member associated with the agreement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "OrderAgreement", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "OrderEditAgreement", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "RefundAgreement", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SalesAgreementConnection", + "description": "An auto-generated type for paginating through multiple SalesAgreements.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SalesAgreementEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SalesAgreementEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "SalesAgreement", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SalesAgreementEdge", + "description": "An auto-generated type which holds one SalesAgreement and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SalesAgreementEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "SalesAgreement", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearch", + "description": "A saved search is a representation of a search query saved in the admin.", + "fields": [ + { + "name": "filters", + "description": "The filters of a saved search.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchFilter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of a saved search.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "query", + "description": "The query string of a saved search. This includes search terms and filters.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourceType", + "description": "The type of resource this saved search is searching in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SearchResultType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "searchTerms", + "description": "The search terms of a saved search.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "description": "An auto-generated type for paginating through multiple SavedSearches.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SavedSearchEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SavedSearchCreateInput", + "description": "The input fields to create a saved search.", + "fields": null, + "inputFields": [ + { + "name": "resourceType", + "description": "The type of resource this saved search is searching in.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SearchResultType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "A descriptive name of the saved search.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The query string of a saved search. This includes search terms and filters.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearchCreatePayload", + "description": "Return type for `savedSearchCreate` mutation.", + "fields": [ + { + "name": "savedSearch", + "description": "The saved search that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SavedSearchDeleteInput", + "description": "The input fields to delete a saved search.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the saved search to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearchDeletePayload", + "description": "Return type for `savedSearchDelete` mutation.", + "fields": [ + { + "name": "deletedSavedSearchId", + "description": "The ID of the saved search that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop of the saved search that was deleted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearchEdge", + "description": "An auto-generated type which holds one SavedSearch and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SavedSearchEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SavedSearchUpdateInput", + "description": "The input fields to update a saved search.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the saved search to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "A descriptive name of the saved search.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The query string of a saved search. This included search terms and filters.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SavedSearchUpdatePayload", + "description": "Return type for `savedSearchUpdate` mutation.", + "fields": [ + { + "name": "savedSearch", + "description": "The saved search that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SavedSearch", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptDiscountApplication", + "description": "Script discount applications capture the intentions of a discount that\nwas created by a Shopify Script for an order's line item or shipping line.\n\nDiscount applications don't represent the actual final amount discounted on a line (line item or shipping line). The actual amount discounted on a line is represented by the [DiscountAllocation](https://shopify.dev/api/admin-graphql/latest/objects/discountallocation) object.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is applied to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the application as defined by the Script.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `title` instead." + }, + { + "name": "index", + "description": "An ordered index that can be used to identify the discount application and indicate the precedence\nof the discount application for calculations.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "How the discount amount is distributed on the discounted lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Whether the discount is applied on line items or shipping lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the application as defined by the Script.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTag", + "description": "

Theme app extensions

\n

Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.

\n\n\nA script tag represents remote JavaScript code that is loaded into the pages of a shop's storefront or the order status page of checkout.\n", + "fields": [ + { + "name": "cache", + "description": "Whether the Shopify CDN can cache and serve the script tag.\nIf `true`, then the script will be cached and served by the CDN.\nThe cache expires 15 minutes after the script tag is successfully returned.\nIf `false`, then the script will be served as is.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the script tag was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayScope", + "description": "The page or pages on the online store that the script should be included.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ScriptTagDisplayScope", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "src", + "description": "The URL to the remote script.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the script tag was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTagConnection", + "description": "An auto-generated type for paginating through multiple ScriptTags.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ScriptTagEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ScriptTagEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTagCreatePayload", + "description": "Return type for `scriptTagCreate` mutation.", + "fields": [ + { + "name": "scriptTag", + "description": "The script tag that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTagDeletePayload", + "description": "Return type for `scriptTagDelete` mutation.", + "fields": [ + { + "name": "deletedScriptTagId", + "description": "The ID of the deleted script tag.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ScriptTagDisplayScope", + "description": "The page or pages on the online store where the script should be included.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": "Include the script on both the web storefront and the order status page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_STATUS", + "description": "Include the script only on the order status page.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE", + "description": "Include the script only on the web storefront.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTagEdge", + "description": "An auto-generated type which holds one ScriptTag and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ScriptTagEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ScriptTagInput", + "description": "The input fields for a script tag. This input object is used when creating or updating\na script tag to specify its URL, where it should be included, and how it will be cached.\n", + "fields": null, + "inputFields": [ + { + "name": "src", + "description": "The URL of the remote script. For example: `https://example.com/path/to/script.js`.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "displayScope", + "description": "The page or pages on the online store where the script should be included.", + "type": { + "kind": "ENUM", + "name": "ScriptTagDisplayScope", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cache", + "description": "Whether the Shopify CDN can cache and serve the script tag.\nIf `true`, then the script will be cached and served by the CDN.\nThe cache expires 15 minutes after the script tag is successfully returned.\nIf `false`, then the script is served as is.\nThe default value is `false`.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptTagUpdatePayload", + "description": "Return type for `scriptTagUpdate` mutation.", + "fields": [ + { + "name": "scriptTag", + "description": "The script tag that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ScriptTag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchFilter", + "description": "A filter in a search query represented by a key value pair.", + "fields": [ + { + "name": "key", + "description": "The key of the search filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the search filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchFilterOptions", + "description": "A list of search filters along with their specific options in value and label pair for filtering.", + "fields": [ + { + "name": "productAvailability", + "description": "A list of options that can be use to filter product availability.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilterOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchResult", + "description": "Represents an individual result returned from a search.", + "fields": [ + { + "name": "description", + "description": "Returns the search result description text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "Returns the Image resource presented to accompany a search result.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference", + "description": "Returns the ID of the resource returned in the search result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Returns the resource title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Returns the absolute URL to the resource in the search result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchResultConnection", + "description": "The connection type for SearchResult.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resultsAfterCount", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "The provided information is not accurate." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchResultEdge", + "description": "An auto-generated type which holds one SearchResult and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SearchResultEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResult", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchResultType", + "description": "Specifies the type of resources to be returned from a search.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT_ORDER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE", + "description": "A file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_PAGE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_BLOG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_ARTICLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "URL_REDIRECT", + "description": "A URL redirect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RULE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_REDEEM_CODE", + "description": "A code discount redeem code.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Segment", + "description": "A dynamic collection of customers based on specific criteria.\n", + "fields": [ + { + "name": "creationDate", + "description": "The date and time when the segment was added to the store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastEditDate", + "description": "The date and time when the segment was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the segment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "query", + "description": "A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentAssociationFilter", + "description": "A filter that takes a value that's associated with an object. For example, the `tags` field is associated with the [`Customer`](/api/admin-graphql/latest/objects/Customer) object.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentAttributeStatistics", + "description": "The statistics of a given attribute.", + "fields": [ + { + "name": "average", + "description": "The average of a given attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sum", + "description": "The sum of a given attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentBooleanFilter", + "description": "A filter with a Boolean value that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentConnection", + "description": "An auto-generated type for paginating through multiple Segments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SegmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentCreatePayload", + "description": "Return type for `segmentCreate` mutation.", + "fields": [ + { + "name": "segment", + "description": "The newly created segment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentDateFilter", + "description": "A filter with a date value that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentDeletePayload", + "description": "Return type for `segmentDelete` mutation.", + "fields": [ + { + "name": "deletedSegmentId", + "description": "ID of the deleted segment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentEdge", + "description": "An auto-generated type which holds one Segment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SegmentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentEnumFilter", + "description": "A filter with a set of possible values that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentEventFilter", + "description": "A filter that's used to segment customers based on the date that an event occured. For example, the `product_bought` event filter allows you to segment customers based on what products they've bought.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parameters", + "description": "The parameters for an event segment filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentEventFilterParameter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "returnValueType", + "description": "The return value type for an event segment filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentEventFilterParameter", + "description": "The parameters for an event segment filter.", + "fields": [ + { + "name": "acceptsMultipleValues", + "description": "Whether the parameter accepts a list of values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localizedDescription", + "description": "The localized description of the parameter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localizedName", + "description": "The localized name of the parameter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "optional", + "description": "Whether the parameter is optional.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parameterType", + "description": "The type of the parameter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the parameter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "description": "The filters used in segment queries associated with a shop.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SegmentAssociationFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentBooleanFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentDateFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentEnumFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentEventFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentFloatFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentIntegerFilter", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SegmentStringFilter", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SegmentFilterConnection", + "description": "An auto-generated type for paginating through multiple SegmentFilters.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentFilterEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SegmentFilterEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentFilterEdge", + "description": "An auto-generated type which holds one SegmentFilter and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SegmentFilterEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentFloatFilter", + "description": "A filter with a double-precision, floating-point value that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentIntegerFilter", + "description": "A filter with an integer that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentMembership", + "description": "The response type for the `segmentMembership` object.\n", + "fields": [ + { + "name": "isMember", + "description": "A Boolean that indicates whether or not the customer in the query is a member of the segment, which is identified using the `segmentId`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentId", + "description": "A `segmentId` that's used for testing membership.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentMembershipResponse", + "description": "A list of maps that contain `segmentId` IDs and `isMember` Booleans. The maps represent segment memberships.\n", + "fields": [ + { + "name": "memberships", + "description": "The membership status for the given list of segments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMembership", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentMigration", + "description": "A segment and its corresponding saved search. \nFor example, you can use `SegmentMigration` to retrieve the segment ID that corresponds to a saved search ID.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "savedSearchId", + "description": "The ID of the saved search.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "segmentId", + "description": "The ID of the segment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentMigrationConnection", + "description": "An auto-generated type for paginating through multiple SegmentMigrations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMigrationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SegmentMigrationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMigration", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentMigrationEdge", + "description": "An auto-generated type which holds one SegmentMigration and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SegmentMigrationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentMigration", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SegmentSortKeys", + "description": "The set of valid sort keys for the Segment query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATION_DATE", + "description": "Sort by the `creation_date` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAST_EDIT_DATE", + "description": "Sort by the `last_edit_date` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentStatistics", + "description": "The statistics of a given segment.", + "fields": [ + { + "name": "attributeStatistics", + "description": "The statistics of a given attribute.", + "args": [ + { + "name": "attributeName", + "description": "The attribute that statistics are retrieved for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentAttributeStatistics", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentStringFilter", + "description": "A filter with a string that's been added to a segment query.", + "fields": [ + { + "name": "localizedName", + "description": "The localized name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiValue", + "description": "Whether a file can have multiple values for a single customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The query name of the filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SegmentFilter", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentUpdatePayload", + "description": "Return type for `segmentUpdate` mutation.", + "fields": [ + { + "name": "segment", + "description": "The updated segment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Segment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentValue", + "description": "A list of suggested values associated with an individual segment. A\nsegment is a group of members, such as customers, that meet specific\ncriteria.\n", + "fields": [ + { + "name": "localizedValue", + "description": "The localized version of the value's name. This name is displayed to the merchant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryName", + "description": "The name of the query associated with the suggestion.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentValueConnection", + "description": "An auto-generated type for paginating through multiple SegmentValues.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentValueEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SegmentValueEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SegmentValueEdge", + "description": "An auto-generated type which holds one SegmentValue and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SegmentValueEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SegmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedOption", + "description": "Properties used by customers to select a product variant.\nProducts can have multiple options, like different sizes or colors.\n", + "fields": [ + { + "name": "name", + "description": "The product option’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The product option’s value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlan", + "description": "Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups\nand policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing\nup these records if you need to restore them later.\n\nFor more information on selling plans, refer to\n[*Creating and managing selling plans*](https://shopify.dev/docs/apps/selling-strategies/subscriptions/selling-plans).\n", + "fields": [ + { + "name": "billingPolicy", + "description": "A selling plan policy which describes the recurring billing details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanBillingPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category", + "description": "The category used to classify the selling plan for reporting purposes.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SellingPlanCategory", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the selling plan was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPolicy", + "description": "A selling plan policy which describes the delivery details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanDeliveryPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Buyer facing string which describes the selling plan commitment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryPolicy", + "description": "When to reserve inventory for a selling plan.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanInventoryPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "A customer-facing description of the selling plan.\n\nIf your store supports multiple currencies, then don't include country-specific pricing content, such as \"Buy monthly, get 10$ CAD off\". This field won't be converted to reflect different currencies.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "Relative position of the selling plan for display. A lower position will be displayed before a higher position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricingPolicies", + "description": "Selling plan pricing details.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPricingPolicy", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "description": "Represents a selling plan policy anchor.", + "fields": [ + { + "name": "cutoffDay", + "description": "The cutoff day for the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` is MONTHDAY, then the value must be between 1-31.\n\nIf `type` is YEARDAY, then the value must be `null`.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "day", + "description": "The day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` isn't WEEKDAY, then the value must be between 1-31.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "month", + "description": "The month of the anchor. If type is different than YEARDAY, then the value must\nbe `null` or between 1-12.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanAnchorType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "description": "The input fields required to create or update a selling plan anchor.", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "Represents the anchor type, must be one of WEEKDAY, MONTHDAY, YEARDAY.\n", + "type": { + "kind": "ENUM", + "name": "SellingPlanAnchorType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "day", + "description": "The day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` isn't WEEKDAY, then the value must be between 1-31.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "month", + "description": "The month of the anchor. If type is different than YEARDAY, then the value must\nbe `null` or between 1-12.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cutoffDay", + "description": "The cutoff day of the anchor.\n\nIf `type` is WEEKDAY, then the value must be between 1-7. Shopify interprets\nthe days of the week according to ISO 8601, where 1 is Monday.\n\nIf `type` is MONTHDAY, then the value must be between 1-31.\n\nIf `type` is YEARDAY, then the value must be `null`.\n\nThis field should only be set if the cutoff field for the delivery policy is `null`.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanAnchorType", + "description": "Represents the anchor type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "WEEKDAY", + "description": "Which day of the week, between 1-7.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MONTHDAY", + "description": "Which day of the month, between 1-31.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YEARDAY", + "description": "Which days of the month and year, month between 1-12, and day between 1-31.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanBillingPolicy", + "description": "Represents the billing frequency associated to the selling plan (for example, bill every week, or bill every\nthree months). The selling plan billing policy and associated records (selling plan groups, selling plans, pricing\npolicies, and delivery policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.\nWe recommend backing up these records if you need to restore them later.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SellingPlanFixedBillingPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringBillingPolicy", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanBillingPolicyInput", + "description": "The input fields that are required to create or update a billing policy type.", + "fields": null, + "inputFields": [ + { + "name": "fixed", + "description": "The fixed billing policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedBillingPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurring", + "description": "The recurring billing policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringBillingPolicyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanCategory", + "description": "The category of the selling plan. For the `OTHER` category,\n you must fill out our [request form](https://docs.google.com/forms/d/e/1FAIpQLSeU18Xmw0Q61V8wdH-dfGafFqIBfRchQKUO8WAF3yJTvgyyZQ/viewform),\n where we'll review your request for a new purchase option.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OTHER", + "description": "The selling plan is for anything not in one of the other categories.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRE_ORDER", + "description": "The selling plan is for pre-orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION", + "description": "The selling plan is for subscriptions.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRY_BEFORE_YOU_BUY", + "description": "The selling plan is for try before you buy purchases.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutCharge", + "description": "The amount charged at checkout when the full amount isn't charged at checkout.", + "fields": [ + { + "name": "type", + "description": "The charge type for the checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanCheckoutChargeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The charge value for the checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanCheckoutChargeValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanCheckoutChargeInput", + "description": "The input fields that are required to create or update a checkout charge.", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "The checkout charge type defined by the policy.", + "type": { + "kind": "ENUM", + "name": "SellingPlanCheckoutChargeType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The checkout charge value defined by the policy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanCheckoutChargeValueInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutChargePercentageValue", + "description": "The percentage value of the price used for checkout charge.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the price used for checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanCheckoutChargeType", + "description": "The checkout charge when the full amount isn't charged at checkout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERCENTAGE", + "description": "The checkout charge is a percentage of the product or variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "The checkout charge is a fixed price amount.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanCheckoutChargeValue", + "description": "The portion of the price to be charged at checkout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutChargePercentageValue", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanCheckoutChargeValueInput", + "description": "The input fields required to create or update an checkout charge value.", + "fields": null, + "inputFields": [ + { + "name": "percentage", + "description": "The percentage value.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedValue", + "description": "The fixed value for an checkout charge.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanConnection", + "description": "An auto-generated type for paginating through multiple SellingPlans.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SellingPlanEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanDeliveryPolicy", + "description": "Represents the delivery frequency associated to the selling plan (for example, deliver every month, or deliver\nevery other week). The selling plan delivery policy and associated records (selling plan groups, selling plans,\npricing policies, and billing policy) are deleted 48 hours after a merchant uninstalls their subscriptions app.\nWe recommend backing up these records if you need to restore them later.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SellingPlanFixedDeliveryPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringDeliveryPolicy", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanDeliveryPolicyInput", + "description": "The input fields that are required to create or update a delivery policy.", + "fields": null, + "inputFields": [ + { + "name": "fixed", + "description": "The fixed delivery policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedDeliveryPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurring", + "description": "The recurring delivery policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringDeliveryPolicyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanEdge", + "description": "An auto-generated type which holds one SellingPlan and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SellingPlanEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedBillingPolicy", + "description": "The fixed selling plan billing policy.", + "fields": [ + { + "name": "checkoutCharge", + "description": "The checkout charge when the full amount isn't charged at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanCheckoutCharge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingBalanceChargeExactTime", + "description": "The exact time when to capture the full payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingBalanceChargeTimeAfterCheckout", + "description": "The period after remaining_balance_charge_trigger, before capturing the full payment. Expressed as an ISO8601 duration.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingBalanceChargeTrigger", + "description": "When to capture payment for amount due.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanRemainingBalanceChargeTrigger", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedBillingPolicyInput", + "description": "The input fields required to create or update a fixed billing policy.", + "fields": null, + "inputFields": [ + { + "name": "remainingBalanceChargeTrigger", + "description": "When to capture the payment for the amount due.", + "type": { + "kind": "ENUM", + "name": "SellingPlanRemainingBalanceChargeTrigger", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remainingBalanceChargeExactTime", + "description": "The date and time to capture the full payment.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "remainingBalanceChargeTimeAfterCheckout", + "description": "The period after capturing the payment for the amount due (`remainingBalanceChargeTrigger`), and before capturing the full payment. Expressed as an ISO8601 duration.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "checkoutCharge", + "description": "The checkout charge policy for the selling plan.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanCheckoutChargeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedDeliveryPolicy", + "description": "Represents a fixed selling plan delivery policy.", + "fields": [ + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cutoff", + "description": "A buffer period for orders to be included in next fulfillment anchor.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentExactTime", + "description": "The date and time when the fulfillment should trigger.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentTrigger", + "description": "What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanFulfillmentTrigger", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intent", + "description": "Whether the delivery policy is merchant or buyer-centric.\nBuyer-centric delivery policies state the time when the buyer will receive the goods.\nMerchant-centric delivery policies state the time when the fulfillment should be started.\nCurrently, only merchant-centric delivery policies are supported.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyIntent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preAnchorBehavior", + "description": "The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedDeliveryPolicyInput", + "description": "The input fields required to create or update a fixed delivery policy.", + "fields": null, + "inputFields": [ + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "fulfillmentTrigger", + "description": "What triggers the fulfillment.", + "type": { + "kind": "ENUM", + "name": "SellingPlanFulfillmentTrigger", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fulfillmentExactTime", + "description": "The date and time when the fulfillment should trigger.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cutoff", + "description": "A buffer period for orders to be included in a cycle.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "intent", + "description": "Whether the delivery policy is merchant or buyer-centric.", + "type": { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyIntent", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "preAnchorBehavior", + "description": "The pre-anchor behavior.", + "type": { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyIntent", + "description": "Possible intentions of a Delivery Policy.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_BEGIN", + "description": "A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanFixedDeliveryPolicyPreAnchorBehavior", + "description": "The fulfillment or delivery behavior of the first fulfillment when the orderis placed before the anchor.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ASAP", + "description": "Orders placed can be fulfilled / delivered immediately. Orders placed inside a cutoff can be fulfilled / delivered at the next anchor.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEXT", + "description": "Orders placed can be fulfilled / delivered at the next anchor date.\nOrders placed inside a cutoff will skip the next anchor and can be fulfilled /\ndelivered at the following anchor.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedPricingPolicy", + "description": "Represents the pricing policy of a subscription or deferred purchase option selling plan.\nThe selling plan fixed pricing policy works with the billing and delivery policy\nto determine the final price. Discounts are divided among fulfillments.\nFor example, a subscription with a $10 discount and two deliveries will have a $5\ndiscount applied to each delivery.\n", + "fields": [ + { + "name": "adjustmentType", + "description": "The price adjustment type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adjustmentValue", + "description": "The price adjustment value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPricingPolicyAdjustmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the fixed selling plan pricing policy was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SellingPlanPricingPolicyBase", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedPricingPolicyInput", + "description": "The input fields required to create or update a fixed selling plan pricing policy.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the pricing policy.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adjustmentType", + "description": "Price adjustment type defined by the policy.", + "type": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adjustmentValue", + "description": "Price adjustment value defined by the policy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyValueInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanFulfillmentTrigger", + "description": "Describes what triggers fulfillment.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ANCHOR", + "description": "Use the anchor values to calculate fulfillment date.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ASAP", + "description": "As soon as possible.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXACT_TIME", + "description": "At an exact time defined by the fulfillment_exact_time field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN", + "description": "Unknown. Usually to be determined in the future.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "description": "Represents a selling method (for example, \"Subscribe and save\" or \"Pre-paid\"). Selling plan groups\nand associated records (selling plans and policies) are deleted 48 hours after a merchant\nuninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.\n", + "fields": [ + { + "name": "appId", + "description": "The ID for app, exposed in Liquid and product JSON.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesToProduct", + "description": "Whether the given product is directly associated to the selling plan group.", + "args": [ + { + "name": "productId", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesToProductVariant", + "description": "Whether the given product variant is directly associated to the selling plan group.", + "args": [ + { + "name": "productVariantId", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesToProductVariants", + "description": "Whether any of the product variants of the given product are associated to the selling plan group.\n", + "args": [ + { + "name": "productId", + "description": "The ID of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the selling plan group was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The merchant-facing description of the selling plan group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchantCode", + "description": "The merchant-facing label of the selling plan group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The buyer-facing label of the selling plan group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The relative position of the selling plan group for display.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCount", + "description": "A count of products associated to the selling plan group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantCount", + "description": "A count of product variants associated to the selling plan group.", + "args": [ + { + "name": "productId", + "description": "The ID of the product to scope the count to.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "Product variants associated to the selling plan group.", + "args": [ + { + "name": "productId", + "description": "Filters the product variants by a product ID.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "Products associated to the selling plan group.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlans", + "description": "Selling plans associated to the selling plan group.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "A summary of the policies associated to the selling plan group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupAddProductVariantsPayload", + "description": "Return type for `sellingPlanGroupAddProductVariants` mutation.", + "fields": [ + { + "name": "sellingPlanGroup", + "description": "The updated selling plan group.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupAddProductsPayload", + "description": "Return type for `sellingPlanGroupAddProducts` mutation.", + "fields": [ + { + "name": "sellingPlanGroup", + "description": "The updated selling plan group.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "description": "An auto-generated type for paginating through multiple SellingPlanGroups.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SellingPlanGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupCreatePayload", + "description": "Return type for `sellingPlanGroupCreate` mutation.", + "fields": [ + { + "name": "sellingPlanGroup", + "description": "The created selling plan group object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupDeletePayload", + "description": "Return type for `sellingPlanGroupDelete` mutation.", + "fields": [ + { + "name": "deletedSellingPlanGroupId", + "description": "The ID of the deleted selling plan group object.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupEdge", + "description": "An auto-generated type which holds one SellingPlanGroup and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SellingPlanGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanGroupInput", + "description": "The input fields required to create or update a selling plan group.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "Buyer facing label of the selling plan group.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appId", + "description": "ID for app, exposed in Liquid and product JSON.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "merchantCode", + "description": "Merchant facing label of the selling plan group.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Merchant facing description of the selling plan group.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sellingPlansToCreate", + "description": "List of selling plans to create.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlansToUpdate", + "description": "List of selling plans to update.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlansToDelete", + "description": "List of selling plans ids to delete.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "options", + "description": "The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "position", + "description": "Relative value for display purposes of the selling plan group. A lower position will be displayed before a higher one.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupRemoveProductVariantsPayload", + "description": "Return type for `sellingPlanGroupRemoveProductVariants` mutation.", + "fields": [ + { + "name": "removedProductVariantIds", + "description": "The removed product variant ids.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupRemoveProductsPayload", + "description": "Return type for `sellingPlanGroupRemoveProducts` mutation.", + "fields": [ + { + "name": "removedProductIds", + "description": "The removed product ids.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanGroupResourceInput", + "description": "The input fields for resource association with a Selling Plan Group.", + "fields": null, + "inputFields": [ + { + "name": "productVariantIds", + "description": "The IDs of the Variants to add to the Selling Plan Group.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productIds", + "description": "The IDs of the Products to add to the Selling Plan Group.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanGroupSortKeys", + "description": "The set of valid sort keys for the SellingPlanGroup query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupUpdatePayload", + "description": "Return type for `sellingPlanGroupUpdate` mutation.", + "fields": [ + { + "name": "deletedSellingPlanIds", + "description": "The IDs of the deleted Subscription Plans.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroup", + "description": "The updated Selling Plan Group.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupUserError", + "description": "Represents a selling plan group custom error.\n", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SellingPlanGroupUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanGroupUserErrorCode", + "description": "Possible error codes that can be returned by `SellingPlanGroupUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EQUAL_TO", + "description": "The input value should be equal to the value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_A_NUMBER", + "description": "The input value is not a number.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "The record with the ID used as the input value couldn't be found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_BIG", + "description": "The input value is too big.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WRONG_LENGTH", + "description": "The input value is the wrong length.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_COUNT_UPPER_BOUND", + "description": "Exceeded the selling plan limit (31).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_COUNT_LOWER_BOUND", + "description": "Must include at least one selling plan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES", + "description": "Selling plan's billing policy max cycles must be greater than min cycles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_BILLING_AND_DELIVERY_POLICY_ANCHORS_MUST_BE_EQUAL", + "description": "Selling plan's billing and delivery policies anchors must be equal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_BILLING_CYCLE_MUST_BE_A_MULTIPLE_OF_DELIVERY_CYCLE", + "description": "Selling plan's billing cycle must be a multiple of delivery cycle.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_PRICING_POLICIES_MUST_CONTAIN_A_FIXED_PRICING_POLICY", + "description": "Selling plan's pricing policies must contain one fixed pricing policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_MISSING_OPTION2_LABEL_ON_PARENT_GROUP", + "description": "Cannot define option2 on this selling plan as there's no label on the parent selling plan group.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_MISSING_OPTION3_LABEL_ON_PARENT_GROUP", + "description": "Cannot define option3 on this selling plan as there's no label on the parent selling plan group.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_OPTION2_REQUIRED_AS_DEFINED_ON_PARENT_GROUP", + "description": "Selling plan's option2 is required because option2 exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_OPTION3_REQUIRED_AS_DEFINED_ON_PARENT_GROUP", + "description": "Selling plan's option3 is required because option3 exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_PRICING_POLICIES_LIMIT", + "description": "Selling plans can't have more than 2 pricing policies.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_LIST_CONTAINS_INVALID_IDS", + "description": "The selling plan list provided contains 1 or more invalid IDs.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT_DOES_NOT_EXIST", + "description": "Product variant does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_DOES_NOT_EXIST", + "description": "Product does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GROUP_DOES_NOT_EXIST", + "description": "Selling plan group does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GROUP_COULD_NOT_BE_DELETED", + "description": "Selling plan group could not be deleted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR_ADDING_RESOURCE_TO_GROUP", + "description": "Could not add the resource to the selling plan group.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_DELIVERY_POLICY_MISSING", + "description": "Missing delivery policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_BILLING_POLICY_MISSING", + "description": "Missing billing policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLAN_DOES_NOT_EXIST", + "description": "Selling plan does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLAN_ID_MUST_BE_SPECIFIED_TO_UPDATE", + "description": "Selling plan ID must be specified to update.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_NEED_ONE_BILLING_POLICY_TYPE", + "description": "Only one billing policy type can be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_NEED_ONE_DELIVERY_POLICY_TYPE", + "description": "Only one delivery policy type can be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_NEED_ONE_PRICING_POLICY_TYPE", + "description": "Only one pricing policy type can be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_AND_DELIVERY_POLICY_TYPES_MUST_BE_THE_SAME", + "description": "Billing and delivery policy types must be the same.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_NEED_ONE_PRICING_POLICY_VALUE", + "description": "Only one pricing policy adjustment value type can be defined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICING_POLICY_ADJUSTMENT_VALUE_AND_TYPE_MUST_MATCH", + "description": "Pricing policy's adjustment value and adjustment type must match.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_DUPLICATE_NAME", + "description": "Cannot have multiple selling plans with the same name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_DUPLICATE_OPTIONS", + "description": "Cannot have multiple selling plans with the same options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_FIXED_PRICING_POLICIES_LIMIT", + "description": "A fixed selling plan can have at most one pricing policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_EXACT_TIME_REQUIRED", + "description": "A fixed billing policy's remaining_balance_charge_exact_time can't be blank when the remaining_balance_charge_trigger is EXACT_TIME.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUT_CHARGE_VALUE_AND_TYPE_MUST_MATCH", + "description": "A fixed billing policy's checkout charge value and type must match.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_NEED_ONE_CHECKOUT_CHARGE_VALUE", + "description": "A fixed billing policy's checkout charge can have at most one value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_EXACT_TIME_NOT_ALLOWED", + "description": "A fixed billing policy's remaining_balance_charge_exact_time must not be present when the remaining_balance_charge_trigger isn't EXACT_TIME.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_TIME_AFTER_CHECKOUT_MUST_BE_GREATER_THAN_ZERO", + "description": "A fixed billing policy's remaining_balance_charge_time_after_checkout must be present and greater than zero when the remaining_balance_charge_trigger is TIME_AFTER_CHECKOUT.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_TRIGGER_ON_FULL_CHECKOUT", + "description": "A fixed billing policy's remaining_balance_charge_trigger must be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is 100.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PARTIAL_PERCENTAGE_CHECKOUT_CHARGE", + "description": "A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PERCENTAGE and checkout_charge_value is less than 100.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REMAINING_BALANCE_CHARGE_TRIGGER_NO_REMAINING_BALANCE_ON_PRICE_CHECKOUT_CHARGE", + "description": "A fixed billing policy's remaining_balance_charge_trigger can't be NO_REMAINING_BALANCE when the checkout_charge_type is PRICE.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_EXACT_TIME_REQUIRED", + "description": "A fixed billing policy's fulfillment_exact_time can't be blank when the fulfillment_trigger is EXACT_TIME.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_EXACT_TIME_NOT_ALLOWED", + "description": "A fixed billing policy's fulfillment_exact_time must not be present when the fulfillment_trigger isn't EXACT_TIME.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_ANCHORS_NOT_ALLOWED", + "description": "A fixed delivery policy's anchors must not be present when the fulfillment_trigger isn't ANCHOR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_ANCHORS_REQUIRED", + "description": "A fixed delivery policy's anchors must be present when the fulfillment_trigger is ANCHOR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_ONE_OF_FIXED_OR_RECURRING_BILLING", + "description": "A selling plan can't have both fixed and recurring billing policies.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLY_ONE_OF_FIXED_OR_RECURRING_DELIVERY", + "description": "A selling plan can't have both fixed and recurring delivery policies.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanInput", + "description": "The input fields to create or update a selling plan.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the selling plan.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Buyer facing string which describes the selling plan content.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "Buyer facing string which describes the selling plan commitment.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingPolicy", + "description": "Selling plan policy which describes the billing details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanBillingPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryPolicy", + "description": "A selling plan policy which describes the delivery details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanDeliveryPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "inventoryPolicy", + "description": "A selling plan policy which describes the inventory details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanInventoryPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pricingPolicies", + "description": "The pricing policies which describe the pricing details. Each selling plan\ncan only contain a maximum of 2 pricing policies.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "options", + "description": "The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same `selling_plan_group.name` and `selling_plan_group.options` values.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "position", + "description": "Relative value for display purposes of this plan. A lower position will be displayed before a higher one.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "category", + "description": "The category used to classify this selling plan for reporting purposes.", + "type": { + "kind": "ENUM", + "name": "SellingPlanCategory", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanInterval", + "description": "Represents valid selling plan interval.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DAY", + "description": "Day interval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEEK", + "description": "Week interval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MONTH", + "description": "Month interval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YEAR", + "description": "Year interval.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanInventoryPolicy", + "description": "The selling plan inventory policy.", + "fields": [ + { + "name": "reserve", + "description": "When to reserve inventory for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanReserve", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanInventoryPolicyInput", + "description": "The input fields required to create or update an inventory policy.", + "fields": null, + "inputFields": [ + { + "name": "reserve", + "description": "When to reserve inventory for the order. The value must be ON_FULFILLMENT or ON_SALE.", + "type": { + "kind": "ENUM", + "name": "SellingPlanReserve", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanPricingPolicy", + "description": "Represents the type of pricing associated to the selling plan (for example, a $10 or 20% discount that is set\nfor a limited period or that is fixed for the duration of the subscription). Selling plan pricing policies and\nassociated records (selling plan groups, selling plans, billing policy, and delivery policy) are deleted 48\nhours after a merchant uninstalls their subscriptions app. We recommend backing up these records if you need\nto restore them later.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SellingPlanFixedPricingPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringPricingPolicy", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "description": "Represents a selling plan pricing policy adjustment type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERCENTAGE", + "description": "Percentage off adjustment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIXED_AMOUNT", + "description": "Fixed amount off adjustment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "Price of the policy.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanPricingPolicyAdjustmentValue", + "description": "Represents a selling plan pricing policy adjustment value type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanPricingPolicyPercentageValue", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "SellingPlanPricingPolicyBase", + "description": "Represents selling plan pricing policy common fields.", + "fields": [ + { + "name": "adjustmentType", + "description": "The price adjustment type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adjustmentValue", + "description": "The price adjustment value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPricingPolicyAdjustmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SellingPlanFixedPricingPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringPricingPolicy", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyInput", + "description": "The input fields required to create or update a selling plan pricing policy.", + "fields": null, + "inputFields": [ + { + "name": "recurring", + "description": "Recurring pricing policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringPricingPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixed", + "description": "Fixed pricing policy details.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanFixedPricingPolicyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanPricingPolicyPercentageValue", + "description": "The percentage value of a selling plan pricing policy percentage type.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyValueInput", + "description": "The input fields required to create or update a pricing policy adjustment value.", + "fields": null, + "inputFields": [ + { + "name": "percentage", + "description": "The percentage value.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedValue", + "description": "The fixed value for an fixed amount off or a new policy price.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringBillingPolicy", + "description": "Represents a recurring selling plan billing policy.", + "fields": [ + { + "name": "anchors", + "description": "Specific anchor dates upon which the billing interval calculations should be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the selling plan billing policy was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The billing frequency, it can be either: day, week, month or year.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intervalCount", + "description": "The number of intervals between billings.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxCycles", + "description": "Maximum number of billing iterations.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minCycles", + "description": "Minimum number of billing iterations.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringBillingPolicyInput", + "description": "The input fields required to create or update a recurring billing policy.", + "fields": null, + "inputFields": [ + { + "name": "interval", + "description": "The billing frequency, it can be either: day, week, month or year.", + "type": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "intervalCount", + "description": "The number of intervals between billings.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "anchors", + "description": "Specific anchor dates upon which the billing interval calculations should be made.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "minCycles", + "description": "Minimum number of billing iterations.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxCycles", + "description": "Maximum number of billing iterations.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringDeliveryPolicy", + "description": "Represents a recurring selling plan delivery policy.", + "fields": [ + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the selling plan delivery policy was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cutoff", + "description": "Number of days which represent a buffer period for orders to be included in a cycle.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intent", + "description": "Whether the delivery policy is merchant or buyer-centric.\nBuyer-centric delivery policies state the time when the buyer will receive the goods.\nMerchant-centric delivery policies state the time when the fulfillment should be started.\nCurrently, only merchant-centric delivery policies are supported.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyIntent", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The delivery frequency, it can be either: day, week, month or year.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intervalCount", + "description": "The number of intervals between deliveries.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preAnchorBehavior", + "description": "The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor. The default value for this field is `ASAP`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringDeliveryPolicyInput", + "description": "The input fields to create or update a recurring delivery policy.", + "fields": null, + "inputFields": [ + { + "name": "interval", + "description": "The delivery frequency, it can be either: day, week, month or year.", + "type": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "intervalCount", + "description": "The number of intervals between deliveries.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "cutoff", + "description": "A buffer period for orders to be included in a cycle.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "intent", + "description": "Intention of this delivery policy, it can be either: delivery or fulfillment.", + "type": { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyIntent", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "preAnchorBehavior", + "description": "The pre-anchor behavior. It can be either: asap or next.", + "type": { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyIntent", + "description": "Whether the delivery policy is merchant or buyer-centric.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FULFILLMENT_BEGIN", + "description": "A merchant-centric delivery policy. Mark this delivery policy to define when the merchant should start fulfillment.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanRecurringDeliveryPolicyPreAnchorBehavior", + "description": "The fulfillment or delivery behaviors of the first fulfillment when the orderis placed before the anchor.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ASAP", + "description": "The orders placed can be fulfilled or delivered immediately. The orders placed inside a cutoff can be fulfilled or delivered at the next anchor.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NEXT", + "description": "The orders placed can be fulfilled or delivered at the next anchor date.\nThe orders placed inside a cutoff will skip the next anchor and can be fulfilled or\ndelivered at the following anchor.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanRecurringPricingPolicy", + "description": "Represents a recurring selling plan pricing policy.", + "fields": [ + { + "name": "adjustmentType", + "description": "The price adjustment type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adjustmentValue", + "description": "The price adjustment value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPricingPolicyAdjustmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "afterCycle", + "description": "Cycle after which this pricing policy applies.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the recurring selling plan pricing policy was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SellingPlanPricingPolicyBase", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SellingPlanRecurringPricingPolicyInput", + "description": "The input fields required to create or update a recurring selling plan pricing policy.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the pricing policy.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adjustmentType", + "description": "Price adjustment type defined by the policy.", + "type": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "adjustmentValue", + "description": "Price adjustment value defined by the policy.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "afterCycle", + "description": "Cycle after which the pricing policy applies.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanRemainingBalanceChargeTrigger", + "description": "When to capture the payment for the remaining amount due.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NO_REMAINING_BALANCE", + "description": "When there's no remaining balance to be charged after checkout.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXACT_TIME", + "description": "At an exact time defined by the remaining_balance_charge_exact_time field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TIME_AFTER_CHECKOUT", + "description": "After the duration defined by the remaining_balance_charge_time_after_checkout field.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanReserve", + "description": "When to reserve inventory for a selling plan.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ON_FULFILLMENT", + "description": "Reserve inventory when order is fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ON_SALE", + "description": "Reserve inventory at time of sale.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ServerPixel", + "description": "A server pixel stores configuration for streaming customer interactions to an EventBridge or PubSub endpoint.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current state of this server pixel.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ServerPixelStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookEndpointAddress", + "description": "Address of the EventBridge or PubSub endpoint.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ServerPixelCreatePayload", + "description": "Return type for `serverPixelCreate` mutation.", + "fields": [ + { + "name": "serverPixel", + "description": "The new server pixel.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ServerPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ServerPixelDeletePayload", + "description": "Return type for `serverPixelDelete` mutation.", + "fields": [ + { + "name": "deletedServerPixelId", + "description": "The ID of the server pixel that was deleted, if one was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsServerPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ServerPixelStatus", + "description": "The current state of a server pixel.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CONNECTED", + "description": "This server pixel is connected: it will stream customer events to the endpoint if it is configured properly.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCONNECTED_UNCONFIGURED", + "description": "This server pixel is disconnected and unconfigured: it does not stream events to the endpoint and no endpoint address had been added to the server pixel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCONNECTED_CONFIGURED", + "description": "This server pixel is disconnected: it does not stream events to the endpoint and an endpoint address has been added to the server pixel.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShippingDiscountClass", + "description": "The class of the discount for combining purposes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHIPPING", + "description": "Combined as a shipping discount.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingLine", + "description": "Represents the shipping details that the customer chose for their order.", + "fields": [ + { + "name": "carrierIdentifier", + "description": "A reference to the carrier service that provided the rate.\nPresent when the rate was computed by a third-party carrier service.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "A reference to the shipping method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "custom", + "description": "Whether the shipping line is custom or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryCategory", + "description": "The general classification of the delivery method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated to the shipping line.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedPrice", + "description": "The pre-tax shipping price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `discountedPriceSet` instead." + }, + { + "name": "discountedPriceSet", + "description": "The pre-tax shipping price with discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalPrice", + "description": "The pre-tax shipping price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalPriceSet` instead." + }, + { + "name": "originalPriceSet", + "description": "The pre-tax shipping price without any discounts applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number at the shipping address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "Returns the price of the shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originalPriceSet` instead." + }, + { + "name": "requestedFulfillmentService", + "description": "The fulfillment service requested for the shipping method.\nPresent if the shipping method requires processing by a third party fulfillment service.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingRateHandle", + "description": "A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source", + "description": "Returns the rate source for the shipping line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxLines", + "description": "The TaxLine objects connected to this shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Returns the title of the shipping line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingLineConnection", + "description": "An auto-generated type for paginating through multiple ShippingLines.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingLineEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ShippingLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingLineEdge", + "description": "An auto-generated type which holds one ShippingLine and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ShippingLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShippingLineInput", + "description": "The input fields for specifying the shipping details for the order.", + "fields": null, + "inputFields": [ + { + "name": "price", + "description": "Price of the shipping rate.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingRateHandle", + "description": "A unique identifier for the shipping rate.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "title", + "description": "Title of the shipping rate.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingLineSale", + "description": "A sale associated with a shipping charge.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLine", + "description": "The shipping line item for the associated sale. `shippingLine` is not available if the `SaleActionType` is a return.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingMethod", + "description": "The shipping method for the delivery. Customers will see applicable shipping methods in the shipping section of checkout.\n", + "fields": [ + { + "name": "code", + "description": "A unique code associated with the rate. For example: `expedited_mail`", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A description of the rate, which customers will see at checkout.\nFor example: `Local delivery`, `Free Express Worldwide`, `Includes tracking and insurance`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingPackageDeletePayload", + "description": "Return type for `shippingPackageDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted shipping package.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingPackageMakeDefaultPayload", + "description": "Return type for `shippingPackageMakeDefault` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShippingPackageType", + "description": "Type of a shipping package.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BOX", + "description": "A shipping box.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FLAT_RATE", + "description": "A flat rate packaging supplied by a carrier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENVELOPE", + "description": "An envelope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOFT_PACK", + "description": "A soft-pack, bubble-wrap or vinyl envelope.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingPackageUpdatePayload", + "description": "Return type for `shippingPackageUpdate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingRate", + "description": "A shipping rate is an additional cost added to the cost of the products that were ordered.", + "fields": [ + { + "name": "handle", + "description": "Human-readable unique identifier for this shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The cost associated with the shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingRefund", + "description": "Represents the shipping costs refunded on the Refund.", + "fields": [ + { + "name": "amount", + "description": "The monetary value of the shipping fees to be refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountSet` instead." + }, + { + "name": "amountSet", + "description": "The monetary value of the shipping fees to be refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumRefundable", + "description": "The maximum amount of shipping fees currently refundable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `maximumRefundableSet` instead." + }, + { + "name": "maximumRefundableSet", + "description": "The maximum amount of shipping fees currently refundable in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tax", + "description": "The monetary value of the tax allocated to shipping fees to be refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `taxSet` instead." + }, + { + "name": "taxSet", + "description": "The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShippingRefundInput", + "description": "The input fields that are required to reimburse shipping costs.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The monetary value of the shipping fees to be reimbursed.", + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fullRefund", + "description": "Whether a full refund is provided.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "description": "Represents a collection of general settings and information about the shop.\n", + "fields": [ + { + "name": "alerts", + "description": "A list of the shop's active alert messages that appear in the Shopify admin.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopAlert", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "allProductCategories", + "description": "A list of the shop's product categories. Limit: 1000 product categories.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductCategory", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "analyticsToken", + "description": "The token required to query the shop's reports or dashboards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Not supported anymore." + }, + { + "name": "assignedFulfillmentOrders", + "description": "The paginated list of fulfillment orders assigned to the shop locations owned by the app.\n\nAssigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations\nmanaged by\n[fulfillment services](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService)\nthat are registered by the app.\nOne app (api_client) can host multiple fulfillment services on a shop.\nEach fulfillment service manages a dedicated location on a shop.\nAssigned fulfillment orders can have associated\n[fulfillment requests](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus),\nor might currently not be requested to be fulfilled.\n\nThe app must have `read_assigned_fulfillment_orders`\n[access scope](https://shopify.dev/docs/api/usage/access-scopes)\nto be able to retrieve fulfillment orders assigned to its locations.\n\nAll assigned fulfillment orders (except those with the `CLOSED` status) will be returned by default.\nPerform filtering with the `assignmentStatus` argument\nto receive only fulfillment orders that have been requested to be fulfilled.\n", + "args": [ + { + "name": "assignmentStatus", + "description": "The assigment status of the fulfillment orders that should be returned.\nIf `assignmentStatus` argument is not provided, then\nthe query will return all assigned fulfillment orders,\nexcept those that have the `CLOSED` status.\n", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderAssignmentStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locationIds", + "description": "Returns fulfillment orders only for certain locations, specified by a list of location IDs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableChannelApps", + "description": "The list of sales channels not currently installed on the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddress", + "description": "The shop's billing address information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channelCount", + "description": "Exposes the number of channels.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `publicationCount` instead." + }, + { + "name": "channelDefinitionsForInstalledChannels", + "description": "List of all channel definitions associated with a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AvailableChannelDefinitionsByChannel", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "channels", + "description": "List of the shop's active sales channels.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ChannelConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.channels` instead." + }, + { + "name": "checkoutApiSupported", + "description": "Specifies whether the shop supports checkouts via Checkout API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionByHandle", + "description": "Return a collection by its handle.", + "args": [ + { + "name": "handle", + "description": "The handle of the collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.collectionByHandle` instead." + }, + { + "name": "collectionSavedSearches", + "description": "List of the shop's collection saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.collectionSavedSearches` instead." + }, + { + "name": "collections", + "description": "List of the shop's collections.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CollectionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `collection_type`\n - `product_publication_status`\n - `publishable_status`\n - `published_status`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.collections` instead." + }, + { + "name": "contactEmail", + "description": "The public-facing contact email address for the shop.\nCustomers will use this email to communicate with the shop owner.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countriesInShippingZones", + "description": "Countries that have been defined in shipping zones for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CountriesInShippingZones", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The three letter code for the currency that the shop sells in.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyFormats", + "description": "How currencies are displayed on your store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencyFormats", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencySettings", + "description": "The presentment currency settings for the shop excluding the shop's own currency.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CurrencySettingConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccounts", + "description": "Whether customer accounts are required, optional, or disabled for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopCustomerAccountsSetting", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSavedSearches", + "description": "List of the shop's customer saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CustomerSavedSearchSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `name`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.customerSavedSearches` instead." + }, + { + "name": "customerTags", + "description": "A list of tags that have been added to customer accounts.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customers", + "description": "Customer accounts associated to the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CustomerSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `accepts_marketing`\n - `country`\n - `customer_date`\n - `email`\n - `last_abandoned_order_date`\n - `order_date`\n - `orders_count`\n - `phone`\n - `state`\n - `tag`\n - `tag_not`\n - `total_spent`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.customers` instead." + }, + { + "name": "description", + "description": "The shop's meta description used in search engine results.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "domains", + "description": "The domains configured for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `domainsPaginated` instead." + }, + { + "name": "draftOrderSavedSearches", + "description": "List of the shop's draft order saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.draftOrderSavedSearches` instead." + }, + { + "name": "draftOrderTags", + "description": "A list of tags that have been added to draft orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draftOrders", + "description": "List of saved draft orders on the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "DraftOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `customer_id`\n - `source`\n - `status`\n - `tag`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DraftOrderConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.draftOrders` instead." + }, + { + "name": "email", + "description": "The shop owner's email address.\nShopify will use this email address to communicate with the shop owner.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabledPresentmentCurrencies", + "description": "The presentment currencies enabled for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "features", + "description": "The set of features enabled for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopFeatures", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentOrders", + "description": "The paginated list of merchant-managed and third-party fulfillment orders.", + "args": [ + { + "name": "includeClosed", + "description": "Whether to include closed fulfillment orders.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "FulfillmentOrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `assigned_location_id`\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentOrderConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.fulfillmentOrders` instead." + }, + { + "name": "fulfillmentServices", + "description": "List of the shop's installed fulfillment services.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentService", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ianaTimezone", + "description": "The shop's time zone as defined by the IANA.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inventoryItems", + "description": "List of the shop's inventory items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `id`\n - `sku`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InventoryItemConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.inventoryItems` instead." + }, + { + "name": "limitedPendingOrderCount", + "description": "The number of pendings orders on the shop.\nLimited to a maximum of 10000.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LimitedPendingOrderCount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "List of active locations of the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "LocationSortKeys", + "ofType": null + }, + "defaultValue": "NAME" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `active`\n - `address1`\n - `address2`\n - `city`\n - `country`\n - `legacy`\n - `name`\n - `province`\n - `zip`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeLegacy", + "description": "If true, also include the legacy locations of fulfillment services.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "includeInactive", + "description": "If true, also include the locations that are deactivated.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.locations` instead." + }, + { + "name": "marketingEvents", + "description": "List of a shop's marketing events.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "MarketingEventSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `app_id`\n - `description`\n - `started_at`\n - `type`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketingEventConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.marketingEvents` instead." + }, + { + "name": "merchantApprovalSignals", + "description": "The approval signals for a shop to support onboarding to channel apps.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MerchantApprovalSignals", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The container the metafield belongs to. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "List of metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "keys", + "description": "List of keys of metafields in the format `namespace.key`, will be returned in the same format.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "myshopifyDomain", + "description": "The shop's .myshopify.com domain name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The shop's name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "navigationSettings", + "description": "The shop's settings related to navigation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "NavigationItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderNumberFormatPrefix", + "description": "The prefix that appears before order numbers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderNumberFormatSuffix", + "description": "The suffix that appears after order numbers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderSavedSearches", + "description": "List of the shop's order saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.orderSavedSearches` instead." + }, + { + "name": "orderTags", + "description": "A list of tags that have been added to orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sort", + "description": "Sort type.", + "type": { + "kind": "ENUM", + "name": "ShopTagSort", + "ofType": null + }, + "defaultValue": "ALPHABETICAL" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "A list of the shop's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "PROCESSED_AT" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `cart_token`\n - `channel`\n - `channel_id`\n - `chargeback_status`\n - `checkout_token`\n - `confirmation_number`\n - `created_at`\n - `credit_card_last4`\n - `customer_id`\n - `delivery_method`\n - `discount_code`\n - `earliest_fulfill_by`\n - `email`\n - `financial_status`\n - `fraud_protection_level`\n - `fulfillment_location_id`\n - `fulfillment_status`\n - `gateway`\n - `location_id`\n - `name`\n - `payment_id`\n - `payment_provider_id`\n - `po_number`\n - `processed_at`\n - `reference_location_id`\n - `return_status`\n - `risk_level`\n - `sales_channel`\n - `sku`\n - `source_identifier`\n - `source_name`\n - `status`\n - `tag`\n - `tag_not`\n - `test`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.orders` instead." + }, + { + "name": "paymentSettings", + "description": "The shop's settings related to payments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pendingOrderCount", + "description": "Number of pending orders on the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `limitedPendingOrderCount` instead." + }, + { + "name": "plan", + "description": "The shop's billing plan.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRuleSavedSearches", + "description": "List of the shop's price rule saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.priceRuleSavedSearches` instead." + }, + { + "name": "priceRules", + "description": "List of the shop’s price rules.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "PriceRuleSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `combines_with`\n - `created_at`\n - `discount_type`\n - `ends_at`\n - `starts_at`\n - `status`\n - `times_used`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRuleConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.priceRules` instead." + }, + { + "name": "primaryDomain", + "description": "The primary domain of the shop's online store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafield", + "description": "Returns a private metafield by namespace and key that belongs to the resource.", + "args": [ + { + "name": "namespace", + "description": "The namespace for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key for the private metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PrivateMetafield", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "privateMetafields", + "description": "List of private metafields that belong to the resource.", + "args": [ + { + "name": "namespace", + "description": "Filter the private metafields by namespace.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PrivateMetafieldConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "productByHandle", + "description": "Return a product by its handle.", + "args": [ + { + "name": "handle", + "description": "A unique string that identifies the product. Handles are automatically generated based on the product's title, and are always lowercase. Whitespace and special characters are replaced with a hyphen: `-`. If there are multiple consecutive whitespace or special characters, then they're replaced with a single hyphen. Whitespace or special characters at the beginning are removed. If a duplicate product title is used, then the handle is auto-incremented by one. For example, if you had two products called `Potion`, then their handles would be `potion` and `potion-1`. After a product has been created, changing the product title doesn't update the handle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.productByHandle` instead." + }, + { + "name": "productImages", + "description": "The list of all images of all products for the shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductImageSortKeys", + "ofType": null + }, + "defaultValue": "CREATED_AT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSavedSearches", + "description": "List of the shop's product saved searches.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SavedSearchConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.productSavedSearches` instead." + }, + { + "name": "productTags", + "description": "A list of tags that have been added to products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productTypes", + "description": "The list of types added to products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariants", + "description": "List of the shop's product variants.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `barcode`\n - `collection`\n - `delivery_profile_id`\n - `exclude_composite`\n - `exclude_variants_with_components`\n - `gift_card`\n - `inventory_quantity`\n - `location_id`\n - `managed`\n - `managed_by`\n - `option1`\n - `option2`\n - `option3`\n - `product_id`\n - `product_ids`\n - `product_publication_status`\n - `product_status`\n - `product_type`\n - `publishable_status`\n - `published_status`\n - `requires_components`\n - `sku`\n - `tag`\n - `tag_not`\n - `taxable`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.productVariants` instead." + }, + { + "name": "productVendors", + "description": "The list of vendors added to products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "List of the shop's products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `barcode`\n - `bundles`\n - `created_at`\n - `delivery_profile_id`\n - `error_feedback`\n - `gift_card`\n - `has_only_composites`\n - `has_only_default_variant`\n - `has_variant_with_components`\n - `id`\n - `inventory_total`\n - `is_price_reduced`\n - `out_of_stock_somewhere`\n - `price`\n - `product_configuration_owner`\n - `product_publication_status`\n - `product_type`\n - `publishable_status`\n - `published_status`\n - `sku`\n - `status`\n - `tag`\n - `tag_not`\n - `title`\n - `updated_at`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "savedSearchId", + "description": "The ID of an existing saved search.\nThe search’s query string is used as the query argument.\nRefer to [SavedSearch](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch).\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.products`." + }, + { + "name": "publicationCount", + "description": "The number of publications for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourceLimits", + "description": "The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopResourceLimits", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "richTextEditorUrl", + "description": "The URL of the rich text editor that can be used for mobile devices.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "search", + "description": "Fetches a list of admin search results by a specified query.", + "args": [ + { + "name": "query", + "description": "The search query to filter by.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "types", + "description": "The search result types to filter by.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SearchResultType", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "searchFilters", + "description": "The list of search filter options for the shop. These can be used to filter productvisibility for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchFilterOptions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "setupRequired", + "description": "Whether the shop has outstanding setup steps.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipsToCountries", + "description": "The list of countries that the shop ships to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopPolicies", + "description": "The list of all legal policies associated with a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPaymentsAccount", + "description": "Shopify Payments account information, including balances and payouts.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsAccount", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `QueryRoot.shopifyPaymentsAccount` instead." + }, + { + "name": "staffMembers", + "description": "The paginated list of the shop's staff members.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMemberConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontAccessTokens", + "description": "The storefront access token of a private application. These are scoped per-application.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StorefrontAccessTokenConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontUrl", + "description": "The URL of the shop's storefront.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url` instead." + }, + { + "name": "taxShipping", + "description": "Whether the shop charges taxes for shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxesIncluded", + "description": "Whether applicable taxes are included in the shop's product prices.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timezoneAbbreviation", + "description": "The shop's time zone abbreviation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timezoneOffset", + "description": "The shop's time zone offset.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "timezoneOffsetMinutes", + "description": "The shop's time zone offset expressed as a number of minutes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactionalSmsDisabled", + "description": "Whether transactional SMS sent by Shopify have been disabled for a shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitSystem", + "description": "The shop's unit system for weights and measures.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "UnitSystem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uploadedImagesByIds", + "description": "Fetches a list of images uploaded to the shop by their IDs.", + "args": [ + { + "name": "imageIds", + "description": "The IDs of the uploaded images.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the shop's online store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weightUnit", + "description": "The shop's primary unit of weight for products and shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopAddress", + "description": "The shop's billing address.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The name of the company or organization.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "coordinatesValidated", + "description": "Whether the address coordinates are valid.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `countryCodeV2` instead." + }, + { + "name": "countryCodeV2", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Always null in this context." + }, + { + "name": "formatted", + "description": "A formatted version of the address, customized by the provided arguments.", + "args": [ + { + "name": "withCompany", + "description": "Whether to include the company in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedArea", + "description": "A comma-separated list of the values for city, province, and country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Always null in this context." + }, + { + "name": "latitude", + "description": "The latitude coordinate of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude coordinate of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name, based on firstName and lastName.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Always null in this context." + }, + { + "name": "phone", + "description": "A phone number associated with the address.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\n\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopAlert", + "description": "An alert message that appears in the Shopify admin about a problem with a store setting, with an action to take. For example, you could show an alert to ask the merchant to enter their billing information to activate Shopify Plus.\n", + "fields": [ + { + "name": "action", + "description": "The text for the button in the alert that links to related information. For example, _Add credit card_.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopAlertAction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A description of the alert and further information, such as whether the merchant will be charged.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopAlertAction", + "description": "An action associated to a shop alert, such as adding a credit card.", + "fields": [ + { + "name": "title", + "description": "The text for the button in the alert. For example, _Add credit card_.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The target URL that the button links to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopBillingPreferences", + "description": "Billing preferences for the shop.", + "fields": [ + { + "name": "currency", + "description": "The currency the shop uses to pay for apps and services.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopBranding", + "description": "Possible branding of a shop.\nBranding can be used to define the look of a shop including its styling and logo in the Shopify Admin.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHOPIFY_GOLD", + "description": "Shop has Shopify Gold branding.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOPIFY_PLUS", + "description": "Shop has Shopify Plus branding.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ROGERS", + "description": "Shop has Rogers branding.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOPIFY", + "description": "Shop has Shopify branding.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopCustomerAccountsSetting", + "description": "Represents the shop's customer account requirement preference.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTIONAL", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISABLED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopFeatures", + "description": "Represents the feature set available to the shop.\nMost fields specify whether a feature is enabled for a shop, and some fields return information\nrelated to specific features.\n", + "fields": [ + { + "name": "avalaraAvatax", + "description": "Whether a shop has access to Avalara AvaTax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "branding", + "description": "The branding of the shop, which influences its look and feel in the Shopify admin.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopBranding", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bundles", + "description": "Represents the Bundles feature configuration for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BundlesFeature", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "captcha", + "description": "Whether a shop's online store can have CAPTCHA protection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "captchaExternalDomains", + "description": "Whether a shop's online store can have CAPTCHA protection for domains not managed by Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryProfiles", + "description": "Whether the delivery profiles functionality is enabled for this shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Delivery profiles are now 100% enabled across Shopify." + }, + { + "name": "dynamicRemarketing", + "description": "Whether a shop has access to the Google Analytics dynamic remarketing feature.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligibleForSubscriptionMigration", + "description": "Whether a shop can be migrated to use Shopify subscriptions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "eligibleForSubscriptions", + "description": "Whether a shop is configured properly to sell subscriptions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "giftCards", + "description": "Whether a shop can create gift cards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "harmonizedSystemCode", + "description": "Whether a shop displays Harmonized System codes on products. This is used for customs when shipping\ninternationally.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "internationalDomains", + "description": "Whether a shop can enable international domains.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "internationalPriceOverrides", + "description": "Whether a shop can enable international price overrides.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "internationalPriceRules", + "description": "Whether a shop can enable international price rules.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacySubscriptionGatewayEnabled", + "description": "Whether a shop has enabled a legacy subscription gateway to handle older subscriptions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "liveView", + "description": "Whether to show the Live View metrics in the Shopify admin. Live view is hidden from merchants that are on a trial\nor don't have a storefront.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiLocation", + "description": "Whether a shop has multi-location functionality.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "All shops support multi-location inventory. Use `QueryRoot.locations` to determine whether shop has more than one location.\n" + }, + { + "name": "onboardingVisual", + "description": "Whether a shop has access to the onboarding visual.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paypalExpressSubscriptionGatewayStatus", + "description": "Whether a shop is configured to sell subscriptions with PayPal Express.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaypalExpressSubscriptionsGatewayStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reports", + "description": "Whether a shop has access to all reporting features.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellsSubscriptions", + "description": "Whether a shop has ever had subscription products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPlus", + "description": "Whether the shop has a Shopify Plus subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use Shop.plan.shopifyPlus instead." + }, + { + "name": "showMetrics", + "description": "Whether to show metrics in the Shopify admin. Metrics are hidden for new merchants until they become meaningful.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefront", + "description": "Whether a shop has an online store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usingShopifyBalance", + "description": "Whether a shop is using Shopify Balance.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopLocale", + "description": "A locale that's been enabled on a shop.", + "fields": [ + { + "name": "locale", + "description": "The locale ISO code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "marketWebPresences", + "description": "The market web presences that use the locale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MarketWebPresence", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The human-readable locale name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "primary", + "description": "Whether the locale is the default locale for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "published", + "description": "Whether the locale is visible to buyers.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopLocaleDisablePayload", + "description": "Return type for `shopLocaleDisable` mutation.", + "fields": [ + { + "name": "locale", + "description": "ISO code of the locale that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopLocaleEnablePayload", + "description": "Return type for `shopLocaleEnable` mutation.", + "fields": [ + { + "name": "shopLocale", + "description": "ISO code of the locale that was enabled.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopLocale", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShopLocaleInput", + "description": "The input fields for a shop locale.\n", + "fields": null, + "inputFields": [ + { + "name": "published", + "description": "Whether the locale is published. Only published locales are visible to the buyer.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketWebPresenceIds", + "description": "The market web presences on which the locale should be enabled. Pass in an empty array to remove the locale across all market web presences.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopLocaleUpdatePayload", + "description": "Return type for `shopLocaleUpdate` mutation.", + "fields": [ + { + "name": "shopLocale", + "description": "The locale that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopLocale", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPlan", + "description": "The billing plan of the shop.\n", + "fields": [ + { + "name": "displayName", + "description": "The name of the shop's billing plan.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerDevelopment", + "description": "Whether the shop is a partner development shop for testing purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPlus", + "description": "Whether the shop has a Shopify Plus subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "description": "Policy that a merchant has configured for their store, such as their refund or privacy policy.", + "fields": [ + { + "name": "body", + "description": "The text of the policy. The maximum size is 512kb.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "The translations associated with the resource.", + "args": [ + { + "name": "locale", + "description": "Filters translations locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The shop policy type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopPolicyType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The public URL of the policy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasPublishedTranslations", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopPolicyErrorCode", + "description": "Possible error codes that can be returned by `ShopPolicyUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TOO_BIG", + "description": "The input value is too big.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShopPolicyInput", + "description": "The input fields required to update a policy.", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "The shop policy type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopPolicyType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "body", + "description": "Policy text, maximum size of 512kb.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopPolicyType", + "description": "Available shop policy types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "REFUND_POLICY", + "description": "The refund policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_POLICY", + "description": "The shipping policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRIVACY_POLICY", + "description": "The privacy policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TERMS_OF_SERVICE", + "description": "The terms of service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TERMS_OF_SALE", + "description": "The terms of sale.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEGAL_NOTICE", + "description": "The legal notice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_POLICY", + "description": "The purchase options cancellation policy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTACT_INFORMATION", + "description": "The contact information.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicyUpdatePayload", + "description": "Return type for `shopPolicyUpdate` mutation.", + "fields": [ + { + "name": "shopPolicy", + "description": "The shop policy that has been updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopPolicyUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicyUserError", + "description": "An error that occurs during the execution of a shop policy mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ShopPolicyErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopResourceFeedbackCreatePayload", + "description": "Return type for `shopResourceFeedbackCreate` mutation.", + "fields": [ + { + "name": "feedback", + "description": "The shop feedback that's created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AppFeedback", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopResourceFeedbackCreateUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopResourceFeedbackCreateUserError", + "description": "An error that occurs during the execution of `ShopResourceFeedbackCreate`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ShopResourceFeedbackCreateUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopResourceFeedbackCreateUserErrorCode", + "description": "Possible error codes that can be returned by `ShopResourceFeedbackCreateUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OUTDATED_FEEDBACK", + "description": "The feedback for a later version of the resource was already accepted.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopResourceLimits", + "description": "Resource limits of a shop.", + "fields": [ + { + "name": "locationLimit", + "description": "Maximum number of locations allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxProductOptions", + "description": "Maximum number of product options allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxProductVariants", + "description": "The maximum number of variants allowed per product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectLimitReached", + "description": "Whether the shop has reached the limit of the number of URL redirects it can make for resources.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "skuResourceLimits", + "description": "The maximum number of variants allowed per shop. If the shop has unlimited SKUs, then the quantity used can't be retrieved.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ResourceLimit", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "This field is deprecated. After the 2023-10 version, we no longer set limits on number of SKUs per shop. Use `maxProductVariants` instead.\n" + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopTagSort", + "description": "Possible sort of tags.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALPHABETICAL", + "description": "Alphabetical sort.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POPULAR", + "description": "Popularity sort.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyFunction", + "description": "A Shopify Function.", + "fields": [ + { + "name": "apiType", + "description": "The API type of the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "apiVersion", + "description": "The API version of the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "app", + "description": "The app that owns the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "App", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appBridge", + "description": "The App Bridge information for the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FunctionsAppBridge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appKey", + "description": "The client ID of the app that owns the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the Shopify Function.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inputQuery", + "description": "The input query of the Shopify Function.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the Shopify Function.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "useCreationUi", + "description": "If the Shopify Function uses the creation UI in the Admin.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyFunctionConnection", + "description": "An auto-generated type for paginating through multiple ShopifyFunctions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunctionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ShopifyFunctionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyFunctionEdge", + "description": "An auto-generated type which holds one ShopifyFunction and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ShopifyFunctionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyFunction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsAccount", + "description": "Balance and payout information for a\n[Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments)\naccount. Balance includes all balances for the currencies supported by the shop.\nYou can also query for a list of payouts, where each payout includes the corresponding currencyCode field.\n", + "fields": [ + { + "name": "activated", + "description": "Whether the Shopify Payments setup is completed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "balance", + "description": "Current balances in all currencies for the account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bankAccounts", + "description": "All bank accounts configured for the Shopify Payments account.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "chargeStatementDescriptor", + "description": "The statement descriptor used for charges.\n\nThe statement descriptor appears on a customer's credit card or bank statement when they make a purchase.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `chargeStatementDescriptors` instead." + }, + { + "name": "chargeStatementDescriptors", + "description": "The statement descriptors used for charges.\n\nThese descriptors appear on a customer's credit card or bank statement when they make a purchase.\n", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "ShopifyPaymentsChargeStatementDescriptor", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The Shopify Payments account country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultCurrency", + "description": "The default payout currency for the Shopify Payments account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disputes", + "description": "All disputes related to the Shopify Payments account.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `id`\n - `initiated_at`\n - `status`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fraudSettings", + "description": "The fraud settings of the Shopify Payments account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsFraudSettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notificationSettings", + "description": "The notifications settings for the account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsNotificationSettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onboardable", + "description": "Whether the Shopify Payments account can be onboarded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payoutSchedule", + "description": "The payout schedule for the account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutSchedule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payoutStatementDescriptor", + "description": "The descriptor used for payouts.\n\nThe descriptor appears on a merchant's bank statement when they receive a payout.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payouts", + "description": "All current and previous payouts made between the account and the bank account.", + "args": [ + { + "name": "transactionType", + "description": "Filter the direction of the payout.", + "type": { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutTransactionType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "permittedVerificationDocuments", + "description": "The permitted documents for identity verification.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerificationDocument", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "verifications", + "description": "The verifications necessary for this account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerification", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccount", + "description": "A bank account that can receive payouts.\n", + "fields": [ + { + "name": "accountNumber", + "description": "The account number of the bank account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "accountNumberLastDigits", + "description": "The last digits of the account number (the rest is redacted).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bankName", + "description": "The name of the bank.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the bank.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date that the bank account was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "The currency of the bank account.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payouts", + "description": "All current and previous payouts made between the account and the bank account.", + "args": [ + { + "name": "transactionType", + "description": "Filter the direction of the payout.", + "type": { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutTransactionType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "routingNumber", + "description": "The routing number of the bank account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the bank account.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsBankAccountStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccountConnection", + "description": "An auto-generated type for paginating through multiple ShopifyPaymentsBankAccounts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccountEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ShopifyPaymentsBankAccountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccount", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccountEdge", + "description": "An auto-generated type which holds one ShopifyPaymentsBankAccount and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ShopifyPaymentsBankAccountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsBankAccountStatus", + "description": "The bank account status.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NEW", + "description": "A bank account that hasn't had any activity and that's not validated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VALIDATED", + "description": "It was determined that the bank account exists.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VERIFIED", + "description": "Bank account validation was successful.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERRORED", + "description": "A payout to the bank account failed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ShopifyPaymentsChargeStatementDescriptor", + "description": "The charge descriptors for a payments account.", + "fields": [ + { + "name": "default", + "description": "The default charge statement descriptor.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "The prefix of the statement descriptor.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDefaultChargeStatementDescriptor", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsJpChargeStatementDescriptor", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDefaultChargeStatementDescriptor", + "description": "The charge descriptors for a payments account.", + "fields": [ + { + "name": "default", + "description": "The default charge statement descriptor.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "The prefix of the statement descriptor.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShopifyPaymentsChargeStatementDescriptor", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "description": "A dispute occurs when a buyer questions the legitimacy of a charge with their financial institution.", + "fields": [ + { + "name": "amount", + "description": "The total amount disputed by the cardholder.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "evidenceDueBy", + "description": "The deadline for evidence submission.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "evidenceSentOn", + "description": "The date when evidence was sent. Returns null if evidence hasn't yet been sent.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "finalizedOn", + "description": "The date when this dispute was resolved. Returns null if the dispute isn't yet resolved.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "initiatedAt", + "description": "The date when this dispute was initiated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The order that contains the charge that's under dispute.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reasonDetails", + "description": "The reason of the dispute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeReasonDetails", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current state of the dispute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DisputeStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Indicates if this dispute is still in the inquiry phase or has turned into a chargeback.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DisputeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeConnection", + "description": "An auto-generated type for paginating through multiple ShopifyPaymentsDisputes.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ShopifyPaymentsDisputeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEdge", + "description": "An auto-generated type which holds one ShopifyPaymentsDispute and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ShopifyPaymentsDisputeEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeEvidence", + "description": "The evidence associated with the dispute.", + "fields": [ + { + "name": "accessActivityLog", + "description": "The activity logs associated with the dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAddress", + "description": "The billing address that's provided by the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancellationPolicyDisclosure", + "description": "The cancellation policy disclosure associated with the dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancellationPolicyFile", + "description": "The cancellation policy file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancellationRebuttal", + "description": "The cancellation rebuttal associated with the dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCommunicationFile", + "description": "The customer communication file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerEmailAddress", + "description": "The customer's email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerFirstName", + "description": "The customer's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerLastName", + "description": "The customer's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPurchaseIp", + "description": "The customer purchase ip for this dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dispute", + "description": "The dispute associated with the evidence.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDispute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disputeFileUploads", + "description": "The file uploads associated with the dispute evidence.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillments", + "description": "The fulfillments associated with the dispute evidence.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFulfillment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productDescription", + "description": "The product description for this dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundPolicyDisclosure", + "description": "The refund policy disclosure associated with the dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundPolicyFile", + "description": "The refund policy file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundRefusalExplanation", + "description": "The refund refusal explanation associated with dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serviceDocumentationFile", + "description": "The service documentation file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The mailing address for shipping that's provided by the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDocumentationFile", + "description": "The shipping documentation file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "submitted", + "description": "Whether the dispute evidence is submitted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uncategorizedFile", + "description": "The uncategorized file associated with the dispute evidence.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uncategorizedText", + "description": "The uncategorized text for the dispute evidence.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsDisputeEvidenceFileType", + "description": "The possible dispute evidence file types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER_COMMUNICATION_FILE", + "description": "Customer Communication File.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUND_POLICY_FILE", + "description": "Refund Policy File.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLATION_POLICY_FILE", + "description": "Cancellation Policy File.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNCATEGORIZED_FILE", + "description": "Uncategorized File.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_DOCUMENTATION_FILE", + "description": "Shipping Documentation File.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SERVICE_DOCUMENTATION_FILE", + "description": "Service Documentation File.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeEvidenceUpdateInput", + "description": "The input fields required to update a dispute evidence object.", + "fields": null, + "inputFields": [ + { + "name": "customerEmailAddress", + "description": "Customer email address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerLastName", + "description": "Customer last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerFirstName", + "description": "Customer first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingAddress", + "description": "The shipping address associated with the dispute evidence.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uncategorizedText", + "description": "Uncategorized text.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "accessActivityLog", + "description": "Activity logs.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cancellationPolicyDisclosure", + "description": "Cancellation policy disclosure.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cancellationRebuttal", + "description": "Cancellation rebuttal.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundPolicyDisclosure", + "description": "Refund policy disclosure.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundRefusalExplanation", + "description": "Refund refusal explanation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cancellationPolicyFile", + "description": "Cancellation policy file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerCommunicationFile", + "description": "Customer communication file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "refundPolicyFile", + "description": "Refund policy file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingDocumentationFile", + "description": "Shipping documentation file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "uncategorizedFile", + "description": "Uncategorized file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "serviceDocumentationFile", + "description": "Service documentation file.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "submitEvidence", + "description": "Whether to submit the evidence.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFileUpload", + "description": "The file upload associated with the dispute evidence.", + "fields": [ + { + "name": "disputeEvidenceType", + "description": "The type of the file for the dispute evidence.", + "args": [], + "type": { + "kind": "ENUM", + "name": "ShopifyPaymentsDisputeEvidenceFileType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileSize", + "description": "The file size.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileType", + "description": "The file type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalFileName", + "description": "The original file name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL for accessing the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShopifyPaymentsDisputeFileUploadUpdateInput", + "description": "The input fields required to update a dispute file upload object.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the file upload to be updated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "destroy", + "description": "Whether to delete this file upload.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeFulfillment", + "description": "The fulfillment associated with dispute evidence.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingCarrier", + "description": "The shipping carrier for this fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDate", + "description": "The shipping date for this fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Date", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingTrackingNumber", + "description": "The shipping tracking number for this fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsDisputeReason", + "description": "The reason for the dispute provided by the cardholder's bank.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FRAUDULENT", + "description": "The cardholder claims that they didn’t authorize the payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GENERAL", + "description": "The dispute is uncategorized, so you should contact the customer for additional details to find out why the payment was disputed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNRECOGNIZED", + "description": "The customer doesn’t recognize the payment appearing on their card statement.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE", + "description": "The customer claims they were charged multiple times for the same product or service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_CANCELLED", + "description": "The customer claims that you continued to charge them after a subscription was canceled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_UNACCEPTABLE", + "description": "The product or service was received but was defective, damaged, or not as described.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_NOT_RECEIVED", + "description": "The customer claims they did not receive the products or services purchased.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREDIT_NOT_PROCESSED", + "description": "The customer claims that the purchased product was returned or the transaction was otherwise canceled, but you haven't yet provided a refund or credit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCORRECT_ACCOUNT_DETAILS", + "description": "The customer account associated with the purchase is incorrect.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INSUFFICIENT_FUNDS", + "description": "The customer's bank account has insufficient funds.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BANK_CANNOT_PROCESS", + "description": "The customer's bank can't process the charge.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DEBIT_NOT_AUTHORIZED", + "description": "The customer's bank can't proceed with the debit since it hasn't been authorized.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_INITIATED", + "description": "The customer initiated the dispute. Contact the customer for additional details on why the payment was disputed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsDisputeReasonDetails", + "description": "Details regarding a dispute reason.", + "fields": [ + { + "name": "networkReasonCode", + "description": "The raw code provided by the payment network.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reason", + "description": "The reason for the dispute provided by the cardholder's banks.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsDisputeReason", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsExtendedAuthorization", + "description": "Presents all Shopify Payments information related to an extended authorization.", + "fields": [ + { + "name": "extendedAuthorizationExpiresAt", + "description": "The time after which the extended authorization expires. After the expiry, the merchant is unable to capture the payment.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "standardAuthorizationExpiresAt", + "description": "The time after which capture will incur an additional fee.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsFraudSettings", + "description": "The fraud settings of a payments account.", + "fields": [ + { + "name": "declineChargeOnAvsFailure", + "description": "Decline a charge if there's an AVS failure.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "declineChargeOnCvcFailure", + "description": "Decline a charge if there's an CVC failure.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsJpChargeStatementDescriptor", + "description": "The charge descriptors for a Japanese payments account.", + "fields": [ + { + "name": "default", + "description": "The default charge statement descriptor.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kana", + "description": "The charge statement descriptor in kana.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kanji", + "description": "The charge statement descriptor in kanji.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prefix", + "description": "The prefix of the statement descriptor.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShopifyPaymentsChargeStatementDescriptor", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsNotificationSettings", + "description": "The notification settings for the account.", + "fields": [ + { + "name": "payouts", + "description": "Receive email notifications when new payouts are sent or payouts fail.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayout", + "description": "Payouts represent the movement of money between a merchant's Shopify\nPayments balance and their bank account.\n", + "fields": [ + { + "name": "bankAccount", + "description": "The bank account for the payout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsBankAccount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gross", + "description": "The total amount and currency of the payout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `net` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "issuedAt", + "description": "The exact time when the payout was issued. The payout only contains\nbalance transactions that were available at this time.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "net", + "description": "The total amount and currency of the payout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The transfer status of the payout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "summary", + "description": "The summary of the payout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutSummary", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactionType", + "description": "The direction of the payout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutTransactionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutConnection", + "description": "An auto-generated type for paginating through multiple ShopifyPaymentsPayouts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ShopifyPaymentsPayoutEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayout", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutEdge", + "description": "An auto-generated type which holds one ShopifyPaymentsPayout and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ShopifyPaymentsPayoutEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayout", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutInterval", + "description": "The interval at which payouts are sent to the connected bank account.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DAILY", + "description": "Each business day.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEEKLY", + "description": "Each week, on the day of week specified by weeklyAnchor.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MONTHLY", + "description": "Each month, on the day of month specified by monthlyAnchor.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "Payouts will not be automatically made.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutSchedule", + "description": "The payment schedule for a payments account.", + "fields": [ + { + "name": "interval", + "description": "The interval at which payouts are sent to the connected bank account.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "monthlyAnchor", + "description": "The day of the month funds will be paid out.\n\nThe value can be any day of the month from the 1st to the 31st.\nIf the payment interval is set to monthly, this value will be used.\nPayouts scheduled between 29-31st of the month are sent on the last day of shorter months.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weeklyAnchor", + "description": "The day of the week funds will be paid out.\n\nThe value can be any weekday from Monday to Friday.\nIf the payment interval is set to weekly, this value will be used.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "DayOfTheWeek", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutStatus", + "description": "The transfer status of the payout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SCHEDULED", + "description": "The payout has been created and had transactions assigned to it, but\nit has not yet been submitted to the bank.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_TRANSIT", + "description": "The payout has been submitted to the bank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAID", + "description": "The payout has been successfully deposited into the bank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "The payout has been declined by the bank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELED", + "description": "The payout has been canceled by Shopify.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsPayoutSummary", + "description": "Breakdown of the total fees and gross of each of the different types of transactions associated\nwith the payout.\n", + "fields": [ + { + "name": "adjustmentsFee", + "description": "Total fees for all adjustments including disputes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adjustmentsGross", + "description": "Total gross amount for all adjustments including disputes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "chargesFee", + "description": "Total fees for all charges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "chargesGross", + "description": "Total gross amount for all charges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundsFee", + "description": "Total fees for all refunds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundsFeeGross", + "description": "Total gross amount for all refunds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reservedFundsFee", + "description": "Total fees for all reserved funds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reservedFundsGross", + "description": "Total gross amount for all reserved funds.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "retriedPayoutsFee", + "description": "Total fees for all retried payouts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "retriedPayoutsGross", + "description": "Total gross amount for all retried payouts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsPayoutTransactionType", + "description": "The possible transaction types for a payout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEPOSIT", + "description": "The payout is a deposit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WITHDRAWAL", + "description": "The payout is a withdrawal.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsRefundSet", + "description": "Presents all Shopify Payments specific information related to an order refund.", + "fields": [ + { + "name": "acquirerReferenceNumber", + "description": "The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsTransactionSet", + "description": "Presents all Shopify Payments specific information related to an order transaction.", + "fields": [ + { + "name": "extendedAuthorizationSet", + "description": "Contains all fields related to an extended authorization.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsExtendedAuthorization", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundSet", + "description": "Contains all fields related to a refund.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopifyPaymentsRefundSet", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerification", + "description": "Each subject (individual) of an account has a verification object giving\n information about the verification state.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the verification.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsVerificationStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subject", + "description": "The subject/individual who has to be verified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerificationSubject", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerificationDocument", + "description": "A document which can be used to verify an individual.", + "fields": [ + { + "name": "backRequired", + "description": "True if the back side of the document is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "frontRequired", + "description": "True if the front side of the document is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the document which can be used for verification.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShopifyPaymentsVerificationDocumentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsVerificationDocumentType", + "description": "The types of possible verification documents.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DRIVERS_LICENSE", + "description": "The subject's driver's license.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GOVERNMENT_IDENTIFICATION", + "description": "A government's identification document of the subject.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PASSPORT", + "description": "The subject's passport.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ShopifyPaymentsVerificationStatus", + "description": "The status of a verification.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VERIFIED", + "description": "The verification has been verified.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNVERIFIED", + "description": "The verification has not yet been verified.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING", + "description": "The verification request has been submitted but a response has not yet been given.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopifyPaymentsVerificationSubject", + "description": "The verification subject represents an individual that has to be verified.", + "fields": [ + { + "name": "familyName", + "description": "The family name of the individual to verify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "givenName", + "description": "The given name of the individual to verify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "ShopifyqlResponse", + "description": "A response to a ShopifyQL query.", + "fields": [ + { + "name": "parseErrors", + "description": "A list of parse errors, if parsing fails.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ParseError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tableData", + "description": "The result in a tabular format with schema and row data.\n To be used as a raw 2-dimensional response of the query.\n It's always present even if query has a `VISUALIZE` keyword.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "TableData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "PolarisVizResponse", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "TableResponse", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "StaffMember", + "description": "Represents the data about a staff member's Shopify account. Merchants can use staff member data to get more information about the staff members in their store.\n", + "fields": [ + { + "name": "active", + "description": "Whether the staff member is active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "avatar", + "description": "The image used as the staff member's avatar in the Shopify admin.", + "args": [ + { + "name": "fallback", + "description": "The default image returned if the staff member has no avatar.", + "type": { + "kind": "ENUM", + "name": "StaffMemberDefaultImage", + "ofType": null + }, + "defaultValue": "DEFAULT" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The staff member's email address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "exists", + "description": "Whether the staff member's account exists.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The staff member's first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "initials", + "description": "The staff member's initials, if available.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isShopOwner", + "description": "Whether the staff member is the shop owner.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The staff member's last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "The staff member's preferred locale. Locale values use the format `language` or `language-COUNTRY`, where `language` is a two-letter language code, and `COUNTRY` is a two-letter country code. For example: `en` or `en-US`", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The staff member's full name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The staff member's phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateData", + "description": "The data used to customize the Shopify admin experience for the staff member.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMemberPrivateData", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StaffMemberConnection", + "description": "An auto-generated type for paginating through multiple StaffMembers.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMemberEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in StaffMemberEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StaffMemberDefaultImage", + "description": "Represents the fallback avatar image for a staff member. This is used only if the staff member has no avatar image.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEFAULT", + "description": "Returns a default avatar image for the staff member.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRANSPARENT", + "description": "Returns a transparent avatar image for the staff member.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "Returns a URL that returns a 404 error if the image is not present.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StaffMemberEdge", + "description": "An auto-generated type which holds one StaffMember and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StaffMemberEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StaffMemberPermission", + "description": "Represents access permissions for a staff member.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLICATIONS", + "description": "The staff member can manage and install apps and channels.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHANNELS", + "description": "The staff member can manage and install sales channels.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS", + "description": "The staff member can view, create, update, and delete customers, and respond to customer messages in the Shopify Messaging API.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DASHBOARD", + "description": "The staff member can view the Shopify Home page, which includes sales information and other shop data.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOMAINS", + "description": "The staff member can view, buy, and manage domains.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT_ORDERS", + "description": "The staff member can create, update, and delete draft orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EDIT_ORDERS", + "description": "The staff member can update orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULL", + "description": "The staff has the same permissions as the [store owner](https://shopify.dev/en/manual/your-account/staff-accounts/staff-permissions#store-owner-permissions) with some exceptions, such as modifying the account billing or deleting staff accounts.", + "isDeprecated": true, + "deprecationReason": "Use the list of the staff member's explicit permissions returned in the `StaffMember.permissions.userPermissions` field instead of `full` permission." + }, + { + "name": "GIFT_CARDS", + "description": "The staff member can view, create, issue, and export gift cards to a CSV file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LINKS", + "description": "The staff member can view and modify links and navigation menus.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS", + "description": "The staff member can create, update, and delete locations where inventory is stocked or managed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETING", + "description": "The staff member can view and create discount codes and automatic discounts, and export discounts to a CSV file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETING_SECTION", + "description": "The staff member can view, create, and automate marketing campaigns.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS", + "description": "The staff member can view, create, update, delete, and cancel orders, and receive order notifications. The staff member can still create draft orders without this permission.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OVERVIEWS", + "description": "The staff member can view the Overview and Live view pages, which include sales information, and other shop and sales channels data.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAGES", + "description": "The staff member can view, create, update, publish, and delete blog posts and pages.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAY_ORDERS_BY_VAULTED_CARD", + "description": "The staff member can pay for an order by using a vaulted card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PREFERENCES", + "description": "The staff member can view the preferences and configuration of a shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTS", + "description": "The staff member can view, create, import, and update products, collections, and inventory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REPORTS", + "description": "The staff member can view and create all reports, which includes sales information and other shop data.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THEMES", + "description": "The staff member can view, update, and publish themes.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRANSLATIONS", + "description": "The staff member can view and create translations.", + "isDeprecated": true, + "deprecationReason": "Unused." + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StaffMemberPrivateData", + "description": "Represents the data used to customize the Shopify admin experience for a logged-in staff member.", + "fields": [ + { + "name": "accountSettingsUrl", + "description": "The URL to the staff member's account settings page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the staff member was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "permissions", + "description": "Access permissions for the staff member.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "StaffMemberPermission", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use StaffMember.permissions.userPermissions instead" + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StageImageInput", + "description": "An image to be uploaded.\n\nDeprecated in favor of\n[StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput),\nwhich is used by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", + "fields": null, + "inputFields": [ + { + "name": "resource", + "description": "The image resource.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "StagedUploadTargetGenerateUploadResource", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "The image filename.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mimeType", + "description": "The image MIME type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "httpMethod", + "description": "HTTP method to be used by the staged upload.", + "type": { + "kind": "ENUM", + "name": "StagedUploadHttpMethodType", + "ofType": null + }, + "defaultValue": "PUT" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedMediaUploadTarget", + "description": "Information about a staged upload target, which should be used to send a request to upload\nthe file.\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", + "fields": [ + { + "name": "parameters", + "description": "Parameters needed to authenticate a request to upload the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StagedUploadParameter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourceUrl", + "description": "The URL to be passed as `originalSource` in\n[CreateMediaInput](https://shopify.dev/api/admin-graphql/latest/input-objects/CreateMediaInput)\nand [FileCreateInput](https://shopify.dev/api/admin-graphql/2022-04/input-objects/FileCreateInput)\nfor the [productCreateMedia](https://shopify.dev/api/admin-graphql/2022-04/mutations/productCreateMedia)\nand [fileCreate](https://shopify.dev/api/admin-graphql/2022-04/mutations/fileCreate)\nmutations.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL to use when sending an request to upload the file. Should be used in conjunction with\nthe parameters field.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StagedUploadHttpMethodType", + "description": "The possible HTTP methods that can be used when sending a request to upload a file using information from a\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "POST", + "description": "The POST HTTP method.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUT", + "description": "The PUT HTTP method.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StagedUploadInput", + "description": "The input fields for generating staged upload targets.", + "fields": null, + "inputFields": [ + { + "name": "resource", + "description": "The file's intended Shopify resource type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "StagedUploadTargetGenerateUploadResource", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "The file's name and extension.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mimeType", + "description": "The file's MIME type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "httpMethod", + "description": "The HTTP method to be used when sending a request to upload the file using the returned staged\nupload target.\n", + "type": { + "kind": "ENUM", + "name": "StagedUploadHttpMethodType", + "ofType": null + }, + "defaultValue": "PUT" + }, + { + "name": "fileSize", + "description": "The size of the file to upload, in bytes. This is required when the request's resource property is set to\n[VIDEO](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-video)\nor [MODEL_3D](https://shopify.dev/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#value-model3d).\n", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedUploadParameter", + "description": "The parameters required to authenticate a file upload request using a\n[StagedMediaUploadTarget's url field](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-stagedmediauploadtarget-url).\n\nFor more information on the upload process, refer to\n[Upload media to Shopify](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).\n", + "fields": [ + { + "name": "name", + "description": "The parameter's name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The parameter's value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedUploadTarget", + "description": "Information about the staged target.\n\nDeprecated in favor of\n[StagedMediaUploadTarget](https://shopify.dev/api/admin-graphql/latest/objects/StagedMediaUploadTarget),\nwhich is returned by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", + "fields": [ + { + "name": "parameters", + "description": "The parameters of an image to be uploaded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageUploadParameter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The image URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StagedUploadTargetGenerateInput", + "description": "The required fields and parameters to generate the URL upload an\"\nasset to Shopify.\n\nDeprecated in favor of\n[StagedUploadInput](https://shopify.dev/api/admin-graphql/latest/objects/StagedUploadInput),\nwhich is used by the\n[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stagedUploadsCreate).\n", + "fields": null, + "inputFields": [ + { + "name": "resource", + "description": "The resource type being uploaded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "StagedUploadTargetGenerateUploadResource", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "filename", + "description": "The filename of the asset being uploaded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "mimeType", + "description": "The MIME type of the asset being uploaded.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "httpMethod", + "description": "The HTTP method to be used by the staged upload.", + "type": { + "kind": "ENUM", + "name": "StagedUploadHttpMethodType", + "ofType": null + }, + "defaultValue": "PUT" + }, + { + "name": "fileSize", + "description": "The size of the file to upload, in bytes.", + "type": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedUploadTargetGeneratePayload", + "description": "Return type for `stagedUploadTargetGenerate` mutation.", + "fields": [ + { + "name": "parameters", + "description": "The signed parameters that can be used to upload the asset.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MutationsStagedUploadTargetGenerateUploadParameter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The signed URL where the asset can be uploaded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StagedUploadTargetGenerateUploadResource", + "description": "The resource type to receive.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COLLECTION_IMAGE", + "description": "An image associated with a collection.\n\nFor example, after uploading an image, you can use the\n[collectionUpdate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/collectionUpdate)\nto add the image to a collection.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILE", + "description": "Represents any file other than HTML.\n\nFor example, after uploading the file, you can add the file to the\n[Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "An image.\n\nFor example, after uploading an image, you can add the image to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia)\nor to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL_3D", + "description": "A Shopify hosted 3d model.\n\nFor example, after uploading the 3d model, you can add the 3d model to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_IMAGE", + "description": "An image that's associated with a product.\n\nFor example, after uploading the image, you can add the image to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_IMAGE", + "description": "An image.\n\nFor example, after uploading the image, you can add the image to the\n[Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO", + "description": "A Shopify-hosted video.\n\nFor example, after uploading the video, you can add the video to a product using the\n[productCreateMedia mutation](https://shopify.dev/api/admin-graphql/latest/mutations/productCreateMedia)\nor to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin using the\n[fileCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/fileCreate).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BULK_MUTATION_VARIABLES", + "description": "Represents bulk mutation variables.\n\nFor example, bulk mutation variables can be used for bulk operations using the\n[bulkOperationRunMutation mutation](https://shopify.dev/api/admin-graphql/latest/mutations/bulkOperationRunMutation).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURN_LABEL", + "description": "Represents a label associated with a return.\n\nFor example, once uploaded, this resource can be used to [create a\nReverseDelivery](https://shopify.dev/api/admin-graphql/unstable/mutations/reverseDeliveryCreateWithShipping).\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "URL_REDIRECT_IMPORT", + "description": "Represents a redirect CSV file.\n\nExample usage: This resource can be used for creating a\n[UrlRedirectImport](https://shopify.dev/api/admin-graphql/2022-04/objects/UrlRedirectImport)\nobject for use in the\n[urlRedirectImportCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate).\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedUploadTargetsGeneratePayload", + "description": "Return type for `stagedUploadTargetsGenerate` mutation.", + "fields": [ + { + "name": "urls", + "description": "The staged upload targets that were generated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StagedUploadTarget", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StagedUploadsCreatePayload", + "description": "Return type for `stagedUploadsCreate` mutation.", + "fields": [ + { + "name": "stagedTargets", + "description": "The staged upload targets that were generated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StagedMediaUploadTarget", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionEnablePayload", + "description": "Return type for `standardMetafieldDefinitionEnable` mutation.", + "fields": [ + { + "name": "createdDefinition", + "description": "The metafield definition that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetafieldDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionEnableUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionEnableUserError", + "description": "An error that occurs during the execution of `StandardMetafieldDefinitionEnable`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "StandardMetafieldDefinitionEnableUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "StandardMetafieldDefinitionEnableUserErrorCode", + "description": "Possible error codes that can be returned by `StandardMetafieldDefinitionEnableUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEMPLATE_NOT_FOUND", + "description": "The standard metafield definition template was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIMIT_EXCEEDED", + "description": "The maximum number of definitions per owner type has been exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNSTRUCTURED_ALREADY_EXISTS", + "description": "The namespace and key is already in use for a set of your metafields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TYPE_NOT_ALLOWED_FOR_CONDITIONS", + "description": "The definition type is not eligible to be used as collection condition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplate", + "description": "Standard metafield definition templates provide preset configurations to create metafield definitions.\nEach template has a specific namespace and key that we've reserved to have specific meanings for common use cases.\n\nRefer to the [list of standard metafield definitions](https://shopify.dev/apps/metafields/definitions/standard-definitions).\n", + "fields": [ + { + "name": "description", + "description": "The description of the standard metafield definition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The key owned by the definition after the definition has been activated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The human-readable name for the standard metafield definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The namespace owned by the definition after the definition has been activated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ownerTypes", + "description": "The list of resource types that the standard metafield definition can be applied to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MetafieldOwnerType", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The associated [metafield definition type](https://shopify.dev/apps/metafields/definitions/types) that the metafield stores.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validations", + "description": "The configured validations for the standard metafield definition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDefinitionValidation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "visibleToStorefrontApi", + "description": "Whether metafields for the definition are by default visible using the Storefront API.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplateConnection", + "description": "An auto-generated type for paginating through multiple StandardMetafieldDefinitionTemplates.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplateEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in StandardMetafieldDefinitionTemplateEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplate", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplateEdge", + "description": "An auto-generated type which holds one StandardMetafieldDefinitionTemplate and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StandardMetafieldDefinitionTemplateEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StandardMetafieldDefinitionTemplate", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardMetaobjectDefinitionEnablePayload", + "description": "Return type for `standardMetaobjectDefinitionEnable` mutation.", + "fields": [ + { + "name": "metaobjectDefinition", + "description": "The metaobject definition that was enabled using the standard template.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MetaobjectDefinition", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StandardizedProductType", + "description": "Represents the details of a specific type of product within the [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt).", + "fields": [ + { + "name": "productTaxonomyNode", + "description": "The product taxonomy node associated with the standardized product type.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductTaxonomyNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StandardizedProductTypeInput", + "description": "Provides the fields and values to use when adding a standard product type to a product. The [Shopify product taxonomy](https://help.shopify.com/txt/product_taxonomy/en.txt) contains the full list of available values.", + "fields": null, + "inputFields": [ + { + "name": "productTaxonomyNodeId", + "description": "The ID of the node in the Shopify taxonomy that represents the product type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessToken", + "description": "A token that's used to delegate unauthenticated access scopes to clients that need to access\nthe unauthenticated Storefront API. An app can have a maximum of 100 active storefront access\ntokens for each shop.\n", + "fields": [ + { + "name": "accessScopes", + "description": "List of permissions associated with the token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AccessScope", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "accessToken", + "description": "The issued public access token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the public access token was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "An arbitrary title for each token determined by the developer, used for reference purposes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the storefront access token was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessTokenConnection", + "description": "An auto-generated type for paginating through multiple StorefrontAccessTokens.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StorefrontAccessTokenEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in StorefrontAccessTokenEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StorefrontAccessToken", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessTokenCreatePayload", + "description": "Return type for `storefrontAccessTokenCreate` mutation.", + "fields": [ + { + "name": "shop", + "description": "The user's shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storefrontAccessToken", + "description": "The storefront access token.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StorefrontAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StorefrontAccessTokenDeleteInput", + "description": "The input fields to delete a storefront access token.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the storefront access token to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessTokenDeletePayload", + "description": "Return type for `storefrontAccessTokenDelete` mutation.", + "fields": [ + { + "name": "deletedStorefrontAccessTokenId", + "description": "The ID of the deleted storefront access token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StorefrontAccessTokenEdge", + "description": "An auto-generated type which holds one StorefrontAccessToken and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StorefrontAccessTokenEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StorefrontAccessToken", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StorefrontAccessTokenInput", + "description": "The input fields for a storefront access token.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "A title for the storefront access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "StorefrontID", + "description": "Represents a unique identifier in the Storefront API. A `StorefrontID` value can be used wherever an ID is expected in the Storefront API.\n\nExample value: `\"Z2lkOi8vc2hvcGlmeS9Qcm9kdWN0LzEwMDc5Nzg1MTAw\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "String", + "description": "Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StringConnection", + "description": "An auto-generated type for paginating through a list of Strings.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StringEdge", + "description": "An auto-generated type which holds one String and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StringEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionAppliedCodeDiscount", + "description": "Represents an applied code discount.", + "fields": [ + { + "name": "id", + "description": "The unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redeemCode", + "description": "The redeem code of the discount that applies on the subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rejectionReason", + "description": "The reason that the discount on the subscription draft is rejected.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionDiscountRejectionReason", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionAtomicLineInput", + "description": "The input fields for mapping a subscription line to a discount.", + "fields": null, + "inputFields": [ + { + "name": "line", + "description": "The new subscription line.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionLineInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discounts", + "description": "The discount to be added to the subscription line.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionAtomicManualDiscountInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionAtomicManualDiscountInput", + "description": "The input fields for mapping a subscription line to a discount.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title associated with the subscription discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Percentage or fixed amount value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurringCycleLimit", + "description": "The maximum number of times the subscription discount will be applied on orders.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "description": "A record of an execution of the subscription billing process. Billing attempts use\nidempotency keys to avoid duplicate order creation. A successful billing attempt\nwill create an order.\n", + "fields": [ + { + "name": "completedAt", + "description": "The date and time when the billing attempt was completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the billing attempt was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorCode", + "description": "A code corresponding to a payment error during processing.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingAttemptErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorMessage", + "description": "A message describing a payment error during processing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "idempotencyKey", + "description": "A unique key generated by the client to avoid duplicate payments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nextActionUrl", + "description": "The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The result of this billing attempt if completed successfully.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originTime", + "description": "The date and time used to calculate fulfillment intervals for a billing attempt that\nsuccessfully completed after the current anchor date. To prevent fulfillment from being\npushed to the next anchor date, this field can override the billing attempt date.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ready", + "description": "Whether the billing attempt is still processing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionContract", + "description": "The subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionBillingAttempts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionBillingAttemptEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptCreatePayload", + "description": "Return type for `subscriptionBillingAttemptCreate` mutation.", + "fields": [ + { + "name": "subscriptionBillingAttempt", + "description": "The subscription billing attempt.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BillingAttemptUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptEdge", + "description": "An auto-generated type which holds one SubscriptionBillingAttempt and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionBillingAttemptEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttempt", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingAttemptErrorCode", + "description": "The possible error codes associated with making billing attempts. The error codes supplement the\n`error_message` to provide consistent results and help with dunning management.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAYMENT_METHOD_NOT_FOUND", + "description": "Payment method was not found.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_PROVIDER_IS_NOT_ENABLED", + "description": "Payment provider is not enabled.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PAYMENT_METHOD", + "description": "Payment method is invalid. Please update or create a new payment method.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNEXPECTED_ERROR", + "description": "There was an unexpected error during the billing attempt.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED_PAYMENT_METHOD", + "description": "Payment method is expired.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_METHOD_DECLINED", + "description": "Payment method was declined by processor.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHENTICATION_ERROR", + "description": "There was an error during the authentication.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TEST_MODE", + "description": "Gateway is in test mode and attempted to bill a live payment method.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUYER_CANCELED_PAYMENT_METHOD", + "description": "Payment method was canceled by buyer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_NOT_FOUND", + "description": "Customer was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_INVALID", + "description": "Customer is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_SHIPPING_ADDRESS", + "description": "The shipping address is either missing or invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CUSTOMER_BILLING_AGREEMENT", + "description": "The billing agreement ID or the transaction ID for the customer's payment method is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVOICE_ALREADY_PAID", + "description": "A payment has already been made for this invoice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_METHOD_INCOMPATIBLE_WITH_GATEWAY_CONFIG", + "description": "Payment method cannot be used with the current payment gateway test mode configuration.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMOUNT_TOO_SMALL", + "description": "The amount is too small.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_ALLOCATIONS_NOT_FOUND", + "description": "No inventory location found or enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRANSIENT_ERROR", + "description": "Transient error, try again later.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingAttemptInput", + "description": "The input fields required to complete a subscription billing attempt.", + "fields": null, + "inputFields": [ + { + "name": "idempotencyKey", + "description": "A unique key generated by the client to avoid duplicate payments. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "originTime", + "description": "The date and time used to calculate fulfillment intervals for a billing attempt that\nsuccessfully completed after the current anchor date. To prevent fulfillment from being\npushed to the next anchor date, this field can override the billing attempt date.\n", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingCycleSelector", + "description": "Select the specific billing cycle to be billed.\nDefault to bill the current billing cycle if not specified.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleSelector", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingAttemptsSortKeys", + "description": "The set of valid sort keys for the SubscriptionBillingAttempts query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "description": "A subscription billing cycle.", + "fields": [ + { + "name": "billingAttemptExpectedDate", + "description": "The date on which the billing attempt is expected to be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAttempts", + "description": "The list of billing attempts associated with the billing cycle.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cycleEndAt", + "description": "The end date of the billing cycle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cycleIndex", + "description": "The index of the billing cycle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cycleStartAt", + "description": "The start date of the billing cycle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "edited", + "description": "Whether this billing cycle was edited.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editedContract", + "description": "The active edited contract for the billing cycle.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditedContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "skipped", + "description": "Whether this billing cycle was skipped.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sourceContract", + "description": "The subscription contract that the billing cycle belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the billing cycle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SubscriptionBillingCycleBillingCycleStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingCycleBillingCycleStatus", + "description": "The possible status values of a subscription billing cycle.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BILLED", + "description": "The billing cycle is billed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNBILLED", + "description": "The billing cycle hasn't been billed.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionBillingCycles.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionBillingCycleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractDraftCommitPayload", + "description": "Return type for `subscriptionBillingCycleContractDraftCommit` mutation.", + "fields": [ + { + "name": "contract", + "description": "The committed Subscription Billing Cycle Edited Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditedContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractDraftConcatenatePayload", + "description": "Return type for `subscriptionBillingCycleContractDraftConcatenate` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleContractEditPayload", + "description": "Return type for `subscriptionBillingCycleContractEdit` mutation.", + "fields": [ + { + "name": "draft", + "description": "The draft subscription contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEdge", + "description": "An auto-generated type which holds one SubscriptionBillingCycle and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionBillingCycleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditDeletePayload", + "description": "Return type for `subscriptionBillingCycleEditDelete` mutation.", + "fields": [ + { + "name": "billingCycles", + "description": "The list of updated billing cycles.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditedContract", + "description": "Represents a subscription contract with billing cycles.", + "fields": [ + { + "name": "app", + "description": "The subscription app that the subscription contract is registered to.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appAdminUrl", + "description": "The URL of the subscription contract page on the subscription app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingCycles", + "description": "The billing cycles that the edited contract belongs to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesSortKeys", + "ofType": null + }, + "defaultValue": "CYCLE_INDEX" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the subscription contract was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency that's used for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes to be added to the generated orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer to whom the subscription contract belongs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethod", + "description": "The customer payment method that's used for the subscription contract.", + "args": [ + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethod", + "description": "The delivery method for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "UNION", + "name": "SubscriptionDeliveryMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPrice", + "description": "The delivery price for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The list of subscription discounts associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineCount", + "description": "The number of lines associated with the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "The list of subscription lines associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note field that will be applied to the generated orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "A list of the subscription contract's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the subscription contract was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "SubscriptionContractBase", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditsDeletePayload", + "description": "Return type for `subscriptionBillingCycleEditsDelete` mutation.", + "fields": [ + { + "name": "billingCycles", + "description": "The list of updated billing cycles.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingCycleErrorCode", + "description": "Possible error codes that can be returned by `SubscriptionBillingCycleUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_NOT_FOUND", + "description": "Can't find the billing cycle.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_CYCLE_EDITS", + "description": "There's no contract or schedule edit associated with the targeted billing cycle(s).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CYCLE_INDEX", + "description": "The index selector is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DATE", + "description": "The date selector is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMPTY_BILLING_CYCLE_EDIT_SCHEDULE_INPUT", + "description": "Billing cycle schedule edit input provided is empty. Must take in parameters to modify schedule.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_DATE_SET_ON_SKIPPED", + "description": "Billing date cannot be set on skipped billing cycle.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_BOUNDS", + "description": "Billing date of a cycle cannot be set to a value outside of its billing date range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", + "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_INDEX_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of index range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_START_DATE_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of start date range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCOMPLETE_BILLING_ATTEMPTS", + "description": "Billing cycle has incomplete billing attempts in progress.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleInput", + "description": "The input fields for specifying the subscription contract and selecting the associated billing cycle.\n", + "fields": null, + "inputFields": [ + { + "name": "contractId", + "description": "The ID of the subscription contract associated with the billing cycle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selector", + "description": "Selects the billing cycle by date or index.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleSelector", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleScheduleEditInput", + "description": "The input fields for parameters to modify the schedule of a specific billing cycle.", + "fields": null, + "inputFields": [ + { + "name": "skip", + "description": "Sets the skip status for the billing cycle.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingDate", + "description": "Sets the expected billing date for the billing cycle.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reason", + "description": "The reason for editing.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SubscriptionBillingCycleScheduleEditInputScheduleEditReason", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingCycleScheduleEditInputScheduleEditReason", + "description": "The input fields for possible reasons for editing the billing cycle's schedule.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BUYER_INITIATED", + "description": "Buyer initiated the schedule edit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANT_INITIATED", + "description": "Merchant initiated the schedule edit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DEV_INITIATED", + "description": "Developer initiated the schedule edit.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleScheduleEditPayload", + "description": "Return type for `subscriptionBillingCycleScheduleEdit` mutation.", + "fields": [ + { + "name": "billingCycle", + "description": "The updated billing cycle.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCycleSelector", + "description": "The input fields to select SubscriptionBillingCycle by either date or index.", + "fields": null, + "inputFields": [ + { + "name": "index", + "description": "Returns a billing cycle by index.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "date", + "description": "Returns a billing cycle by date.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleUserError", + "description": "The possible errors for a subscription billing cycle.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingCycleErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCyclesDateRangeSelector", + "description": "The input fields to select a subset of subscription billing cycles within a date range.", + "fields": null, + "inputFields": [ + { + "name": "startDate", + "description": "The start date and time for the range.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "endDate", + "description": "The end date and time for the range.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingCyclesIndexRangeSelector", + "description": "The input fields to select a subset of subscription billing cycles within an index range.", + "fields": null, + "inputFields": [ + { + "name": "startIndex", + "description": "The start index for the range.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "endIndex", + "description": "The end index for the range.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesSortKeys", + "description": "The set of valid sort keys for the SubscriptionBillingCycles query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CYCLE_INDEX", + "description": "Sort by the `cycle_index` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesTargetSelection", + "description": "Select subscription billing cycles to be targeted.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": "Target all current and upcoming subscription billing cycles.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionBillingPolicy", + "description": "Represents a Subscription Billing Policy.", + "fields": [ + { + "name": "anchors", + "description": "Specific anchor dates upon which the billing interval calculations should be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intervalCount", + "description": "The number of billing intervals between invoices.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxCycles", + "description": "Maximum amount of cycles after which the subscription ends.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minCycles", + "description": "Minimum amount of cycles required in the subscription.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingPolicyInput", + "description": "The input fields for a Subscription Billing Policy.", + "fields": null, + "inputFields": [ + { + "name": "interval", + "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "intervalCount", + "description": "The number of billing intervals between invoices.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "minCycles", + "description": "Minimum amount of cycles required in the subscription.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxCycles", + "description": "Maximum amount of cycles required in the subscription.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "anchors", + "description": "Specific anchor dates upon which the billing interval calculations should be made.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContract", + "description": "Represents a Subscription Contract.", + "fields": [ + { + "name": "app", + "description": "The subscription app that the subscription contract is registered to.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appAdminUrl", + "description": "The URL of the subscription contract page on the subscription app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingAttempts", + "description": "The list of billing attempts associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingAttemptConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingPolicy", + "description": "The billing policy associated with the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the subscription contract was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency that's used for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes to be added to the generated orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer to whom the subscription contract belongs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethod", + "description": "The customer payment method that's used for the subscription contract.", + "args": [ + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethod", + "description": "The delivery method for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "UNION", + "name": "SubscriptionDeliveryMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPolicy", + "description": "The delivery policy associated with the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDeliveryPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPrice", + "description": "The delivery price for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The list of subscription discounts associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastPaymentStatus", + "description": "The current status of the last payment.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionContractLastPaymentStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineCount", + "description": "The number of lines associated with the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "The list of subscription lines associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nextBillingDate", + "description": "The next billing date for the subscription contract.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note field that will be applied to the generated orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "A list of the subscription contract's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originOrder", + "description": "The order from which this contract originated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "revisionId", + "description": "The revision id of the contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The current status of the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SubscriptionContractSubscriptionStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the subscription contract was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "SubscriptionContractBase", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractAtomicCreateInput", + "description": "The input fields required to create a Subscription Contract.", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The ID of the customer to associate with the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "nextBillingDate", + "description": "The next billing date for the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currencyCode", + "description": "The currency used for the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "contract", + "description": "The attributes used as input for the Subscription Draft.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDraftInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lines", + "description": "A list of new Subscription Lines.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionAtomicLineInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "discountCodes", + "description": "A list of discount redeem codes to apply to the subscription contract.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractAtomicCreatePayload", + "description": "Return type for `subscriptionContractAtomicCreate` mutation.", + "fields": [ + { + "name": "contract", + "description": "The new Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "SubscriptionContractBase", + "description": "Represents subscription contract common fields.", + "fields": [ + { + "name": "app", + "description": "The subscription app that the subscription contract is registered to.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "App", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appAdminUrl", + "description": "The URL of the subscription contract page on the subscription app.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency that's used for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes to be added to the generated orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer to whom the subscription contract belongs.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethod", + "description": "The customer payment method that's used for the subscription contract.", + "args": [ + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethod", + "description": "The delivery method for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "UNION", + "name": "SubscriptionDeliveryMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPrice", + "description": "The delivery price for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The list of subscription discounts associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineCount", + "description": "The number of lines associated with the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "The list of subscription lines associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note field that will be applied to the generated orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "A list of the subscription contract's orders.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the subscription contract was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleEditedContract", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionContracts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContractEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionContractEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractCreateInput", + "description": "The input fields required to create a Subscription Contract.", + "fields": null, + "inputFields": [ + { + "name": "customerId", + "description": "The ID of the customer to associate with the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "nextBillingDate", + "description": "The next billing date for the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currencyCode", + "description": "The currency used for the subscription contract.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "contract", + "description": "The attributes used as input for the Subscription Draft.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDraftInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractCreatePayload", + "description": "Return type for `subscriptionContractCreate` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractEdge", + "description": "An auto-generated type which holds one SubscriptionContract and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionContractEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionContractErrorCode", + "description": "Possible error codes that can be returned by `SubscriptionContractUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionContractLastPaymentStatus", + "description": "The possible status values of the last payment on a subscription contract.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUCCEEDED", + "description": "Successful subscription billing attempt.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "Failed subscription billing attempt.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionContractProductChangeInput", + "description": "The input fields required to create a Subscription Contract.", + "fields": null, + "inputFields": [ + { + "name": "productVariantId", + "description": "The ID of the product variant the subscription line refers to.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "currentPrice", + "description": "The price of the product.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractProductChangePayload", + "description": "Return type for `subscriptionContractProductChange` mutation.", + "fields": [ + { + "name": "contract", + "description": "The new Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineUpdated", + "description": "The updated Subscription Line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractSetNextBillingDatePayload", + "description": "Return type for `subscriptionContractSetNextBillingDate` mutation.", + "fields": [ + { + "name": "contract", + "description": "The updated Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionContractUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionContractSubscriptionStatus", + "description": "The possible status values of a subscription.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACTIVE", + "description": "The contract is active and continuing per its policies.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAUSED", + "description": "The contract is temporarily paused and is expected to resume in the future.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "The contract was ended by an unplanned customer action.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "The contract has ended per the expected circumstances. All billing and deliverycycles of the subscriptions were executed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILED", + "description": "The contract ended because billing failed and no further billing attempts are expected.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STALE", + "description": "The contract has expired due to inactivity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractUpdatePayload", + "description": "Return type for `subscriptionContractUpdate` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionContractUserError", + "description": "Represents a Subscription Contract error.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionContractErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionCyclePriceAdjustment", + "description": "Represents a Subscription Line Pricing Cycle Adjustment.", + "fields": [ + { + "name": "adjustmentType", + "description": "Price adjustment type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "adjustmentValue", + "description": "Price adjustment value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPricingPolicyAdjustmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "afterCycle", + "description": "The number of cycles required before this pricing policy applies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "computedPrice", + "description": "The computed price after the adjustments applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SubscriptionDeliveryMethod", + "description": "Describes the delivery method to use to get the physical goods to the customer.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodLocalDelivery", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodPickup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodShipping", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodInput", + "description": "Specifies delivery method fields for a subscription draft.\nThis is an input union: one, and only one, field can be provided.\nThe field provided will determine which delivery method is to be used.\n", + "fields": null, + "inputFields": [ + { + "name": "shipping", + "description": "The input fields for the shipping delivery method.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodShippingInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "localDelivery", + "description": "The input fields for the local delivery method.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pickup", + "description": "The input fields for the pickup delivery method.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodPickupInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodLocalDelivery", + "description": "A local delivery method, which includes a mailing address and a local delivery option.", + "fields": [ + { + "name": "address", + "description": "The address to deliver to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionMailingAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localDeliveryOption", + "description": "The details of the local delivery method to use.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryInput", + "description": "The input fields for a local delivery method.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "The address to deliver to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "localDeliveryOption", + "description": "The details of the local delivery method to use.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryOptionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryOption", + "description": "The selected delivery option on a subscription contract.", + "fields": [ + { + "name": "code", + "description": "A custom reference to the delivery method for use with automations.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The details displayed to the customer to describe the local delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "instructions", + "description": "The delivery instructions that the customer can provide to the merchant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number that the customer provided to the merchant.\nFormatted using E.164 standard. For example, `+16135551111`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the local delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the local delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodLocalDeliveryOptionInput", + "description": "The input fields for local delivery option.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title of the local delivery option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the local delivery option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The details displayed to the customer to describe the local delivery option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "A custom reference to the delivery method for use with automations.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number that the customer must provide to the merchant.\nFormatted using E.164 standard. For example, `+16135551111`.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "instructions", + "description": "The delivery instructions that the customer can provide to the merchant.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodPickup", + "description": "A delivery method with a pickup option.", + "fields": [ + { + "name": "pickupOption", + "description": "The details of the pickup delivery method to use.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodPickupOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodPickupInput", + "description": "The input fields for a pickup delivery method.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", + "fields": null, + "inputFields": [ + { + "name": "pickupOption", + "description": "The details of the pickup method to use.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodPickupOptionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodPickupOption", + "description": "Represents the selected pickup option on a subscription contract.", + "fields": [ + { + "name": "code", + "description": "A custom reference to the delivery method for use with automations.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The details displayed to the customer to describe the pickup option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location where the customer will pickup the merchandise.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the pickup option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the pickup option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodPickupOptionInput", + "description": "The input fields for pickup option.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title of the pickup option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the pickup option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The details displayed to the customer to describe the pickup option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "A custom reference to the delivery method for use with automations.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "locationId", + "description": "The ID of the pickup location.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodShipping", + "description": "Represents a shipping delivery method: a mailing address and a shipping option.", + "fields": [ + { + "name": "address", + "description": "The address to ship to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionMailingAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingOption", + "description": "The details of the shipping method to use.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodShippingOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodShippingInput", + "description": "Specifies shipping delivery method fields.\n\nThis input accepts partial input. When a field is not provided,\nits prior value is left unchanged.\n", + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "The address to ship to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingOption", + "description": "The details of the shipping method to use.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodShippingOptionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryMethodShippingOption", + "description": "Represents the selected shipping option on a subscription contract.", + "fields": [ + { + "name": "carrierService", + "description": "The carrier service that's providing this shipping option.\nThis field isn't currently supported and returns null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This field has never been implemented." + }, + { + "name": "code", + "description": "The code of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodShippingOptionInput", + "description": "The input fields for shipping option.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title of the shipping option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the shipping option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description of the shipping option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "code", + "description": "The code of the shipping option.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "carrierServiceId", + "description": "The carrier service ID of the shipping option.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SubscriptionDeliveryOption", + "description": "The delivery option for a subscription contract.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionLocalDeliveryOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionPickupOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionShippingOption", + "ofType": null + } + ] + }, + { + "kind": "UNION", + "name": "SubscriptionDeliveryOptionResult", + "description": "The result of the query to fetch delivery options for the subscription contract.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryOptionResultFailure", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryOptionResultSuccess", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryOptionResultFailure", + "description": "A failure to find the available delivery options for a subscription contract.", + "fields": [ + { + "name": "message", + "description": "The reason for the failure.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryOptionResultSuccess", + "description": "The delivery option for a subscription contract.", + "fields": [ + { + "name": "deliveryOptions", + "description": "The available delivery options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SubscriptionDeliveryOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDeliveryPolicy", + "description": "Represents a Subscription Delivery Policy.", + "fields": [ + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAnchor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interval", + "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "intervalCount", + "description": "The number of delivery intervals between deliveries.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryPolicyInput", + "description": "The input fields for a Subscription Delivery Policy.", + "fields": null, + "inputFields": [ + { + "name": "interval", + "description": "The kind of interval that's associated with this schedule (e.g. Monthly, Weekly, etc).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanInterval", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "intervalCount", + "description": "The number of billing intervals between invoices.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "anchors", + "description": "The specific anchor dates upon which the delivery interval calculations should be made.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanAnchorInput", + "ofType": null + } + } + }, + "defaultValue": "[]" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SubscriptionDiscount", + "description": "Subscription draft discount types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionAppliedCodeDiscount", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountAllocation", + "description": "Represents what a particular discount reduces from a line price.", + "fields": [ + { + "name": "amount", + "description": "Allocation amount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Discount that created the allocation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SubscriptionDiscount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionDiscounts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionDiscountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SubscriptionDiscount", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountEdge", + "description": "An auto-generated type which holds one SubscriptionDiscount and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionDiscountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SubscriptionDiscount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountEntitledLines", + "description": "Represents the subscription lines the discount applies on.", + "fields": [ + { + "name": "all", + "description": "Specify whether the subscription discount will apply on all subscription lines.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "The list of subscription lines associated with the subscription discount.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountFixedAmountValue", + "description": "The value of the discount and how it will be applied.", + "fields": [ + { + "name": "amount", + "description": "The fixed amount value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "appliesOnEachItem", + "description": "Whether the amount is applied per item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountPercentageValue", + "description": "The percentage value of the discount.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionDiscountRejectionReason", + "description": "The reason a discount on a subscription draft was rejected.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_FOUND", + "description": "Discount code is not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_ENTITLED_LINE_ITEMS", + "description": "Discount does not apply to any of the given line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QUANTITY_NOT_IN_RANGE", + "description": "Quantity of items does not qualify for the discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PURCHASE_NOT_IN_RANGE", + "description": "Purchase amount of items does not qualify for the discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_NOT_ELIGIBLE", + "description": "Given customer does not qualify for the discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "USAGE_LIMIT_REACHED", + "description": "Discount usage limit has been reached.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_USAGE_LIMIT_REACHED", + "description": "Customer usage limit has been reached.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CURRENTLY_INACTIVE", + "description": "Discount is inactive.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_ENTITLED_SHIPPING_LINES", + "description": "No applicable shipping lines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCOMPATIBLE_PURCHASE_TYPE", + "description": "Purchase type does not qualify for the discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNAL_ERROR", + "description": "Internal error during discount code validation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SubscriptionDiscountValue", + "description": "The value of the discount and how it will be applied.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionDiscountFixedAmountValue", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDiscountPercentageValue", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "description": "Represents a Subscription Draft.", + "fields": [ + { + "name": "billingCycle", + "description": "The billing cycle that the subscription contract will be associated with.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycle", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "billingPolicy", + "description": "The billing policy for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "concatenatedBillingCycles", + "description": "The billing cycles of the contracts that will be concatenated to the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SubscriptionBillingCyclesSortKeys", + "ofType": null + }, + "defaultValue": "CYCLE_INDEX" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionBillingCycleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency used for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes to be added to the generated orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer to whom the subscription contract belongs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPaymentMethod", + "description": "The customer payment method used for the subscription contract.", + "args": [ + { + "name": "showRevoked", + "description": "Whether to show the customer's revoked payment method.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethod", + "description": "The delivery method for each billing of the subscription contract.", + "args": [], + "type": { + "kind": "UNION", + "name": "SubscriptionDeliveryMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryOptions", + "description": "The available delivery options for a given delivery address. Returns `null` for pending requests.\n", + "args": [ + { + "name": "deliveryAddress", + "description": "The address to deliver the subscription contract to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "UNION", + "name": "SubscriptionDeliveryOptionResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPolicy", + "description": "The delivery policy for the subscription contract.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDeliveryPolicy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryPrice", + "description": "The delivery price for each billing the subscription contract.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounts", + "description": "The list of subscription discounts which will be associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountsAdded", + "description": "The list of subscription discounts to be added to the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountsRemoved", + "description": "The list of subscription discounts to be removed from the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountsUpdated", + "description": "The list of subscription discounts to be updated on the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "The list of subscription lines which will be associated with the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linesAdded", + "description": "The list of subscription lines to be added to the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "linesRemoved", + "description": "The list of subscription lines to be removed from the subscription contract.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nextBillingDate", + "description": "The next billing date for the subscription contract.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note field that will be applied to the generated orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalContract", + "description": "The original subscription contract.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingOptions", + "description": "Available Shipping Options for a given delivery address. Returns NULL for pending requests.\n", + "args": [ + { + "name": "deliveryAddress", + "description": "The address to delivery the subscription contract to.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "UNION", + "name": "SubscriptionShippingOptionResult", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `deliveryOptions` instead." + }, + { + "name": "status", + "description": "The current status of the subscription contract.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionContractSubscriptionStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftCommitPayload", + "description": "Return type for `subscriptionDraftCommit` mutation.", + "fields": [ + { + "name": "contract", + "description": "The updated Subscription Contract object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionContract", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountAddPayload", + "description": "Return type for `subscriptionDraftDiscountAdd` mutation.", + "fields": [ + { + "name": "discountAdded", + "description": "The added Subscription Discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountCodeApplyPayload", + "description": "Return type for `subscriptionDraftDiscountCodeApply` mutation.", + "fields": [ + { + "name": "appliedDiscount", + "description": "The added subscription discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionAppliedCodeDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The subscription contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountRemovePayload", + "description": "Return type for `subscriptionDraftDiscountRemove` mutation.", + "fields": [ + { + "name": "discountRemoved", + "description": "The removed subscription draft discount.", + "args": [], + "type": { + "kind": "UNION", + "name": "SubscriptionDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The subscription contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftDiscountUpdatePayload", + "description": "Return type for `subscriptionDraftDiscountUpdate` mutation.", + "fields": [ + { + "name": "discountUpdated", + "description": "The updated Subscription Discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubscriptionDraftErrorCode", + "description": "Possible error codes that can be returned by `SubscriptionDraftUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALREADY_REMOVED", + "description": "This line has already been removed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENCE", + "description": "Input value is not present.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMMITTED", + "description": "Subscription draft has been already committed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_IN_RANGE", + "description": "Value is not in range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_AN_INTEGER", + "description": "The value is not an integer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_MAX_CYCLES_MUST_BE_GREATER_THAN_MIN_CYCLES", + "description": "The maximum number of cycles must be greater than the minimum.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_MUST_BE_MULTIPLE_OF_BILLING", + "description": "The delivery policy interval must be a multiple of the billing policy interval.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_BILLING_DATE", + "description": "Next billing date is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_NOTE_LENGTH", + "description": "Note length is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LINES", + "description": "Must have at least one line.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_ENTITLED_LINES", + "description": "Discount must have at least one entitled line.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_DOES_NOT_EXIST", + "description": "The customer doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_MISMATCH", + "description": "The payment method customer must be the same as the contract customer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_METHOD_REQUIRED", + "description": "The delivery method can't be blank if any lines require shipping.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_LOCAL_DELIVERY_OPTIONS", + "description": "The local delivery options must be set for local delivery.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_DISCOUNTS_UNIQUE_AFTER_CYCLE", + "description": "The after cycle attribute must be unique between cycle discounts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ADJUSTMENT_TYPE", + "description": "The adjustment value must the same type as the adjustment type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_ADJUSTMENT_VALUE", + "description": "The adjustment value must be either fixed_value or percentage.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STALE_CONTRACT", + "description": "Another operation updated the contract concurrently as the commit was in progress.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CURRENCY_NOT_ENABLED", + "description": "Currency is not enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HAS_FUTURE_EDITS", + "description": "Cannot update a subscription contract with a current or upcoming billing cycle contract edit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_CYCLE_PRESENT", + "description": "Cannot commit a billing cycle contract draft with this mutation. Please use SubscriptionBillingCycleContractDraftCommit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_CYCLE_ABSENT", + "description": "Cannot commit a contract draft with this mutation. Please use SubscriptionDraftCommit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_CYCLE_CONTRACT_DRAFT_DELIVERY_POLICY_INVALID", + "description": "Delivery policy cannot be updated for billing cycle contract drafts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BILLING_CYCLE_CONTRACT_DRAFT_BILLING_POLICY_INVALID", + "description": "Billing policy cannot be updated for billing cycle contract drafts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONCATENATION_BILLING_CYCLE_CONTRACT_DRAFT_REQUIRED", + "description": "Contract draft must be a billing cycle contract draft for contract concatenation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DUPLICATE_CONCATENATED_CONTRACTS", + "description": "Concatenated contracts cannot contain duplicate subscription contracts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPCOMING_CYCLE_LIMIT_EXCEEDED", + "description": "Billing cycle selector cannot select upcoming billing cycle past limit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_INDEX_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of index range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_START_DATE_OUT_OF_RANGE", + "description": "Billing cycle selector cannot select billing cycle outside of start date range.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CYCLE_SELECTOR_VALIDATE_ONE_OF", + "description": "Billing cycle selector requires exactly one of index or date to be provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXCEEDED_MAX_CONCATENATED_CONTRACTS", + "description": "Maximum number of concatenated contracts on a billing cycle contract draft exceeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN", + "description": "The input value should be greater than the minimum allowed value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftFreeShippingDiscountAddPayload", + "description": "Return type for `subscriptionDraftFreeShippingDiscountAdd` mutation.", + "fields": [ + { + "name": "discountAdded", + "description": "The added subscription free shipping discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The subscription contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftFreeShippingDiscountUpdatePayload", + "description": "Return type for `subscriptionDraftFreeShippingDiscountUpdate` mutation.", + "fields": [ + { + "name": "discountUpdated", + "description": "The updated Subscription Discount.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDraftInput", + "description": "The input fields required to create a Subscription Draft.", + "fields": null, + "inputFields": [ + { + "name": "status", + "description": "The current status of the subscription contract.", + "type": { + "kind": "ENUM", + "name": "SubscriptionContractSubscriptionStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentMethodId", + "description": "The ID of the payment method to be used for the subscription contract.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "nextBillingDate", + "description": "The next billing date for the subscription contract.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "billingPolicy", + "description": "The billing policy for the subscription contract.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionBillingPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryPolicy", + "description": "The delivery policy for the subscription contract.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryPolicyInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryPrice", + "description": "The shipping price for each renewal the subscription contract.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryMethod", + "description": "The delivery method for the subscription contract.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionDeliveryMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The note field that will be applied to the generated orders.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes added to the subscription contract.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftLineAddPayload", + "description": "Return type for `subscriptionDraftLineAdd` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineAdded", + "description": "The added Subscription Line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftLineRemovePayload", + "description": "Return type for `subscriptionDraftLineRemove` mutation.", + "fields": [ + { + "name": "discountsUpdated", + "description": "The list of updated subscription discounts impacted by the removed line.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineRemoved", + "description": "The removed Subscription Line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftLineUpdatePayload", + "description": "Return type for `subscriptionDraftLineUpdate` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Contract draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineUpdated", + "description": "The updated Subscription Line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftUpdatePayload", + "description": "Return type for `subscriptionDraftUpdate` mutation.", + "fields": [ + { + "name": "draft", + "description": "The Subscription Draft object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionDraft", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionDraftUserError", + "description": "Represents a Subscription Draft error.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionDraftErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionFreeShippingDiscountInput", + "description": "The input fields for a subscription free shipping discount on a contract.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title associated with the subscription free shipping discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurringCycleLimit", + "description": "The maximum number of times the subscription free shipping discount will be applied on orders.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionLine", + "description": "Represents a Subscription Line.", + "fields": [ + { + "name": "currentPrice", + "description": "The price per unit for the subscription line in the contract's currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "List of custom attributes associated to the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "Discount allocations.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineDiscountedPrice", + "description": "Total line price including all discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pricingPolicy", + "description": "Describe the price changes of the line over time.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SubscriptionPricingPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "The product ID associated with the subscription line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the unit selected for the subscription line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether physical shipping is required for the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanId", + "description": "The selling plan ID associated to the line.\n\nIndicates which selling plan was used to create this\ncontract line initially. The selling plan ID is also used to\nfind the associated delivery profile.\n\nThe subscription contract, subscription line, or selling plan might have\nchanged. As a result, the selling plan's attributes might not\nmatch the information on the contract.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanName", + "description": "The selling plan name associated to the line. This name describes\nthe order line items created from this subscription line\nfor both merchants and customers.\n\nThe value can be different from the selling plan's name, because both\nthe selling plan's name and the subscription line's selling_plan_name\nattribute can be updated independently.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "Variant SKU number of the item associated with the subscription line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxable", + "description": "Whether the variant is taxable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Product title of the item associated with the subscription line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantId", + "description": "The product variant ID associated with the subscription line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantImage", + "description": "The image associated with the line item's variant or product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantTitle", + "description": "Product variant title of the item associated with the subscription line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionLineConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionLines.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLineEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionLineEdge", + "description": "An auto-generated type which holds one SubscriptionLine and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionLine", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionLineInput", + "description": "The input fields required to add a new subscription line to a contract.", + "fields": null, + "inputFields": [ + { + "name": "productVariantId", + "description": "The ID of the product variant the subscription line refers to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currentPrice", + "description": "The price of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "The custom attributes for this subscription line.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanId", + "description": "The selling plan for the subscription line.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sellingPlanName", + "description": "The selling plan name for the subscription line.\n\nDefaults to using the selling plan's current name when not specified.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pricingPolicy", + "description": "Describes expected price changes of the subscription line over time.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionPricingPolicyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionLineUpdateInput", + "description": "The input fields required to update a subscription line on a contract.", + "fields": null, + "inputFields": [ + { + "name": "productVariantId", + "description": "The ID of the product variant the subscription line refers to.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the product.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sellingPlanId", + "description": "The selling plan for the subscription line.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sellingPlanName", + "description": "The selling plan name for the subscription line.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "currentPrice", + "description": "The price of the product.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "The custom attributes for this subscription line.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "pricingPolicy", + "description": "Describes expected price changes of the subscription line over time.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionPricingPolicyInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionLocalDeliveryOption", + "description": "A local delivery option for a subscription contract.", + "fields": [ + { + "name": "code", + "description": "The code of the local delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the local delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneRequired", + "description": "Whether a phone number is required for the local delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the local delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the local delivery option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the local delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionMailingAddress", + "description": "Represents a Mailing Address on a Subscription.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The name of the customer's company or organization.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name of the customer, based on firstName and lastName.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer. Formatted using E.164 standard. For example, _+16135551111_.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\n\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "description": "Custom subscription discount.", + "fields": [ + { + "name": "entitledLines", + "description": "Entitled line items used to apply the subscription discount on.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionDiscountEntitledLines", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringCycleLimit", + "description": "The maximum number of times the subscription discount will be applied on orders.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rejectionReason", + "description": "The reason that the discount on the subscription draft is rejected.", + "args": [], + "type": { + "kind": "ENUM", + "name": "SubscriptionDiscountRejectionReason", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "Type of line the discount applies on.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title associated with the subscription discount.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the subscription discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "usageCount", + "description": "The number of times the discount was applied.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the subscription discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SubscriptionDiscountValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountConnection", + "description": "An auto-generated type for paginating through multiple SubscriptionManualDiscounts.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SubscriptionManualDiscountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionManualDiscountEdge", + "description": "An auto-generated type which holds one SubscriptionManualDiscount and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SubscriptionManualDiscountEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionManualDiscount", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountEntitledLinesInput", + "description": "The input fields for the subscription lines the discount applies on.", + "fields": null, + "inputFields": [ + { + "name": "all", + "description": "Specify whether the subscription discount will apply on all subscription lines.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lines", + "description": "The ID of the lines to add to or remove from the subscription discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountLinesInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountFixedAmountInput", + "description": "The input fields for the fixed amount value of the discount and distribution on the lines.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "Fixed amount value.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "appliesOnEachItem", + "description": "Whether the amount is intended per line item or once per subscription.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountInput", + "description": "The input fields for a subscription discount on a contract.", + "fields": null, + "inputFields": [ + { + "name": "title", + "description": "The title associated with the subscription discount.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Percentage or fixed amount value of the discount.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountValueInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recurringCycleLimit", + "description": "The maximum number of times the subscription discount will be applied on orders.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "entitledLines", + "description": "Entitled line items used to apply the subscription discount on.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountEntitledLinesInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountLinesInput", + "description": "The input fields for line items that the discount refers to.", + "fields": null, + "inputFields": [ + { + "name": "add", + "description": "The ID of the lines to add to the subscription discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "remove", + "description": "The ID of the lines to remove from the subscription discount.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountValueInput", + "description": "The input fields for the discount value and its distribution.", + "fields": null, + "inputFields": [ + { + "name": "percentage", + "description": "The percentage value of the discount. Value must be between 0 - 100.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fixedAmount", + "description": "Fixed amount input in the currency defined by the subscription.", + "type": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionManualDiscountFixedAmountInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionPickupOption", + "description": "A pickup option to deliver a subscription contract.", + "fields": [ + { + "name": "code", + "description": "The code of the pickup option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the pickup option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The pickup location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneRequired", + "description": "Whether a phone number is required for the pickup option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickupTime", + "description": "The estimated amount of time it takes for the pickup to be ready. For example, \"Usually ready in 24 hours\".).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the pickup option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the pickup option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the pickup option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionPricingPolicy", + "description": "Represents a Subscription Line Pricing Policy.", + "fields": [ + { + "name": "basePrice", + "description": "The base price per unit for the subscription line in the contract's currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cycleDiscounts", + "description": "The adjustments per cycle for the subscription line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionCyclePriceAdjustment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionPricingPolicyCycleDiscountsInput", + "description": "The input fields for an array containing all pricing changes for each billing cycle.", + "fields": null, + "inputFields": [ + { + "name": "afterCycle", + "description": "The cycle after which the pricing policy applies.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "adjustmentType", + "description": "The price adjustment type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanPricingPolicyAdjustmentType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "adjustmentValue", + "description": "The price adjustment value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SellingPlanPricingPolicyValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "computedPrice", + "description": "The computed price after the adjustments are applied.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SubscriptionPricingPolicyInput", + "description": "The input fields for expected price changes of the subscription line over time.", + "fields": null, + "inputFields": [ + { + "name": "basePrice", + "description": "The base price per unit for the subscription line in the contract's currency.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cycleDiscounts", + "description": "An array containing all pricing changes for each billing cycle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SubscriptionPricingPolicyCycleDiscountsInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionShippingOption", + "description": "A shipping option to deliver a subscription contract.", + "fields": [ + { + "name": "carrierService", + "description": "The carrier service that's providing this shipping option.\nThis field isn't currently supported and returns null.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryCarrierService", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "This field has never been implemented." + }, + { + "name": "code", + "description": "The code of the shipping option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneRequired", + "description": "If a phone number is required for the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentTitle", + "description": "The presentment title of the shipping option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the shipping option.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the shipping option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SubscriptionShippingOptionResult", + "description": "The result of the query to fetch shipping options for the subscription contract.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubscriptionShippingOptionResultFailure", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionShippingOptionResultSuccess", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SubscriptionShippingOptionResultFailure", + "description": "Failure determining available shipping options for delivery of a subscription contract.", + "fields": [ + { + "name": "message", + "description": "Failure reason.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionShippingOptionResultSuccess", + "description": "A shipping option for delivery of a subscription contract.", + "fields": [ + { + "name": "shippingOptions", + "description": "Available shipping options.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionShippingOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SuggestedOrderTransaction", + "description": "A suggested transaction. Suggested transaction are usually used in the context of refunds\nand exchanges.\n", + "fields": [ + { + "name": "accountNumber", + "description": "The masked account number associated with the payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amount", + "description": "The amount of the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountSet` instead." + }, + { + "name": "amountSet", + "description": "The amount and currency of the suggested order transaction in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedGateway", + "description": "The human-readable payment gateway name suggested to process the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gateway", + "description": "The suggested payment gateway used to process the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": "Specifies the kind of the suggested order transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SuggestedOrderTransactionKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumRefundable", + "description": "Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `maximumRefundableSet` instead." + }, + { + "name": "maximumRefundableSet", + "description": "Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentTransaction", + "description": "The associated parent transaction, for example the authorization of a capture.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderTransaction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SuggestedOrderTransactionKind", + "description": "Specifies the kind of the suggested order transaction.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SUGGESTED_REFUND", + "description": "A suggested refund transaction for an order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SuggestedRefund", + "description": "Represents a refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund.", + "fields": [ + { + "name": "amount", + "description": "The total monetary value to be refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountSet` instead." + }, + { + "name": "amountSet", + "description": "The total monetary value to be refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedSubtotalSet", + "description": "The sum of all the discounted prices of the line items being refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumRefundable", + "description": "The total monetary value available to refund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `maximumRefundableSet` instead." + }, + { + "name": "maximumRefundableSet", + "description": "The total monetary value available to refund in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundDuties", + "description": "A list of duties to be refunded from the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundDuty", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundLineItems", + "description": "A list of line items to be refunded, along with restock instructions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping", + "description": "The shipping costs to be refunded from the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingRefund", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The sum of all the prices of the line items being refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `subtotalSet` instead." + }, + { + "name": "subtotalSet", + "description": "The sum of all the prices of the line items being refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestedTransactions", + "description": "A list of suggested order transactions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SuggestedOrderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCartDiscountAmountSet", + "description": "The total cart discount amount that was applied to all line items in this refund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDutiesSet", + "description": "The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxSet", + "description": "The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxes", + "description": "The sum of the taxes being refunded from the order. The value must be positive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTaxSet` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SuggestedReturnRefund", + "description": "Represents a return refund suggested by Shopify based on the items being reimbursed. You can then use the suggested refund object to generate an actual refund for the return.", + "fields": [ + { + "name": "amount", + "description": "The total monetary value to be refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedSubtotal", + "description": "The sum of all the discounted prices of the line items being refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumRefundable", + "description": "The total monetary value available to refund in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundDuties", + "description": "A list of duties to be refunded from the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RefundDuty", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping", + "description": "The shipping costs to be refunded from the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingRefund", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The sum of all the prices of the line items being refunded in shop and presentment currencies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestedTransactions", + "description": "A list of suggested order transactions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SuggestedOrderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCartDiscountAmount", + "description": "The total cart discount amount that was applied to all line items in this refund.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDuties", + "description": "The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTax", + "description": "The sum of the taxes being refunded in shop and presentment currencies. The value must be positive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TableData", + "description": "The result in a tabular format with schema information and formatted and unformatted row data.", + "fields": [ + { + "name": "columns", + "description": "The data table columns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TableDataColumn", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rowData", + "description": "The formatted data values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unformattedData", + "description": "The unformatted data values.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TableDataColumn", + "description": "A nested array representation of the data. An index in an array represents a row number.", + "fields": [ + { + "name": "comparedTo", + "description": "For comparison columns, indicates the column to compare to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dataType", + "description": "The data type of the column value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The display name of the column in the data model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the column in the data model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TableResponse", + "description": "The default table response structure for a ShopifyQL query.", + "fields": [ + { + "name": "parseErrors", + "description": "A list of parse errors, if parsing fails.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ParseError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tableData", + "description": "The result in a tabular format with schema and row data.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "TableData", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "ShopifyqlResponse", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TagsAddPayload", + "description": "Return type for `tagsAdd` mutation.", + "fields": [ + { + "name": "node", + "description": "The object that was updated.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TagsRemovePayload", + "description": "Return type for `tagsRemove` mutation.", + "fields": [ + { + "name": "node", + "description": "The object that was updated.", + "args": [], + "type": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TaxAppConfiguration", + "description": "Tax app configuration of a merchant.", + "fields": [ + { + "name": "state", + "description": "State of the tax app configuration.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TaxPartnerState", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TaxAppConfigurePayload", + "description": "Return type for `taxAppConfigure` mutation.", + "fields": [ + { + "name": "taxAppConfiguration", + "description": "The updated tax app configuration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "TaxAppConfiguration", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TaxAppConfigureUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TaxAppConfigureUserError", + "description": "An error that occurs during the execution of `TaxAppConfigure`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "TaxAppConfigureUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TaxAppConfigureUserErrorCode", + "description": "Possible error codes that can be returned by `TaxAppConfigureUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "TAX_PARTNER_NOT_FOUND", + "description": "Unable to find the tax partner record.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_PARTNER_STATE_UPDATE_FAILED", + "description": "Unable to update tax partner state.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_PARTNER_ALREADY_ACTIVE", + "description": "Unable to update already active tax partner.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TaxExemption", + "description": "Available customer tax exemptions.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CA_STATUS_CARD_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid STATUS_CARD_EXEMPTION in Canada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_BC_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in British Columbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_MB_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Manitoba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_DIPLOMAT_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid DIPLOMAT_EXEMPTION in Canada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_BC_COMMERCIAL_FISHERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in British Columbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_MB_COMMERCIAL_FISHERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Manitoba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_NS_COMMERCIAL_FISHERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Nova Scotia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_PE_COMMERCIAL_FISHERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Prince Edward Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_COMMERCIAL_FISHERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid COMMERCIAL_FISHERY_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_BC_PRODUCTION_AND_MACHINERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in British Columbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_PRODUCTION_AND_MACHINERY_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid PRODUCTION_AND_MACHINERY_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_BC_SUB_CONTRACTOR_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in British Columbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_SUB_CONTRACTOR_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid SUB_CONTRACTOR_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_BC_CONTRACTOR_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in British Columbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_CONTRACTOR_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid CONTRACTOR_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_ON_PURCHASE_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid PURCHASE_EXEMPTION in Ontario.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_MB_FARMER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Manitoba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_NS_FARMER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Nova Scotia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA_SK_FARMER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid FARMER_EXEMPTION in Saskatchewan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EU_REVERSE_CHARGE_EXEMPTION_RULE", + "description": "This customer is exempt from VAT for purchases within the EU that is shipping from outside of customer's country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_AL_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alabama.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_AK_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Alaska.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_AZ_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arizona.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_AR_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Arkansas.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_CA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in California.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_CO_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Colorado.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_CT_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Connecticut.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_DE_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Delaware.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_FL_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Florida.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_GA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Georgia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_HI_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Hawaii.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_ID_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Idaho.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_IL_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Illinois.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_IN_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Indiana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_IA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Iowa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_KS_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kansas.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_KY_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Kentucky.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_LA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Louisiana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_ME_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maine.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MD_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Maryland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Massachusetts.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MI_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Michigan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MN_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Minnesota.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MS_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Mississippi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MO_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Missouri.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_MT_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Montana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NE_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nebraska.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NV_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Nevada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NH_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Hampshire.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NJ_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Jersey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NM_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New Mexico.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NY_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in New York.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_NC_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Carolina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_ND_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in North Dakota.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_OH_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Ohio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_OK_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oklahoma.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_OR_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Oregon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_PA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Pennsylvania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_RI_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Rhode Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_SC_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Carolina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_SD_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in South Dakota.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_TN_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Tennessee.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_TX_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Texas.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_UT_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Utah.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_VT_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Vermont.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_VA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Virginia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_WA_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_WV_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in West Virginia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_WI_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wisconsin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_WY_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Wyoming.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US_DC_RESELLER_EXEMPTION", + "description": "This customer is exempt from specific taxes for holding a valid RESELLER_EXEMPTION in Washington DC.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TaxLine", + "description": "Represents a single tax applied to the associated line item.", + "fields": [ + { + "name": "channelLiable", + "description": "Whether the channel that submitted the tax line is liable for remitting. A value of null indicates unknown liability for this tax line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The amount of tax, in shop currency, after discounts and before returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `priceSet` instead." + }, + { + "name": "priceSet", + "description": "The amount of tax, in shop and presentment currencies, after discounts and before returns.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rate", + "description": "The proportion of the line item price that the tax represents as a decimal.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ratePercentage", + "description": "The proportion of the line item price that the tax represents as a percentage.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The name of the tax.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TaxPartnerState", + "description": "State of the tax app configuration.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "App is not configured.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "READY", + "description": "App is configured, but not used for tax calculations.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ACTIVE", + "description": "App is configured and to be used for tax calculations.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TenderTransaction", + "description": "A TenderTransaction represents a transaction with financial impact on a shop's balance sheet. A tender transaction always\nrepresents actual money movement between a buyer and a shop. TenderTransactions can be used instead of OrderTransactions\nfor reconciling a shop's cash flow. A TenderTransaction is immutable once created.\n", + "fields": [ + { + "name": "amount", + "description": "The amount and currency of the tender transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentMethod", + "description": "Information about the payment method used for the transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedAt", + "description": "Date and time when the transaction was processed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remoteReference", + "description": "The remote gateway reference associated with the tender transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the transaction is a test transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transactionDetails", + "description": "Information about the payment instrument used for the transaction.", + "args": [], + "type": { + "kind": "UNION", + "name": "TenderTransactionDetails", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The staff member who performed the transaction.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "StaffMember", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TenderTransactionConnection", + "description": "An auto-generated type for paginating through multiple TenderTransactions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TenderTransactionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in TenderTransactionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TenderTransaction", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TenderTransactionCreditCardDetails", + "description": "Information about the credit card used for this transaction.", + "fields": [ + { + "name": "creditCardCompany", + "description": "The name of the company that issued the customer's credit card. Example: `Visa`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creditCardNumber", + "description": "The customer's credit card number, with all digits except the last 4 redacted. Example: `•••• •••• •••• 1234`", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "TenderTransactionDetails", + "description": "Information about the payment instrument used for this transaction.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "TenderTransactionCreditCardDetails", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "TenderTransactionEdge", + "description": "An auto-generated type which holds one TenderTransaction and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of TenderTransactionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TenderTransaction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TipSale", + "description": "A sale associated with a tip.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItem", + "description": "The line item for the associated sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TransactionFee", + "description": "Transaction fee related to an order transaction.", + "fields": [ + { + "name": "amount", + "description": "Amount of the fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "flatFee", + "description": "Flat rate charge for a transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "flatFeeName", + "description": "Name of the credit card flat fee.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rate", + "description": "Percentage charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rateName", + "description": "Name of the credit card rate.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxAmount", + "description": "Tax amount charged on the fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Name of the type of fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslatableContent", + "description": "Translatable content of a resource's field.", + "fields": [ + { + "name": "digest", + "description": "Hash digest representation of the content value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The resource field that's being translated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "Locale of the content.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Type of the translatable content.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LocalizableContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Content value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslatableResource", + "description": "A resource that has translatable fields.", + "fields": [ + { + "name": "resourceId", + "description": "GID of the resource.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translatableContent", + "description": "Translatable content.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableContent", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "translations", + "description": "Translatable content translations.", + "args": [ + { + "name": "locale", + "description": "Filters translations by locale.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "outdated", + "description": "Filters by outdated translations.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "Filters translations by market ID. Use this argument to retrieve content specific to a market.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslatableResourceConnection", + "description": "An auto-generated type for paginating through multiple TranslatableResources.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableResourceEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in TranslatableResourceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableResource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslatableResourceEdge", + "description": "An auto-generated type which holds one TranslatableResource and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of TranslatableResourceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslatableResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TranslatableResourceType", + "description": "Specifies the type of resources that are translatable.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COLLECTION", + "description": "A product collection. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_METHOD_DEFINITION", + "description": "The delivery method definition. For example, \"Standard\", or \"Expedited\".\n Translatable fields: `name`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMAIL_TEMPLATE", + "description": "An email template. Translatable fields: `title`, `body_html`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FILTER", + "description": "A filter. Translatable fields: `label`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LINK", + "description": "A link to direct users. Translatable fields: `title`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METAFIELD", + "description": "A Metafield. Translatable fields: `value`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METAOBJECT", + "description": "A Metaobject. Translatable fields are determined by the Metaobject type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_ARTICLE", + "description": "An online store article. Translatable fields: `title`, `body_html`, `summary_html`, `handle`, `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_BLOG", + "description": "An online store blog. Translatable fields: `title`, `handle`, `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_MENU", + "description": "A category of links. Translatable fields: `title`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_PAGE", + "description": "An online store page. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONLINE_STORE_THEME", + "description": "An online store theme. Translatable fields: `dynamic keys based on theme data`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PACKING_SLIP_TEMPLATE", + "description": "A packing slip template. Translatable fields: `body`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_GATEWAY", + "description": "A payment gateway. Translatable fields: `name`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "An online store product. Translatable fields: `title`, `body_html`, `handle`, `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_OPTION", + "description": "An online store custom product property name. For example, \"Size\", \"Color\", or \"Material\".\n Translatable fields: `name`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_VARIANT", + "description": "An online store product variant. Translatable fields: `title`, `option1`, `option2`, `option3`. The field `title` has been deprecated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN", + "description": "A selling plan. Translatable fields:`name`, `option1`, `option2`, `option3`, `description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_GROUP", + "description": "A selling plan group. Translatable fields: `name`, `option1`, `option2`, `option3`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP", + "description": "A shop. Translatable fields: `meta_title`, `meta_description`.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_POLICY", + "description": "A shop policy. Translatable fields: `body`.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Translation", + "description": "Translation of a field of a resource.", + "fields": [ + { + "name": "key", + "description": "On the resource that this translation belongs to, the reference to the value being translated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locale", + "description": "ISO code of the translation locale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market that the translation is specific to. Null value means the translation is available in all markets.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "outdated", + "description": "Whether the original content has changed since this translation was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the translation was updated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Translation value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TranslationErrorCode", + "description": "Possible error codes that can be returned by `TranslationUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_NOT_FOUND", + "description": "Resource does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_NOT_TRANSLATABLE", + "description": "Resource is not translatable.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_MANY_KEYS_FOR_RESOURCE", + "description": "Too many translation keys for the resource.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_KEY_FOR_MODEL", + "description": "Translation key is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILS_RESOURCE_VALIDATION", + "description": "Translation value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TRANSLATABLE_CONTENT", + "description": "Translatable content is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_MARKET_LOCALIZABLE_CONTENT", + "description": "Market localizable content is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LOCALE_FOR_SHOP", + "description": "Locale is invalid for the shop.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_CODE", + "description": "Locale language code is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_FORMAT", + "description": "Locale code format is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_CUSTOM_CONTENT_NOT_ALLOWED", + "description": "The shop isn't allowed to operate on market custom content.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_DOES_NOT_EXIST", + "description": "The market corresponding to the `marketId` argument doesn't exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKET_LOCALE_CREATION_FAILED", + "description": "The market override locale creation failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESOURCE_NOT_MARKET_CUSTOMIZABLE", + "description": "The specified resource can't be customized for a market.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_LOCALE_FOR_MARKET", + "description": "The locale is missing on the market corresponding to the `marketId` argument.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE_FOR_HANDLE_TRANSLATION", + "description": "The handle is already taken for this resource.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "TranslationInput", + "description": "The input fields and values for creating or updating a translation.", + "fields": null, + "inputFields": [ + { + "name": "locale", + "description": "ISO code of the locale being translated into. Only locales returned in `shopLocales` are valid.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "On the resource that this translation belongs to, the reference to the value being translated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the translation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "translatableContentDigest", + "description": "Hash digest representation of the content being translated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "marketId", + "description": "The ID of the market that the translation is specific to. Not specifying this field means that the translation will be available in all markets.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslationUserError", + "description": "Represents an error that happens during the execution of a translation mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "TranslationErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslationsRegisterPayload", + "description": "Return type for `translationsRegister` mutation.", + "fields": [ + { + "name": "translations", + "description": "The translations that were created or updated.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TranslationsRemovePayload", + "description": "Return type for `translationsRemove` mutation.", + "fields": [ + { + "name": "translations", + "description": "The translations that were deleted.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Translation", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "TranslationUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "TypedAttribute", + "description": "Represents a typed custom attribute.", + "fields": [ + { + "name": "key", + "description": "Key or name of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "URL", + "description": "Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\n\nFor example, `\"https://johns-apparel.myshopify.com\"` is a valid URL. It includes a scheme (`https`) and a host\n(`johns-apparel.myshopify.com`).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UTMInput", + "description": "Specifies the\n[Urchin Traffic Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters)\nthat are associated with a related marketing campaign.\n", + "fields": null, + "inputFields": [ + { + "name": "campaign", + "description": "The name of the UTM campaign.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "source", + "description": "The name of the website or application where the referral link exists.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "medium", + "description": "The UTM campaign medium.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UTMParameters", + "description": "Represents a set of UTM parameters.", + "fields": [ + { + "name": "campaign", + "description": "The name of a marketing campaign.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content", + "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "medium", + "description": "The medium of a marketing campaign, such as a banner or email newsletter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "source", + "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "term", + "description": "Paid search terms used by a marketing campaign.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UnitSystem", + "description": "Systems of weights and measures.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IMPERIAL_SYSTEM", + "description": "Imperial system of weights and measures.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METRIC_SYSTEM", + "description": "Metric system of weights and measures.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UnknownSale", + "description": "This is represents new sale types that have been added in future API versions. You may update to a more recent API version to receive additional details about this sale.", + "fields": [ + { + "name": "actionType", + "description": "The type of order action that the sale represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleActionType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineType", + "description": "The line type assocated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SaleLineType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of units either ordered or intended to be returned.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxes", + "description": "All individual taxes associated with the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SaleTax", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total sale amount after taxes and discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountAfterTaxes", + "description": "The total discounts allocated to the sale after taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDiscountAmountBeforeTaxes", + "description": "The total discounts allocated to the sale before taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The total amount of taxes for the sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyBag", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Sale", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "UnsignedInt64", + "description": "An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits.\n\nExample value: `\"50\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateMediaInput", + "description": "The input fields required to update a media object.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "Specifies the media to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "previewImageSource", + "description": "The source from which to update the media preview image. May be an external URL or staged upload URL.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "alt", + "description": "The alt text associated to the media.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirect", + "description": "The URL redirect for the online store.", + "fields": [ + { + "name": "id", + "description": "The ID of the URL redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "target", + "description": "The target location where the user will be redirected to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteAllPayload", + "description": "Return type for `urlRedirectBulkDeleteAll` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the redirects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteByIdsPayload", + "description": "Return type for `urlRedirectBulkDeleteByIds` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the redirects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteByIdsUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteByIdsUserError", + "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteByIds`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteByIdsUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteByIdsUserErrorCode", + "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteByIdsUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IDS_EMPTY", + "description": "You must pass one or more [`URLRedirect`](\n https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect\n ) object IDs.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySavedSearchPayload", + "description": "Return type for `urlRedirectBulkDeleteBySavedSearch` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the redirects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySavedSearchUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySavedSearchUserError", + "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteBySavedSearch`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteBySavedSearchUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteBySavedSearchUserErrorCode", + "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteBySavedSearchUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SAVED_SEARCH_NOT_FOUND", + "description": "Saved search not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_SAVED_SEARCH_QUERY", + "description": "The saved search's query cannot match all entries or be empty.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySearchPayload", + "description": "Return type for `urlRedirectBulkDeleteBySearch` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job removing the redirects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySearchUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectBulkDeleteBySearchUserError", + "description": "An error that occurs during the execution of `UrlRedirectBulkDeleteBySearch`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteBySearchUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectBulkDeleteBySearchUserErrorCode", + "description": "Possible error codes that can be returned by `UrlRedirectBulkDeleteBySearchUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID_SEARCH_ARGUMENT", + "description": "Invalid search string.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectConnection", + "description": "An auto-generated type for paginating through multiple UrlRedirects.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in UrlRedirectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectCreatePayload", + "description": "Return type for `urlRedirectCreate` mutation.", + "fields": [ + { + "name": "urlRedirect", + "description": "The created redirect.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectDeletePayload", + "description": "Return type for `urlRedirectDelete` mutation.", + "fields": [ + { + "name": "deletedUrlRedirectId", + "description": "The ID of the deleted redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectEdge", + "description": "An auto-generated type which holds one UrlRedirect and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of UrlRedirectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectErrorCode", + "description": "Possible error codes that can be returned by `UrlRedirectUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DOES_NOT_EXIST", + "description": "Redirect does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATE_FAILED", + "description": "Redirect could not be created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATE_FAILED", + "description": "Redirect could not be updated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELETE_FAILED", + "description": "Redirect could not be deleted.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImport", + "description": "A request to import a [`URLRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object\ninto the Online Store channel. Apps can use this to query the state of an `UrlRedirectImport` request.\n\nFor more information, see [`url-redirect`](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect)s.\n", + "fields": [ + { + "name": "count", + "description": "The number of rows in the file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdCount", + "description": "The number of redirects created from the import.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "failedCount", + "description": "The number of redirects that failed to be imported.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "finished", + "description": "Whether the import is finished.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "finishedAt", + "description": "The date and time when the import finished.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the `UrlRedirectImport` object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewRedirects", + "description": "A list of up to three previews of the URL redirects to be imported.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectImportPreview", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedCount", + "description": "The number of redirects updated during the import.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImportCreatePayload", + "description": "Return type for `urlRedirectImportCreate` mutation.", + "fields": [ + { + "name": "urlRedirectImport", + "description": "The created `URLRedirectImport` object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UrlRedirectImport", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectImportUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectImportErrorCode", + "description": "Possible error codes that can be returned by `UrlRedirectImportUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FILE_DOES_NOT_EXIST", + "description": "CSV file does not exist at given URL.", + "isDeprecated": true, + "deprecationReason": "This error code is never returned" + }, + { + "name": "NOT_FOUND", + "description": "URL redirect import not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_IMPORTED", + "description": "The import has already completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "The import is already in progress.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImportPreview", + "description": "A preview of a URL redirect import row.", + "fields": [ + { + "name": "path", + "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "target", + "description": "The target location where the user will be redirected to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImportSubmitPayload", + "description": "Return type for `urlRedirectImportSubmit` mutation.", + "fields": [ + { + "name": "job", + "description": "The asynchronous job importing the redirects.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectImportUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectImportUserError", + "description": "Represents an error that happens during execution of a redirect import mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRedirectImportErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UrlRedirectInput", + "description": "The input fields to create or update a URL redirect.", + "fields": null, + "inputFields": [ + { + "name": "path", + "description": "The old path to be redirected from. When the user visits this path, they will be redirected to the target location.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "target", + "description": "The target location where the user will be redirected to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UrlRedirectSortKeys", + "description": "The set of valid sort keys for the UrlRedirect query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PATH", + "description": "Sort by the `path` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectUpdatePayload", + "description": "Return type for `urlRedirectUpdate` mutation.", + "fields": [ + { + "name": "urlRedirect", + "description": "Returns the updated URL redirect.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectUserError", + "description": "Represents an error that happens during execution of a redirect mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UrlRedirectErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UserError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "UtcOffset", + "description": "Time between UTC time and a location's observed time, in the format `\"+HH:MM\"` or `\"-HH:MM\"`.\n\nExample value: `\"-07:00\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VaultCreditCard", + "description": "Represents a credit card payment instrument.", + "fields": [ + { + "name": "billingAddress", + "description": "The billing address of the card.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerCreditCardBillingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "brand", + "description": "The brand for the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expired", + "description": "Whether the card has been expired.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryMonth", + "description": "The expiry month of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryYear", + "description": "The expiry year of the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastDigits", + "description": "The last four digits for the card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the card holder.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VaultPaypalBillingAgreement", + "description": "Represents a paypal billing agreement payment instrument.", + "fields": [ + { + "name": "inactive", + "description": "Whether the paypal billing agreement is inactive.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The paypal account name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paypalAccountEmail", + "description": "The paypal account email address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Vector3", + "description": "Representation of 3d vectors and points. It can represent\neither the coordinates of a point in space, a direction, or\nsize. Presented as an object with three floating-point values.\n", + "fields": [ + { + "name": "x", + "description": "The x coordinate of Vector3.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "y", + "description": "The y coordinate of Vector3.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "z", + "description": "The z coordinate of Vector3.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Video", + "description": "Represents a Shopify hosted video.\n", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was created.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "duration", + "description": "The video's duration in milliseconds. This value is `null` unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileErrors", + "description": "Any errors that have occurred on the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FileError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileStatus", + "description": "The status of the file.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FileStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filename", + "description": "The video's filename.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaErrors", + "description": "Any errors which have occurred on the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaWarnings", + "description": "The warnings attached to the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaWarning", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalSource", + "description": "The video's original source. This value is `null` unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "VideoSource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "preview", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPreviewImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sources", + "description": "The video's sources. This value is empty unless the video's status field is\n[READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "VideoSource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current status of the media.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the file was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "File", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VideoSource", + "description": "Represents a source for a Shopify hosted video.\n\nTypes of sources include the original video, lower resolution versions of the original video,\nand an m3u8 playlist file.\n\nOnly [videos](https://shopify.dev/api/admin-graphql/latest/objects/video) with a status field\nof [READY](https://shopify.dev/api/admin-graphql/latest/enums/MediaStatus#value-ready) have sources.\n", + "fields": [ + { + "name": "fileSize", + "description": "The video source's file size in bytes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "format", + "description": "The video source's file format extension.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The video source's height.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The video source's MIME type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The video source's URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The video source's width.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "VisualizationType", + "description": "A type of visualization.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LINE", + "description": "Line Chart.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAR", + "description": "Bar Chart.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebPixel", + "description": "A web pixel settings.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "settings", + "description": "The settings JSON object for the web pixel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebPixelCreatePayload", + "description": "Return type for `webPixelCreate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsWebPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixel", + "description": "The created web pixel settings.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebPixelDeletePayload", + "description": "Return type for `webPixelDelete` mutation.", + "fields": [ + { + "name": "deletedWebPixelId", + "description": "The ID of the web pixel settings that was deleted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsWebPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WebPixelInput", + "description": "The input fields to use to update a web pixel.", + "fields": null, + "inputFields": [ + { + "name": "settings", + "description": "The web pixel settings in JSON format.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebPixelUpdatePayload", + "description": "Return type for `webPixelUpdate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ErrorsWebPixelUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webPixel", + "description": "The updated web pixel settings.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebPixel", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookEventBridgeEndpoint", + "description": "An Amazon EventBridge partner event source to which webhook subscriptions publish events.", + "fields": [ + { + "name": "arn", + "description": "The ARN of this EventBridge partner event source.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ARN", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookHttpEndpoint", + "description": "An HTTPS endpoint to which webhook subscriptions send POST requests.", + "fields": [ + { + "name": "callbackUrl", + "description": "The URL to which the webhooks events are sent.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookPubSubEndpoint", + "description": "A Google Cloud Pub/Sub topic to which webhook subscriptions publish events.", + "fields": [ + { + "name": "pubSubProject", + "description": "The Google Cloud Pub/Sub project ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pubSubTopic", + "description": "The Google Cloud Pub/Sub topic ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscription", + "description": "A webhook subscription is a persisted data object created by an app using the REST Admin API or GraphQL Admin API.\nIt describes the topic that the app wants to receive, and a destination where Shopify should send webhooks of the specified topic.\nWhen an event for a given topic occurs, the webhook subscription sends a relevant payload to the destination.\nLearn more about the [webhooks system](https://shopify.dev/apps/webhooks).\n", + "fields": [ + { + "name": "apiVersion", + "description": "The Admin API version that Shopify uses to serialize webhook events. This value is inherited from the app that created the webhook subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ApiVersion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "callbackUrl", + "description": "The destination URI to which the webhook subscription will send a message when an event occurs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `endpoint` instead." + }, + { + "name": "createdAt", + "description": "The date and time when the webhook subscription was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endpoint", + "description": "The endpoint to which the webhook subscription will send events.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "WebhookSubscriptionEndpoint", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "format", + "description": "The format in which the webhook subscription should send the data.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "includeFields", + "description": "An optional array of top-level resource fields that should be serialized and sent in the webhook message. If null, then all fields will be sent.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "legacyResourceId", + "description": "The ID of the corresponding resource in the REST Admin API.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafieldNamespaces", + "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privateMetafieldNamespaces", + "description": "The list of namespaces for private metafields that should be included in the webhook subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Metafields created using a reserved namespace are private by default. See our guide for\n[migrating private metafields](https://shopify.dev/docs/apps/custom-data/metafields/migrate-private-metafields).\n" + }, + { + "name": "topic", + "description": "The type of event that triggers the webhook. The topic determines when the webhook subscription sends a webhook, as well as what class of data object that webhook contains.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the webhook subscription was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "LegacyInteroperability", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscriptionConnection", + "description": "An auto-generated type for paginating through multiple WebhookSubscriptions.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WebhookSubscriptionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in WebhookSubscriptionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscriptionCreatePayload", + "description": "Return type for `webhookSubscriptionCreate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscriptionDeletePayload", + "description": "Return type for `webhookSubscriptionDelete` mutation.", + "fields": [ + { + "name": "deletedWebhookSubscriptionId", + "description": "The ID of the deleted webhook subscription.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscriptionEdge", + "description": "An auto-generated type which holds one WebhookSubscription and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of WebhookSubscriptionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "WebhookSubscriptionEndpoint", + "description": "An endpoint to which webhook subscriptions send webhooks events.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "WebhookEventBridgeEndpoint", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "WebhookHttpEndpoint", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "WebhookPubSubEndpoint", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "description": "The supported formats for webhook subscriptions.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "JSON", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XML", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WebhookSubscriptionInput", + "description": "The input fields for a webhook subscription.\n", + "fields": null, + "inputFields": [ + { + "name": "callbackUrl", + "description": "URL where the webhook subscription should send the POST request when the event occurs.", + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "format", + "description": "The format in which the webhook subscription should send the data.", + "type": { + "kind": "ENUM", + "name": "WebhookSubscriptionFormat", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeFields", + "description": "The list of fields to be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "metafieldNamespaces", + "description": "The list of namespaces for any metafields that should be included in the webhook subscription.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WebhookSubscriptionSortKeys", + "description": "The set of valid sort keys for the WebhookSubscription query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WebhookSubscriptionTopic", + "description": "The supported topics for webhook subscriptions. You can use webhook subscriptions to receive\nnotifications about particular events in a shop.\n\nYou don't create webhook subscriptions to\n[mandatory webhooks](https://shopify.dev/apps/webhooks/configuration/mandatory-webhooks).\nInstead, you configure mandatory webhooks in your Partner Dashboard as part of your app setup.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APP_UNINSTALLED", + "description": "The webhook topic for `app/uninstalled` events. Occurs whenever a shop has uninstalled the app.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CARTS_CREATE", + "description": "The webhook topic for `carts/create` events. Occurs when a cart is created in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are created in a custom storefront. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CARTS_UPDATE", + "description": "The webhook topic for `carts/update` events. Occurs when a cart is updated in the online store. Other types of carts aren't supported. For example, the webhook doesn't support carts that are updated in a custom storefront. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHANNELS_DELETE", + "description": "The webhook topic for `channels/delete` events. Occurs whenever a channel is deleted. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUTS_CREATE", + "description": "The webhook topic for `checkouts/create` events. Occurs whenever a checkout is created. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUTS_DELETE", + "description": "The webhook topic for `checkouts/delete` events. Occurs whenever a checkout is deleted. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKOUTS_UPDATE", + "description": "The webhook topic for `checkouts/update` events. Occurs whenever a checkout is updated. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PAYMENT_METHODS_CREATE", + "description": "The webhook topic for `customer_payment_methods/create` events. Occurs whenever a customer payment method is created. Requires the `read_customer_payment_methods` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PAYMENT_METHODS_UPDATE", + "description": "The webhook topic for `customer_payment_methods/update` events. Occurs whenever a customer payment method is updated. Requires the `read_customer_payment_methods` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_PAYMENT_METHODS_REVOKE", + "description": "The webhook topic for `customer_payment_methods/revoke` events. Occurs whenever a customer payment method is revoked. Requires the `read_customer_payment_methods` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_LISTINGS_ADD", + "description": "The webhook topic for `collection_listings/add` events. Occurs whenever a collection listing is added. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_LISTINGS_REMOVE", + "description": "The webhook topic for `collection_listings/remove` events. Occurs whenever a collection listing is removed. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_LISTINGS_UPDATE", + "description": "The webhook topic for `collection_listings/update` events. Occurs whenever a collection listing is updated. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_PUBLICATIONS_CREATE", + "description": "The webhook topic for `collection_publications/create` events. Occurs whenever a collection publication listing is created. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_PUBLICATIONS_DELETE", + "description": "The webhook topic for `collection_publications/delete` events. Occurs whenever a collection publication listing is deleted. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_PUBLICATIONS_UPDATE", + "description": "The webhook topic for `collection_publications/update` events. Occurs whenever a collection publication listing is updated. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTIONS_CREATE", + "description": "The webhook topic for `collections/create` events. Occurs whenever a collection is created. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTIONS_DELETE", + "description": "The webhook topic for `collections/delete` events. Occurs whenever a collection is deleted. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTIONS_UPDATE", + "description": "The webhook topic for `collections/update` events. Occurs whenever a collection is updated, including whenever products are added or removed from the collection. Occurs once if multiple products are added or removed from a collection at the same time. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_GROUPS_CREATE", + "description": "The webhook topic for `customer_groups/create` events. Occurs whenever a customer saved search is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_GROUPS_DELETE", + "description": "The webhook topic for `customer_groups/delete` events. Occurs whenever a customer saved search is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_GROUPS_UPDATE", + "description": "The webhook topic for `customer_groups/update` events. Occurs whenever a customer saved search is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_CREATE", + "description": "The webhook topic for `customers/create` events. Occurs whenever a customer is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_DELETE", + "description": "The webhook topic for `customers/delete` events. Occurs whenever a customer is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_DISABLE", + "description": "The webhook topic for `customers/disable` events. Occurs whenever a customer account is disabled. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_ENABLE", + "description": "The webhook topic for `customers/enable` events. Occurs whenever a customer account is enabled. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_UPDATE", + "description": "The webhook topic for `customers/update` events. Occurs whenever a customer is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_MARKETING_CONSENT_UPDATE", + "description": "The webhook topic for `customers_marketing_consent/update` events. Occurs whenever a customer's SMS marketing consent is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_TAGS_ADDED", + "description": "The webhook topic for `customer.tags_added` events. Triggers when tags are added to a customer. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_TAGS_REMOVED", + "description": "The webhook topic for `customer.tags_removed` events. Triggers when tags are removed from a customer. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_EMAIL_MARKETING_CONSENT_UPDATE", + "description": "The webhook topic for `customers_email_marketing_consent/update` events. Occurs whenever a customer's email marketing consent is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPUTES_CREATE", + "description": "The webhook topic for `disputes/create` events. Occurs whenever a dispute is created. Requires the `read_shopify_payments_disputes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISPUTES_UPDATE", + "description": "The webhook topic for `disputes/update` events. Occurs whenever a dispute is updated. Requires the `read_shopify_payments_disputes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT_ORDERS_CREATE", + "description": "The webhook topic for `draft_orders/create` events. Occurs whenever a draft order is created. Requires the `read_draft_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT_ORDERS_DELETE", + "description": "The webhook topic for `draft_orders/delete` events. Occurs whenever a draft order is deleted. Requires the `read_draft_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DRAFT_ORDERS_UPDATE", + "description": "The webhook topic for `draft_orders/update` events. Occurs whenever a draft order is updated. Requires the `read_draft_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_EVENTS_CREATE", + "description": "The webhook topic for `fulfillment_events/create` events. Occurs whenever a fulfillment event is created. Requires the `read_fulfillments` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_EVENTS_DELETE", + "description": "The webhook topic for `fulfillment_events/delete` events. Occurs whenever a fulfillment event is deleted. Requires the `read_fulfillments` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENTS_CREATE", + "description": "The webhook topic for `fulfillments/create` events. Occurs whenever a fulfillment is created. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENTS_UPDATE", + "description": "The webhook topic for `fulfillments/update` events. Occurs whenever a fulfillment is updated. Requires at least one of the following scopes: read_fulfillments, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTRIBUTED_SESSIONS_FIRST", + "description": "The webhook topic for `attributed_sessions/first` events. Occurs whenever an order with a \"first\" attributed session is attributed. Requires the `read_marketing_events` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ATTRIBUTED_SESSIONS_LAST", + "description": "The webhook topic for `attributed_sessions/last` events. Occurs whenever an order with a \"last\" attributed session is attributed. Requires the `read_marketing_events` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDER_TRANSACTIONS_CREATE", + "description": "The webhook topic for `order_transactions/create` events. Occurs when a order transaction is created or when it's status is updated. Only occurs for transactions with a status of success, failure or error. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_CANCELLED", + "description": "The webhook topic for `orders/cancelled` events. Occurs whenever an order is cancelled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_CREATE", + "description": "The webhook topic for `orders/create` events. Occurs whenever an order is created. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_DELETE", + "description": "The webhook topic for `orders/delete` events. Occurs whenever an order is deleted. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_EDITED", + "description": "The webhook topic for `orders/edited` events. Occurs whenever an order is edited. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_FULFILLED", + "description": "The webhook topic for `orders/fulfilled` events. Occurs whenever an order is fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_PAID", + "description": "The webhook topic for `orders/paid` events. Occurs whenever an order is paid. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_PARTIALLY_FULFILLED", + "description": "The webhook topic for `orders/partially_fulfilled` events. Occurs whenever an order is partially fulfilled. Requires at least one of the following scopes: read_orders, read_marketplace_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERS_UPDATED", + "description": "The webhook topic for `orders/updated` events. Occurs whenever an order is updated. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_MOVED", + "description": "The webhook topic for `fulfillment_orders/moved` events. Occurs whenever the location which is assigned to fulfill one or more fulfillment order line items is changed.\n\n* `original_fulfillment_order` - The final state of the original fulfillment order.\n* `moved_fulfillment_order` - The fulfillment order which now contains the re-assigned line items.\n* `source_location` - The original location which was assigned to fulfill the line items (available as of the `2023-04` API version).\n* `destination_location_id` - The ID of the location which is now responsible for fulfilling the line items.\n\n**Note:** The [assignedLocation](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-assignedlocation)\nof the `original_fulfillment_order` might be changed by the move operation.\nIf you need to determine the originally assigned location, then you should refer to the `source_location`.\n\n[Learn more about moving line items](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentOrderMove).\n Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_HOLD_RELEASED", + "description": "The webhook topic for `fulfillment_orders/hold_released` events. Occurs whenever a fulfillment order hold is released. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_SCHEDULED_FULFILLMENT_ORDER_READY", + "description": "The webhook topic for `fulfillment_orders/scheduled_fulfillment_order_ready` events. Occurs whenever a fulfillment order which was scheduled becomes due. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_ORDER_ROUTING_COMPLETE", + "description": "The webhook topic for `fulfillment_orders/order_routing_complete` events. Occurs when an order has finished being routed and it's fulfillment orders assigned to a fulfillment service's location. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_CANCELLED", + "description": "The webhook topic for `fulfillment_orders/cancelled` events. Occurs when a fulfillment order is cancelled. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_FULFILLMENT_SERVICE_FAILED_TO_COMPLETE", + "description": "The webhook topic for `fulfillment_orders/fulfillment_service_failed_to_complete` events. Occurs when a fulfillment service intends to close an in_progress fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_REJECTED", + "description": "The webhook topic for `fulfillment_orders/fulfillment_request_rejected` events. Occurs when a 3PL rejects a fulfillment request that was sent by a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_SUBMITTED", + "description": "The webhook topic for `fulfillment_orders/cancellation_request_submitted` events. Occurs when a merchant requests a fulfillment request to be cancelled after that request was approved by a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_ACCEPTED", + "description": "The webhook topic for `fulfillment_orders/cancellation_request_accepted` events. Occurs when a 3PL accepts a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_CANCELLATION_REQUEST_REJECTED", + "description": "The webhook topic for `fulfillment_orders/cancellation_request_rejected` events. Occurs when a 3PL rejects a fulfillment cancellation request, received from a merchant. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_SUBMITTED", + "description": "The webhook topic for `fulfillment_orders/fulfillment_request_submitted` events. Occurs when a merchant submits a fulfillment request to a 3PL. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_FULFILLMENT_REQUEST_ACCEPTED", + "description": "The webhook topic for `fulfillment_orders/fulfillment_request_accepted` events. Occurs when a fulfillment service accepts a request to fulfill a fulfillment order. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_LOCAL_DELIVERY", + "description": "The webhook topic for `fulfillment_orders/line_items_prepared_for_local_delivery` events. Occurs whenever a fulfillment order's line items are prepared for local delivery. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_PLACED_ON_HOLD", + "description": "The webhook topic for `fulfillment_orders/placed_on_hold` events. Occurs when a fulfillment order is placed on hold. Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_LISTINGS_ADD", + "description": "The webhook topic for `product_listings/add` events. Occurs whenever an active product is listed on a channel. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_LISTINGS_REMOVE", + "description": "The webhook topic for `product_listings/remove` events. Occurs whenever a product listing is removed from the channel. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_LISTINGS_UPDATE", + "description": "The webhook topic for `product_listings/update` events. Occurs whenever a product publication is updated. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED_PRODUCT_LISTINGS_ADD", + "description": "The webhook topic for `scheduled_product_listings/add` events. Occurs whenever a product is scheduled to be published. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED_PRODUCT_LISTINGS_UPDATE", + "description": "The webhook topic for `scheduled_product_listings/update` events. Occurs whenever a product's scheduled availability date changes. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED_PRODUCT_LISTINGS_REMOVE", + "description": "The webhook topic for `scheduled_product_listings/remove` events. Occurs whenever a product is no longer scheduled to be published. Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_PUBLICATIONS_CREATE", + "description": "The webhook topic for `product_publications/create` events. Occurs whenever a product publication for an active product is created, or whenever an existing product publication is published. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_PUBLICATIONS_DELETE", + "description": "The webhook topic for `product_publications/delete` events. Occurs whenever a product publication for an active product is removed, or whenever an existing product publication is unpublished. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_PUBLICATIONS_UPDATE", + "description": "The webhook topic for `product_publications/update` events. Occurs whenever a product publication is updated. Requires the `read_publications` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTS_CREATE", + "description": "The webhook topic for `products/create` events. Occurs whenever a product is created. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTS_DELETE", + "description": "The webhook topic for `products/delete` events. Occurs whenever a product is deleted. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCTS_UPDATE", + "description": "The webhook topic for `products/update` events. Occurs whenever a product is updated, or whenever a product is ordered, or whenever a variant is added, removed, or updated. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUNDS_CREATE", + "description": "The webhook topic for `refunds/create` events. Occurs whenever a new refund is created without errors on an order, independent from the movement of money. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEGMENTS_CREATE", + "description": "The webhook topic for `segments/create` events. Occurs whenever a segment is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEGMENTS_DELETE", + "description": "The webhook topic for `segments/delete` events. Occurs whenever a segment is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEGMENTS_UPDATE", + "description": "The webhook topic for `segments/update` events. Occurs whenever a segment is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ADDRESSES_CREATE", + "description": "The webhook topic for `shipping_addresses/create` events. Occurs whenever a shipping address is created. Requires the `read_shipping` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_ADDRESSES_UPDATE", + "description": "The webhook topic for `shipping_addresses/update` events. Occurs whenever a shipping address is updated. Requires the `read_shipping` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_UPDATE", + "description": "The webhook topic for `shop/update` events. Occurs whenever a shop is updated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_PARTNERS_UPDATE", + "description": "The webhook topic for `tax_partners/update` events. Occurs whenever a tax partner is created or updated. Requires the `read_taxes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_SERVICES_CREATE", + "description": "The webhook topic for `tax_services/create` events. Occurs whenever a tax service is created. Requires the `read_taxes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAX_SERVICES_UPDATE", + "description": "The webhook topic for `tax_services/update` events. Occurs whenver a tax service is updated. Requires the `read_taxes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THEMES_CREATE", + "description": "The webhook topic for `themes/create` events. Occurs whenever a theme is created. Does not occur when theme files are created. Requires the `read_themes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THEMES_DELETE", + "description": "The webhook topic for `themes/delete` events. Occurs whenever a theme is deleted. Does not occur when theme files are deleted. Requires the `read_themes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THEMES_PUBLISH", + "description": "The webhook topic for `themes/publish` events. Occurs whenever a theme with the main or mobile (deprecated) role is published. Requires the `read_themes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THEMES_UPDATE", + "description": "The webhook topic for `themes/update` events. Occurs whenever a theme is updated. Does not occur when theme files are updated. Requires the `read_themes` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANTS_IN_STOCK", + "description": "The webhook topic for `variants/in_stock` events. Occurs whenever a variant becomes in stock. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANTS_OUT_OF_STOCK", + "description": "The webhook topic for `variants/out_of_stock` events. Occurs whenever a variant becomes out of stock. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_LEVELS_CONNECT", + "description": "The webhook topic for `inventory_levels/connect` events. Occurs whenever an inventory level is connected. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_LEVELS_UPDATE", + "description": "The webhook topic for `inventory_levels/update` events. Occurs whenever an inventory level is updated. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_LEVELS_DISCONNECT", + "description": "The webhook topic for `inventory_levels/disconnect` events. Occurs whenever an inventory level is disconnected. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_ITEMS_CREATE", + "description": "The webhook topic for `inventory_items/create` events. Occurs whenever an inventory item is created. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_ITEMS_UPDATE", + "description": "The webhook topic for `inventory_items/update` events. Occurs whenever an inventory item is updated. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_ITEMS_DELETE", + "description": "The webhook topic for `inventory_items/delete` events. Occurs whenever an inventory item is deleted. Requires the `read_inventory` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS_ACTIVATE", + "description": "The webhook topic for `locations/activate` events. Occurs whenever a deactivated location is re-activated. Requires the `read_locations` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS_DEACTIVATE", + "description": "The webhook topic for `locations/deactivate` events. Occurs whenever a location is deactivated. Requires the `read_locations` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS_CREATE", + "description": "The webhook topic for `locations/create` events. Occurs whenever a location is created. Requires the `read_locations` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS_UPDATE", + "description": "The webhook topic for `locations/update` events. Occurs whenever a location is updated. Requires the `read_locations` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCATIONS_DELETE", + "description": "The webhook topic for `locations/delete` events. Occurs whenever a location is deleted. Requires the `read_locations` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TENDER_TRANSACTIONS_CREATE", + "description": "The webhook topic for `tender_transactions/create` events. Occurs when a tender transaction is created. Requires the `read_orders` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_PURCHASES_ONE_TIME_UPDATE", + "description": "The webhook topic for `app_purchases_one_time/update` events. Occurs whenever a one-time app charge is updated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_SUBSCRIPTIONS_APPROACHING_CAPPED_AMOUNT", + "description": "The webhook topic for `app_subscriptions/approaching_capped_amount` events. Occurs when the balance used on an app subscription crosses 90% of the capped amount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APP_SUBSCRIPTIONS_UPDATE", + "description": "The webhook topic for `app_subscriptions/update` events. Occurs whenever an app subscription is updated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCALES_CREATE", + "description": "The webhook topic for `locales/create` events. Occurs whenever a shop locale is created Requires the `read_locales` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCALES_UPDATE", + "description": "The webhook topic for `locales/update` events. Occurs whenever a shop locale is updated, such as published or unpublished Requires the `read_locales` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOMAINS_CREATE", + "description": "The webhook topic for `domains/create` events. Occurs whenever a domain is created.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOMAINS_UPDATE", + "description": "The webhook topic for `domains/update` events. Occurs whenever a domain is updated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOMAINS_DESTROY", + "description": "The webhook topic for `domains/destroy` events. Occurs whenever a domain is destroyed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_CONTRACTS_CREATE", + "description": "The webhook topic for `subscription_contracts/create` events. Occurs whenever a subscription contract is created. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_CONTRACTS_UPDATE", + "description": "The webhook topic for `subscription_contracts/update` events. Occurs whenever a subscription contract is updated. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_CREATE", + "description": "The webhook topic for `subscription_billing_cycle_edits/create` events. Occurs whenever a subscription contract billing cycle is edited. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_UPDATE", + "description": "The webhook topic for `subscription_billing_cycle_edits/update` events. Occurs whenever a subscription contract billing cycle edit is updated. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_CYCLE_EDITS_DELETE", + "description": "The webhook topic for `subscription_billing_cycle_edits/delete` events. Occurs whenever a subscription contract billing cycle edit is deleted. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROFILES_CREATE", + "description": "The webhook topic for `profiles/create` events. Occurs whenever a delivery profile is created Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROFILES_UPDATE", + "description": "The webhook topic for `profiles/update` events. Occurs whenever a delivery profile is updated Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PROFILES_DELETE", + "description": "The webhook topic for `profiles/delete` events. Occurs whenever a delivery profile is deleted Requires at least one of the following scopes: read_shipping, read_assigned_shipping.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_ATTEMPTS_SUCCESS", + "description": "The webhook topic for `subscription_billing_attempts/success` events. Occurs whenever a subscription billing attempt succeeds. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_ATTEMPTS_FAILURE", + "description": "The webhook topic for `subscription_billing_attempts/failure` events. Occurs whenever a subscription billing attempt fails. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION_BILLING_ATTEMPTS_CHALLENGED", + "description": "The webhook topic for `subscription_billing_attempts/challenged` events. Occurs when the financial instutition challenges the subscripttion billing attempt charge as per 3D Secure. Requires the `read_own_subscription_contracts` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_CANCEL", + "description": "The webhook topic for `returns/cancel` events. Occurs whenever a return is canceled. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_CLOSE", + "description": "The webhook topic for `returns/close` events. Occurs whenever a return is closed. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_REOPEN", + "description": "The webhook topic for `returns/reopen` events. Occurs whenever a closed return is reopened. Requires at least one of the following scopes: read_orders, read_marketplace_orders, read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_REQUEST", + "description": "The webhook topic for `returns/request` events. Occurs whenever a return is requested. This means `Return.status` is `REQUESTED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_APPROVE", + "description": "The webhook topic for `returns/approve` events. Occurs whenever a return is approved. This means `Return.status` is `OPEN`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNS_DECLINE", + "description": "The webhook topic for `returns/decline` events. Occurs whenever a return is declined. This means `Return.status` is `DECLINED`. Requires at least one of the following scopes: read_returns, read_marketplace_returns, read_buyer_membership_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REVERSE_DELIVERIES_ATTACH_DELIVERABLE", + "description": "The webhook topic for `reverse_deliveries/attach_deliverable` events. Occurs whenever a deliverable is attached to a reverse delivery.\nThis occurs when a reverse delivery is created or updated with delivery metadata.\nMetadata includes the delivery method, label, and tracking information associated with a reverse delivery.\n Requires at least one of the following scopes: read_returns, read_marketplace_returns.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REVERSE_FULFILLMENT_ORDERS_DISPOSE", + "description": "The webhook topic for `reverse_fulfillment_orders/dispose` events. Occurs whenever a disposition is made on a reverse fulfillment order.\nThis includes dispositions made on reverse deliveries that are associated with the reverse fulfillment order.\n Requires at least one of the following scopes: read_returns, read_marketplace_returns.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_TERMS_CREATE", + "description": "The webhook topic for `payment_terms/create` events. Occurs whenever payment terms are created. Requires the `read_payment_terms` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_TERMS_DELETE", + "description": "The webhook topic for `payment_terms/delete` events. Occurs whenever payment terms are deleted. Requires the `read_payment_terms` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_TERMS_UPDATE", + "description": "The webhook topic for `payment_terms/update` events. Occurs whenever payment terms are updated. Requires the `read_payment_terms` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_SCHEDULES_DUE", + "description": "The webhook topic for `payment_schedules/due` events. Occurs whenever payment schedules are due. Requires the `read_payment_terms` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_GROUPS_CREATE", + "description": "The webhook topic for `selling_plan_groups/create` events. Notifies when a SellingPlanGroup is created. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_GROUPS_UPDATE", + "description": "The webhook topic for `selling_plan_groups/update` events. Notifies when a SellingPlanGroup is updated. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SELLING_PLAN_GROUPS_DELETE", + "description": "The webhook topic for `selling_plan_groups/delete` events. Notifies when a SellingPlanGroup is deleted. Requires the `read_products` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BULK_OPERATIONS_FINISH", + "description": "The webhook topic for `bulk_operations/finish` events. Notifies when a Bulk Operation finishes.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_FEEDS_CREATE", + "description": "The webhook topic for `product_feeds/create` events. Triggers when product feed is created Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_FEEDS_UPDATE", + "description": "The webhook topic for `product_feeds/update` events. Triggers when product feed is updated Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_FEEDS_INCREMENTAL_SYNC", + "description": "The webhook topic for `product_feeds/incremental_sync` events. Occurs whenever a product publication is created, updated or removed for a product feed Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_FEEDS_FULL_SYNC", + "description": "The webhook topic for `product_feeds/full_sync` events. Triggers when a full sync for a product feed is performed Requires the `read_product_listings` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETS_CREATE", + "description": "The webhook topic for `markets/create` events. Occurs when a new market is created. Requires the `read_markets` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETS_UPDATE", + "description": "The webhook topic for `markets/update` events. Occurs when a market is updated. Requires the `read_markets` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MARKETS_DELETE", + "description": "The webhook topic for `markets/delete` events. Occurs when a market is deleted. Requires the `read_markets` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_RESCHEDULED", + "description": "The webhook topic for `fulfillment_orders/rescheduled` events. Triggers when a fulfillment order is rescheduled Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUDIT_EVENTS_ADMIN_API_ACTIVITY", + "description": "The webhook topic for `audit_events/admin_api_activity` events. Triggers for each auditable Admin API request. This topic is limited to one active subscription per Plus store and requires the use of Google Cloud Pub/Sub or AWS EventBridge. Requires the `read_audit_events` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLMENT_ORDERS_LINE_ITEMS_PREPARED_FOR_PICKUP", + "description": "The webhook topic for `fulfillment_orders/line_items_prepared_for_pickup` events. Triggers when one or more of the line items for a fulfillment order are prepared for pickup Requires at least one of the following scopes: read_merchant_managed_fulfillment_orders, read_assigned_fulfillment_orders, read_third_party_fulfillment_orders.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANIES_CREATE", + "description": "The webhook topic for `companies/create` events. Occurs whenever a company is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANIES_UPDATE", + "description": "The webhook topic for `companies/update` events. Occurs whenever a company is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANIES_DELETE", + "description": "The webhook topic for `companies/delete` events. Occurs whenever a company is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATIONS_CREATE", + "description": "The webhook topic for `company_locations/create` events. Occurs whenever a company location is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATIONS_UPDATE", + "description": "The webhook topic for `company_locations/update` events. Occurs whenever a company location is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_LOCATIONS_DELETE", + "description": "The webhook topic for `company_locations/delete` events. Occurs whenever a company location is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACTS_CREATE", + "description": "The webhook topic for `company_contacts/create` events. Occurs whenever a company contact is created. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACTS_UPDATE", + "description": "The webhook topic for `company_contacts/update` events. Occurs whenever a company contact is updated. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACTS_DELETE", + "description": "The webhook topic for `company_contacts/delete` events. Occurs whenever a company contact is deleted. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMERS_MERGE", + "description": "The webhook topic for `customers/merge` events. Triggers when two customers are merged Requires the `read_customer_merge` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACT_ROLES_ASSIGN", + "description": "The webhook topic for `company_contact_roles/assign` events. Occurs whenever a role is assigned to a contact at a location. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY_CONTACT_ROLES_REVOKE", + "description": "The webhook topic for `company_contact_roles/revoke` events. Occurs whenever a role is revoked from a contact at a location. Requires the `read_customers` scope.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WebhookSubscriptionUpdatePayload", + "description": "Return type for `webhookSubscriptionUpdate` mutation.", + "fields": [ + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webhookSubscription", + "description": "The webhook subscription that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "WebhookSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Weight", + "description": "A weight, which includes a numeric value and a unit of measurement.", + "fields": [ + { + "name": "unit", + "description": "The unit of measurement for `value`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The weight value using the unit system specified with `unit`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "WeightInput", + "description": "The input fields for the weight unit and value inputs.\n", + "fields": null, + "inputFields": [ + { + "name": "value", + "description": "The weight value using the unit system specified with `weight_unit`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "unit", + "description": "Unit of measurement for `value`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WeightUnit", + "description": "Units of measurement for weight.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "KILOGRAMS", + "description": "1 kilogram equals 1000 grams.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GRAMS", + "description": "Metric system unit of mass.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POUNDS", + "description": "1 pound equals 16 ounces.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUNCES", + "description": "Imperial system unit of mass.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Directive", + "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", + "fields": [ + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRepeatable", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__DirectiveLocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onField", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + }, + { + "name": "onFragment", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + }, + { + "name": "onOperation", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__DirectiveLocation", + "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUERY", + "description": "Location adjacent to a query operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUTATION", + "description": "Location adjacent to a mutation operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION", + "description": "Location adjacent to a subscription operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD", + "description": "Location adjacent to a field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_DEFINITION", + "description": "Location adjacent to a fragment definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_SPREAD", + "description": "Location adjacent to a fragment spread.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INLINE_FRAGMENT", + "description": "Location adjacent to an inline fragment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEMA", + "description": "Location adjacent to a schema definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCALAR", + "description": "Location adjacent to a scalar definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Location adjacent to an object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD_DEFINITION", + "description": "Location adjacent to a field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARGUMENT_DEFINITION", + "description": "Location adjacent to an argument definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Location adjacent to an interface definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Location adjacent to a union definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Location adjacent to an enum definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM_VALUE", + "description": "Location adjacent to an enum value definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Location adjacent to an input object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_FIELD_DEFINITION", + "description": "Location adjacent to an input object field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIABLE_DEFINITION", + "description": "Location adjacent to a variable definition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__EnumValue", + "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", + "fields": [ + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPrivatelyDocumented", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Field", + "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", + "fields": [ + { + "name": "accessRestricted", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "accessRestrictedReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPrivatelyDocumented", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isProtected", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "protectedContent", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "protectedSubject", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiredAccess", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__InputValue", + "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", + "fields": [ + { + "name": "defaultValue", + "description": "A GraphQL-formatted string representing the default value for this input value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gidTypes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Schema", + "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "directives", + "description": "A list of all directives supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Directive", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mutationType", + "description": "If this server supports mutation, the type that mutation operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryType", + "description": "The type that query operations will be rooted at.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionType", + "description": "If this server support subscription, the type that subscription operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "A list of all types supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Type", + "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", + "fields": [ + { + "name": "accessRestricted", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "accessRestrictedReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "componentName", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enumValues", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__EnumValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Field", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inputFields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interfaces", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isOneOf", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPrivatelyDocumented", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isProtected", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__TypeKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ofType", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "possibleTypes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "protectedSubject", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiredAccess", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "specifiedByURL", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__TypeKind", + "description": "An enum describing what kind of type a given `__Type` is.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SCALAR", + "description": "Indicates this type is a scalar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Indicates this type is a union. `possibleTypes` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Indicates this type is an enum. `enumValues` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Indicates this type is an input object. `inputFields` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST", + "description": "Indicates this type is a list. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_NULL", + "description": "Indicates this type is a non-null. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "deliveryProfileCreatePayload", + "description": "Return type for `deliveryProfileCreate` mutation.", + "fields": [ + { + "name": "profile", + "description": "The delivery profile that was created.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "deliveryProfileRemovePayload", + "description": "Return type for `deliveryProfileRemove` mutation.", + "fields": [ + { + "name": "job", + "description": "The delivery profile deletion job triggered by the mutation.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Job", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "deliveryProfileUpdatePayload", + "description": "Return type for `deliveryProfileUpdate` mutation.", + "fields": [ + { + "name": "profile", + "description": "The delivery profile that was updated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + } + ], + "directives": [ + { + "name": "include", + "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Included when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "skip", + "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Skipped when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "deprecated", + "description": "Marks an element of a GraphQL schema as no longer supported.", + "locations": [ + "FIELD_DEFINITION", + "ENUM_VALUE", + "ARGUMENT_DEFINITION", + "INPUT_FIELD_DEFINITION" + ], + "args": [ + { + "name": "reason", + "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in [Markdown](https://daringfireball.net/projects/markdown/).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"No longer supported\"" + } + ] + }, + { + "name": "oneOf", + "description": "Requires that exactly one field must be supplied and that field must not be `null`.", + "locations": [ + "INPUT_OBJECT" + ], + "args": [] + }, + { + "name": "accessRestricted", + "description": "Marks an element of a GraphQL schema as having restricted access.", + "locations": [ + "FIELD_DEFINITION", + "OBJECT" + ], + "args": [ + { + "name": "reason", + "description": "Explains the reason around this restriction", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "null" + } + ] + }, + { + "name": "cost", + "description": "Provides a weighted cost for GraphQL fields and types while calculating the complexity of a request during static analysis.", + "locations": [ + "FIELD_DEFINITION", + "OBJECT" + ], + "args": [ + { + "name": "weight", + "description": "Specifies a cost added to request complexity for each possible appearance of the tagged schema element. A `weight` value may be a serialized float or string formula.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "listSize", + "description": "Provides the maximum possible size of a returned list, or how to inspect this information in a request. This value is used during static analysis to calculate the overall complexity of a request.", + "locations": [ + "FIELD_DEFINITION" + ], + "args": [ + { + "name": "assumedSize", + "description": "Statically defines the maximum possible size of the returned list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "slicingArguments", + "description": "The names of numeric slicing arguments that can statically define the maximum length of the returned list.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sizedFields", + "description": "The names of list sub-fields that adhere to the maximum length defined by `assumedSize` and `slicingArguments`.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "requireOneSlicingArgument", + "description": "Informs static analysis to expect exactly one of the defined slicing arguments to be present in a query.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + } + ] + } + ] + } + }, + "extensions": { + "cost": { + "requestedQueryCost": 59, + "actualQueryCost": 59, + "throttleStatus": { + "maximumAvailable": 1000.0, + "currentlyAvailable": 915, + "restoreRate": 50.0 + } + } + } +} diff --git a/shopify/utils/admin/queries.ts b/shopify/utils/admin/queries.ts new file mode 100644 index 000000000..8ae51e799 --- /dev/null +++ b/shopify/utils/admin/queries.ts @@ -0,0 +1,8 @@ +import { gql } from "../../../utils/graphql.ts"; + +// Fixme: This is to avoid typescript generation errors +// because it does not accept generating an empty schema +// TODO: Remove this once you add any other query +export const Noop = { + query: gql`query Noop { app(id: "") { description } }`, +}; diff --git a/shopify/utils/fragments/cart.ts b/shopify/utils/fragments/cart.ts deleted file mode 100644 index d80340e11..000000000 --- a/shopify/utils/fragments/cart.ts +++ /dev/null @@ -1,73 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; - -export const fragment = gql` -fragment Cart on Cart { - id - checkoutUrl - totalQuantity - lines(first: 100) { - nodes { - id - quantity - merchandise { - ...on ProductVariant { - id - title - image { - url - altText - } - product { - title - } - price { - amount - currencyCode - } - } - } - cost { - totalAmount { - amount - currencyCode - } - subtotalAmount{ - amount - currencyCode - } - amountPerQuantity { - amount - currencyCode - } - compareAtAmountPerQuantity { - amount - currencyCode - } - } - } - } - cost { - subtotalAmount { - amount - currencyCode - } - totalAmount { - amount - currencyCode - } - checkoutChargeAmount{ - amount - currencyCode - } - } - discountCodes { - code - applicable - } - discountAllocations{ - discountedAmount { - amount - currencyCode - } - } -}`; diff --git a/shopify/utils/fragments/product.ts b/shopify/utils/fragments/product.ts deleted file mode 100644 index cacdec3ae..000000000 --- a/shopify/utils/fragments/product.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; - -export const fragment = gql` -fragment Product on Product { - availableForSale - createdAt - description - descriptionHtml - featuredImage { - altText - url - } - handle - id - images(first: 10) { - nodes { - altText - url - } - } - isGiftCard - media(first: 10) { - nodes { - alt - previewImage { - altText - url - } - mediaContentType - } - } - onlineStoreUrl - options { - name - values - } - priceRange { - minVariantPrice { - amount - currencyCode - } - maxVariantPrice { - amount - currencyCode - } - } - productType - publishedAt - requiresSellingPlan - seo { - title - description - } - tags - title - totalInventory - updatedAt - variants(first: 10) { - nodes { - ...ProductVariant - } - } - vendor -} -`; diff --git a/shopify/utils/fragments/productVariant.ts b/shopify/utils/fragments/productVariant.ts deleted file mode 100644 index 0e2c8a4cc..000000000 --- a/shopify/utils/fragments/productVariant.ts +++ /dev/null @@ -1,42 +0,0 @@ -import { gql } from "../../../utils/graphql.ts"; - -export const fragment = gql` -fragment ProductVariant on ProductVariant { - availableForSale - barcode - compareAtPrice { - amount - currencyCode - } - currentlyNotInStock - id - image { - altText - url - } - price { - amount - currencyCode - } - quantityAvailable - requiresShipping - selectedOptions { - name - value - } - sku - title - unitPrice { - amount - currencyCode - } - unitPriceMeasurement { - measuredType - quantityValue - referenceUnit - quantityUnit - } - weight - weightUnit -} -`; diff --git a/shopify/utils/storefront/queries.ts b/shopify/utils/storefront/queries.ts new file mode 100644 index 000000000..b8da51a59 --- /dev/null +++ b/shopify/utils/storefront/queries.ts @@ -0,0 +1,255 @@ +import { gql } from "../../../utils/graphql.ts"; + +const ProductVariant = gql` +fragment ProductVariant on ProductVariant { + availableForSale + barcode + compareAtPrice { + amount + currencyCode + } + currentlyNotInStock + id + image { + altText + url + } + price { + amount + currencyCode + } + quantityAvailable + requiresShipping + selectedOptions { + name + value + } + sku + title + unitPrice { + amount + currencyCode + } + unitPriceMeasurement { + measuredType + quantityValue + referenceUnit + quantityUnit + } + weight + weightUnit +} +`; + +const Product = gql` +fragment Product on Product { + availableForSale + createdAt + description + descriptionHtml + featuredImage { + altText + url + } + handle + id + images(first: 10) { + nodes { + altText + url + } + } + isGiftCard + media(first: 10) { + nodes { + alt + previewImage { + altText + url + } + mediaContentType + } + } + onlineStoreUrl + options { + name + values + } + priceRange { + minVariantPrice { + amount + currencyCode + } + maxVariantPrice { + amount + currencyCode + } + } + productType + publishedAt + requiresSellingPlan + seo { + title + description + } + tags + title + totalInventory + updatedAt + variants(first: 10) { + nodes { + ...ProductVariant + } + } + vendor +} +`; + +const Cart = gql` +fragment Cart on Cart { + id + checkoutUrl + totalQuantity + lines(first: 100) { + nodes { + id + quantity + merchandise { + ...on ProductVariant { + id + title + image { + url + altText + } + product { + title + } + price { + amount + currencyCode + } + } + } + cost { + totalAmount { + amount + currencyCode + } + subtotalAmount{ + amount + currencyCode + } + amountPerQuantity { + amount + currencyCode + } + compareAtAmountPerQuantity { + amount + currencyCode + } + } + } + } + cost { + subtotalAmount { + amount + currencyCode + } + totalAmount { + amount + currencyCode + } + checkoutChargeAmount{ + amount + currencyCode + } + } + discountCodes { + code + applicable + } + discountAllocations{ + discountedAmount { + amount + currencyCode + } + } +}`; + +export const CreateCart = { + query: gql`mutation CreateCart { + payload: cartCreate { + cart { id } + } +}`, +}; + +export const GetCart = { + fragments: [Cart], + query: gql`query GetCart($id: ID!) { cart(id: $id) { ...Cart } }`, +}; + +export const GetProduct = { + fragments: [Product, ProductVariant], + query: gql`query GetProduct($handle: String) { + product(handle: $handle) { ...Product } + }`, +}; + +export const ListProducts = { + fragments: [Product, ProductVariant], + query: gql`query ListProducts($first: Int, $after: String, $query: String) { + products(first: $first, after: $after, query: $query) { + nodes { + ...Product + } + } + }`, +}; + +export const SearchProducts = { + fragments: [Product, ProductVariant], + query: gql`query SearchProducts($first: Int, $after: String, $query: String) { + products(first: $first, after: $after, query: $query) { + pageInfo { + hasNextPage + } + nodes { + ...Product + } + } + }`, +}; + +export const AddItemToCart = { + fragments: [Cart], + query: gql`mutation AddItemToCart($cartId: ID!, $lines: [CartLineInput!]!) { + payload: cartLinesAdd(cartId: $cartId, lines: $lines) { + cart { ...Cart } + } + }`, +}; + +export const AddCoupon = { + fragments: [Cart], + query: gql`mutation AddCoupon($cartId: ID!, $discountCodes: [String!]!) { + payload: cartDiscountCodesUpdate(cartId: $cartId, discountCodes: $discountCodes) { + cart { ...Cart } + userErrors { + field + message + } + } + }`, +}; + +export const UpdateItems = { + fragments: [Cart], + query: + gql`mutation UpdateItems($cartId: ID!, $lines: [CartLineUpdateInput!]!) { + payload: cartLinesUpdate(cartId: $cartId, lines: $lines) { + cart { ...Cart } + } + }`, +}; diff --git a/shopify/utils/storefront.graphql.gen.ts b/shopify/utils/storefront/storefront.graphql.gen.ts similarity index 71% rename from shopify/utils/storefront.graphql.gen.ts rename to shopify/utils/storefront/storefront.graphql.gen.ts index da0898fbd..9e3a226cf 100644 --- a/shopify/utils/storefront.graphql.gen.ts +++ b/shopify/utils/storefront/storefront.graphql.gen.ts @@ -4,82 +4,90 @@ // This file SHOULD be checked into source version control. // To generate this file: deno task start // + export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { [K in keyof T]: T[K] }; -export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; -export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; -export type MakeEmpty = { [_ in K]?: never }; -export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +export type Exact = { + [K in keyof T]: T[K]; +}; +export type MakeOptional = + & Omit + & { [SubKey in K]?: Maybe }; +export type MakeMaybe = + & Omit + & { [SubKey in K]: Maybe }; +export type MakeEmpty = + { [_ in K]?: never }; +export type Incremental = + | T + | { + [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; + }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string; } - String: { input: string; output: string; } - Boolean: { input: boolean; output: boolean; } - Int: { input: number; output: number; } - Float: { input: number; output: number; } - Color: { input: any; output: any; } - DateTime: { input: any; output: any; } - Decimal: { input: any; output: any; } - HTML: { input: any; output: any; } - JSON: { input: any; output: any; } - URL: { input: any; output: any; } - UnsignedInt64: { input: any; output: any; } + ID: { input: string; output: string }; + String: { input: string; output: string }; + Boolean: { input: boolean; output: boolean }; + Int: { input: number; output: number }; + Float: { input: number; output: number }; + Color: { input: any; output: any }; + DateTime: { input: any; output: any }; + Decimal: { input: any; output: any }; + HTML: { input: any; output: any }; + JSON: { input: any; output: any }; + URL: { input: any; output: any }; + UnsignedInt64: { input: any; output: any }; }; /** * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). * Versions are commonly referred to by their handle (for example, `2021-10`). - * */ export type ApiVersion = { /** The human-readable name of the version. */ - displayName: Scalars['String']['output']; + displayName: Scalars["String"]["output"]; /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** * Whether the version is actively supported by Shopify. Supported API versions * are guaranteed to be stable. Unsupported API versions include unstable, * release candidate, and end-of-life versions that are marked as unsupported. * For more information, refer to * [Versioning](https://shopify.dev/api/usage/versioning). - * */ - supported: Scalars['Boolean']['output']; + supported: Scalars["Boolean"]["output"]; }; /** * The input fields for submitting Apple Pay payment method information for checkout. - * */ export type ApplePayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** The data for the Apple Pay wallet. */ - data: Scalars['String']['input']; + data: Scalars["String"]["input"]; /** The header data for the Apple Pay wallet. */ header: ApplePayWalletHeaderInput; /** The last digits of the card used to create the payment. */ - lastDigits?: InputMaybe; + lastDigits?: InputMaybe; /** The signature for the Apple Pay wallet. */ - signature: Scalars['String']['input']; + signature: Scalars["String"]["input"]; /** The version for the Apple Pay wallet. */ - version: Scalars['String']['input']; + version: Scalars["String"]["input"]; }; /** * The input fields for submitting wallet payment method information for checkout. - * */ export type ApplePayWalletHeaderInput = { /** The application data for the Apple Pay wallet. */ - applicationData?: InputMaybe; + applicationData?: InputMaybe; /** The ephemeral public key for the Apple Pay wallet. */ - ephemeralPublicKey: Scalars['String']['input']; + ephemeralPublicKey: Scalars["String"]["input"]; /** The public key hash for the Apple Pay wallet. */ - publicKeyHash: Scalars['String']['input']; + publicKeyHash: Scalars["String"]["input"]; /** The transaction ID for the Apple Pay wallet. */ - transactionId: Scalars['String']['input']; + transactionId: Scalars["String"]["input"]; }; /** Details about the gift card used on the checkout. */ @@ -99,91 +107,90 @@ export type AppliedGiftCard = Node & { */ balanceV2: MoneyV2; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The last characters of the gift card. */ - lastCharacters: Scalars['String']['output']; + lastCharacters: Scalars["String"]["output"]; /** The amount that was applied to the checkout in its currency. */ presentmentAmountUsed: MoneyV2; }; /** An article in an online store blog. */ -export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** - * The article's author. - * @deprecated Use `authorV2` instead. - */ - author: ArticleAuthor; - /** The article's author. */ - authorV2?: Maybe; - /** The blog that the article belongs to. */ - blog: Blog; - /** List of comments posted on the article. */ - comments: CommentConnection; - /** Stripped content of the article, single line with HTML tags removed. */ - content: Scalars['String']['output']; - /** The content of the article, complete with HTML formatting. */ - contentHtml: Scalars['HTML']['output']; - /** Stripped excerpt of the article, single line with HTML tags removed. */ - excerpt?: Maybe; - /** The excerpt of the article, complete with HTML formatting. */ - excerptHtml?: Maybe; - /** A human-friendly unique string for the Article automatically generated from its title. */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** The image associated with the article. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** The date and time when the article was published. */ - publishedAt: Scalars['DateTime']['output']; - /** The article’s SEO information. */ - seo?: Maybe; - /** - * A categorization that a article can be tagged with. - * - */ - tags: Array; - /** The article’s name. */ - title: Scalars['String']['output']; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; -}; - +export type Article = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** + * The article's author. + * @deprecated Use `authorV2` instead. + */ + author: ArticleAuthor; + /** The article's author. */ + authorV2?: Maybe; + /** The blog that the article belongs to. */ + blog: Blog; + /** List of comments posted on the article. */ + comments: CommentConnection; + /** Stripped content of the article, single line with HTML tags removed. */ + content: Scalars["String"]["output"]; + /** The content of the article, complete with HTML formatting. */ + contentHtml: Scalars["HTML"]["output"]; + /** Stripped excerpt of the article, single line with HTML tags removed. */ + excerpt?: Maybe; + /** The excerpt of the article, complete with HTML formatting. */ + excerptHtml?: Maybe; + /** A human-friendly unique string for the Article automatically generated from its title. */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** The image associated with the article. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The date and time when the article was published. */ + publishedAt: Scalars["DateTime"]["output"]; + /** The article’s SEO information. */ + seo?: Maybe; + /** + * A categorization that a article can be tagged with. + */ + tags: Array; + /** The article’s name. */ + title: Scalars["String"]["output"]; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + }; /** An article in an online store blog. */ export type ArticleCommentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleExcerptArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** An article in an online store blog. */ export type ArticleMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An article in an online store blog. */ export type ArticleMetafieldsArgs = { identifiers: Array; @@ -192,20 +199,19 @@ export type ArticleMetafieldsArgs = { /** The author of an article. */ export type ArticleAuthor = { /** The author's bio. */ - bio?: Maybe; + bio?: Maybe; /** The author’s email. */ - email: Scalars['String']['output']; + email: Scalars["String"]["output"]; /** The author's first name. */ - firstName: Scalars['String']['output']; + firstName: Scalars["String"]["output"]; /** The author's last name. */ - lastName: Scalars['String']['output']; + lastName: Scalars["String"]["output"]; /** The author's full name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple Articles. - * */ export type ArticleConnection = { /** A list of edges. */ @@ -218,11 +224,10 @@ export type ArticleConnection = { /** * An auto-generated type which holds one Article and a cursor during pagination. - * */ export type ArticleEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ArticleEdge. */ node: Article; }; @@ -230,43 +235,41 @@ export type ArticleEdge = { /** The set of valid sort keys for the Article query. */ export type ArticleSortKeys = /** Sort by the `author` value. */ - | 'AUTHOR' + | "AUTHOR" /** Sort by the `blog_title` value. */ - | 'BLOG_TITLE' + | "BLOG_TITLE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `published_at` value. */ - | 'PUBLISHED_AT' + | "PUBLISHED_AT" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** Represents a generic custom attribute. */ export type Attribute = { /** Key or name of the attribute. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** Value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** The input fields for an attribute. */ export type AttributeInput = { /** Key or name of the attribute. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** Value of the attribute. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** * Automatic discount applications capture the intentions of a discount that was automatically applied. - * */ export type AutomaticDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -276,7 +279,7 @@ export type AutomaticDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -287,9 +290,8 @@ export type AvailableShippingRates = { * Whether or not the shipping rates are ready. * The `shippingRates` field is `null` when this value is `false`. * This field should be polled until its value becomes `true`. - * */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** The fetched shipping rates. `null` until the `ready` field is `true`. */ shippingRates?: Maybe>; }; @@ -299,7 +301,6 @@ export type AvailableShippingRates = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type BaseCartLine = { /** An attribute associated with the cart line. */ @@ -316,30 +317,27 @@ export type BaseCartLine = { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** * An object with an ID field to support global identification, in accordance with the * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type BaseCartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** * An auto-generated type for paginating through multiple BaseCartLines. - * */ export type BaseCartLineConnection = { /** A list of edges. */ @@ -352,11 +350,10 @@ export type BaseCartLineConnection = { /** * An auto-generated type which holds one BaseCartLine and a cursor during pagination. - * */ export type BaseCartLineEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of BaseCartLineEdge. */ node: BaseCartLine; }; @@ -371,49 +368,44 @@ export type Blog = HasMetafields & Node & OnlineStorePublishable & { authors: Array; /** * A human-friendly unique string for the Blog automatically generated from its title. - * */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The blog's SEO information. */ seo?: Maybe; /** The blogs’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; - /** An online store blog. */ export type BlogArticleByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** An online store blog. */ export type BlogArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** An online store blog. */ export type BlogMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An online store blog. */ export type BlogMetafieldsArgs = { identifiers: Array; @@ -421,7 +413,6 @@ export type BlogMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Blogs. - * */ export type BlogConnection = { /** A list of edges. */ @@ -434,11 +425,10 @@ export type BlogConnection = { /** * An auto-generated type which holds one Blog and a cursor during pagination. - * */ export type BlogEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of BlogEdge. */ node: Blog; }; @@ -446,21 +436,19 @@ export type BlogEdge = { /** The set of valid sort keys for the Blog query. */ export type BlogSortKeys = /** Sort by the `handle` value. */ - | 'HANDLE' + | "HANDLE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** * The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets). - * */ export type Brand = { /** The colors of the store's brand. */ @@ -470,27 +458,25 @@ export type Brand = { /** The store's default logo. */ logo?: Maybe; /** The store's short description. */ - shortDescription?: Maybe; + shortDescription?: Maybe; /** The store's slogan. */ - slogan?: Maybe; + slogan?: Maybe; /** The store's preferred logo for square UI elements. */ squareLogo?: Maybe; }; /** * A group of related colors for the shop's brand. - * */ export type BrandColorGroup = { /** The background color. */ - background?: Maybe; + background?: Maybe; /** The foreground color. */ - foreground?: Maybe; + foreground?: Maybe; }; /** * The colors of the shop's brand. - * */ export type BrandColors = { /** The shop's primary brand colors. */ @@ -502,24 +488,23 @@ export type BrandColors = { /** Card brand, such as Visa or Mastercard, which can be used for payments. */ export type CardBrand = /** American Express. */ - | 'AMERICAN_EXPRESS' + | "AMERICAN_EXPRESS" /** Diners Club. */ - | 'DINERS_CLUB' + | "DINERS_CLUB" /** Discover. */ - | 'DISCOVER' + | "DISCOVER" /** JCB. */ - | 'JCB' + | "JCB" /** Mastercard. */ - | 'MASTERCARD' + | "MASTERCARD" /** Visa. */ - | 'VISA'; + | "VISA"; /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type Cart = HasMetafields & Node & { /** An attribute associated with the cart. */ @@ -529,20 +514,18 @@ export type Cart = HasMetafields & Node & { /** Information about the buyer that's interacting with the cart. */ buyerIdentity: CartBuyerIdentity; /** The URL of the checkout for the cart. */ - checkoutUrl: Scalars['URL']['output']; + checkoutUrl: Scalars["URL"]["output"]; /** * The estimated costs that the buyer will pay at checkout. The costs are subject * to change and changes will be reflected at checkout. The `cost` field uses the * `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ cost: CartCost; /** The date and time when the cart was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** * The delivery groups available for the cart, based on the buyer identity default * delivery address preference or the default address of the logged-in customer. - * */ deliveryGroups: CartDeliveryGroupConnection; /** The discounts that have been applied to the entire cart. */ @@ -559,7 +542,7 @@ export type Cart = HasMetafields & Node & { */ estimatedCost: CartEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** A list of lines containing information about the items the customer intends to purchase. */ lines: BaseCartLineConnection; /** Returns a metafield found by namespace and key. */ @@ -567,77 +550,67 @@ export type Cart = HasMetafields & Node & { /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A note that's associated with the cart. For example, the note can be a personalized message to the buyer. */ - note?: Maybe; + note?: Maybe; /** The total number of items in the cart. */ - totalQuantity: Scalars['Int']['output']; + totalQuantity: Scalars["Int"]["output"]; /** The date and time when the cart was updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartDeliveryGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A cart represents the merchandise that a buyer intends to purchase, * and the estimated cost associated with the cart. Learn how to * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * during a customer's session. - * */ export type CartMetafieldsArgs = { identifiers: Array; @@ -656,7 +629,7 @@ export type CartAutomaticDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Represents information about the buyer that is interacting with the cart. */ @@ -669,19 +642,17 @@ export type CartBuyerIdentity = { * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. - * */ deliveryAddressPreferences: Array; /** The email address of the buyer that's interacting with the cart. */ - email?: Maybe; + email?: Maybe; /** The phone number of the buyer that's interacting with the cart. */ - phone?: Maybe; + phone?: Maybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. - * */ - walletPreferences: Array; + walletPreferences: Array; }; /** @@ -689,31 +660,28 @@ export type CartBuyerIdentity = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. - * */ export type CartBuyerIdentityInput = { /** The country where the buyer is located. */ countryCode?: InputMaybe; /** The access token used to identify the customer associated with the cart. */ - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; /** * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. * The rank of the preferences is determined by the order of the addresses in the array. Preferences * can be used to populate relevant fields in the checkout flow. - * */ deliveryAddressPreferences?: InputMaybe>; /** The email address of the buyer that is interacting with the cart. */ - email?: InputMaybe; + email?: InputMaybe; /** The phone number of the buyer that is interacting with the cart. */ - phone?: InputMaybe; + phone?: InputMaybe; /** * A set of wallet preferences tied to the buyer that is interacting with the cart. * Preferences can be used to populate relevant payment fields in the checkout flow. * Accepted value: `["shop_pay"]`. - * */ - walletPreferences?: InputMaybe>; + walletPreferences?: InputMaybe>; }; /** Return type for `cartBuyerIdentityUpdate` mutation. */ @@ -726,20 +694,17 @@ export type CartBuyerIdentityUpdatePayload = { /** * Represents how credit card details are provided for a direct payment. - * */ -export type CartCardSource = - /** +export type CartCardSource = /** * The credit card was provided by a third party and vaulted on their system. * Using this value requires a separate permission from Shopify. - * */ - | 'SAVED_CREDIT_CARD'; + "SAVED_CREDIT_CARD"; /** The discount that has been applied to the cart line using a discount code. */ export type CartCodeDiscountAllocation = CartDiscountAllocation & { /** The code used to apply the discount. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; }; @@ -752,45 +717,48 @@ export type CartCompletionActionRequired = { /** The action required to complete the cart completion attempt. */ action?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; }; /** The result of a cart completion attempt. */ -export type CartCompletionAttemptResult = CartCompletionActionRequired | CartCompletionFailed | CartCompletionProcessing | CartCompletionSuccess; +export type CartCompletionAttemptResult = + | CartCompletionActionRequired + | CartCompletionFailed + | CartCompletionProcessing + | CartCompletionSuccess; /** A failed completion to checkout a cart. */ export type CartCompletionFailed = { /** The errors that caused the checkout to fail. */ errors: Array; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; }; /** A cart checkout completion that's still processing. */ export type CartCompletionProcessing = { /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** The number of milliseconds to wait before polling again. */ - pollDelay: Scalars['Int']['output']; + pollDelay: Scalars["Int"]["output"]; }; /** A successful completion to checkout a cart and a created order. */ export type CartCompletionSuccess = { /** The date and time when the job completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The ID of the cart completion attempt. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** The ID of the order that's created in Shopify. */ - orderId: Scalars['ID']['output']; + orderId: Scalars["ID"]["output"]; /** The URL of the order confirmation in Shopify. */ - orderUrl: Scalars['URL']['output']; + orderUrl: Scalars["URL"]["output"]; }; /** * The costs that the buyer will pay at checkout. * The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ export type CartCost = { /** @@ -798,25 +766,24 @@ export type CartCost = { * checkout. The checkout charge amount doesn't include any deferred payments * that'll be paid at a later date. If the cart has no deferred payments, then * the checkout charge amount is equivalent to `subtotalAmount`. - * */ checkoutChargeAmount: MoneyV2; /** The amount, before taxes and cart-level discounts, for the customer to pay. */ subtotalAmount: MoneyV2; /** Whether the subtotal amount is estimated. */ - subtotalAmountEstimated: Scalars['Boolean']['output']; + subtotalAmountEstimated: Scalars["Boolean"]["output"]; /** The total amount for the customer to pay. */ totalAmount: MoneyV2; /** Whether the total amount is estimated. */ - totalAmountEstimated: Scalars['Boolean']['output']; + totalAmountEstimated: Scalars["Boolean"]["output"]; /** The duty amount for the customer to pay at checkout. */ totalDutyAmount?: Maybe; /** Whether the total duty amount is estimated. */ - totalDutyAmountEstimated: Scalars['Boolean']['output']; + totalDutyAmountEstimated: Scalars["Boolean"]["output"]; /** The tax amount for the customer to pay at checkout. */ totalTaxAmount?: Maybe; /** Whether the total tax amount is estimated. */ - totalTaxAmountEstimated: Scalars['Boolean']['output']; + totalTaxAmountEstimated: Scalars["Boolean"]["output"]; }; /** Return type for `cartCreate` mutation. */ @@ -832,7 +799,7 @@ export type CartCustomDiscountAllocation = CartDiscountAllocation & { /** The discounted amount that has been applied to the cart line. */ discountedAmount: MoneyV2; /** The title of the allocated discount. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Information about the options available for one or more line items to be delivered to a specific address. */ @@ -844,24 +811,22 @@ export type CartDeliveryGroup = { /** The delivery options available for the delivery group. */ deliveryOptions: Array; /** The ID for the delivery group. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The selected delivery option for the delivery group. */ selectedDeliveryOption?: Maybe; }; - /** Information about the options available for one or more line items to be delivered to a specific address. */ export type CartDeliveryGroupCartLinesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple CartDeliveryGroups. - * */ export type CartDeliveryGroupConnection = { /** A list of edges. */ @@ -874,11 +839,10 @@ export type CartDeliveryGroupConnection = { /** * An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination. - * */ export type CartDeliveryGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CartDeliveryGroupEdge. */ node: CartDeliveryGroup; }; @@ -886,22 +850,21 @@ export type CartDeliveryGroupEdge = { /** Information about a delivery option. */ export type CartDeliveryOption = { /** The code of the delivery option. */ - code?: Maybe; + code?: Maybe; /** The method for the delivery option. */ deliveryMethodType: DeliveryMethodType; /** The description of the delivery option. */ - description?: Maybe; + description?: Maybe; /** The estimated cost for the delivery option. */ estimatedCost: MoneyV2; /** The unique identifier of the delivery option. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** The title of the delivery option. */ - title?: Maybe; + title?: Maybe; }; /** * The input fields for submitting direct payment method information for checkout. - * */ export type CartDirectPaymentMethodInput = { /** The customer's billing address. */ @@ -909,7 +872,7 @@ export type CartDirectPaymentMethodInput = { /** The source of the credit card payment. */ cardSource?: InputMaybe; /** The session ID for the direct payment method used to create the payment. */ - sessionId: Scalars['String']['input']; + sessionId: Scalars["String"]["input"]; }; /** The discounts that have been applied to the cart line. */ @@ -921,9 +884,9 @@ export type CartDiscountAllocation = { /** The discount codes applied to the cart. */ export type CartDiscountCode = { /** Whether the discount code is applicable to the cart's current contents. */ - applicable: Scalars['Boolean']['output']; + applicable: Scalars["Boolean"]["output"]; /** The code for the discount. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; }; /** Return type for `cartDiscountCodesUpdate` mutation. */ @@ -937,27 +900,27 @@ export type CartDiscountCodesUpdatePayload = { /** Possible error codes that can be returned by `CartUserError`. */ export type CartErrorCode = /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Delivery group was not found in cart. */ - | 'INVALID_DELIVERY_GROUP' + | "INVALID_DELIVERY_GROUP" /** Delivery option was not valid. */ - | 'INVALID_DELIVERY_OPTION' + | "INVALID_DELIVERY_OPTION" /** Merchandise line was not found in cart. */ - | 'INVALID_MERCHANDISE_LINE' + | "INVALID_MERCHANDISE_LINE" /** The metafields were not valid. */ - | 'INVALID_METAFIELDS' + | "INVALID_METAFIELDS" /** The payment wasn't valid. */ - | 'INVALID_PAYMENT' + | "INVALID_PAYMENT" /** Cannot update payment on an empty cart */ - | 'INVALID_PAYMENT_EMPTY_CART' + | "INVALID_PAYMENT_EMPTY_CART" /** The input value should be less than the maximum value allowed. */ - | 'LESS_THAN' + | "LESS_THAN" /** Missing discount code. */ - | 'MISSING_DISCOUNT_CODE' + | "MISSING_DISCOUNT_CODE" /** Missing note. */ - | 'MISSING_NOTE' + | "MISSING_NOTE" /** The payment method is not supported. */ - | 'PAYMENT_METHOD_NOT_SUPPORTED'; + | "PAYMENT_METHOD_NOT_SUPPORTED"; /** * The estimated costs that the buyer will pay at checkout. @@ -965,7 +928,6 @@ export type CartErrorCode = * [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) * to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). - * */ export type CartEstimatedCost = { /** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`. */ @@ -982,7 +944,6 @@ export type CartEstimatedCost = { /** * The input fields for submitting a billing address without a selected payment method. - * */ export type CartFreePaymentMethodInput = { /** The customer's billing address. */ @@ -997,40 +958,35 @@ export type CartInput = { * The customer associated with the cart. Used to determine [international pricing] * (https://shopify.dev/custom-storefronts/internationalization/international-pricing). * Buyer identity should match the customer's shipping address. - * */ buyerIdentity?: InputMaybe; /** * The case-insensitive discount codes that the customer added at checkout. - * */ - discountCodes?: InputMaybe>; + discountCodes?: InputMaybe>; /** A list of merchandise lines to add to the cart. */ lines?: InputMaybe>; /** The metafields to associate with this cart. */ metafields?: InputMaybe>; /** * A note that's associated with the cart. For example, the note can be a personalized message to the buyer. - * */ - note?: InputMaybe; + note?: InputMaybe; }; /** The input fields for a cart metafield value to set. */ export type CartInputMetafieldInput = { /** The key name of the metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). - * */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. - * */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents information about the merchandise in the cart. */ @@ -1049,19 +1005,18 @@ export type CartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** Represents information about the merchandise in the cart. */ export type CartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** The cost of the merchandise line that the buyer will pay at checkout. */ @@ -1078,7 +1033,6 @@ export type CartLineCost = { /** * The estimated cost of the merchandise line that the buyer will pay at checkout. - * */ export type CartLineEstimatedCost = { /** The amount of the merchandise line. */ @@ -1096,11 +1050,11 @@ export type CartLineInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise that the buyer intends to purchase. */ - merchandiseId: Scalars['ID']['input']; + merchandiseId: Scalars["ID"]["input"]; /** The quantity of the merchandise. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** The input fields to update a line item on a cart. */ @@ -1108,13 +1062,13 @@ export type CartLineUpdateInput = { /** An array of key-value pairs that contains additional information about the merchandise line. */ attributes?: InputMaybe>; /** The ID of the merchandise line. */ - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; /** The ID of the merchandise for the line item. */ - merchandiseId?: InputMaybe; + merchandiseId?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The ID of the selling plan that the merchandise is being purchased with. */ - sellingPlanId?: InputMaybe; + sellingPlanId?: InputMaybe; }; /** Return type for `cartLinesAdd` mutation. */ @@ -1146,17 +1100,16 @@ export type CartMetafieldDeleteInput = { /** * The key name of the cart metafield. Can either be a composite key (`namespace.key`) or a simple key * that relies on the default app-reserved namespace. - * */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The ID of the cart resource. */ - ownerId: Scalars['ID']['input']; + ownerId: Scalars["ID"]["input"]; }; /** Return type for `cartMetafieldDelete` mutation. */ export type CartMetafieldDeletePayload = { /** The ID of the deleted cart metafield. */ - deletedId?: Maybe; + deletedId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -1164,20 +1117,18 @@ export type CartMetafieldDeletePayload = { /** The input fields for a cart metafield value to set. */ export type CartMetafieldsSetInput = { /** The key name of the cart metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The ID of the cart resource. */ - ownerId: Scalars['ID']['input']; + ownerId: Scalars["ID"]["input"]; /** * The type of data that the cart metafield stores. * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). - * */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; /** * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. - * */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Return type for `cartMetafieldsSet` mutation. */ @@ -1198,31 +1149,26 @@ export type CartNoteUpdatePayload = { /** * The input fields for updating the payment method that will be used to checkout. - * */ export type CartPaymentInput = { /** The amount that the customer will be charged at checkout. */ amount: MoneyInput; /** * The input fields to use when checking out a cart with a direct payment method (like a credit card). - * */ directPaymentMethod?: InputMaybe; /** * The input fields to use to checkout a cart without providing a payment method. * Use this payment method input if the total cost of the cart is 0. - * */ freePaymentMethod?: InputMaybe; /** * An ID of the order placed on the originating platform. * Note that this value doesn't correspond to the Shopify Order ID. - * */ - sourceIdentifier?: InputMaybe; + sourceIdentifier?: InputMaybe; /** * The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay). - * */ walletPaymentMethod?: InputMaybe; }; @@ -1237,13 +1183,12 @@ export type CartPaymentUpdatePayload = { /** * The input fields for updating the selected delivery options for a delivery group. - * */ export type CartSelectedDeliveryOptionInput = { /** The ID of the cart delivery group. */ - deliveryGroupId: Scalars['ID']['input']; + deliveryGroupId: Scalars["ID"]["input"]; /** The handle of the selected delivery option. */ - deliveryOptionHandle: Scalars['String']['input']; + deliveryOptionHandle: Scalars["String"]["input"]; }; /** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */ @@ -1263,21 +1208,24 @@ export type CartSubmitForCompletionPayload = { }; /** The result of cart submit completion. */ -export type CartSubmitForCompletionResult = SubmitAlreadyAccepted | SubmitFailed | SubmitSuccess | SubmitThrottled; +export type CartSubmitForCompletionResult = + | SubmitAlreadyAccepted + | SubmitFailed + | SubmitSuccess + | SubmitThrottled; /** Represents an error that happens during execution of a cart mutation. */ export type CartUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** * The input fields for submitting wallet payment method information for checkout. - * */ export type CartWalletPaymentMethodInput = { /** The payment method information for the Apple Pay wallet. */ @@ -1294,15 +1242,14 @@ export type Checkout = Node & { * The available shipping rates for this Checkout. * Should only be used when checkout `requiresShipping` is `true` and * the shipping address is valid. - * */ availableShippingRates?: Maybe; /** The identity of the customer associated with the checkout. */ buyerIdentity: CheckoutBuyerIdentity; /** The date and time when the checkout was completed. */ - completedAt?: Maybe; + completedAt?: Maybe; /** The date and time when the checkout was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The currency code for the checkout. */ currencyCode: CurrencyCode; /** A list of extra information that's added to the checkout. */ @@ -1310,19 +1257,19 @@ export type Checkout = Node & { /** Discounts that have been applied on the checkout. */ discountApplications: DiscountApplicationConnection; /** The email attached to this checkout. */ - email?: Maybe; + email?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems: CheckoutLineItemConnection; /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ lineItemsSubtotalPrice: MoneyV2; /** The note associated with the checkout. */ - note?: Maybe; + note?: Maybe; /** The resulting order from a paid checkout. */ order?: Maybe; /** The Order Status Page for this Checkout, null when checkout isn't completed. */ - orderStatusUrl?: Maybe; + orderStatusUrl?: Maybe; /** The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards. */ paymentDue: MoneyV2; /** @@ -1335,16 +1282,14 @@ export type Checkout = Node & { * have asynchronous operations that can take time to finish. If you want * to complete a checkout or ensure all the fields are populated and up to * date, polling is required until the value is true. - * */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** States whether or not the fulfillment requires shipping. */ - requiresShipping: Scalars['Boolean']['output']; + requiresShipping: Scalars["Boolean"]["output"]; /** The shipping address to where the line items will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. - * */ shippingDiscountAllocations: Array; /** Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object. */ @@ -1357,9 +1302,9 @@ export type Checkout = Node & { */ subtotalPriceV2: MoneyV2; /** Whether the checkout is tax exempt. */ - taxExempt: Scalars['Boolean']['output']; + taxExempt: Scalars["Boolean"]["output"]; /** Whether taxes are included in the line item and shipping line prices. */ - taxesIncluded: Scalars['Boolean']['output']; + taxesIncluded: Scalars["Boolean"]["output"]; /** The sum of all the duties applied to the line items in the checkout. */ totalDuties?: Maybe; /** The sum of all the prices of all the items in the checkout, including taxes and duties. */ @@ -1377,29 +1322,27 @@ export type Checkout = Node & { */ totalTaxV2: MoneyV2; /** The date and time when the checkout was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** The url pointing to the checkout accessible from the web. */ - webUrl: Scalars['URL']['output']; + webUrl: Scalars["URL"]["output"]; }; - /** A container for all the information required to checkout items and pay. */ export type CheckoutDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** A container for all the information required to checkout items and pay. */ export type CheckoutLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** The input fields required to update a checkout's attributes. */ @@ -1409,13 +1352,12 @@ export type CheckoutAttributesUpdateV2Input = { * The required attributes are city, province, and country. * Full validation of the addresses is still done at completion time. Defaults to `false` with * each operation. - * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; }; /** Return type for `checkoutAttributesUpdateV2` mutation. */ @@ -1443,7 +1385,6 @@ export type CheckoutBuyerIdentityInput = { * The country code of one of the shop's * [enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup). * For example, `CA`. Including this field creates a checkout in the specified country's currency. - * */ countryCode: CountryCode; }; @@ -1497,19 +1438,18 @@ export type CheckoutCreateInput = { * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. * The required attributes are city, province, and country. * Full validation of addresses is still done at completion time. Defaults to `null`. - * */ - allowPartialAddresses?: InputMaybe; + allowPartialAddresses?: InputMaybe; /** The identity of the customer associated with the checkout. */ buyerIdentity?: InputMaybe; /** A list of extra information that's added to the checkout. */ customAttributes?: InputMaybe>; /** The email with which the customer wants to checkout. */ - email?: InputMaybe; + email?: InputMaybe; /** A list of line item objects, each one containing information about an item in the checkout. */ lineItems?: InputMaybe>; /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: InputMaybe; + note?: InputMaybe; /** The shipping address to where the line items will be shipped. */ shippingAddress?: InputMaybe; }; @@ -1521,7 +1461,7 @@ export type CheckoutCreatePayload = { /** The list of errors that occurred from executing the mutation. */ checkoutUserErrors: Array; /** The checkout queue token. Available only to selected stores. */ - queueToken?: Maybe; + queueToken?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `checkoutUserErrors` instead. @@ -1599,97 +1539,97 @@ export type CheckoutEmailUpdateV2Payload = { /** Possible error codes that can be returned by `CheckoutUserError`. */ export type CheckoutErrorCode = /** Checkout is already completed. */ - | 'ALREADY_COMPLETED' + | "ALREADY_COMPLETED" /** Input email contains an invalid domain name. */ - | 'BAD_DOMAIN' + | "BAD_DOMAIN" /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** Cart does not meet discount requirements notice. */ - | 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE' + | "CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE" /** Customer already used once per customer discount notice. */ - | 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE' + | "CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE" /** Discount already applied. */ - | 'DISCOUNT_ALREADY_APPLIED' + | "DISCOUNT_ALREADY_APPLIED" /** Discount code isn't working right now. Please contact us for help. */ - | 'DISCOUNT_CODE_APPLICATION_FAILED' + | "DISCOUNT_CODE_APPLICATION_FAILED" /** Discount disabled. */ - | 'DISCOUNT_DISABLED' + | "DISCOUNT_DISABLED" /** Discount expired. */ - | 'DISCOUNT_EXPIRED' + | "DISCOUNT_EXPIRED" /** Discount limit reached. */ - | 'DISCOUNT_LIMIT_REACHED' + | "DISCOUNT_LIMIT_REACHED" /** Discount not found. */ - | 'DISCOUNT_NOT_FOUND' + | "DISCOUNT_NOT_FOUND" /** Checkout is already completed. */ - | 'EMPTY' + | "EMPTY" /** Queue token has expired. */ - | 'EXPIRED_QUEUE_TOKEN' + | "EXPIRED_QUEUE_TOKEN" /** Gift card has already been applied. */ - | 'GIFT_CARD_ALREADY_APPLIED' + | "GIFT_CARD_ALREADY_APPLIED" /** Gift card code is invalid. */ - | 'GIFT_CARD_CODE_INVALID' + | "GIFT_CARD_CODE_INVALID" /** Gift card currency does not match checkout currency. */ - | 'GIFT_CARD_CURRENCY_MISMATCH' + | "GIFT_CARD_CURRENCY_MISMATCH" /** Gift card has no funds left. */ - | 'GIFT_CARD_DEPLETED' + | "GIFT_CARD_DEPLETED" /** Gift card is disabled. */ - | 'GIFT_CARD_DISABLED' + | "GIFT_CARD_DISABLED" /** Gift card is expired. */ - | 'GIFT_CARD_EXPIRED' + | "GIFT_CARD_EXPIRED" /** Gift card was not found. */ - | 'GIFT_CARD_NOT_FOUND' + | "GIFT_CARD_NOT_FOUND" /** Gift card cannot be applied to a checkout that contains a gift card. */ - | 'GIFT_CARD_UNUSABLE' + | "GIFT_CARD_UNUSABLE" /** The input value should be greater than or equal to the minimum value allowed. */ - | 'GREATER_THAN_OR_EQUAL_TO' + | "GREATER_THAN_OR_EQUAL_TO" /** Higher value discount applied. */ - | 'HIGHER_VALUE_DISCOUNT_APPLIED' + | "HIGHER_VALUE_DISCOUNT_APPLIED" /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Cannot specify country and presentment currency code. */ - | 'INVALID_COUNTRY_AND_CURRENCY' + | "INVALID_COUNTRY_AND_CURRENCY" /** Input Zip is invalid for country provided. */ - | 'INVALID_FOR_COUNTRY' + | "INVALID_FOR_COUNTRY" /** Input Zip is invalid for country and province provided. */ - | 'INVALID_FOR_COUNTRY_AND_PROVINCE' + | "INVALID_FOR_COUNTRY_AND_PROVINCE" /** Invalid province in country. */ - | 'INVALID_PROVINCE_IN_COUNTRY' + | "INVALID_PROVINCE_IN_COUNTRY" /** Queue token is invalid. */ - | 'INVALID_QUEUE_TOKEN' + | "INVALID_QUEUE_TOKEN" /** Invalid region in country. */ - | 'INVALID_REGION_IN_COUNTRY' + | "INVALID_REGION_IN_COUNTRY" /** Invalid state in country. */ - | 'INVALID_STATE_IN_COUNTRY' + | "INVALID_STATE_IN_COUNTRY" /** The input value should be less than the maximum value allowed. */ - | 'LESS_THAN' + | "LESS_THAN" /** The input value should be less than or equal to the maximum value allowed. */ - | 'LESS_THAN_OR_EQUAL_TO' + | "LESS_THAN_OR_EQUAL_TO" /** Line item was not found in checkout. */ - | 'LINE_ITEM_NOT_FOUND' + | "LINE_ITEM_NOT_FOUND" /** Checkout is locked. */ - | 'LOCKED' + | "LOCKED" /** Maximum number of discount codes limit reached. */ - | 'MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED' + | "MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED" /** Missing payment input. */ - | 'MISSING_PAYMENT_INPUT' + | "MISSING_PAYMENT_INPUT" /** Not enough in stock. */ - | 'NOT_ENOUGH_IN_STOCK' + | "NOT_ENOUGH_IN_STOCK" /** Input value is not supported. */ - | 'NOT_SUPPORTED' + | "NOT_SUPPORTED" /** The input value needs to be blank. */ - | 'PRESENT' + | "PRESENT" /** Product is not published for this customer. */ - | 'PRODUCT_NOT_AVAILABLE' + | "PRODUCT_NOT_AVAILABLE" /** Shipping rate expired. */ - | 'SHIPPING_RATE_EXPIRED' + | "SHIPPING_RATE_EXPIRED" /** Throttled during checkout. */ - | 'THROTTLED_DURING_CHECKOUT' + | "THROTTLED_DURING_CHECKOUT" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The amount of the payment does not match the value to be paid. */ - | 'TOTAL_PRICE_MISMATCH' + | "TOTAL_PRICE_MISMATCH" /** Unable to apply discount. */ - | 'UNABLE_TO_APPLY'; + | "UNABLE_TO_APPLY"; /** Return type for `checkoutGiftCardRemoveV2` mutation. */ export type CheckoutGiftCardRemoveV2Payload = { @@ -1724,11 +1664,11 @@ export type CheckoutLineItem = Node & { /** The discounts that have been allocated onto the checkout line item by discount applications. */ discountAllocations: Array; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The quantity of the line item. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** Title of the line item. Defaults to the product's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Unit price of the line item. */ unitPrice?: Maybe; /** Product variant of the line item. */ @@ -1737,7 +1677,6 @@ export type CheckoutLineItem = Node & { /** * An auto-generated type for paginating through multiple CheckoutLineItems. - * */ export type CheckoutLineItemConnection = { /** A list of edges. */ @@ -1750,11 +1689,10 @@ export type CheckoutLineItemConnection = { /** * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. - * */ export type CheckoutLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CheckoutLineItemEdge. */ node: CheckoutLineItem; }; @@ -1764,9 +1702,9 @@ export type CheckoutLineItemInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The quantity of the line item. */ - quantity: Scalars['Int']['input']; + quantity: Scalars["Int"]["input"]; /** The ID of the product variant for the line item. */ - variantId: Scalars['ID']['input']; + variantId: Scalars["ID"]["input"]; }; /** The input fields to update a line item on the checkout. */ @@ -1774,11 +1712,11 @@ export type CheckoutLineItemUpdateInput = { /** Extra information in the form of an array of Key-Value pairs about the line item. */ customAttributes?: InputMaybe>; /** The ID of the line item. */ - id?: InputMaybe; + id?: InputMaybe; /** The quantity of the line item. */ - quantity?: InputMaybe; + quantity?: InputMaybe; /** The variant ID of the line item. */ - variantId?: InputMaybe; + variantId?: InputMaybe; }; /** Return type for `checkoutLineItemsAdd` mutation. */ @@ -1859,99 +1797,93 @@ export type CheckoutUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ -export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** Stripped description of the collection, single line with HTML tags removed. */ - description: Scalars['String']['output']; - /** The description of the collection, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML']['output']; - /** - * A human-friendly unique string for the collection automatically generated from its title. - * Limit of 255 characters. - * - */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** Image associated with the collection. */ - image?: Maybe; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of products in the collection. */ - products: ProductConnection; - /** The collection's SEO information. */ - seo: Seo; - /** The collection’s name. Limit of 255 characters. */ - title: Scalars['String']['output']; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** The date and time when the collection was last modified. */ - updatedAt: Scalars['DateTime']['output']; -}; - +export type Collection = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** Stripped description of the collection, single line with HTML tags removed. */ + description: Scalars["String"]["output"]; + /** The description of the collection, complete with HTML formatting. */ + descriptionHtml: Scalars["HTML"]["output"]; + /** + * A human-friendly unique string for the collection automatically generated from its title. + * Limit of 255 characters. + */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** Image associated with the collection. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of products in the collection. */ + products: ProductConnection; + /** The collection's SEO information. */ + seo: Seo; + /** The collection’s name. Limit of 255 characters. */ + title: Scalars["String"]["output"]; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** The date and time when the collection was last modified. */ + updatedAt: Scalars["DateTime"]["output"]; + }; /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionMetafieldsArgs = { identifiers: Array; }; - /** * A collection represents a grouping of products that a shop owner can create to * organize them or make their shops easier to browse. - * */ export type CollectionProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** * An auto-generated type for paginating through multiple Collections. - * */ export type CollectionConnection = { /** A list of edges. */ @@ -1961,16 +1893,15 @@ export type CollectionConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Collections. */ - totalCount: Scalars['UnsignedInt64']['output']; + totalCount: Scalars["UnsignedInt64"]["output"]; }; /** * An auto-generated type which holds one Collection and a cursor during pagination. - * */ export type CollectionEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CollectionEdge. */ node: Collection; }; @@ -1978,47 +1909,44 @@ export type CollectionEdge = { /** The set of valid sort keys for the Collection query. */ export type CollectionSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** A comment on an article. */ export type Comment = Node & { /** The comment’s author. */ author: CommentAuthor; /** Stripped content of the comment, single line with HTML tags removed. */ - content: Scalars['String']['output']; + content: Scalars["String"]["output"]; /** The content of the comment, complete with HTML formatting. */ - contentHtml: Scalars['HTML']['output']; + contentHtml: Scalars["HTML"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; - /** A comment on an article. */ export type CommentContentArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; /** The author of a comment. */ export type CommentAuthor = { /** The author's email. */ - email: Scalars['String']['output']; + email: Scalars["String"]["output"]; /** The author’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple Comments. - * */ export type CommentConnection = { /** A list of edges. */ @@ -2031,11 +1959,10 @@ export type CommentConnection = { /** * An auto-generated type which holds one Comment and a cursor during pagination. - * */ export type CommentEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of CommentEdge. */ node: Comment; }; @@ -2043,7 +1970,7 @@ export type CommentEdge = { /** The action for the 3DS payment redirect. */ export type CompletePaymentChallenge = { /** The URL for the 3DS payment redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; /** An error that occurred during a cart completion attempt. */ @@ -2051,24 +1978,24 @@ export type CompletionError = { /** The error code. */ code: CompletionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during a cart completion attempt. */ export type CompletionErrorCode = - | 'ERROR' - | 'INVENTORY_RESERVATION_ERROR' - | 'PAYMENT_AMOUNT_TOO_SMALL' - | 'PAYMENT_CALL_ISSUER' - | 'PAYMENT_CARD_DECLINED' - | 'PAYMENT_ERROR' - | 'PAYMENT_GATEWAY_NOT_ENABLED_ERROR' - | 'PAYMENT_INSUFFICIENT_FUNDS' - | 'PAYMENT_INVALID_BILLING_ADDRESS' - | 'PAYMENT_INVALID_CREDIT_CARD' - | 'PAYMENT_INVALID_CURRENCY' - | 'PAYMENT_INVALID_PAYMENT_METHOD' - | 'PAYMENT_TRANSIENT_ERROR'; + | "ERROR" + | "INVENTORY_RESERVATION_ERROR" + | "PAYMENT_AMOUNT_TOO_SMALL" + | "PAYMENT_CALL_ISSUER" + | "PAYMENT_CARD_DECLINED" + | "PAYMENT_ERROR" + | "PAYMENT_GATEWAY_NOT_ENABLED_ERROR" + | "PAYMENT_INSUFFICIENT_FUNDS" + | "PAYMENT_INVALID_BILLING_ADDRESS" + | "PAYMENT_INVALID_CREDIT_CARD" + | "PAYMENT_INVALID_CURRENCY" + | "PAYMENT_INVALID_PAYMENT_METHOD" + | "PAYMENT_TRANSIENT_ERROR"; /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLine = BaseCartLine & Node & { @@ -2086,21 +2013,20 @@ export type ComponentizableCartLine = BaseCartLine & Node & { */ estimatedCost: CartLineEstimatedCost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The components of the line item. */ lineComponents: Array; /** The merchandise that the buyer intends to purchase. */ merchandise: Merchandise; /** The quantity of the merchandise that the customer intends to purchase. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ sellingPlanAllocation?: Maybe; }; - /** Represents information about the grouped merchandise in the cart. */ export type ComponentizableCartLineAttributeArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** A country. */ @@ -2114,7 +2040,7 @@ export type Country = { /** The market that includes this country. */ market?: Maybe; /** The name of the country. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The unit system used in the country. */ unitSystem: UnitSystem; }; @@ -2124,982 +2050,974 @@ export type Country = { * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision * of another country. For example, the territories associated with Spain are represented by the country code `ES`, * and the territories associated with the United States of America are represented by the country code `US`. - * */ export type CountryCode = /** Ascension Island. */ - | 'AC' + | "AC" /** Andorra. */ - | 'AD' + | "AD" /** United Arab Emirates. */ - | 'AE' + | "AE" /** Afghanistan. */ - | 'AF' + | "AF" /** Antigua & Barbuda. */ - | 'AG' + | "AG" /** Anguilla. */ - | 'AI' + | "AI" /** Albania. */ - | 'AL' + | "AL" /** Armenia. */ - | 'AM' + | "AM" /** Netherlands Antilles. */ - | 'AN' + | "AN" /** Angola. */ - | 'AO' + | "AO" /** Argentina. */ - | 'AR' + | "AR" /** Austria. */ - | 'AT' + | "AT" /** Australia. */ - | 'AU' + | "AU" /** Aruba. */ - | 'AW' + | "AW" /** Åland Islands. */ - | 'AX' + | "AX" /** Azerbaijan. */ - | 'AZ' + | "AZ" /** Bosnia & Herzegovina. */ - | 'BA' + | "BA" /** Barbados. */ - | 'BB' + | "BB" /** Bangladesh. */ - | 'BD' + | "BD" /** Belgium. */ - | 'BE' + | "BE" /** Burkina Faso. */ - | 'BF' + | "BF" /** Bulgaria. */ - | 'BG' + | "BG" /** Bahrain. */ - | 'BH' + | "BH" /** Burundi. */ - | 'BI' + | "BI" /** Benin. */ - | 'BJ' + | "BJ" /** St. Barthélemy. */ - | 'BL' + | "BL" /** Bermuda. */ - | 'BM' + | "BM" /** Brunei. */ - | 'BN' + | "BN" /** Bolivia. */ - | 'BO' + | "BO" /** Caribbean Netherlands. */ - | 'BQ' + | "BQ" /** Brazil. */ - | 'BR' + | "BR" /** Bahamas. */ - | 'BS' + | "BS" /** Bhutan. */ - | 'BT' + | "BT" /** Bouvet Island. */ - | 'BV' + | "BV" /** Botswana. */ - | 'BW' + | "BW" /** Belarus. */ - | 'BY' + | "BY" /** Belize. */ - | 'BZ' + | "BZ" /** Canada. */ - | 'CA' + | "CA" /** Cocos (Keeling) Islands. */ - | 'CC' + | "CC" /** Congo - Kinshasa. */ - | 'CD' + | "CD" /** Central African Republic. */ - | 'CF' + | "CF" /** Congo - Brazzaville. */ - | 'CG' + | "CG" /** Switzerland. */ - | 'CH' + | "CH" /** Côte d’Ivoire. */ - | 'CI' + | "CI" /** Cook Islands. */ - | 'CK' + | "CK" /** Chile. */ - | 'CL' + | "CL" /** Cameroon. */ - | 'CM' + | "CM" /** China. */ - | 'CN' + | "CN" /** Colombia. */ - | 'CO' + | "CO" /** Costa Rica. */ - | 'CR' + | "CR" /** Cuba. */ - | 'CU' + | "CU" /** Cape Verde. */ - | 'CV' + | "CV" /** Curaçao. */ - | 'CW' + | "CW" /** Christmas Island. */ - | 'CX' + | "CX" /** Cyprus. */ - | 'CY' + | "CY" /** Czechia. */ - | 'CZ' + | "CZ" /** Germany. */ - | 'DE' + | "DE" /** Djibouti. */ - | 'DJ' + | "DJ" /** Denmark. */ - | 'DK' + | "DK" /** Dominica. */ - | 'DM' + | "DM" /** Dominican Republic. */ - | 'DO' + | "DO" /** Algeria. */ - | 'DZ' + | "DZ" /** Ecuador. */ - | 'EC' + | "EC" /** Estonia. */ - | 'EE' + | "EE" /** Egypt. */ - | 'EG' + | "EG" /** Western Sahara. */ - | 'EH' + | "EH" /** Eritrea. */ - | 'ER' + | "ER" /** Spain. */ - | 'ES' + | "ES" /** Ethiopia. */ - | 'ET' + | "ET" /** Finland. */ - | 'FI' + | "FI" /** Fiji. */ - | 'FJ' + | "FJ" /** Falkland Islands. */ - | 'FK' + | "FK" /** Faroe Islands. */ - | 'FO' + | "FO" /** France. */ - | 'FR' + | "FR" /** Gabon. */ - | 'GA' + | "GA" /** United Kingdom. */ - | 'GB' + | "GB" /** Grenada. */ - | 'GD' + | "GD" /** Georgia. */ - | 'GE' + | "GE" /** French Guiana. */ - | 'GF' + | "GF" /** Guernsey. */ - | 'GG' + | "GG" /** Ghana. */ - | 'GH' + | "GH" /** Gibraltar. */ - | 'GI' + | "GI" /** Greenland. */ - | 'GL' + | "GL" /** Gambia. */ - | 'GM' + | "GM" /** Guinea. */ - | 'GN' + | "GN" /** Guadeloupe. */ - | 'GP' + | "GP" /** Equatorial Guinea. */ - | 'GQ' + | "GQ" /** Greece. */ - | 'GR' + | "GR" /** South Georgia & South Sandwich Islands. */ - | 'GS' + | "GS" /** Guatemala. */ - | 'GT' + | "GT" /** Guinea-Bissau. */ - | 'GW' + | "GW" /** Guyana. */ - | 'GY' + | "GY" /** Hong Kong SAR. */ - | 'HK' + | "HK" /** Heard & McDonald Islands. */ - | 'HM' + | "HM" /** Honduras. */ - | 'HN' + | "HN" /** Croatia. */ - | 'HR' + | "HR" /** Haiti. */ - | 'HT' + | "HT" /** Hungary. */ - | 'HU' + | "HU" /** Indonesia. */ - | 'ID' + | "ID" /** Ireland. */ - | 'IE' + | "IE" /** Israel. */ - | 'IL' + | "IL" /** Isle of Man. */ - | 'IM' + | "IM" /** India. */ - | 'IN' + | "IN" /** British Indian Ocean Territory. */ - | 'IO' + | "IO" /** Iraq. */ - | 'IQ' + | "IQ" /** Iran. */ - | 'IR' + | "IR" /** Iceland. */ - | 'IS' + | "IS" /** Italy. */ - | 'IT' + | "IT" /** Jersey. */ - | 'JE' + | "JE" /** Jamaica. */ - | 'JM' + | "JM" /** Jordan. */ - | 'JO' + | "JO" /** Japan. */ - | 'JP' + | "JP" /** Kenya. */ - | 'KE' + | "KE" /** Kyrgyzstan. */ - | 'KG' + | "KG" /** Cambodia. */ - | 'KH' + | "KH" /** Kiribati. */ - | 'KI' + | "KI" /** Comoros. */ - | 'KM' + | "KM" /** St. Kitts & Nevis. */ - | 'KN' + | "KN" /** North Korea. */ - | 'KP' + | "KP" /** South Korea. */ - | 'KR' + | "KR" /** Kuwait. */ - | 'KW' + | "KW" /** Cayman Islands. */ - | 'KY' + | "KY" /** Kazakhstan. */ - | 'KZ' + | "KZ" /** Laos. */ - | 'LA' + | "LA" /** Lebanon. */ - | 'LB' + | "LB" /** St. Lucia. */ - | 'LC' + | "LC" /** Liechtenstein. */ - | 'LI' + | "LI" /** Sri Lanka. */ - | 'LK' + | "LK" /** Liberia. */ - | 'LR' + | "LR" /** Lesotho. */ - | 'LS' + | "LS" /** Lithuania. */ - | 'LT' + | "LT" /** Luxembourg. */ - | 'LU' + | "LU" /** Latvia. */ - | 'LV' + | "LV" /** Libya. */ - | 'LY' + | "LY" /** Morocco. */ - | 'MA' + | "MA" /** Monaco. */ - | 'MC' + | "MC" /** Moldova. */ - | 'MD' + | "MD" /** Montenegro. */ - | 'ME' + | "ME" /** St. Martin. */ - | 'MF' + | "MF" /** Madagascar. */ - | 'MG' + | "MG" /** North Macedonia. */ - | 'MK' + | "MK" /** Mali. */ - | 'ML' + | "ML" /** Myanmar (Burma). */ - | 'MM' + | "MM" /** Mongolia. */ - | 'MN' + | "MN" /** Macao SAR. */ - | 'MO' + | "MO" /** Martinique. */ - | 'MQ' + | "MQ" /** Mauritania. */ - | 'MR' + | "MR" /** Montserrat. */ - | 'MS' + | "MS" /** Malta. */ - | 'MT' + | "MT" /** Mauritius. */ - | 'MU' + | "MU" /** Maldives. */ - | 'MV' + | "MV" /** Malawi. */ - | 'MW' + | "MW" /** Mexico. */ - | 'MX' + | "MX" /** Malaysia. */ - | 'MY' + | "MY" /** Mozambique. */ - | 'MZ' + | "MZ" /** Namibia. */ - | 'NA' + | "NA" /** New Caledonia. */ - | 'NC' + | "NC" /** Niger. */ - | 'NE' + | "NE" /** Norfolk Island. */ - | 'NF' + | "NF" /** Nigeria. */ - | 'NG' + | "NG" /** Nicaragua. */ - | 'NI' + | "NI" /** Netherlands. */ - | 'NL' + | "NL" /** Norway. */ - | 'NO' + | "NO" /** Nepal. */ - | 'NP' + | "NP" /** Nauru. */ - | 'NR' + | "NR" /** Niue. */ - | 'NU' + | "NU" /** New Zealand. */ - | 'NZ' + | "NZ" /** Oman. */ - | 'OM' + | "OM" /** Panama. */ - | 'PA' + | "PA" /** Peru. */ - | 'PE' + | "PE" /** French Polynesia. */ - | 'PF' + | "PF" /** Papua New Guinea. */ - | 'PG' + | "PG" /** Philippines. */ - | 'PH' + | "PH" /** Pakistan. */ - | 'PK' + | "PK" /** Poland. */ - | 'PL' + | "PL" /** St. Pierre & Miquelon. */ - | 'PM' + | "PM" /** Pitcairn Islands. */ - | 'PN' + | "PN" /** Palestinian Territories. */ - | 'PS' + | "PS" /** Portugal. */ - | 'PT' + | "PT" /** Paraguay. */ - | 'PY' + | "PY" /** Qatar. */ - | 'QA' + | "QA" /** Réunion. */ - | 'RE' + | "RE" /** Romania. */ - | 'RO' + | "RO" /** Serbia. */ - | 'RS' + | "RS" /** Russia. */ - | 'RU' + | "RU" /** Rwanda. */ - | 'RW' + | "RW" /** Saudi Arabia. */ - | 'SA' + | "SA" /** Solomon Islands. */ - | 'SB' + | "SB" /** Seychelles. */ - | 'SC' + | "SC" /** Sudan. */ - | 'SD' + | "SD" /** Sweden. */ - | 'SE' + | "SE" /** Singapore. */ - | 'SG' + | "SG" /** St. Helena. */ - | 'SH' + | "SH" /** Slovenia. */ - | 'SI' + | "SI" /** Svalbard & Jan Mayen. */ - | 'SJ' + | "SJ" /** Slovakia. */ - | 'SK' + | "SK" /** Sierra Leone. */ - | 'SL' + | "SL" /** San Marino. */ - | 'SM' + | "SM" /** Senegal. */ - | 'SN' + | "SN" /** Somalia. */ - | 'SO' + | "SO" /** Suriname. */ - | 'SR' + | "SR" /** South Sudan. */ - | 'SS' + | "SS" /** São Tomé & Príncipe. */ - | 'ST' + | "ST" /** El Salvador. */ - | 'SV' + | "SV" /** Sint Maarten. */ - | 'SX' + | "SX" /** Syria. */ - | 'SY' + | "SY" /** Eswatini. */ - | 'SZ' + | "SZ" /** Tristan da Cunha. */ - | 'TA' + | "TA" /** Turks & Caicos Islands. */ - | 'TC' + | "TC" /** Chad. */ - | 'TD' + | "TD" /** French Southern Territories. */ - | 'TF' + | "TF" /** Togo. */ - | 'TG' + | "TG" /** Thailand. */ - | 'TH' + | "TH" /** Tajikistan. */ - | 'TJ' + | "TJ" /** Tokelau. */ - | 'TK' + | "TK" /** Timor-Leste. */ - | 'TL' + | "TL" /** Turkmenistan. */ - | 'TM' + | "TM" /** Tunisia. */ - | 'TN' + | "TN" /** Tonga. */ - | 'TO' + | "TO" /** Turkey. */ - | 'TR' + | "TR" /** Trinidad & Tobago. */ - | 'TT' + | "TT" /** Tuvalu. */ - | 'TV' + | "TV" /** Taiwan. */ - | 'TW' + | "TW" /** Tanzania. */ - | 'TZ' + | "TZ" /** Ukraine. */ - | 'UA' + | "UA" /** Uganda. */ - | 'UG' + | "UG" /** U.S. Outlying Islands. */ - | 'UM' + | "UM" /** United States. */ - | 'US' + | "US" /** Uruguay. */ - | 'UY' + | "UY" /** Uzbekistan. */ - | 'UZ' + | "UZ" /** Vatican City. */ - | 'VA' + | "VA" /** St. Vincent & Grenadines. */ - | 'VC' + | "VC" /** Venezuela. */ - | 'VE' + | "VE" /** British Virgin Islands. */ - | 'VG' + | "VG" /** Vietnam. */ - | 'VN' + | "VN" /** Vanuatu. */ - | 'VU' + | "VU" /** Wallis & Futuna. */ - | 'WF' + | "WF" /** Samoa. */ - | 'WS' + | "WS" /** Kosovo. */ - | 'XK' + | "XK" /** Yemen. */ - | 'YE' + | "YE" /** Mayotte. */ - | 'YT' + | "YT" /** South Africa. */ - | 'ZA' + | "ZA" /** Zambia. */ - | 'ZM' + | "ZM" /** Zimbabwe. */ - | 'ZW' + | "ZW" /** Unknown Region. */ - | 'ZZ'; + | "ZZ"; /** Credit card information used for a payment. */ export type CreditCard = { /** The brand of the credit card. */ - brand?: Maybe; + brand?: Maybe; /** The expiry month of the credit card. */ - expiryMonth?: Maybe; + expiryMonth?: Maybe; /** The expiry year of the credit card. */ - expiryYear?: Maybe; + expiryYear?: Maybe; /** The credit card's BIN number. */ - firstDigits?: Maybe; + firstDigits?: Maybe; /** The first name of the card holder. */ - firstName?: Maybe; + firstName?: Maybe; /** The last 4 digits of the credit card. */ - lastDigits?: Maybe; + lastDigits?: Maybe; /** The last name of the card holder. */ - lastName?: Maybe; + lastName?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; /** * Specifies the fields required to complete a checkout with * a Shopify vaulted credit card payment. - * */ export type CreditCardPaymentInputV2 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars['String']['input']; + idempotencyKey: Scalars["String"]["input"]; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars['String']['input']; + vaultId: Scalars["String"]["input"]; }; /** The part of the image that should remain after cropping. */ export type CropRegion = /** Keep the bottom of the image. */ - | 'BOTTOM' + | "BOTTOM" /** Keep the center of the image. */ - | 'CENTER' + | "CENTER" /** Keep the left of the image. */ - | 'LEFT' + | "LEFT" /** Keep the right of the image. */ - | 'RIGHT' + | "RIGHT" /** Keep the top of the image. */ - | 'TOP'; + | "TOP"; /** A currency. */ export type Currency = { /** The ISO code of the currency. */ isoCode: CurrencyCode; /** The name of the currency. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The symbol of the currency. */ - symbol: Scalars['String']['output']; + symbol: Scalars["String"]["output"]; }; /** * The three-letter currency codes that represent the world currencies used in * stores. These include standard ISO 4217 codes, legacy codes, * and non-standard codes. - * */ export type CurrencyCode = /** United Arab Emirates Dirham (AED). */ - | 'AED' + | "AED" /** Afghan Afghani (AFN). */ - | 'AFN' + | "AFN" /** Albanian Lek (ALL). */ - | 'ALL' + | "ALL" /** Armenian Dram (AMD). */ - | 'AMD' + | "AMD" /** Netherlands Antillean Guilder. */ - | 'ANG' + | "ANG" /** Angolan Kwanza (AOA). */ - | 'AOA' + | "AOA" /** Argentine Pesos (ARS). */ - | 'ARS' + | "ARS" /** Australian Dollars (AUD). */ - | 'AUD' + | "AUD" /** Aruban Florin (AWG). */ - | 'AWG' + | "AWG" /** Azerbaijani Manat (AZN). */ - | 'AZN' + | "AZN" /** Bosnia and Herzegovina Convertible Mark (BAM). */ - | 'BAM' + | "BAM" /** Barbadian Dollar (BBD). */ - | 'BBD' + | "BBD" /** Bangladesh Taka (BDT). */ - | 'BDT' + | "BDT" /** Bulgarian Lev (BGN). */ - | 'BGN' + | "BGN" /** Bahraini Dinar (BHD). */ - | 'BHD' + | "BHD" /** Burundian Franc (BIF). */ - | 'BIF' + | "BIF" /** Bermudian Dollar (BMD). */ - | 'BMD' + | "BMD" /** Brunei Dollar (BND). */ - | 'BND' + | "BND" /** Bolivian Boliviano (BOB). */ - | 'BOB' + | "BOB" /** Brazilian Real (BRL). */ - | 'BRL' + | "BRL" /** Bahamian Dollar (BSD). */ - | 'BSD' + | "BSD" /** Bhutanese Ngultrum (BTN). */ - | 'BTN' + | "BTN" /** Botswana Pula (BWP). */ - | 'BWP' + | "BWP" /** Belarusian Ruble (BYN). */ - | 'BYN' + | "BYN" /** Belarusian Ruble (BYR). */ - | 'BYR' + | "BYR" /** Belize Dollar (BZD). */ - | 'BZD' + | "BZD" /** Canadian Dollars (CAD). */ - | 'CAD' + | "CAD" /** Congolese franc (CDF). */ - | 'CDF' + | "CDF" /** Swiss Francs (CHF). */ - | 'CHF' + | "CHF" /** Chilean Peso (CLP). */ - | 'CLP' + | "CLP" /** Chinese Yuan Renminbi (CNY). */ - | 'CNY' + | "CNY" /** Colombian Peso (COP). */ - | 'COP' + | "COP" /** Costa Rican Colones (CRC). */ - | 'CRC' + | "CRC" /** Cape Verdean escudo (CVE). */ - | 'CVE' + | "CVE" /** Czech Koruny (CZK). */ - | 'CZK' + | "CZK" /** Djiboutian Franc (DJF). */ - | 'DJF' + | "DJF" /** Danish Kroner (DKK). */ - | 'DKK' + | "DKK" /** Dominican Peso (DOP). */ - | 'DOP' + | "DOP" /** Algerian Dinar (DZD). */ - | 'DZD' + | "DZD" /** Egyptian Pound (EGP). */ - | 'EGP' + | "EGP" /** Eritrean Nakfa (ERN). */ - | 'ERN' + | "ERN" /** Ethiopian Birr (ETB). */ - | 'ETB' + | "ETB" /** Euro (EUR). */ - | 'EUR' + | "EUR" /** Fijian Dollars (FJD). */ - | 'FJD' + | "FJD" /** Falkland Islands Pounds (FKP). */ - | 'FKP' + | "FKP" /** United Kingdom Pounds (GBP). */ - | 'GBP' + | "GBP" /** Georgian Lari (GEL). */ - | 'GEL' + | "GEL" /** Ghanaian Cedi (GHS). */ - | 'GHS' + | "GHS" /** Gibraltar Pounds (GIP). */ - | 'GIP' + | "GIP" /** Gambian Dalasi (GMD). */ - | 'GMD' + | "GMD" /** Guinean Franc (GNF). */ - | 'GNF' + | "GNF" /** Guatemalan Quetzal (GTQ). */ - | 'GTQ' + | "GTQ" /** Guyanese Dollar (GYD). */ - | 'GYD' + | "GYD" /** Hong Kong Dollars (HKD). */ - | 'HKD' + | "HKD" /** Honduran Lempira (HNL). */ - | 'HNL' + | "HNL" /** Croatian Kuna (HRK). */ - | 'HRK' + | "HRK" /** Haitian Gourde (HTG). */ - | 'HTG' + | "HTG" /** Hungarian Forint (HUF). */ - | 'HUF' + | "HUF" /** Indonesian Rupiah (IDR). */ - | 'IDR' + | "IDR" /** Israeli New Shekel (NIS). */ - | 'ILS' + | "ILS" /** Indian Rupees (INR). */ - | 'INR' + | "INR" /** Iraqi Dinar (IQD). */ - | 'IQD' + | "IQD" /** Iranian Rial (IRR). */ - | 'IRR' + | "IRR" /** Icelandic Kronur (ISK). */ - | 'ISK' + | "ISK" /** Jersey Pound. */ - | 'JEP' + | "JEP" /** Jamaican Dollars (JMD). */ - | 'JMD' + | "JMD" /** Jordanian Dinar (JOD). */ - | 'JOD' + | "JOD" /** Japanese Yen (JPY). */ - | 'JPY' + | "JPY" /** Kenyan Shilling (KES). */ - | 'KES' + | "KES" /** Kyrgyzstani Som (KGS). */ - | 'KGS' + | "KGS" /** Cambodian Riel. */ - | 'KHR' + | "KHR" /** Kiribati Dollar (KID). */ - | 'KID' + | "KID" /** Comorian Franc (KMF). */ - | 'KMF' + | "KMF" /** South Korean Won (KRW). */ - | 'KRW' + | "KRW" /** Kuwaiti Dinar (KWD). */ - | 'KWD' + | "KWD" /** Cayman Dollars (KYD). */ - | 'KYD' + | "KYD" /** Kazakhstani Tenge (KZT). */ - | 'KZT' + | "KZT" /** Laotian Kip (LAK). */ - | 'LAK' + | "LAK" /** Lebanese Pounds (LBP). */ - | 'LBP' + | "LBP" /** Sri Lankan Rupees (LKR). */ - | 'LKR' + | "LKR" /** Liberian Dollar (LRD). */ - | 'LRD' + | "LRD" /** Lesotho Loti (LSL). */ - | 'LSL' + | "LSL" /** Lithuanian Litai (LTL). */ - | 'LTL' + | "LTL" /** Latvian Lati (LVL). */ - | 'LVL' + | "LVL" /** Libyan Dinar (LYD). */ - | 'LYD' + | "LYD" /** Moroccan Dirham. */ - | 'MAD' + | "MAD" /** Moldovan Leu (MDL). */ - | 'MDL' + | "MDL" /** Malagasy Ariary (MGA). */ - | 'MGA' + | "MGA" /** Macedonia Denar (MKD). */ - | 'MKD' + | "MKD" /** Burmese Kyat (MMK). */ - | 'MMK' + | "MMK" /** Mongolian Tugrik. */ - | 'MNT' + | "MNT" /** Macanese Pataca (MOP). */ - | 'MOP' + | "MOP" /** Mauritanian Ouguiya (MRU). */ - | 'MRU' + | "MRU" /** Mauritian Rupee (MUR). */ - | 'MUR' + | "MUR" /** Maldivian Rufiyaa (MVR). */ - | 'MVR' + | "MVR" /** Malawian Kwacha (MWK). */ - | 'MWK' + | "MWK" /** Mexican Pesos (MXN). */ - | 'MXN' + | "MXN" /** Malaysian Ringgits (MYR). */ - | 'MYR' + | "MYR" /** Mozambican Metical. */ - | 'MZN' + | "MZN" /** Namibian Dollar. */ - | 'NAD' + | "NAD" /** Nigerian Naira (NGN). */ - | 'NGN' + | "NGN" /** Nicaraguan Córdoba (NIO). */ - | 'NIO' + | "NIO" /** Norwegian Kroner (NOK). */ - | 'NOK' + | "NOK" /** Nepalese Rupee (NPR). */ - | 'NPR' + | "NPR" /** New Zealand Dollars (NZD). */ - | 'NZD' + | "NZD" /** Omani Rial (OMR). */ - | 'OMR' + | "OMR" /** Panamian Balboa (PAB). */ - | 'PAB' + | "PAB" /** Peruvian Nuevo Sol (PEN). */ - | 'PEN' + | "PEN" /** Papua New Guinean Kina (PGK). */ - | 'PGK' + | "PGK" /** Philippine Peso (PHP). */ - | 'PHP' + | "PHP" /** Pakistani Rupee (PKR). */ - | 'PKR' + | "PKR" /** Polish Zlotych (PLN). */ - | 'PLN' + | "PLN" /** Paraguayan Guarani (PYG). */ - | 'PYG' + | "PYG" /** Qatari Rial (QAR). */ - | 'QAR' + | "QAR" /** Romanian Lei (RON). */ - | 'RON' + | "RON" /** Serbian dinar (RSD). */ - | 'RSD' + | "RSD" /** Russian Rubles (RUB). */ - | 'RUB' + | "RUB" /** Rwandan Franc (RWF). */ - | 'RWF' + | "RWF" /** Saudi Riyal (SAR). */ - | 'SAR' + | "SAR" /** Solomon Islands Dollar (SBD). */ - | 'SBD' + | "SBD" /** Seychellois Rupee (SCR). */ - | 'SCR' + | "SCR" /** Sudanese Pound (SDG). */ - | 'SDG' + | "SDG" /** Swedish Kronor (SEK). */ - | 'SEK' + | "SEK" /** Singapore Dollars (SGD). */ - | 'SGD' + | "SGD" /** Saint Helena Pounds (SHP). */ - | 'SHP' + | "SHP" /** Sierra Leonean Leone (SLL). */ - | 'SLL' + | "SLL" /** Somali Shilling (SOS). */ - | 'SOS' + | "SOS" /** Surinamese Dollar (SRD). */ - | 'SRD' + | "SRD" /** South Sudanese Pound (SSP). */ - | 'SSP' + | "SSP" /** Sao Tome And Principe Dobra (STD). */ - | 'STD' + | "STD" /** Sao Tome And Principe Dobra (STN). */ - | 'STN' + | "STN" /** Syrian Pound (SYP). */ - | 'SYP' + | "SYP" /** Swazi Lilangeni (SZL). */ - | 'SZL' + | "SZL" /** Thai baht (THB). */ - | 'THB' + | "THB" /** Tajikistani Somoni (TJS). */ - | 'TJS' + | "TJS" /** Turkmenistani Manat (TMT). */ - | 'TMT' + | "TMT" /** Tunisian Dinar (TND). */ - | 'TND' + | "TND" /** Tongan Pa'anga (TOP). */ - | 'TOP' + | "TOP" /** Turkish Lira (TRY). */ - | 'TRY' + | "TRY" /** Trinidad and Tobago Dollars (TTD). */ - | 'TTD' + | "TTD" /** Taiwan Dollars (TWD). */ - | 'TWD' + | "TWD" /** Tanzanian Shilling (TZS). */ - | 'TZS' + | "TZS" /** Ukrainian Hryvnia (UAH). */ - | 'UAH' + | "UAH" /** Ugandan Shilling (UGX). */ - | 'UGX' + | "UGX" /** United States Dollars (USD). */ - | 'USD' + | "USD" /** Uruguayan Pesos (UYU). */ - | 'UYU' + | "UYU" /** Uzbekistan som (UZS). */ - | 'UZS' + | "UZS" /** Venezuelan Bolivares (VED). */ - | 'VED' + | "VED" /** Venezuelan Bolivares (VEF). */ - | 'VEF' + | "VEF" /** Venezuelan Bolivares (VES). */ - | 'VES' + | "VES" /** Vietnamese đồng (VND). */ - | 'VND' + | "VND" /** Vanuatu Vatu (VUV). */ - | 'VUV' + | "VUV" /** Samoan Tala (WST). */ - | 'WST' + | "WST" /** Central African CFA Franc (XAF). */ - | 'XAF' + | "XAF" /** East Caribbean Dollar (XCD). */ - | 'XCD' + | "XCD" /** West African CFA franc (XOF). */ - | 'XOF' + | "XOF" /** CFP Franc (XPF). */ - | 'XPF' + | "XPF" /** Unrecognized currency. */ - | 'XXX' + | "XXX" /** Yemeni Rial (YER). */ - | 'YER' + | "YER" /** South African Rand (ZAR). */ - | 'ZAR' + | "ZAR" /** Zambian Kwacha (ZMW). */ - | 'ZMW'; + | "ZMW"; /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type Customer = HasMetafields & { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing: Scalars['Boolean']['output']; + acceptsMarketing: Scalars["Boolean"]["output"]; /** A list of addresses for the customer. */ addresses: MailingAddressConnection; /** The date and time when the customer was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The customer’s default address. */ defaultAddress?: Maybe; /** The customer’s name, email or phone number. */ - displayName: Scalars['String']['output']; + displayName: Scalars["String"]["output"]; /** The customer’s email address. */ - email?: Maybe; + email?: Maybe; /** The customer’s first name. */ - firstName?: Maybe; + firstName?: Maybe; /** A unique ID for the customer. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The customer's most recently updated, incomplete checkout. */ lastIncompleteCheckout?: Maybe; /** The customer’s last name. */ - lastName?: Maybe; + lastName?: Maybe; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The number of orders that the customer has made at the store in their lifetime. */ - numberOfOrders: Scalars['UnsignedInt64']['output']; + numberOfOrders: Scalars["UnsignedInt64"]["output"]; /** The orders associated with the customer. */ orders: OrderConnection; /** The customer’s phone number. */ - phone?: Maybe; + phone?: Maybe; /** * A comma separated list of tags that have been added to the customer. * Additional access scope required: unauthenticated_read_customer_tags. - * */ - tags: Array; + tags: Array; /** The date and time when the customer information was updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerAddressesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerMetafieldsArgs = { identifiers: Array; }; - /** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ export type CustomerOrdersArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ export type CustomerAccessToken = { /** The customer’s access token. */ - accessToken: Scalars['String']['output']; + accessToken: Scalars["String"]["output"]; /** The date and time when the customer access token expires. */ - expiresAt: Scalars['DateTime']['output']; + expiresAt: Scalars["DateTime"]["output"]; }; /** The input fields required to create a customer access token. */ export type CustomerAccessTokenCreateInput = { /** The email associated to the customer. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The login password to be used by the customer. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; }; /** Return type for `customerAccessTokenCreate` mutation. */ @@ -3126,9 +3044,9 @@ export type CustomerAccessTokenCreateWithMultipassPayload = { /** Return type for `customerAccessTokenDelete` mutation. */ export type CustomerAccessTokenDeletePayload = { /** The destroyed access token. */ - deletedAccessToken?: Maybe; + deletedAccessToken?: Maybe; /** ID of the destroyed customer access token. */ - deletedCustomerAccessTokenId?: Maybe; + deletedCustomerAccessTokenId?: Maybe; /** The list of errors that occurred from executing the mutation. */ userErrors: Array; }; @@ -3154,9 +3072,9 @@ export type CustomerActivateByUrlPayload = { /** The input fields to activate a customer. */ export type CustomerActivateInput = { /** The activation token required to activate the customer. */ - activationToken: Scalars['String']['input']; + activationToken: Scalars["String"]["input"]; /** New password that will be set during activation. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; }; /** Return type for `customerActivate` mutation. */ @@ -3192,7 +3110,7 @@ export type CustomerAddressDeletePayload = { /** The list of errors that occurred from executing the mutation. */ customerUserErrors: Array; /** ID of the deleted customer address. */ - deletedCustomerAddressId?: Maybe; + deletedCustomerAddressId?: Maybe; /** * The list of errors that occurred from executing the mutation. * @deprecated Use `customerUserErrors` instead. @@ -3216,22 +3134,21 @@ export type CustomerAddressUpdatePayload = { /** The input fields to create a new customer. */ export type CustomerCreateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerCreate` mutation. */ @@ -3263,35 +3180,35 @@ export type CustomerDefaultAddressUpdatePayload = { /** Possible error codes that can be returned by `CustomerUserError`. */ export type CustomerErrorCode = /** Customer already enabled. */ - | 'ALREADY_ENABLED' + | "ALREADY_ENABLED" /** Input email contains an invalid domain name. */ - | 'BAD_DOMAIN' + | "BAD_DOMAIN" /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** Input contains HTML tags. */ - | 'CONTAINS_HTML_TAGS' + | "CONTAINS_HTML_TAGS" /** Input contains URL. */ - | 'CONTAINS_URL' + | "CONTAINS_URL" /** Customer is disabled. */ - | 'CUSTOMER_DISABLED' + | "CUSTOMER_DISABLED" /** The input value is invalid. */ - | 'INVALID' + | "INVALID" /** Multipass token is not valid. */ - | 'INVALID_MULTIPASS_REQUEST' + | "INVALID_MULTIPASS_REQUEST" /** Address does not exist. */ - | 'NOT_FOUND' + | "NOT_FOUND" /** Input password starts or ends with whitespace. */ - | 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE' + | "PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE" /** The input value is already taken. */ - | 'TAKEN' + | "TAKEN" /** Invalid activation token. */ - | 'TOKEN_INVALID' + | "TOKEN_INVALID" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The input value is too short. */ - | 'TOO_SHORT' + | "TOO_SHORT" /** Unidentified customer. */ - | 'UNIDENTIFIED_CUSTOMER'; + | "UNIDENTIFIED_CUSTOMER"; /** Return type for `customerRecover` mutation. */ export type CustomerRecoverPayload = { @@ -3322,9 +3239,9 @@ export type CustomerResetByUrlPayload = { /** The input fields to reset a customer's password. */ export type CustomerResetInput = { /** New password that will be set as part of the reset password process. */ - password: Scalars['String']['input']; + password: Scalars["String"]["input"]; /** The reset token required to reset the customer’s password. */ - resetToken: Scalars['String']['input']; + resetToken: Scalars["String"]["input"]; }; /** Return type for `customerReset` mutation. */ @@ -3345,22 +3262,21 @@ export type CustomerResetPayload = { /** The input fields to update the Customer information. */ export type CustomerUpdateInput = { /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: InputMaybe; + acceptsMarketing?: InputMaybe; /** The customer’s email. */ - email?: InputMaybe; + email?: InputMaybe; /** The customer’s first name. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The customer’s last name. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** The login password used by the customer. */ - password?: InputMaybe; + password?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. - * */ - phone?: InputMaybe; + phone?: InputMaybe; }; /** Return type for `customerUpdate` mutation. */ @@ -3370,7 +3286,6 @@ export type CustomerUpdatePayload = { /** * The newly created customer access token. If the customer's password is updated, all previous access tokens * (including the one used to perform this mutation) become invalid, and a new token is generated. - * */ customerAccessToken?: Maybe; /** The list of errors that occurred from executing the mutation. */ @@ -3387,9 +3302,9 @@ export type CustomerUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** A delivery address of the buyer that is interacting with the cart. */ @@ -3397,14 +3312,12 @@ export type DeliveryAddress = MailingAddress; /** * The input fields for delivery address preferences. - * */ export type DeliveryAddressInput = { /** * The ID of a customer address that is associated with the buyer that is interacting with the cart. - * */ - customerAddressId?: InputMaybe; + customerAddressId?: InputMaybe; /** A delivery address preference of a buyer that is interacting with the cart. */ deliveryAddress?: InputMaybe; }; @@ -3412,32 +3325,31 @@ export type DeliveryAddressInput = { /** List of different delivery method types. */ export type DeliveryMethodType = /** Local Delivery. */ - | 'LOCAL' + | "LOCAL" /** None. */ - | 'NONE' + | "NONE" /** Shipping to a Pickup Point. */ - | 'PICKUP_POINT' + | "PICKUP_POINT" /** Local Pickup. */ - | 'PICK_UP' + | "PICK_UP" /** Retail. */ - | 'RETAIL' + | "RETAIL" /** Shipping. */ - | 'SHIPPING'; + | "SHIPPING"; /** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ export type DigitalWallet = /** Android Pay. */ - | 'ANDROID_PAY' + | "ANDROID_PAY" /** Apple Pay. */ - | 'APPLE_PAY' + | "APPLE_PAY" /** Google Pay. */ - | 'GOOGLE_PAY' + | "GOOGLE_PAY" /** Shopify Pay. */ - | 'SHOPIFY_PAY'; + | "SHOPIFY_PAY"; /** * An amount discounting the line that has been allocated by a discount. - * */ export type DiscountAllocation = { /** Amount of discount allocated. */ @@ -3449,7 +3361,6 @@ export type DiscountAllocation = { /** * Discount applications capture the intentions of a discount source at * the time of application. - * */ export type DiscountApplication = { /** The method by which the discount's value is allocated to its entitled items. */ @@ -3465,15 +3376,14 @@ export type DiscountApplication = { /** The method by which the discount's value is allocated onto its entitled lines. */ export type DiscountApplicationAllocationMethod = /** The value is spread across all entitled lines. */ - | 'ACROSS' + | "ACROSS" /** The value is applied onto every entitled line. */ - | 'EACH' + | "EACH" /** The value is specifically applied onto a particular line. */ - | 'ONE'; + | "ONE"; /** * An auto-generated type for paginating through multiple DiscountApplications. - * */ export type DiscountApplicationConnection = { /** A list of edges. */ @@ -3486,11 +3396,10 @@ export type DiscountApplicationConnection = { /** * An auto-generated type which holds one DiscountApplication and a cursor during pagination. - * */ export type DiscountApplicationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of DiscountApplicationEdge. */ node: DiscountApplication; }; @@ -3500,38 +3409,35 @@ export type DiscountApplicationEdge = { * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. - * */ export type DiscountApplicationTargetSelection = /** The discount is allocated onto all the lines. */ - | 'ALL' + | "ALL" /** The discount is allocated onto only the lines that it's entitled for. */ - | 'ENTITLED' + | "ENTITLED" /** The discount is allocated onto explicitly chosen lines. */ - | 'EXPLICIT'; + | "EXPLICIT"; /** * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. - * */ export type DiscountApplicationTargetType = /** The discount applies onto line items. */ - | 'LINE_ITEM' + | "LINE_ITEM" /** The discount applies onto shipping lines. */ - | 'SHIPPING_LINE'; + | "SHIPPING_LINE"; /** * Discount code applications capture the intentions of a discount code at * the time that it is applied. - * */ export type DiscountCodeApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** Specifies whether the discount code was applied successfully. */ - applicable: Scalars['Boolean']['output']; + applicable: Scalars["Boolean"]["output"]; /** The string identifying the discount code that was used at the time of application. */ - code: Scalars['String']['output']; + code: Scalars["String"]["output"]; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ @@ -3543,40 +3449,40 @@ export type DiscountCodeApplication = DiscountApplication & { /** Represents an error in the input of a mutation. */ export type DisplayableError = { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** Represents a web address. */ export type Domain = { /** The host name of the domain (eg: `example.com`). */ - host: Scalars['String']['output']; + host: Scalars["String"]["output"]; /** Whether SSL is enabled or not. */ - sslEnabled: Scalars['Boolean']['output']; + sslEnabled: Scalars["Boolean"]["output"]; /** The URL of the domain (eg: `https://example.com`). */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** Represents a video hosted outside of Shopify. */ export type ExternalVideo = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** The embed URL of the video for the respective host. */ - embedUrl: Scalars['URL']['output']; + embedUrl: Scalars["URL"]["output"]; /** * The URL. * @deprecated Use `originUrl` instead. */ - embeddedUrl: Scalars['URL']['output']; + embeddedUrl: Scalars["URL"]["output"]; /** The host of the external video. */ host: MediaHost; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The origin URL of the video on the respective host. */ - originUrl: Scalars['URL']['output']; + originUrl: Scalars["URL"]["output"]; /** The presentation for a media. */ presentation?: Maybe; /** The preview image for the media. */ @@ -3586,9 +3492,9 @@ export type ExternalVideo = Media & Node & { /** A filter that is supported on the parent field. */ export type Filter = { /** A unique identifier. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** A human-friendly string for this filter. */ - label: Scalars['String']['output']; + label: Scalars["String"]["output"]; /** An enumeration that denotes the type of data this filter represents. */ type: FilterType; /** The list of values for this filter. */ @@ -3600,33 +3506,31 @@ export type Filter = { * * For more information, refer to [Filter products in a collection with the Storefront API] * (https://shopify.dev/custom-storefronts/products-collections/filter-products). - * */ export type FilterType = /** A boolean value. */ - | 'BOOLEAN' + | "BOOLEAN" /** A list of selectable values. */ - | 'LIST' + | "LIST" /** A range of prices. */ - | 'PRICE_RANGE'; + | "PRICE_RANGE"; /** A selectable value within a filter. */ export type FilterValue = { /** The number of results that match this filter value. */ - count: Scalars['Int']['output']; + count: Scalars["Int"]["output"]; /** A unique identifier. */ - id: Scalars['String']['output']; + id: Scalars["String"]["output"]; /** * An input object that can be used to filter by this value on the parent field. * * The value is provided as a helper for building dynamic filtering UI. For * example, if you have a list of selected `FilterValue` objects, you can combine * their respective `input` values to use in a subsequent query. - * */ - input: Scalars['JSON']['output']; + input: Scalars["JSON"]["output"]; /** A human-friendly string for this filter value. */ - label: Scalars['String']['output']; + label: Scalars["String"]["output"]; }; /** Represents a single fulfillment in an order. */ @@ -3634,29 +3538,26 @@ export type Fulfillment = { /** List of the fulfillment's line items. */ fulfillmentLineItems: FulfillmentLineItemConnection; /** The name of the tracking company. */ - trackingCompany?: Maybe; + trackingCompany?: Maybe; /** * Tracking information associated with the fulfillment, * such as the tracking number and tracking URL. - * */ trackingInfo: Array; }; - /** Represents a single fulfillment in an order. */ export type FulfillmentFulfillmentLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** Represents a single fulfillment in an order. */ export type FulfillmentTrackingInfoArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ @@ -3664,12 +3565,11 @@ export type FulfillmentLineItem = { /** The associated order's line item. */ lineItem: OrderLineItem; /** The amount fulfilled in this fulfillment. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** * An auto-generated type for paginating through multiple FulfillmentLineItems. - * */ export type FulfillmentLineItemConnection = { /** A list of edges. */ @@ -3682,11 +3582,10 @@ export type FulfillmentLineItemConnection = { /** * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. - * */ export type FulfillmentLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of FulfillmentLineItemEdge. */ node: FulfillmentLineItem; }; @@ -3694,33 +3593,33 @@ export type FulfillmentLineItemEdge = { /** Tracking information associated with the fulfillment. */ export type FulfillmentTrackingInfo = { /** The tracking number of the fulfillment. */ - number?: Maybe; + number?: Maybe; /** The URL to track the fulfillment. */ - url?: Maybe; + url?: Maybe; }; /** The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. */ export type GenericFile = Node & { /** A word or phrase to indicate the contents of a file. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The MIME type of the file. */ - mimeType?: Maybe; + mimeType?: Maybe; /** The size of the original file in bytes. */ - originalFileSize?: Maybe; + originalFileSize?: Maybe; /** The preview image for the file. */ previewImage?: Maybe; /** The URL of the file. */ - url?: Maybe; + url?: Maybe; }; /** The input fields used to specify a geographical location. */ export type GeoCoordinateInput = { /** The coordinate's latitude value. */ - latitude: Scalars['Float']['input']; + latitude: Scalars["Float"]["input"]; /** The coordinate's longitude value. */ - longitude: Scalars['Float']['input']; + longitude: Scalars["Float"]["input"]; }; /** Represents information about the metafields associated to the specified resource. */ @@ -3731,14 +3630,12 @@ export type HasMetafields = { metafields: Array>; }; - /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Represents information about the metafields associated to the specified resource. */ export type HasMetafieldsMetafieldsArgs = { identifiers: Array; @@ -3747,19 +3644,19 @@ export type HasMetafieldsMetafieldsArgs = { /** The input fields to identify a metafield on an owner resource by namespace and key. */ export type HasMetafieldsIdentifier = { /** The identifier for the metafield. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The container the metafield belongs to. */ - namespace: Scalars['String']['input']; + namespace: Scalars["String"]["input"]; }; /** Represents an image resource. */ export type Image = { /** A word or phrase to share the nature or contents of an image. */ - altText?: Maybe; + altText?: Maybe; /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - height?: Maybe; + height?: Maybe; /** A unique ID for the image. */ - id?: Maybe; + id?: Maybe; /** * The location of the original image as a URL. * @@ -3767,12 +3664,12 @@ export type Image = { * * @deprecated Use `url` instead. */ - originalSrc: Scalars['URL']['output']; + originalSrc: Scalars["URL"]["output"]; /** * The location of the image as a URL. * @deprecated Use `url` instead. */ - src: Scalars['URL']['output']; + src: Scalars["URL"]["output"]; /** * The location of the transformed image as a URL. * @@ -3781,7 +3678,7 @@ export type Image = { * * @deprecated Use `url(transform:)` instead */ - transformedSrc: Scalars['URL']['output']; + transformedSrc: Scalars["URL"]["output"]; /** * The location of the image as a URL. * @@ -3790,24 +3687,21 @@ export type Image = { * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. * * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). - * */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ - width?: Maybe; + width?: Maybe; }; - /** Represents an image resource. */ export type ImageTransformedSrcArgs = { crop?: InputMaybe; - maxHeight?: InputMaybe; - maxWidth?: InputMaybe; + maxHeight?: InputMaybe; + maxWidth?: InputMaybe; preferredContentType?: InputMaybe; - scale?: InputMaybe; + scale?: InputMaybe; }; - /** Represents an image resource. */ export type ImageUrlArgs = { transform?: InputMaybe; @@ -3815,7 +3709,6 @@ export type ImageUrlArgs = { /** * An auto-generated type for paginating through multiple Images. - * */ export type ImageConnection = { /** A list of edges. */ @@ -3829,19 +3722,18 @@ export type ImageConnection = { /** List of supported image content types. */ export type ImageContentType = /** A JPG image. */ - | 'JPG' + | "JPG" /** A PNG image. */ - | 'PNG' + | "PNG" /** A WEBP image. */ - | 'WEBP'; + | "WEBP"; /** * An auto-generated type which holds one Image and a cursor during pagination. - * */ export type ImageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ImageEdge. */ node: Image; }; @@ -3851,7 +3743,6 @@ export type ImageEdge = { * * All transformation options are considered best effort. Any transformation that * the original image type doesn't support will be ignored. - * */ export type ImageTransformInput = { /** @@ -3862,332 +3753,327 @@ export type ImageTransformInput = { * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ * maxWidth: 5, maxHeight: 10, crop: LEFT }` will result * in an image with a width of 5 and height of 10, where the right side of the image is removed. - * */ crop?: InputMaybe; /** * Image height in pixels between 1 and 5760. - * */ - maxHeight?: InputMaybe; + maxHeight?: InputMaybe; /** * Image width in pixels between 1 and 5760. - * */ - maxWidth?: InputMaybe; + maxWidth?: InputMaybe; /** * Convert the source image into the preferred content type. * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. - * */ preferredContentType?: InputMaybe; /** * Image size multiplier for high-resolution retina displays. Must be within 1..3. - * */ - scale?: InputMaybe; + scale?: InputMaybe; }; /** A language. */ export type Language = { /** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */ - endonymName: Scalars['String']['output']; + endonymName: Scalars["String"]["output"]; /** The ISO code. */ isoCode: LanguageCode; /** The name of the language in the current language. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; /** ISO 639-1 language codes supported by Shopify. */ export type LanguageCode = /** Afrikaans. */ - | 'AF' + | "AF" /** Akan. */ - | 'AK' + | "AK" /** Amharic. */ - | 'AM' + | "AM" /** Arabic. */ - | 'AR' + | "AR" /** Assamese. */ - | 'AS' + | "AS" /** Azerbaijani. */ - | 'AZ' + | "AZ" /** Belarusian. */ - | 'BE' + | "BE" /** Bulgarian. */ - | 'BG' + | "BG" /** Bambara. */ - | 'BM' + | "BM" /** Bangla. */ - | 'BN' + | "BN" /** Tibetan. */ - | 'BO' + | "BO" /** Breton. */ - | 'BR' + | "BR" /** Bosnian. */ - | 'BS' + | "BS" /** Catalan. */ - | 'CA' + | "CA" /** Chechen. */ - | 'CE' + | "CE" /** Central Kurdish. */ - | 'CKB' + | "CKB" /** Czech. */ - | 'CS' + | "CS" /** Church Slavic. */ - | 'CU' + | "CU" /** Welsh. */ - | 'CY' + | "CY" /** Danish. */ - | 'DA' + | "DA" /** German. */ - | 'DE' + | "DE" /** Dzongkha. */ - | 'DZ' + | "DZ" /** Ewe. */ - | 'EE' + | "EE" /** Greek. */ - | 'EL' + | "EL" /** English. */ - | 'EN' + | "EN" /** Esperanto. */ - | 'EO' + | "EO" /** Spanish. */ - | 'ES' + | "ES" /** Estonian. */ - | 'ET' + | "ET" /** Basque. */ - | 'EU' + | "EU" /** Persian. */ - | 'FA' + | "FA" /** Fulah. */ - | 'FF' + | "FF" /** Finnish. */ - | 'FI' + | "FI" /** Filipino. */ - | 'FIL' + | "FIL" /** Faroese. */ - | 'FO' + | "FO" /** French. */ - | 'FR' + | "FR" /** Western Frisian. */ - | 'FY' + | "FY" /** Irish. */ - | 'GA' + | "GA" /** Scottish Gaelic. */ - | 'GD' + | "GD" /** Galician. */ - | 'GL' + | "GL" /** Gujarati. */ - | 'GU' + | "GU" /** Manx. */ - | 'GV' + | "GV" /** Hausa. */ - | 'HA' + | "HA" /** Hebrew. */ - | 'HE' + | "HE" /** Hindi. */ - | 'HI' + | "HI" /** Croatian. */ - | 'HR' + | "HR" /** Hungarian. */ - | 'HU' + | "HU" /** Armenian. */ - | 'HY' + | "HY" /** Interlingua. */ - | 'IA' + | "IA" /** Indonesian. */ - | 'ID' + | "ID" /** Igbo. */ - | 'IG' + | "IG" /** Sichuan Yi. */ - | 'II' + | "II" /** Icelandic. */ - | 'IS' + | "IS" /** Italian. */ - | 'IT' + | "IT" /** Japanese. */ - | 'JA' + | "JA" /** Javanese. */ - | 'JV' + | "JV" /** Georgian. */ - | 'KA' + | "KA" /** Kikuyu. */ - | 'KI' + | "KI" /** Kazakh. */ - | 'KK' + | "KK" /** Kalaallisut. */ - | 'KL' + | "KL" /** Khmer. */ - | 'KM' + | "KM" /** Kannada. */ - | 'KN' + | "KN" /** Korean. */ - | 'KO' + | "KO" /** Kashmiri. */ - | 'KS' + | "KS" /** Kurdish. */ - | 'KU' + | "KU" /** Cornish. */ - | 'KW' + | "KW" /** Kyrgyz. */ - | 'KY' + | "KY" /** Latin. */ - | 'LA' + | "LA" /** Luxembourgish. */ - | 'LB' + | "LB" /** Ganda. */ - | 'LG' + | "LG" /** Lingala. */ - | 'LN' + | "LN" /** Lao. */ - | 'LO' + | "LO" /** Lithuanian. */ - | 'LT' + | "LT" /** Luba-Katanga. */ - | 'LU' + | "LU" /** Latvian. */ - | 'LV' + | "LV" /** Malagasy. */ - | 'MG' + | "MG" /** Māori. */ - | 'MI' + | "MI" /** Macedonian. */ - | 'MK' + | "MK" /** Malayalam. */ - | 'ML' + | "ML" /** Mongolian. */ - | 'MN' + | "MN" /** Moldavian. */ - | 'MO' + | "MO" /** Marathi. */ - | 'MR' + | "MR" /** Malay. */ - | 'MS' + | "MS" /** Maltese. */ - | 'MT' + | "MT" /** Burmese. */ - | 'MY' + | "MY" /** Norwegian (Bokmål). */ - | 'NB' + | "NB" /** North Ndebele. */ - | 'ND' + | "ND" /** Nepali. */ - | 'NE' + | "NE" /** Dutch. */ - | 'NL' + | "NL" /** Norwegian Nynorsk. */ - | 'NN' + | "NN" /** Norwegian. */ - | 'NO' + | "NO" /** Oromo. */ - | 'OM' + | "OM" /** Odia. */ - | 'OR' + | "OR" /** Ossetic. */ - | 'OS' + | "OS" /** Punjabi. */ - | 'PA' + | "PA" /** Polish. */ - | 'PL' + | "PL" /** Pashto. */ - | 'PS' + | "PS" /** Portuguese. */ - | 'PT' + | "PT" /** Portuguese (Brazil). */ - | 'PT_BR' + | "PT_BR" /** Portuguese (Portugal). */ - | 'PT_PT' + | "PT_PT" /** Quechua. */ - | 'QU' + | "QU" /** Romansh. */ - | 'RM' + | "RM" /** Rundi. */ - | 'RN' + | "RN" /** Romanian. */ - | 'RO' + | "RO" /** Russian. */ - | 'RU' + | "RU" /** Kinyarwanda. */ - | 'RW' + | "RW" /** Sanskrit. */ - | 'SA' + | "SA" /** Sardinian. */ - | 'SC' + | "SC" /** Sindhi. */ - | 'SD' + | "SD" /** Northern Sami. */ - | 'SE' + | "SE" /** Sango. */ - | 'SG' + | "SG" /** Serbo-Croatian. */ - | 'SH' + | "SH" /** Sinhala. */ - | 'SI' + | "SI" /** Slovak. */ - | 'SK' + | "SK" /** Slovenian. */ - | 'SL' + | "SL" /** Shona. */ - | 'SN' + | "SN" /** Somali. */ - | 'SO' + | "SO" /** Albanian. */ - | 'SQ' + | "SQ" /** Serbian. */ - | 'SR' + | "SR" /** Sundanese. */ - | 'SU' + | "SU" /** Swedish. */ - | 'SV' + | "SV" /** Swahili. */ - | 'SW' + | "SW" /** Tamil. */ - | 'TA' + | "TA" /** Telugu. */ - | 'TE' + | "TE" /** Tajik. */ - | 'TG' + | "TG" /** Thai. */ - | 'TH' + | "TH" /** Tigrinya. */ - | 'TI' + | "TI" /** Turkmen. */ - | 'TK' + | "TK" /** Tongan. */ - | 'TO' + | "TO" /** Turkish. */ - | 'TR' + | "TR" /** Tatar. */ - | 'TT' + | "TT" /** Uyghur. */ - | 'UG' + | "UG" /** Ukrainian. */ - | 'UK' + | "UK" /** Urdu. */ - | 'UR' + | "UR" /** Uzbek. */ - | 'UZ' + | "UZ" /** Vietnamese. */ - | 'VI' + | "VI" /** Volapük. */ - | 'VO' + | "VO" /** Wolof. */ - | 'WO' + | "WO" /** Xhosa. */ - | 'XH' + | "XH" /** Yiddish. */ - | 'YI' + | "YI" /** Yoruba. */ - | 'YO' + | "YO" /** Chinese. */ - | 'ZH' + | "ZH" /** Chinese (Simplified). */ - | 'ZH_CN' + | "ZH_CN" /** Chinese (Traditional). */ - | 'ZH_TW' + | "ZH_TW" /** Zulu. */ - | 'ZU'; + | "ZU"; /** Information about the localized experiences configured for the shop. */ export type Localization = { @@ -4208,23 +4094,21 @@ export type Location = HasMetafields & Node & { /** The address of the location. */ address: LocationAddress; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The name of the location. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; }; - /** Represents a location where product inventory is held. */ export type LocationMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Represents a location where product inventory is held. */ export type LocationMetafieldsArgs = { identifiers: Array; @@ -4232,41 +4116,38 @@ export type LocationMetafieldsArgs = { /** * Represents the address of a location. - * */ export type LocationAddress = { /** The first line of the address for the location. */ - address1?: Maybe; + address1?: Maybe; /** The second line of the address for the location. */ - address2?: Maybe; + address2?: Maybe; /** The city of the location. */ - city?: Maybe; + city?: Maybe; /** The country of the location. */ - country?: Maybe; + country?: Maybe; /** The country code of the location. */ - countryCode?: Maybe; + countryCode?: Maybe; /** A formatted version of the address for the location. */ - formatted: Array; + formatted: Array; /** The latitude coordinates of the location. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinates of the location. */ - longitude?: Maybe; + longitude?: Maybe; /** The phone number of the location. */ - phone?: Maybe; + phone?: Maybe; /** The province of the location. */ - province?: Maybe; + province?: Maybe; /** * The code for the province, state, or district of the address of the location. - * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The ZIP code of the location. */ - zip?: Maybe; + zip?: Maybe; }; /** * An auto-generated type for paginating through multiple Locations. - * */ export type LocationConnection = { /** A list of edges. */ @@ -4279,11 +4160,10 @@ export type LocationConnection = { /** * An auto-generated type which holds one Location and a cursor during pagination. - * */ export type LocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of LocationEdge. */ node: Location; }; @@ -4291,29 +4171,28 @@ export type LocationEdge = { /** The set of valid sort keys for the Location query. */ export type LocationSortKeys = /** Sort by the `city` value. */ - | 'CITY' + | "CITY" /** Sort by the `distance` value. */ - | 'DISTANCE' + | "DISTANCE" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `name` value. */ - | 'NAME'; + | "NAME"; /** Represents a mailing address for customers and shipping. */ export type MailingAddress = Node & { /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe; + address1?: Maybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. - * */ - address2?: Maybe; + address2?: Maybe; /** The name of the city, district, village, or town. */ - city?: Maybe; + city?: Maybe; /** The name of the customer's company or organization. */ - company?: Maybe; + company?: Maybe; /** The name of the country. */ - country?: Maybe; + country?: Maybe; /** * The two-letter code for the country of the address. * @@ -4321,60 +4200,55 @@ export type MailingAddress = Node & { * * @deprecated Use `countryCodeV2` instead. */ - countryCode?: Maybe; + countryCode?: Maybe; /** * The two-letter code for the country of the address. * * For example, US. - * */ countryCodeV2?: Maybe; /** The first name of the customer. */ - firstName?: Maybe; + firstName?: Maybe; /** A formatted version of the address, customized by the provided arguments. */ - formatted: Array; + formatted: Array; /** A comma-separated list of the values for city, province, and country. */ - formattedArea?: Maybe; + formattedArea?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The last name of the customer. */ - lastName?: Maybe; + lastName?: Maybe; /** The latitude coordinate of the customer address. */ - latitude?: Maybe; + latitude?: Maybe; /** The longitude coordinate of the customer address. */ - longitude?: Maybe; + longitude?: Maybe; /** The full name of the customer, based on firstName and lastName. */ - name?: Maybe; + name?: Maybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: Maybe; + phone?: Maybe; /** The region of the address, such as the province, state, or district. */ - province?: Maybe; + province?: Maybe; /** * The two-letter code for the region. * * For example, ON. - * */ - provinceCode?: Maybe; + provinceCode?: Maybe; /** The zip or postal code of the address. */ - zip?: Maybe; + zip?: Maybe; }; - /** Represents a mailing address for customers and shipping. */ export type MailingAddressFormattedArgs = { - withCompany?: InputMaybe; - withName?: InputMaybe; + withCompany?: InputMaybe; + withName?: InputMaybe; }; /** * An auto-generated type for paginating through multiple MailingAddresses. - * */ export type MailingAddressConnection = { /** A list of edges. */ @@ -4387,11 +4261,10 @@ export type MailingAddressConnection = { /** * An auto-generated type which holds one MailingAddress and a cursor during pagination. - * */ export type MailingAddressEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MailingAddressEdge. */ node: MailingAddress; }; @@ -4400,58 +4273,52 @@ export type MailingAddressEdge = { export type MailingAddressInput = { /** * The first line of the address. Typically the street address or PO Box number. - * */ - address1?: InputMaybe; + address1?: InputMaybe; /** * The second line of the address. Typically the number of the apartment, suite, or unit. - * */ - address2?: InputMaybe; + address2?: InputMaybe; /** * The name of the city, district, village, or town. - * */ - city?: InputMaybe; + city?: InputMaybe; /** * The name of the customer's company or organization. - * */ - company?: InputMaybe; + company?: InputMaybe; /** The name of the country. */ - country?: InputMaybe; + country?: InputMaybe; /** The first name of the customer. */ - firstName?: InputMaybe; + firstName?: InputMaybe; /** The last name of the customer. */ - lastName?: InputMaybe; + lastName?: InputMaybe; /** * A unique phone number for the customer. * * Formatted using E.164 standard. For example, _+16135551111_. - * */ - phone?: InputMaybe; + phone?: InputMaybe; /** The region of the address, such as the province, state, or district. */ - province?: InputMaybe; + province?: InputMaybe; /** The zip or postal code of the address. */ - zip?: InputMaybe; + zip?: InputMaybe; }; /** * Manual discount applications capture the intentions of a discount that was manually created. - * */ export type ManualDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ allocationMethod: DiscountApplicationAllocationMethod; /** The description of the application. */ - description?: Maybe; + description?: Maybe; /** Which lines of targetType that the discount is allocated over. */ targetSelection: DiscountApplicationTargetSelection; /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -4460,25 +4327,22 @@ export type ManualDiscountApplication = DiscountApplication & { export type Market = HasMetafields & Node & { /** * A human-readable unique string for the market automatically generated from its title. - * */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; }; - /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ export type MarketMetafieldsArgs = { identifiers: Array; @@ -4487,9 +4351,9 @@ export type MarketMetafieldsArgs = { /** Represents a media interface. */ export type Media = { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4500,7 +4364,6 @@ export type Media = { /** * An auto-generated type for paginating through multiple Media. - * */ export type MediaConnection = { /** A list of edges. */ @@ -4514,21 +4377,20 @@ export type MediaConnection = { /** The possible content types for a media object. */ export type MediaContentType = /** An externally hosted video. */ - | 'EXTERNAL_VIDEO' + | "EXTERNAL_VIDEO" /** A Shopify hosted image. */ - | 'IMAGE' + | "IMAGE" /** A 3d model. */ - | 'MODEL_3D' + | "MODEL_3D" /** A Shopify hosted video. */ - | 'VIDEO'; + | "VIDEO"; /** * An auto-generated type which holds one Media and a cursor during pagination. - * */ export type MediaEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MediaEdge. */ node: Media; }; @@ -4536,16 +4398,16 @@ export type MediaEdge = { /** Host for a Media Resource. */ export type MediaHost = /** Host for Vimeo embedded videos. */ - | 'VIMEO' + | "VIMEO" /** Host for YouTube embedded videos. */ - | 'YOUTUBE'; + | "YOUTUBE"; /** Represents a Shopify hosted image. */ export type MediaImage = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The image for the media. */ image?: Maybe; /** The media content type. */ @@ -4559,12 +4421,11 @@ export type MediaImage = Media & Node & { /** A media presentation. */ export type MediaPresentation = Node & { /** A JSON object representing a presentation view. */ - asJson?: Maybe; + asJson?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; - /** A media presentation. */ export type MediaPresentationAsJsonArgs = { format: MediaPresentationFormat; @@ -4573,78 +4434,82 @@ export type MediaPresentationAsJsonArgs = { /** The possible formats for a media presentation. */ export type MediaPresentationFormat = /** A media image presentation. */ - | 'IMAGE' + | "IMAGE" /** A model viewer presentation. */ - | 'MODEL_VIEWER'; + | "MODEL_VIEWER"; /** * A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy * of hyperlinks (items). - * */ export type Menu = Node & { /** The menu's handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The menu's child items. */ items: Array; /** The count of items on the menu. */ - itemsCount: Scalars['Int']['output']; + itemsCount: Scalars["Int"]["output"]; /** The menu's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** A menu item within a parent menu. */ export type MenuItem = Node & { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The menu item's child items. */ items: Array; /** The linked resource. */ resource?: Maybe; /** The ID of the linked resource. */ - resourceId?: Maybe; + resourceId?: Maybe; /** The menu item's tags to filter a collection. */ - tags: Array; + tags: Array; /** The menu item's title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The menu item's type. */ type: MenuItemType; /** The menu item's URL. */ - url?: Maybe; + url?: Maybe; }; /** * The list of possible resources a `MenuItem` can reference. - * */ -export type MenuItemResource = Article | Blog | Collection | Page | Product | ShopPolicy; +export type MenuItemResource = + | Article + | Blog + | Collection + | Page + | Product + | ShopPolicy; /** A menu item type. */ export type MenuItemType = /** An article link. */ - | 'ARTICLE' + | "ARTICLE" /** A blog link. */ - | 'BLOG' + | "BLOG" /** A catalog link. */ - | 'CATALOG' + | "CATALOG" /** A collection link. */ - | 'COLLECTION' + | "COLLECTION" /** A collection link. */ - | 'COLLECTIONS' + | "COLLECTIONS" /** A frontpage link. */ - | 'FRONTPAGE' + | "FRONTPAGE" /** An http link. */ - | 'HTTP' + | "HTTP" /** A page link. */ - | 'PAGE' + | "PAGE" /** A product link. */ - | 'PRODUCT' + | "PRODUCT" /** A search link. */ - | 'SEARCH' + | "SEARCH" /** A shop policy link. */ - | 'SHOP_POLICY'; + | "SHOP_POLICY"; /** The merchandise to be purchased at checkout. */ export type Merchandise = ProductVariant; @@ -4652,19 +4517,18 @@ export type Merchandise = ProductVariant; /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. - * */ export type Metafield = Node & { /** The date and time when the storefront metafield was created. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The description of a metafield. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The unique identifier for the metafield within its namespace. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** The container for a group of metafields that the metafield is associated with. */ - namespace: Scalars['String']['output']; + namespace: Scalars["String"]["output"]; /** The type of resource that the metafield is attached to. */ parentResource: MetafieldParentResource; /** Returns a reference object if the metafield's type is a resource reference. */ @@ -4674,43 +4538,40 @@ export type Metafield = Node & { /** * The type name of the metafield. * Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). - * */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The date and time when the metafield was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */ - value: Scalars['String']['output']; + value: Scalars["String"]["output"]; }; - /** * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are * comprised of keys, values, and value types. - * */ export type MetafieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** Possible error codes that can be returned by `MetafieldDeleteUserError`. */ export type MetafieldDeleteErrorCode = /** The owner ID is invalid. */ - | 'INVALID_OWNER' + | "INVALID_OWNER" /** Metafield not found. */ - | 'METAFIELD_DOES_NOT_EXIST'; + | "METAFIELD_DOES_NOT_EXIST"; /** An error that occurs during the execution of cart metafield deletion. */ export type MetafieldDeleteUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** @@ -4721,29 +4582,46 @@ export type MetafieldDeleteUserError = DisplayableError & { * - `number_decimal` * - `single_line_text_field` * - `boolean` as of 2022-04. - * */ export type MetafieldFilter = { /** The key of the metafield to filter on. */ - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; /** The namespace of the metafield to filter on. */ - namespace: Scalars['String']['input']; + namespace: Scalars["String"]["input"]; /** The value of the metafield. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** A resource that the metafield belongs to. */ -export type MetafieldParentResource = Article | Blog | Cart | Collection | Customer | Location | Market | Order | Page | Product | ProductVariant | Shop; +export type MetafieldParentResource = + | Article + | Blog + | Cart + | Collection + | Customer + | Location + | Market + | Order + | Page + | Product + | ProductVariant + | Shop; /** * Returns the resource which is being referred to by a metafield. - * */ -export type MetafieldReference = Collection | GenericFile | MediaImage | Metaobject | Page | Product | ProductVariant | Video; +export type MetafieldReference = + | Collection + | GenericFile + | MediaImage + | Metaobject + | Page + | Product + | ProductVariant + | Video; /** * An auto-generated type for paginating through multiple MetafieldReferences. - * */ export type MetafieldReferenceConnection = { /** A list of edges. */ @@ -4756,11 +4634,10 @@ export type MetafieldReferenceConnection = { /** * An auto-generated type which holds one MetafieldReference and a cursor during pagination. - * */ export type MetafieldReferenceEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MetafieldReferenceEdge. */ node: MetafieldReference; }; @@ -4770,33 +4647,33 @@ export type MetafieldsSetUserError = DisplayableError & { /** The error code. */ code?: Maybe; /** The index of the array element that's causing the error. */ - elementIndex?: Maybe; + elementIndex?: Maybe; /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** Possible error codes that can be returned by `MetafieldsSetUserError`. */ export type MetafieldsSetUserErrorCode = /** The input value is blank. */ - | 'BLANK' + | "BLANK" /** The input value isn't included in the list. */ - | 'INCLUSION' + | "INCLUSION" /** The owner ID is invalid. */ - | 'INVALID_OWNER' + | "INVALID_OWNER" /** The type is invalid. */ - | 'INVALID_TYPE' + | "INVALID_TYPE" /** The value is invalid for metafield type or for definition options. */ - | 'INVALID_VALUE' + | "INVALID_VALUE" /** The input value should be less than or equal to the maximum value allowed. */ - | 'LESS_THAN_OR_EQUAL_TO' + | "LESS_THAN_OR_EQUAL_TO" /** The input value needs to be blank. */ - | 'PRESENT' + | "PRESENT" /** The input value is too long. */ - | 'TOO_LONG' + | "TOO_LONG" /** The input value is too short. */ - | 'TOO_SHORT'; + | "TOO_SHORT"; /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type Metaobject = Node & { @@ -4805,28 +4682,25 @@ export type Metaobject = Node & { /** * All object fields with defined values. * Omitted object keys can be assumed null, and no guarantees are made about field order. - * */ fields: Array; /** The unique handle of the metaobject. Useful as a custom ID. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The type of the metaobject. Defines the namespace of its associated metafields. */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The date and time when the metaobject was last updated. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** An instance of a user-defined model based on a MetaobjectDefinition. */ export type MetaobjectFieldArgs = { - key: Scalars['String']['input']; + key: Scalars["String"]["input"]; }; /** * An auto-generated type for paginating through multiple Metaobjects. - * */ export type MetaobjectConnection = { /** A list of edges. */ @@ -4839,11 +4713,10 @@ export type MetaobjectConnection = { /** * An auto-generated type which holds one Metaobject and a cursor during pagination. - * */ export type MetaobjectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of MetaobjectEdge. */ node: Metaobject; }; @@ -4851,7 +4724,7 @@ export type MetaobjectEdge = { /** Provides the value of a Metaobject field. */ export type MetaobjectField = { /** The field key. */ - key: Scalars['String']['output']; + key: Scalars["String"]["output"]; /** A referenced object if the field type is a resource reference. */ reference?: Maybe; /** A list of referenced objects if the field type is a resource reference list. */ @@ -4859,36 +4732,34 @@ export type MetaobjectField = { /** * The type name of the field. * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). - * */ - type: Scalars['String']['output']; + type: Scalars["String"]["output"]; /** The field value. */ - value?: Maybe; + value?: Maybe; }; - /** Provides the value of a Metaobject field. */ export type MetaobjectFieldReferencesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; }; /** The input fields used to retrieve a metaobject by handle. */ export type MetaobjectHandleInput = { /** The handle of the metaobject. */ - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; /** The type of the metaobject. */ - type: Scalars['String']['input']; + type: Scalars["String"]["input"]; }; /** Represents a Shopify hosted 3D model. */ export type Model3d = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -4902,30 +4773,29 @@ export type Model3d = Media & Node & { /** Represents a source for a Shopify hosted 3d model. */ export type Model3dSource = { /** The filesize of the 3d model. */ - filesize: Scalars['Int']['output']; + filesize: Scalars["Int"]["output"]; /** The format of the 3d model. */ - format: Scalars['String']['output']; + format: Scalars["String"]["output"]; /** The MIME type of the 3d model. */ - mimeType: Scalars['String']['output']; + mimeType: Scalars["String"]["output"]; /** The URL of the 3d model. */ - url: Scalars['String']['output']; + url: Scalars["String"]["output"]; }; /** The input fields for a monetary value with currency. */ export type MoneyInput = { /** Decimal money amount. */ - amount: Scalars['Decimal']['input']; + amount: Scalars["Decimal"]["input"]; /** Currency of the money. */ currencyCode: CurrencyCode; }; /** * A monetary value with currency. - * */ export type MoneyV2 = { /** Decimal money amount. */ - amount: Scalars['Decimal']['output']; + amount: Scalars["Decimal"]["output"]; /** Currency of the money. */ currencyCode: CurrencyCode; }; @@ -4939,7 +4809,6 @@ export type Mutation = { * Buyer identity is used to determine * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) * and should match the customer's shipping address. - * */ cartBuyerIdentityUpdate?: Maybe; /** Creates a new cart. */ @@ -4958,7 +4827,6 @@ export type Mutation = { * Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. * * Allows a maximum of 25 cart metafields to be set at a time. - * */ cartMetafieldsSet?: Maybe; /** Updates the note on the cart. */ @@ -4966,7 +4834,9 @@ export type Mutation = { /** Update the customer's payment method that will be used to checkout. */ cartPaymentUpdate?: Maybe; /** Update the selected delivery options for a delivery group. */ - cartSelectedDeliveryOptionsUpdate?: Maybe; + cartSelectedDeliveryOptionsUpdate?: Maybe< + CartSelectedDeliveryOptionsUpdatePayload + >; /** Submit the cart for checkout completion. */ cartSubmitForCompletion?: Maybe; /** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */ @@ -4974,9 +4844,13 @@ export type Mutation = { /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ checkoutCompleteFree?: Maybe; /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). */ - checkoutCompleteWithCreditCardV2?: Maybe; + checkoutCompleteWithCreditCardV2?: Maybe< + CheckoutCompleteWithCreditCardV2Payload + >; /** Completes a checkout with a tokenized payment. */ - checkoutCompleteWithTokenizedPaymentV3?: Maybe; + checkoutCompleteWithTokenizedPaymentV3?: Maybe< + CheckoutCompleteWithTokenizedPaymentV3Payload + >; /** Creates a new checkout. */ checkoutCreate?: Maybe; /** Associates a customer to the checkout. */ @@ -5002,13 +4876,14 @@ export type Mutation = { /** Updates line items on a checkout. */ checkoutLineItemsUpdate?: Maybe; /** Updates the shipping address of an existing checkout. */ - checkoutShippingAddressUpdateV2?: Maybe; + checkoutShippingAddressUpdateV2?: Maybe< + CheckoutShippingAddressUpdateV2Payload + >; /** Updates the shipping lines on an existing checkout. */ checkoutShippingLineUpdate?: Maybe; /** * Creates a customer access token. * The customer access token is required to modify the customer object in any way. - * */ customerAccessTokenCreate?: Maybe; /** @@ -5016,9 +4891,10 @@ export type Mutation = { * [multipass token](https://shopify.dev/api/multipass) instead of email and * password. A customer record is created if the customer doesn't exist. If a customer * record already exists but the record is disabled, then the customer record is enabled. - * */ - customerAccessTokenCreateWithMultipass?: Maybe; + customerAccessTokenCreateWithMultipass?: Maybe< + CustomerAccessTokenCreateWithMultipassPayload + >; /** Permanently destroys a customer access token. */ customerAccessTokenDelete?: Maybe; /** @@ -5026,7 +4902,6 @@ export type Mutation = { * * Access token renewal must happen *before* a token expires. * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. - * */ customerAccessTokenRenew?: Maybe; /** Activates a customer. */ @@ -5056,332 +4931,283 @@ export type Mutation = { * * Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this * mutation presents a security risk. - * */ customerRecover?: Maybe; /** * "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." - * */ customerReset?: Maybe; /** * "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." - * */ customerResetByUrl?: Maybe; /** Updates an existing customer. */ customerUpdate?: Maybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartAttributesUpdateArgs = { attributes: Array; - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartBuyerIdentityUpdateArgs = { buyerIdentity: CartBuyerIdentityInput; - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartCreateArgs = { input?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartDiscountCodesUpdateArgs = { - cartId: Scalars['ID']['input']; - discountCodes?: InputMaybe>; + cartId: Scalars["ID"]["input"]; + discountCodes?: InputMaybe>; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesAddArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesRemoveArgs = { - cartId: Scalars['ID']['input']; - lineIds: Array; + cartId: Scalars["ID"]["input"]; + lineIds: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartLinesUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; lines: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldDeleteArgs = { input: CartMetafieldDeleteInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartMetafieldsSetArgs = { metafields: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartNoteUpdateArgs = { - cartId: Scalars['ID']['input']; - note?: InputMaybe; + cartId: Scalars["ID"]["input"]; + note?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartPaymentUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; payment: CartPaymentInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSelectedDeliveryOptionsUpdateArgs = { - cartId: Scalars['ID']['input']; + cartId: Scalars["ID"]["input"]; selectedDeliveryOptions: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCartSubmitForCompletionArgs = { - attemptToken: Scalars['String']['input']; - cartId: Scalars['ID']['input']; + attemptToken: Scalars["String"]["input"]; + cartId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutAttributesUpdateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; input: CheckoutAttributesUpdateV2Input; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteFreeArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithCreditCardV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; payment: CreditCardPaymentInputV2; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; payment: TokenizedPaymentInputV3; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCreateArgs = { input: CheckoutCreateInput; - queueToken?: InputMaybe; + queueToken?: InputMaybe; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerAssociateV2Args = { - checkoutId: Scalars['ID']['input']; - customerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCustomerDisassociateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeApplyV2Args = { - checkoutId: Scalars['ID']['input']; - discountCode: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + discountCode: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutDiscountCodeRemoveArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutEmailUpdateV2Args = { - checkoutId: Scalars['ID']['input']; - email: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + email: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardRemoveV2Args = { - appliedGiftCardId: Scalars['ID']['input']; - checkoutId: Scalars['ID']['input']; + appliedGiftCardId: Scalars["ID"]["input"]; + checkoutId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutGiftCardsAppendArgs = { - checkoutId: Scalars['ID']['input']; - giftCardCodes: Array; + checkoutId: Scalars["ID"]["input"]; + giftCardCodes: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsAddArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsRemoveArgs = { - checkoutId: Scalars['ID']['input']; - lineItemIds: Array; + checkoutId: Scalars["ID"]["input"]; + lineItemIds: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsReplaceArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutLineItemsUpdateArgs = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; lineItems: Array; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingAddressUpdateV2Args = { - checkoutId: Scalars['ID']['input']; + checkoutId: Scalars["ID"]["input"]; shippingAddress: MailingAddressInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingLineUpdateArgs = { - checkoutId: Scalars['ID']['input']; - shippingRateHandle: Scalars['String']['input']; + checkoutId: Scalars["ID"]["input"]; + shippingRateHandle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenCreateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenCreateWithMultipassArgs = { - multipassToken: Scalars['String']['input']; + multipassToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenDeleteArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; input: CustomerActivateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerActivateByUrlArgs = { - activationUrl: Scalars['URL']['input']; - password: Scalars['String']['input']; + activationUrl: Scalars["URL"]["input"]; + password: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressCreateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressDeleteArgs = { - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerAddressUpdateArgs = { address: MailingAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerCreateArgs = { input: CustomerCreateInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerDefaultAddressUpdateArgs = { - addressId: Scalars['ID']['input']; - customerAccessToken: Scalars['String']['input']; + addressId: Scalars["ID"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerRecoverArgs = { - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; input: CustomerResetInput; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerResetByUrlArgs = { - password: Scalars['String']['input']; - resetUrl: Scalars['URL']['input']; + password: Scalars["String"]["input"]; + resetUrl: Scalars["URL"]["input"]; }; - /** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCustomerUpdateArgs = { customer: CustomerUpdateInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; /** @@ -5389,17 +5215,16 @@ export type MutationCustomerUpdateArgs = { * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. - * */ export type Node = { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; }; /** Represents a resource that can be published to the Online Store sales channel. */ export type OnlineStorePublishable = { /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; }; /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ @@ -5409,7 +5234,7 @@ export type Order = HasMetafields & Node & { /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ cancelReason?: Maybe; /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ - canceledAt?: Maybe; + canceledAt?: Maybe; /** The code of the currency used for the payment. */ currencyCode: CurrencyCode; /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order. */ @@ -5423,21 +5248,21 @@ export type Order = HasMetafields & Node & { /** A list of the custom attributes added to the order. */ customAttributes: Array; /** The locale code in which this specific order happened. */ - customerLocale?: Maybe; + customerLocale?: Maybe; /** The unique URL that the customer can use to access the order. */ - customerUrl?: Maybe; + customerUrl?: Maybe; /** Discounts that have been applied on the order. */ discountApplications: DiscountApplicationConnection; /** Whether the order has had any edits applied or not. */ - edited: Scalars['Boolean']['output']; + edited: Scalars["Boolean"]["output"]; /** The customer's email address. */ - email?: Maybe; + email?: Maybe; /** The financial status of the order. */ financialStatus?: Maybe; /** The fulfillment status for the order. */ fulfillmentStatus: OrderFulfillmentStatus; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** List of the order’s line items. */ lineItems: OrderLineItemConnection; /** Returns a metafield found by namespace and key. */ @@ -5447,33 +5272,30 @@ export type Order = HasMetafields & Node & { /** * Unique identifier for the order that appears on the order. * For example, _#1000_ or _Store1001. - * */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** A unique numeric identifier for the order for use by shop owner and customer. */ - orderNumber: Scalars['Int']['output']; + orderNumber: Scalars["Int"]["output"]; /** The total cost of duties charged at checkout. */ originalTotalDuties?: Maybe; /** The total price of the order before any applied edits. */ originalTotalPrice: MoneyV2; /** The customer's phone number for receiving SMS notifications. */ - phone?: Maybe; + phone?: Maybe; /** * The date and time when the order was imported. * This value can be set to dates in the past when importing from other systems. * If no value is provided, it will be auto-generated based on current date and time. - * */ - processedAt: Scalars['DateTime']['output']; + processedAt: Scalars["DateTime"]["output"]; /** The address to where the order will be shipped. */ shippingAddress?: Maybe; /** * The discounts that have been allocated onto the shipping line by discount applications. - * */ shippingDiscountAllocations: Array; /** The unique URL for the order's status page. */ - statusUrl: Scalars['URL']['output']; + statusUrl: Scalars["URL"]["output"]; /** Price of the order before shipping and taxes. */ subtotalPrice?: Maybe; /** @@ -5513,61 +5335,55 @@ export type Order = HasMetafields & Node & { totalTaxV2?: Maybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderDiscountApplicationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderLineItemsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderMetafieldsArgs = { identifiers: Array; }; - /** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ export type OrderSuccessfulFulfillmentsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; /** Represents the reason for the order's cancellation. */ export type OrderCancelReason = /** The customer wanted to cancel the order. */ - | 'CUSTOMER' + | "CUSTOMER" /** Payment was declined. */ - | 'DECLINED' + | "DECLINED" /** The order was fraudulent. */ - | 'FRAUD' + | "FRAUD" /** There was insufficient inventory. */ - | 'INVENTORY' + | "INVENTORY" /** The order was canceled for an unlisted reason. */ - | 'OTHER'; + | "OTHER"; /** * An auto-generated type for paginating through multiple Orders. - * */ export type OrderConnection = { /** A list of edges. */ @@ -5577,16 +5393,15 @@ export type OrderConnection = { /** Information to aid in pagination. */ pageInfo: PageInfo; /** The total count of Orders. */ - totalCount: Scalars['UnsignedInt64']['output']; + totalCount: Scalars["UnsignedInt64"]["output"]; }; /** * An auto-generated type which holds one Order and a cursor during pagination. - * */ export type OrderEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of OrderEdge. */ node: Order; }; @@ -5594,45 +5409,45 @@ export type OrderEdge = { /** Represents the order's current financial status. */ export type OrderFinancialStatus = /** Displayed as **Authorized**. */ - | 'AUTHORIZED' + | "AUTHORIZED" /** Displayed as **Paid**. */ - | 'PAID' + | "PAID" /** Displayed as **Partially paid**. */ - | 'PARTIALLY_PAID' + | "PARTIALLY_PAID" /** Displayed as **Partially refunded**. */ - | 'PARTIALLY_REFUNDED' + | "PARTIALLY_REFUNDED" /** Displayed as **Pending**. */ - | 'PENDING' + | "PENDING" /** Displayed as **Refunded**. */ - | 'REFUNDED' + | "REFUNDED" /** Displayed as **Voided**. */ - | 'VOIDED'; + | "VOIDED"; /** Represents the order's aggregated fulfillment status for display purposes. */ export type OrderFulfillmentStatus = /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ - | 'FULFILLED' + | "FULFILLED" /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ - | 'IN_PROGRESS' + | "IN_PROGRESS" /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ - | 'ON_HOLD' + | "ON_HOLD" /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ - | 'OPEN' + | "OPEN" /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ - | 'PARTIALLY_FULFILLED' + | "PARTIALLY_FULFILLED" /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ - | 'PENDING_FULFILLMENT' + | "PENDING_FULFILLMENT" /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ - | 'RESTOCKED' + | "RESTOCKED" /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ - | 'SCHEDULED' + | "SCHEDULED" /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ - | 'UNFULFILLED'; + | "UNFULFILLED"; /** Represents a single line in an order. There is one line item for each distinct product variant. */ export type OrderLineItem = { /** The number of entries associated to the line item minus the items that have been removed. */ - currentQuantity: Scalars['Int']['output']; + currentQuantity: Scalars["Int"]["output"]; /** List of custom attributes associated to the line item. */ customAttributes: Array; /** The discounts that have been allocated onto the order line item by discount applications. */ @@ -5642,16 +5457,15 @@ export type OrderLineItem = { /** The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it's displayed in the presentment currency. */ originalTotalPrice: MoneyV2; /** The number of products variants associated to the line item. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The title of the product combined with title of the variant. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The product variant object associated to the line item. */ variant?: Maybe; }; /** * An auto-generated type for paginating through multiple OrderLineItems. - * */ export type OrderLineItemConnection = { /** A list of edges. */ @@ -5664,11 +5478,10 @@ export type OrderLineItemConnection = { /** * An auto-generated type which holds one OrderLineItem and a cursor during pagination. - * */ export type OrderLineItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of OrderLineItemEdge. */ node: OrderLineItem; }; @@ -5676,54 +5489,51 @@ export type OrderLineItemEdge = { /** The set of valid sort keys for the Order query. */ export type OrderSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `processed_at` value. */ - | 'PROCESSED_AT' + | "PROCESSED_AT" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `total_price` value. */ - | 'TOTAL_PRICE'; + | "TOTAL_PRICE"; /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & { /** The description of the page, complete with HTML formatting. */ - body: Scalars['HTML']['output']; + body: Scalars["HTML"]["output"]; /** Summary of the page body. */ - bodySummary: Scalars['String']['output']; + bodySummary: Scalars["String"]["output"]; /** The timestamp of the page creation. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** A human-friendly unique string for the page automatically generated from its title. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; + onlineStoreUrl?: Maybe; /** The page's SEO information. */ seo?: Maybe; /** The title of the page. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; /** The timestamp of the latest page update. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; }; - /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ export type PageMetafieldsArgs = { identifiers: Array; @@ -5731,7 +5541,6 @@ export type PageMetafieldsArgs = { /** * An auto-generated type for paginating through multiple Pages. - * */ export type PageConnection = { /** A list of edges. */ @@ -5744,11 +5553,10 @@ export type PageConnection = { /** * An auto-generated type which holds one Page and a cursor during pagination. - * */ export type PageEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of PageEdge. */ node: Page; }; @@ -5757,33 +5565,31 @@ export type PageEdge = { * Returns information about pagination in a connection, in accordance with the * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). - * */ export type PageInfo = { /** The cursor corresponding to the last node in edges. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Whether there are more pages to fetch following the current page. */ - hasNextPage: Scalars['Boolean']['output']; + hasNextPage: Scalars["Boolean"]["output"]; /** Whether there are any pages prior to the current page. */ - hasPreviousPage: Scalars['Boolean']['output']; + hasPreviousPage: Scalars["Boolean"]["output"]; /** The cursor corresponding to the first node in edges. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** The set of valid sort keys for the Page query. */ export type PageSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT'; + | "UPDATED_AT"; /** A payment applied to a checkout. */ export type Payment = Node & { @@ -5801,22 +5607,21 @@ export type Payment = Node & { /** The credit card used for the payment in the case of direct payments. */ creditCard?: Maybe; /** A message describing a processing error during asynchronous processing. */ - errorMessage?: Maybe; + errorMessage?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** * A client-side generated token to identify a payment and perform idempotent operations. * For more information, refer to * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). - * */ - idempotencyKey?: Maybe; + idempotencyKey?: Maybe; /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ - nextActionUrl?: Maybe; + nextActionUrl?: Maybe; /** Whether the payment is still processing asynchronously. */ - ready: Scalars['Boolean']['output']; + ready: Scalars["Boolean"]["output"]; /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ - test: Scalars['Boolean']['output']; + test: Scalars["Boolean"]["output"]; /** The actual transaction recorded by Shopify after having processed the payment with the gateway. */ transaction?: Maybe; }; @@ -5826,7 +5631,7 @@ export type PaymentSettings = { /** List of the card brands which the shop accepts. */ acceptedCardBrands: Array; /** The url pointing to the endpoint to vault credit cards. */ - cardVaultUrl: Scalars['URL']['output']; + cardVaultUrl: Scalars["URL"]["output"]; /** The country where the shop is located. */ countryCode: CountryCode; /** The three-letter code for the shop's primary currency. */ @@ -5834,11 +5639,10 @@ export type PaymentSettings = { /** * A list of enabled currencies (ISO 4217 format) that the shop accepts. * Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. - * */ enabledPresentmentCurrencies: Array; /** The shop’s Shopify Payments account ID. */ - shopifyPaymentsAccountId?: Maybe; + shopifyPaymentsAccountId?: Maybe; /** List of the digital wallets which the shop supports. */ supportedDigitalWallets: Array; }; @@ -5846,27 +5650,26 @@ export type PaymentSettings = { /** The valid values for the types of payment token. */ export type PaymentTokenType = /** Apple Pay token type. */ - | 'APPLE_PAY' + | "APPLE_PAY" /** Google Pay token type. */ - | 'GOOGLE_PAY' + | "GOOGLE_PAY" /** Shopify Pay token type. */ - | 'SHOPIFY_PAY' + | "SHOPIFY_PAY" /** Stripe token type. */ - | 'STRIPE_VAULT_TOKEN' + | "STRIPE_VAULT_TOKEN" /** Vault payment token type. */ - | 'VAULT'; + | "VAULT"; /** Decides the distribution of results. */ export type PredictiveSearchLimitScope = /** Return results up to limit across all types. */ - | 'ALL' + | "ALL" /** Return results up to limit per type. */ - | 'EACH'; + | "EACH"; /** * A predictive search result represents a list of products, collections, pages, articles, and query suggestions * that matches the predictive search query. - * */ export type PredictiveSearchResult = { /** The articles that match the search query. */ @@ -5884,31 +5687,30 @@ export type PredictiveSearchResult = { /** The types of search items to perform predictive search on. */ export type PredictiveSearchType = /** Returns matching articles. */ - | 'ARTICLE' + | "ARTICLE" /** Returns matching collections. */ - | 'COLLECTION' + | "COLLECTION" /** Returns matching pages. */ - | 'PAGE' + | "PAGE" /** Returns matching products. */ - | 'PRODUCT' + | "PRODUCT" /** Returns matching query strings. */ - | 'QUERY'; + | "QUERY"; /** * The input fields for a filter used to view a subset of products in a collection matching a specific price range. - * */ export type PriceRangeFilter = { /** The maximum price in the range. Empty indicates no max price. */ - max?: InputMaybe; + max?: InputMaybe; /** The minimum price in the range. Defaults to zero. */ - min?: InputMaybe; + min?: InputMaybe; }; /** The value of the percentage pricing object. */ export type PricingPercentageValue = { /** The percentage value of the object. */ - percentage: Scalars['Float']['output']; + percentage: Scalars["Float"]["output"]; }; /** The price value (fixed or percentage) for a discount application. */ @@ -5919,265 +5721,242 @@ export type PricingValue = MoneyV2 | PricingPercentageValue; * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ -export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable & { - /** Indicates if at least one product variant is available for sale. */ - availableForSale: Scalars['Boolean']['output']; - /** List of collections a product belongs to. */ - collections: CollectionConnection; - /** The compare at price of the product across all variants. */ - compareAtPriceRange: ProductPriceRange; - /** The date and time when the product was created. */ - createdAt: Scalars['DateTime']['output']; - /** Stripped description of the product, single line with HTML tags removed. */ - description: Scalars['String']['output']; - /** The description of the product, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML']['output']; - /** - * The featured image for the product. - * - * This field is functionally equivalent to `images(first: 1)`. - * - */ - featuredImage?: Maybe; - /** - * A human-friendly unique string for the Product automatically generated from its title. - * They are used by the Liquid templating language to refer to objects. - * - */ - handle: Scalars['String']['output']; - /** A globally-unique ID. */ - id: Scalars['ID']['output']; - /** List of images associated with the product. */ - images: ImageConnection; - /** Whether the product is a gift card. */ - isGiftCard: Scalars['Boolean']['output']; - /** The media associated with the product. */ - media: MediaConnection; - /** Returns a metafield found by namespace and key. */ - metafield?: Maybe; - /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ - metafields: Array>; - /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ - onlineStoreUrl?: Maybe; - /** List of product options. */ - options: Array; - /** The price range. */ - priceRange: ProductPriceRange; - /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ - productType: Scalars['String']['output']; - /** The date and time when the product was published to the channel. */ - publishedAt: Scalars['DateTime']['output']; - /** Whether the product can only be purchased with a selling plan. */ - requiresSellingPlan: Scalars['Boolean']['output']; - /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ - sellingPlanGroups: SellingPlanGroupConnection; - /** The product's SEO information. */ - seo: Seo; - /** - * A comma separated list of tags that have been added to the product. - * Additional access scope required for private apps: unauthenticated_read_product_tags. - * - */ - tags: Array; - /** The product’s title. */ - title: Scalars['String']['output']; - /** The total quantity of inventory in stock for this Product. */ - totalInventory?: Maybe; - /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; - /** - * The date and time when the product was last modified. - * A product's `updatedAt` value can change for different reasons. For example, if an order - * is placed for a product that has inventory tracking set up, then the inventory adjustment - * is counted as an update. - * - */ - updatedAt: Scalars['DateTime']['output']; - /** - * Find a product’s variant based on its selected options. - * This is useful for converting a user’s selection of product options into a single matching variant. - * If there is not a variant for the selected options, `null` will be returned. - * - */ - variantBySelectedOptions?: Maybe; - /** List of the product’s variants. */ - variants: ProductVariantConnection; - /** The product’s vendor name. */ - vendor: Scalars['String']['output']; -}; - +export type Product = + & HasMetafields + & Node + & OnlineStorePublishable + & Trackable + & { + /** Indicates if at least one product variant is available for sale. */ + availableForSale: Scalars["Boolean"]["output"]; + /** List of collections a product belongs to. */ + collections: CollectionConnection; + /** The compare at price of the product across all variants. */ + compareAtPriceRange: ProductPriceRange; + /** The date and time when the product was created. */ + createdAt: Scalars["DateTime"]["output"]; + /** Stripped description of the product, single line with HTML tags removed. */ + description: Scalars["String"]["output"]; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml: Scalars["HTML"]["output"]; + /** + * The featured image for the product. + * + * This field is functionally equivalent to `images(first: 1)`. + */ + featuredImage?: Maybe; + /** + * A human-friendly unique string for the Product automatically generated from its title. + * They are used by the Liquid templating language to refer to objects. + */ + handle: Scalars["String"]["output"]; + /** A globally-unique ID. */ + id: Scalars["ID"]["output"]; + /** List of images associated with the product. */ + images: ImageConnection; + /** Whether the product is a gift card. */ + isGiftCard: Scalars["Boolean"]["output"]; + /** The media associated with the product. */ + media: MediaConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of product options. */ + options: Array; + /** The price range. */ + priceRange: ProductPriceRange; + /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ + productType: Scalars["String"]["output"]; + /** The date and time when the product was published to the channel. */ + publishedAt: Scalars["DateTime"]["output"]; + /** Whether the product can only be purchased with a selling plan. */ + requiresSellingPlan: Scalars["Boolean"]["output"]; + /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** The product's SEO information. */ + seo: Seo; + /** + * A comma separated list of tags that have been added to the product. + * Additional access scope required for private apps: unauthenticated_read_product_tags. + */ + tags: Array; + /** The product’s title. */ + title: Scalars["String"]["output"]; + /** The total quantity of inventory in stock for this Product. */ + totalInventory?: Maybe; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** + * The date and time when the product was last modified. + * A product's `updatedAt` value can change for different reasons. For example, if an order + * is placed for a product that has inventory tracking set up, then the inventory adjustment + * is counted as an update. + */ + updatedAt: Scalars["DateTime"]["output"]; + /** + * Find a product’s variant based on its selected options. + * This is useful for converting a user’s selection of product options into a single matching variant. + * If there is not a variant for the selected options, `null` will be returned. + */ + variantBySelectedOptions?: Maybe; + /** List of the product’s variants. */ + variants: ProductVariantConnection; + /** The product’s vendor name. */ + vendor: Scalars["String"]["output"]; + }; /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductDescriptionArgs = { - truncateAt?: InputMaybe; + truncateAt?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductImagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMediaArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductMetafieldsArgs = { identifiers: Array; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductOptionsArgs = { - first?: InputMaybe; + first?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductSellingPlanGroupsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductVariantBySelectedOptionsArgs = { selectedOptions: Array; }; - /** * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. * For example, a digital download (such as a movie, music or ebook file) also * qualifies as a product, as do services (such as equipment rental, work for hire, * customization of another product or an extended warranty). - * */ export type ProductVariantsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; /** The set of valid sort keys for the ProductCollection query. */ export type ProductCollectionSortKeys = /** Sort by the `best-selling` value. */ - | 'BEST_SELLING' + | "BEST_SELLING" /** Sort by the `collection-default` value. */ - | 'COLLECTION_DEFAULT' + | "COLLECTION_DEFAULT" /** Sort by the `created` value. */ - | 'CREATED' + | "CREATED" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `manual` value. */ - | 'MANUAL' + | "MANUAL" /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** * An auto-generated type for paginating through multiple Products. - * */ export type ProductConnection = { /** A list of edges. */ @@ -6192,11 +5971,10 @@ export type ProductConnection = { /** * An auto-generated type which holds one Product and a cursor during pagination. - * */ export type ProductEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ProductEdge. */ node: Product; }; @@ -6205,21 +5983,20 @@ export type ProductEdge = { * The input fields for a filter used to view a subset of products in a collection. * By default, the `available` and `price` filters are enabled. Filters are customized with the Shopify Search & Discovery app. * Learn more about [customizing storefront filtering](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters). - * */ export type ProductFilter = { /** Filter on if the product is available for sale. */ - available?: InputMaybe; + available?: InputMaybe; /** A range of prices to filter with-in. */ price?: InputMaybe; /** A product metafield to filter on. */ productMetafield?: InputMaybe; /** The product type to filter on. */ - productType?: InputMaybe; + productType?: InputMaybe; /** The product vendor to filter on. */ - productVendor?: InputMaybe; + productVendor?: InputMaybe; /** A product tag to filter on. */ - tag?: InputMaybe; + tag?: InputMaybe; /** A variant metafield to filter on. */ variantMetafield?: InputMaybe; /** A variant option to filter on. */ @@ -6229,44 +6006,41 @@ export type ProductFilter = { /** The set of valid sort keys for the ProductImage query. */ export type ProductImageSortKeys = /** Sort by the `created_at` value. */ - | 'CREATED_AT' + | "CREATED_AT" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE'; + | "RELEVANCE"; /** The set of valid sort keys for the ProductMedia query. */ export type ProductMediaSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE'; + | "RELEVANCE"; /** * Product property names like "Size", "Color", and "Material" that the customers can select. * Variants are selected based on permutations of these options. * 255 characters limit each. - * */ export type ProductOption = Node & { /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The product option’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The corresponding value to the product option name. */ - values: Array; + values: Array; }; /** The price range of the product. */ @@ -6280,48 +6054,45 @@ export type ProductPriceRange = { /** * The recommendation intent that is used to generate product recommendations. * You can use intent to generate product recommendations according to different strategies. - * */ export type ProductRecommendationIntent = /** Offer customers products that are complementary to a product for which recommendations are to be fetched. An example is add-on products that display in a Pair it with section. */ - | 'COMPLEMENTARY' + | "COMPLEMENTARY" /** Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section. */ - | 'RELATED'; + | "RELATED"; /** The set of valid sort keys for the Product query. */ export type ProductSortKeys = /** Sort by the `best_selling` value. */ - | 'BEST_SELLING' + | "BEST_SELLING" /** Sort by the `created_at` value. */ - | 'CREATED_AT' + | "CREATED_AT" /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** Sort by the `product_type` value. */ - | 'PRODUCT_TYPE' + | "PRODUCT_TYPE" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `title` value. */ - | 'TITLE' + | "TITLE" /** Sort by the `updated_at` value. */ - | 'UPDATED_AT' + | "UPDATED_AT" /** Sort by the `vendor` value. */ - | 'VENDOR'; + | "VENDOR"; /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariant = HasMetafields & Node & { /** Indicates if the product variant is available for sale. */ - availableForSale: Scalars['Boolean']['output']; + availableForSale: Scalars["Boolean"]["output"]; /** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */ - barcode?: Maybe; + barcode?: Maybe; /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. */ compareAtPrice?: Maybe; /** @@ -6330,9 +6101,9 @@ export type ProductVariant = HasMetafields & Node & { */ compareAtPriceV2?: Maybe; /** Whether a product is out of stock but still available for purchase (used for backorders). */ - currentlyNotInStock: Scalars['Boolean']['output']; + currentlyNotInStock: Scalars["Boolean"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Image associated with the product variant. This field falls back to the product image if no image is available. */ image?: Maybe; /** Returns a metafield found by namespace and key. */ @@ -6349,78 +6120,69 @@ export type ProductVariant = HasMetafields & Node & { /** The product object that the product variant belongs to. */ product: Product; /** The total sellable quantity of the variant for online sales channels. */ - quantityAvailable?: Maybe; + quantityAvailable?: Maybe; /** Whether a customer needs to provide a shipping address when placing an order for the product variant. */ - requiresShipping: Scalars['Boolean']['output']; + requiresShipping: Scalars["Boolean"]["output"]; /** List of product options applied to the variant. */ selectedOptions: Array; /** Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. */ sellingPlanAllocations: SellingPlanAllocationConnection; /** The SKU (stock keeping unit) associated with the variant. */ - sku?: Maybe; + sku?: Maybe; /** The in-store pickup availability of this variant by location. */ storeAvailability: StoreAvailabilityConnection; /** The product variant’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The unit price value for the variant based on the variant's measurement. */ unitPrice?: Maybe; /** The unit price measurement for the variant. */ unitPriceMeasurement?: Maybe; /** The weight of the product variant in the unit system specified with `weight_unit`. */ - weight?: Maybe; + weight?: Maybe; /** Unit of measurement for weight. */ weightUnit: WeightUnit; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantMetafieldsArgs = { identifiers: Array; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantSellingPlanAllocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; - /** * A product variant represents a different version of a product, such as differing sizes or differing colors. - * */ export type ProductVariantStoreAvailabilityArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple ProductVariants. - * */ export type ProductVariantConnection = { /** A list of edges. */ @@ -6433,11 +6195,10 @@ export type ProductVariantConnection = { /** * An auto-generated type which holds one ProductVariant and a cursor during pagination. - * */ export type ProductVariantEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of ProductVariantEdge. */ node: ProductVariant; }; @@ -6445,19 +6206,18 @@ export type ProductVariantEdge = { /** The set of valid sort keys for the ProductVariant query. */ export type ProductVariantSortKeys = /** Sort by the `id` value. */ - | 'ID' + | "ID" /** Sort by the `position` value. */ - | 'POSITION' + | "POSITION" /** * Sort by relevance to the search terms when the `query` parameter is specified on the connection. * Don't use this sort key when no search query is specified. - * */ - | 'RELEVANCE' + | "RELEVANCE" /** Sort by the `sku` value. */ - | 'SKU' + | "SKU" /** Sort by the `title` value. */ - | 'TITLE'; + | "TITLE"; /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRoot = { @@ -6477,12 +6237,10 @@ export type QueryRoot = { /** * Retrieve a cart by its ID. For more information, refer to * [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage). - * */ cart?: Maybe; /** * A poll for the status of the cart checkout completion and order creation. - * */ cartCompletionAttempt?: Maybe; /** Fetch a specific `Collection` by one of its unique attributes. */ @@ -6497,7 +6255,6 @@ export type QueryRoot = { /** * The customer associated with the given access token. Tokens are obtained by using the * [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate). - * */ customer?: Maybe; /** Returns the localized experiences configured for the shop. */ @@ -6506,8 +6263,6 @@ export type QueryRoot = { * List of the shop's locations that support in-store pickup. * * When sorting by distance, you must specify a location via the `near` argument. - * - * */ locations: LocationConnection; /** Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle. */ @@ -6542,13 +6297,11 @@ export type QueryRoot = { * Find recommended products related to a given `product_id`. * To learn more about how recommendations are generated, see * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). - * */ productRecommendations?: Maybe>; /** * Tags added to products. * Additional access scope required: unauthenticated_read_product_tags. - * */ productTags: StringConnection; /** List of product types for the shop's products that are published to your app. */ @@ -6565,260 +6318,230 @@ export type QueryRoot = { urlRedirects: UrlRedirectConnection; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticleArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootArticlesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootBlogsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCartCompletionAttemptArgs = { - attemptId: Scalars['String']['input']; + attemptId: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCollectionsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootCustomerArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootLocationsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; near?: InputMaybe; - reverse?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMenuArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectArgs = { handle?: InputMaybe; - id?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootMetaobjectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; - sortKey?: InputMaybe; - type: Scalars['String']['input']; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodeArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPageByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPagesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootPredictiveSearchArgs = { - limit?: InputMaybe; + limit?: InputMaybe; limitScope?: InputMaybe; - query: Scalars['String']['input']; + query: Scalars["String"]["input"]; searchableFields?: InputMaybe>; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductArgs = { - handle?: InputMaybe; - id?: InputMaybe; + handle?: InputMaybe; + id?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductByHandleArgs = { - handle: Scalars['String']['input']; + handle: Scalars["String"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductRecommendationsArgs = { intent?: InputMaybe; - productId: Scalars['ID']['input']; + productId: Scalars["ID"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTagsArgs = { - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductTypesArgs = { - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; sortKey?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootSearchArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; prefix?: InputMaybe; productFilters?: InputMaybe>; - query: Scalars['String']['input']; - reverse?: InputMaybe; + query: Scalars["String"]["input"]; + reverse?: InputMaybe; sortKey?: InputMaybe; types?: InputMaybe>; unavailableProducts?: InputMaybe; }; - /** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ export type QueryRootUrlRedirectsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - query?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; }; /** SEO information. */ export type Seo = { /** The meta description. */ - description?: Maybe; + description?: Maybe; /** The SEO title. */ - title?: Maybe; + title?: Maybe; }; /** * Script discount applications capture the intentions of a discount that * was created by a Shopify Script. - * */ export type ScriptDiscountApplication = DiscountApplication & { /** The method by which the discount's value is allocated to its entitled items. */ @@ -6828,7 +6551,7 @@ export type ScriptDiscountApplication = DiscountApplication & { /** The type of line that the discount is applicable towards. */ targetType: DiscountApplicationTargetType; /** The title of the application as defined by the Script. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** The value of the discount application. */ value: PricingValue; }; @@ -6836,29 +6559,27 @@ export type ScriptDiscountApplication = DiscountApplication & { /** Specifies whether to perform a partial word match on the last search term. */ export type SearchPrefixQueryType = /** Perform a partial word match on the last search term. */ - | 'LAST' + | "LAST" /** Don't perform a partial word match on the last search term. */ - | 'NONE'; + | "NONE"; /** A search query suggestion. */ export type SearchQuerySuggestion = Trackable & { /** The text of the search query suggestion with highlighted HTML tags. */ - styledText: Scalars['String']['output']; + styledText: Scalars["String"]["output"]; /** The text of the search query suggestion. */ - text: Scalars['String']['output']; + text: Scalars["String"]["output"]; /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** * A search result that matches the search query. - * */ export type SearchResultItem = Article | Page | Product; /** * An auto-generated type for paginating through multiple SearchResultItems. - * */ export type SearchResultItemConnection = { /** A list of edges. */ @@ -6870,16 +6591,15 @@ export type SearchResultItemConnection = { /** A list of available filters. */ productFilters: Array; /** The total number of results. */ - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** * An auto-generated type which holds one SearchResultItem and a cursor during pagination. - * */ export type SearchResultItemEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SearchResultItemEdge. */ node: SearchResultItem; }; @@ -6887,67 +6607,66 @@ export type SearchResultItemEdge = { /** The set of valid sort keys for the search query. */ export type SearchSortKeys = /** Sort by the `price` value. */ - | 'PRICE' + | "PRICE" /** Sort by relevance to the search terms. */ - | 'RELEVANCE'; + | "RELEVANCE"; /** The types of search items to perform search within. */ export type SearchType = /** Returns matching articles. */ - | 'ARTICLE' + | "ARTICLE" /** Returns matching pages. */ - | 'PAGE' + | "PAGE" /** Returns matching products. */ - | 'PRODUCT'; + | "PRODUCT"; /** Specifies whether to display results for unavailable products. */ export type SearchUnavailableProductsType = /** Exclude unavailable products. */ - | 'HIDE' + | "HIDE" /** Show unavailable products after all other matching results. This is the default. */ - | 'LAST' + | "LAST" /** Show unavailable products in the order that they're found. */ - | 'SHOW'; + | "SHOW"; /** Specifies the list of resource fields to search. */ export type SearchableField = /** Author of the page or article. */ - | 'AUTHOR' + | "AUTHOR" /** Body of the page or article or product description or collection description. */ - | 'BODY' + | "BODY" /** Product type. */ - | 'PRODUCT_TYPE' + | "PRODUCT_TYPE" /** Tag associated with the product or article. */ - | 'TAG' + | "TAG" /** Title of the page or article or product title or collection title. */ - | 'TITLE' + | "TITLE" /** Variant barcode. */ - | 'VARIANTS_BARCODE' + | "VARIANTS_BARCODE" /** Variant SKU. */ - | 'VARIANTS_SKU' + | "VARIANTS_SKU" /** Variant title. */ - | 'VARIANTS_TITLE' + | "VARIANTS_TITLE" /** Product vendor. */ - | 'VENDOR'; + | "VENDOR"; /** * Properties used by customers to select a product variant. * Products can have multiple options, like different sizes or colors. - * */ export type SelectedOption = { /** The product option’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The product option’s value. */ - value: Scalars['String']['output']; + value: Scalars["String"]["output"]; }; /** The input fields required for a selected option. */ export type SelectedOptionInput = { /** The product option’s name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product option’s value. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents how products and variants can be sold and purchased. */ @@ -6955,17 +6674,17 @@ export type SellingPlan = { /** The initial payment due for the purchase. */ checkoutCharge: SellingPlanCheckoutCharge; /** The description of the selling plan. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. */ options: Array; /** The price adjustments that a selling plan makes when a variant is purchased with a selling plan. */ priceAdjustments: Array; /** Whether purchasing the selling plan will result in multiple deliveries. */ - recurringDeliveries: Scalars['Boolean']['output']; + recurringDeliveries: Scalars["Boolean"]["output"]; }; /** Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. */ @@ -6982,7 +6701,6 @@ export type SellingPlanAllocation = { /** * An auto-generated type for paginating through multiple SellingPlanAllocations. - * */ export type SellingPlanAllocationConnection = { /** A list of edges. */ @@ -6995,11 +6713,10 @@ export type SellingPlanAllocationConnection = { /** * An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination. - * */ export type SellingPlanAllocationEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanAllocationEdge. */ node: SellingPlanAllocation; }; @@ -7027,22 +6744,23 @@ export type SellingPlanCheckoutCharge = { /** The percentage value of the price used for checkout charge. */ export type SellingPlanCheckoutChargePercentageValue = { /** The percentage value of the price used for checkout charge. */ - percentage: Scalars['Float']['output']; + percentage: Scalars["Float"]["output"]; }; /** The checkout charge when the full amount isn't charged at checkout. */ export type SellingPlanCheckoutChargeType = /** The checkout charge is a percentage of the product or variant price. */ - | 'PERCENTAGE' + | "PERCENTAGE" /** The checkout charge is a fixed price amount. */ - | 'PRICE'; + | "PRICE"; /** The portion of the price to be charged at checkout. */ -export type SellingPlanCheckoutChargeValue = MoneyV2 | SellingPlanCheckoutChargePercentageValue; +export type SellingPlanCheckoutChargeValue = + | MoneyV2 + | SellingPlanCheckoutChargePercentageValue; /** * An auto-generated type for paginating through multiple SellingPlans. - * */ export type SellingPlanConnection = { /** A list of edges. */ @@ -7055,11 +6773,10 @@ export type SellingPlanConnection = { /** * An auto-generated type which holds one SellingPlan and a cursor during pagination. - * */ export type SellingPlanEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanEdge. */ node: SellingPlan; }; @@ -7079,28 +6796,26 @@ export type SellingPlanFixedPriceAdjustment = { /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroup = { /** A display friendly name for the app that created the selling plan group. */ - appName?: Maybe; + appName?: Maybe; /** The name of the selling plan group. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. */ options: Array; /** A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */ sellingPlans: SellingPlanConnection; }; - /** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ export type SellingPlanGroupSellingPlansArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - reverse?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; }; /** * An auto-generated type for paginating through multiple SellingPlanGroups. - * */ export type SellingPlanGroupConnection = { /** A list of edges. */ @@ -7113,11 +6828,10 @@ export type SellingPlanGroupConnection = { /** * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. - * */ export type SellingPlanGroupEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of SellingPlanGroupEdge. */ node: SellingPlanGroup; }; @@ -7129,23 +6843,23 @@ export type SellingPlanGroupEdge = { */ export type SellingPlanGroupOption = { /** The name of the option. For example, 'Delivery every'. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. */ - values: Array; + values: Array; }; /** An option provided by a Selling Plan. */ export type SellingPlanOption = { /** The name of the option (ie "Delivery every"). */ - name?: Maybe; + name?: Maybe; /** The value of the option (ie "Month"). */ - value?: Maybe; + value?: Maybe; }; /** A percentage amount that's deducted from the original variant price. For example, 10% off. */ export type SellingPlanPercentagePriceAdjustment = { /** The percentage value of the price adjustment. */ - adjustmentPercentage: Scalars['Int']['output']; + adjustmentPercentage: Scalars["Int"]["output"]; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. */ @@ -7153,16 +6867,19 @@ export type SellingPlanPriceAdjustment = { /** The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. */ adjustmentValue: SellingPlanPriceAdjustmentValue; /** The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. */ - orderCount?: Maybe; + orderCount?: Maybe; }; /** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. */ -export type SellingPlanPriceAdjustmentValue = SellingPlanFixedAmountPriceAdjustment | SellingPlanFixedPriceAdjustment | SellingPlanPercentagePriceAdjustment; +export type SellingPlanPriceAdjustmentValue = + | SellingPlanFixedAmountPriceAdjustment + | SellingPlanFixedPriceAdjustment + | SellingPlanPercentagePriceAdjustment; /** A shipping rate to be applied to a checkout. */ export type ShippingRate = { /** Human-readable unique identifier for this shipping rate. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** Price of this shipping rate. */ price: MoneyV2; /** @@ -7171,7 +6888,7 @@ export type ShippingRate = { */ priceV2: MoneyV2; /** Title of this shipping rate. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; }; /** Shop represents a collection of the general settings and information about the shop. */ @@ -7179,17 +6896,17 @@ export type Shop = HasMetafields & Node & { /** The shop's branding configuration. */ brand?: Maybe; /** A description of the shop. */ - description?: Maybe; + description?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Returns a metafield found by namespace and key. */ metafield?: Maybe; /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ metafields: Array>; /** A string representing the way currency is formatted when the currency isn’t specified. */ - moneyFormat: Scalars['String']['output']; + moneyFormat: Scalars["String"]["output"]; /** The shop’s name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Settings related to payments. */ paymentSettings: PaymentSettings; /** The primary domain of the shop’s Online Store. */ @@ -7208,14 +6925,12 @@ export type Shop = HasMetafields & Node & { termsOfService?: Maybe; }; - /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldArgs = { - key: Scalars['String']['input']; - namespace: Scalars['String']['input']; + key: Scalars["String"]["input"]; + namespace: Scalars["String"]["input"]; }; - /** Shop represents a collection of the general settings and information about the shop. */ export type ShopMetafieldsArgs = { identifiers: Array; @@ -7223,67 +6938,63 @@ export type ShopMetafieldsArgs = { /** * The input fields for submitting Shop Pay payment method information for checkout. - * */ export type ShopPayWalletContentInput = { /** The customer's billing address. */ billingAddress: MailingAddressInput; /** Session token for transaction. */ - sessionToken: Scalars['String']['input']; + sessionToken: Scalars["String"]["input"]; }; /** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ export type ShopPolicy = Node & { /** Policy text, maximum size of 64kb. */ - body: Scalars['String']['output']; + body: Scalars["String"]["output"]; /** Policy’s handle. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** Policy’s title. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Public URL to the policy. */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** * A policy for the store that comes with a default value, such as a subscription policy. * If the merchant hasn't configured a policy for their store, then the policy will return the default value. * Otherwise, the policy will return the merchant-configured value. - * */ export type ShopPolicyWithDefault = { /** The text of the policy. Maximum size: 64KB. */ - body: Scalars['String']['output']; + body: Scalars["String"]["output"]; /** The handle of the policy. */ - handle: Scalars['String']['output']; + handle: Scalars["String"]["output"]; /** The unique ID of the policy. A default policy doesn't have an ID. */ - id?: Maybe; + id?: Maybe; /** The title of the policy. */ - title: Scalars['String']['output']; + title: Scalars["String"]["output"]; /** Public URL to the policy. */ - url: Scalars['URL']['output']; + url: Scalars["URL"]["output"]; }; /** * The availability of a product variant at a particular location. * Local pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result. - * */ export type StoreAvailability = { /** Whether the product variant is in-stock at this location. */ - available: Scalars['Boolean']['output']; + available: Scalars["Boolean"]["output"]; /** The location where this product variant is stocked at. */ location: Location; /** Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). */ - pickUpTime: Scalars['String']['output']; + pickUpTime: Scalars["String"]["output"]; /** The quantity of the product variant in-stock at this location. */ - quantityAvailable: Scalars['Int']['output']; + quantityAvailable: Scalars["Int"]["output"]; }; /** * An auto-generated type for paginating through multiple StoreAvailabilities. - * */ export type StoreAvailabilityConnection = { /** A list of edges. */ @@ -7296,18 +7007,16 @@ export type StoreAvailabilityConnection = { /** * An auto-generated type which holds one StoreAvailability and a cursor during pagination. - * */ export type StoreAvailabilityEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of StoreAvailabilityEdge. */ node: StoreAvailability; }; /** * An auto-generated type for paginating through a list of Strings. - * */ export type StringConnection = { /** A list of edges. */ @@ -7318,13 +7027,12 @@ export type StringConnection = { /** * An auto-generated type which holds one String and a cursor during pagination. - * */ export type StringEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of StringEdge. */ - node: Scalars['String']['output']; + node: Scalars["String"]["output"]; }; /** An error that occurred during cart submit for completion. */ @@ -7332,115 +7040,115 @@ export type SubmissionError = { /** The error code. */ code: SubmissionErrorCode; /** The error message. */ - message?: Maybe; + message?: Maybe; }; /** The code of the error that occurred during cart submit for completion. */ export type SubmissionErrorCode = - | 'BUYER_IDENTITY_EMAIL_IS_INVALID' - | 'BUYER_IDENTITY_EMAIL_REQUIRED' - | 'BUYER_IDENTITY_PHONE_IS_INVALID' - | 'DELIVERY_ADDRESS1_INVALID' - | 'DELIVERY_ADDRESS1_REQUIRED' - | 'DELIVERY_ADDRESS1_TOO_LONG' - | 'DELIVERY_ADDRESS2_INVALID' - | 'DELIVERY_ADDRESS2_REQUIRED' - | 'DELIVERY_ADDRESS2_TOO_LONG' - | 'DELIVERY_ADDRESS_REQUIRED' - | 'DELIVERY_CITY_INVALID' - | 'DELIVERY_CITY_REQUIRED' - | 'DELIVERY_CITY_TOO_LONG' - | 'DELIVERY_COMPANY_INVALID' - | 'DELIVERY_COMPANY_REQUIRED' - | 'DELIVERY_COMPANY_TOO_LONG' - | 'DELIVERY_COUNTRY_REQUIRED' - | 'DELIVERY_FIRST_NAME_INVALID' - | 'DELIVERY_FIRST_NAME_REQUIRED' - | 'DELIVERY_FIRST_NAME_TOO_LONG' - | 'DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY' - | 'DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE' - | 'DELIVERY_LAST_NAME_INVALID' - | 'DELIVERY_LAST_NAME_REQUIRED' - | 'DELIVERY_LAST_NAME_TOO_LONG' - | 'DELIVERY_NO_DELIVERY_AVAILABLE' - | 'DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE' - | 'DELIVERY_OPTIONS_PHONE_NUMBER_INVALID' - | 'DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED' - | 'DELIVERY_PHONE_NUMBER_INVALID' - | 'DELIVERY_PHONE_NUMBER_REQUIRED' - | 'DELIVERY_POSTAL_CODE_INVALID' - | 'DELIVERY_POSTAL_CODE_REQUIRED' - | 'DELIVERY_ZONE_NOT_FOUND' - | 'DELIVERY_ZONE_REQUIRED_FOR_COUNTRY' - | 'ERROR' - | 'MERCHANDISE_LINE_LIMIT_REACHED' - | 'MERCHANDISE_NOT_APPLICABLE' - | 'MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE' - | 'MERCHANDISE_OUT_OF_STOCK' - | 'MERCHANDISE_PRODUCT_NOT_PUBLISHED' - | 'NO_DELIVERY_GROUP_SELECTED' - | 'PAYMENTS_ADDRESS1_INVALID' - | 'PAYMENTS_ADDRESS1_REQUIRED' - | 'PAYMENTS_ADDRESS1_TOO_LONG' - | 'PAYMENTS_ADDRESS2_INVALID' - | 'PAYMENTS_ADDRESS2_REQUIRED' - | 'PAYMENTS_ADDRESS2_TOO_LONG' - | 'PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND' - | 'PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY' - | 'PAYMENTS_CITY_INVALID' - | 'PAYMENTS_CITY_REQUIRED' - | 'PAYMENTS_CITY_TOO_LONG' - | 'PAYMENTS_COMPANY_INVALID' - | 'PAYMENTS_COMPANY_REQUIRED' - | 'PAYMENTS_COMPANY_TOO_LONG' - | 'PAYMENTS_COUNTRY_REQUIRED' - | 'PAYMENTS_CREDIT_CARD_BASE_EXPIRED' - | 'PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED' - | 'PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' - | 'PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED' - | 'PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK' - | 'PAYMENTS_CREDIT_CARD_GENERIC' - | 'PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK' - | 'PAYMENTS_CREDIT_CARD_MONTH_INCLUSION' - | 'PAYMENTS_CREDIT_CARD_NAME_INVALID' - | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID' - | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT' - | 'PAYMENTS_CREDIT_CARD_SESSION_ID' - | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK' - | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' - | 'PAYMENTS_CREDIT_CARD_YEAR_EXPIRED' - | 'PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR' - | 'PAYMENTS_FIRST_NAME_INVALID' - | 'PAYMENTS_FIRST_NAME_REQUIRED' - | 'PAYMENTS_FIRST_NAME_TOO_LONG' - | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY' - | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE' - | 'PAYMENTS_LAST_NAME_INVALID' - | 'PAYMENTS_LAST_NAME_REQUIRED' - | 'PAYMENTS_LAST_NAME_TOO_LONG' - | 'PAYMENTS_METHOD_REQUIRED' - | 'PAYMENTS_METHOD_UNAVAILABLE' - | 'PAYMENTS_PHONE_NUMBER_INVALID' - | 'PAYMENTS_PHONE_NUMBER_REQUIRED' - | 'PAYMENTS_POSTAL_CODE_INVALID' - | 'PAYMENTS_POSTAL_CODE_REQUIRED' - | 'PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED' - | 'PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT' - | 'PAYMENTS_WALLET_CONTENT_MISSING' - | 'TAXES_DELIVERY_GROUP_ID_NOT_FOUND' - | 'TAXES_LINE_ID_NOT_FOUND' - | 'TAXES_MUST_BE_DEFINED'; + | "BUYER_IDENTITY_EMAIL_IS_INVALID" + | "BUYER_IDENTITY_EMAIL_REQUIRED" + | "BUYER_IDENTITY_PHONE_IS_INVALID" + | "DELIVERY_ADDRESS1_INVALID" + | "DELIVERY_ADDRESS1_REQUIRED" + | "DELIVERY_ADDRESS1_TOO_LONG" + | "DELIVERY_ADDRESS2_INVALID" + | "DELIVERY_ADDRESS2_REQUIRED" + | "DELIVERY_ADDRESS2_TOO_LONG" + | "DELIVERY_ADDRESS_REQUIRED" + | "DELIVERY_CITY_INVALID" + | "DELIVERY_CITY_REQUIRED" + | "DELIVERY_CITY_TOO_LONG" + | "DELIVERY_COMPANY_INVALID" + | "DELIVERY_COMPANY_REQUIRED" + | "DELIVERY_COMPANY_TOO_LONG" + | "DELIVERY_COUNTRY_REQUIRED" + | "DELIVERY_FIRST_NAME_INVALID" + | "DELIVERY_FIRST_NAME_REQUIRED" + | "DELIVERY_FIRST_NAME_TOO_LONG" + | "DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY" + | "DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE" + | "DELIVERY_LAST_NAME_INVALID" + | "DELIVERY_LAST_NAME_REQUIRED" + | "DELIVERY_LAST_NAME_TOO_LONG" + | "DELIVERY_NO_DELIVERY_AVAILABLE" + | "DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE" + | "DELIVERY_OPTIONS_PHONE_NUMBER_INVALID" + | "DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED" + | "DELIVERY_PHONE_NUMBER_INVALID" + | "DELIVERY_PHONE_NUMBER_REQUIRED" + | "DELIVERY_POSTAL_CODE_INVALID" + | "DELIVERY_POSTAL_CODE_REQUIRED" + | "DELIVERY_ZONE_NOT_FOUND" + | "DELIVERY_ZONE_REQUIRED_FOR_COUNTRY" + | "ERROR" + | "MERCHANDISE_LINE_LIMIT_REACHED" + | "MERCHANDISE_NOT_APPLICABLE" + | "MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE" + | "MERCHANDISE_OUT_OF_STOCK" + | "MERCHANDISE_PRODUCT_NOT_PUBLISHED" + | "NO_DELIVERY_GROUP_SELECTED" + | "PAYMENTS_ADDRESS1_INVALID" + | "PAYMENTS_ADDRESS1_REQUIRED" + | "PAYMENTS_ADDRESS1_TOO_LONG" + | "PAYMENTS_ADDRESS2_INVALID" + | "PAYMENTS_ADDRESS2_REQUIRED" + | "PAYMENTS_ADDRESS2_TOO_LONG" + | "PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND" + | "PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY" + | "PAYMENTS_CITY_INVALID" + | "PAYMENTS_CITY_REQUIRED" + | "PAYMENTS_CITY_TOO_LONG" + | "PAYMENTS_COMPANY_INVALID" + | "PAYMENTS_COMPANY_REQUIRED" + | "PAYMENTS_COMPANY_TOO_LONG" + | "PAYMENTS_COUNTRY_REQUIRED" + | "PAYMENTS_CREDIT_CARD_BASE_EXPIRED" + | "PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED" + | "PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT" + | "PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED" + | "PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK" + | "PAYMENTS_CREDIT_CARD_GENERIC" + | "PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK" + | "PAYMENTS_CREDIT_CARD_MONTH_INCLUSION" + | "PAYMENTS_CREDIT_CARD_NAME_INVALID" + | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID" + | "PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT" + | "PAYMENTS_CREDIT_CARD_SESSION_ID" + | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK" + | "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE" + | "PAYMENTS_CREDIT_CARD_YEAR_EXPIRED" + | "PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR" + | "PAYMENTS_FIRST_NAME_INVALID" + | "PAYMENTS_FIRST_NAME_REQUIRED" + | "PAYMENTS_FIRST_NAME_TOO_LONG" + | "PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY" + | "PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE" + | "PAYMENTS_LAST_NAME_INVALID" + | "PAYMENTS_LAST_NAME_REQUIRED" + | "PAYMENTS_LAST_NAME_TOO_LONG" + | "PAYMENTS_METHOD_REQUIRED" + | "PAYMENTS_METHOD_UNAVAILABLE" + | "PAYMENTS_PHONE_NUMBER_INVALID" + | "PAYMENTS_PHONE_NUMBER_REQUIRED" + | "PAYMENTS_POSTAL_CODE_INVALID" + | "PAYMENTS_POSTAL_CODE_REQUIRED" + | "PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED" + | "PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT" + | "PAYMENTS_WALLET_CONTENT_MISSING" + | "TAXES_DELIVERY_GROUP_ID_NOT_FOUND" + | "TAXES_LINE_ID_NOT_FOUND" + | "TAXES_MUST_BE_DEFINED"; /** Cart submit for checkout completion is successful. */ export type SubmitAlreadyAccepted = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars['String']['output']; + attemptId: Scalars["String"]["output"]; }; /** Cart submit for checkout completion failed. */ export type SubmitFailed = { /** The URL of the checkout for the cart. */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** The list of errors that occurred from executing the mutation. */ errors: Array; }; @@ -7448,7 +7156,7 @@ export type SubmitFailed = { /** Cart submit for checkout completion is already accepted. */ export type SubmitSuccess = { /** The ID of the cart completion attempt that will be used for polling for the result. */ - attemptId: Scalars['String']['output']; + attemptId: Scalars["String"]["output"]; }; /** Cart submit for checkout completion is throttled. */ @@ -7457,29 +7165,27 @@ export type SubmitThrottled = { * UTC date time string that indicates the time after which clients should make their next * poll request. Any poll requests sent before this time will be ignored. Use this value to schedule the * next poll request. - * */ - pollAfter: Scalars['DateTime']['output']; + pollAfter: Scalars["DateTime"]["output"]; }; /** * Specifies the fields required to complete a checkout with * a tokenized payment. - * */ export type TokenizedPaymentInputV3 = { /** The billing address for the payment. */ billingAddress: MailingAddressInput; /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ - idempotencyKey: Scalars['String']['input']; + idempotencyKey: Scalars["String"]["input"]; /** Public Hash Key used for AndroidPay payments only. */ - identifier?: InputMaybe; + identifier?: InputMaybe; /** The amount and currency of the payment. */ paymentAmount: MoneyInput; /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String']['input']; + paymentData: Scalars["String"]["input"]; /** Whether to execute the payment in test mode, if possible. Test mode isn't supported in production stores. Defaults to `false`. */ - test?: InputMaybe; + test?: InputMaybe; /** The type of payment token. */ type: PaymentTokenType; }; @@ -7487,7 +7193,7 @@ export type TokenizedPaymentInputV3 = { /** Represents a resource that you can track the origin of the search traffic. */ export type Trackable = { /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ - trackingParameters?: Maybe; + trackingParameters?: Maybe; }; /** An object representing exchange of money for a product or service. */ @@ -7509,7 +7215,7 @@ export type Transaction = { /** The status of the transaction. */ statusV2?: Maybe; /** Whether the transaction was done in test mode or not. */ - test: Scalars['Boolean']['output']; + test: Scalars["Boolean"]["output"]; }; /** The different kinds of order transactions. */ @@ -7517,32 +7223,30 @@ export type TransactionKind = /** * An amount reserved against the cardholder's funding source. * Money does not change hands until the authorization is captured. - * */ - | 'AUTHORIZATION' + | "AUTHORIZATION" /** A transfer of the money that was reserved during the authorization stage. */ - | 'CAPTURE' + | "CAPTURE" /** Money returned to the customer when they have paid too much. */ - | 'CHANGE' + | "CHANGE" /** An authorization for a payment taken with an EMV credit card reader. */ - | 'EMV_AUTHORIZATION' + | "EMV_AUTHORIZATION" /** An authorization and capture performed together in a single step. */ - | 'SALE'; + | "SALE"; /** Transaction statuses describe the status of a transaction. */ export type TransactionStatus = /** There was an error while processing the transaction. */ - | 'ERROR' + | "ERROR" /** The transaction failed. */ - | 'FAILURE' + | "FAILURE" /** The transaction is pending. */ - | 'PENDING' + | "PENDING" /** The transaction succeeded. */ - | 'SUCCESS'; + | "SUCCESS"; /** * The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). - * */ export type UnitPriceMeasurement = { /** The type of unit of measurement for the unit price measurement. */ @@ -7550,69 +7254,68 @@ export type UnitPriceMeasurement = { /** The quantity unit for the unit price measurement. */ quantityUnit?: Maybe; /** The quantity value for the unit price measurement. */ - quantityValue: Scalars['Float']['output']; + quantityValue: Scalars["Float"]["output"]; /** The reference unit for the unit price measurement. */ referenceUnit?: Maybe; /** The reference value for the unit price measurement. */ - referenceValue: Scalars['Int']['output']; + referenceValue: Scalars["Int"]["output"]; }; /** The accepted types of unit of measurement. */ export type UnitPriceMeasurementMeasuredType = /** Unit of measurements representing areas. */ - | 'AREA' + | "AREA" /** Unit of measurements representing lengths. */ - | 'LENGTH' + | "LENGTH" /** Unit of measurements representing volumes. */ - | 'VOLUME' + | "VOLUME" /** Unit of measurements representing weights. */ - | 'WEIGHT'; + | "WEIGHT"; /** The valid units of measurement for a unit price measurement. */ export type UnitPriceMeasurementMeasuredUnit = /** 100 centiliters equals 1 liter. */ - | 'CL' + | "CL" /** 100 centimeters equals 1 meter. */ - | 'CM' + | "CM" /** Metric system unit of weight. */ - | 'G' + | "G" /** 1 kilogram equals 1000 grams. */ - | 'KG' + | "KG" /** Metric system unit of volume. */ - | 'L' + | "L" /** Metric system unit of length. */ - | 'M' + | "M" /** Metric system unit of area. */ - | 'M2' + | "M2" /** 1 cubic meter equals 1000 liters. */ - | 'M3' + | "M3" /** 1000 milligrams equals 1 gram. */ - | 'MG' + | "MG" /** 1000 milliliters equals 1 liter. */ - | 'ML' + | "ML" /** 1000 millimeters equals 1 meter. */ - | 'MM'; + | "MM"; /** Systems of weights and measures. */ export type UnitSystem = /** Imperial system of weights and measures. */ - | 'IMPERIAL_SYSTEM' + | "IMPERIAL_SYSTEM" /** Metric system of weights and measures. */ - | 'METRIC_SYSTEM'; + | "METRIC_SYSTEM"; /** A redirect on the online store. */ export type UrlRedirect = Node & { /** The ID of the URL redirect. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. */ - path: Scalars['String']['output']; + path: Scalars["String"]["output"]; /** The target location where the user will be redirected to. */ - target: Scalars['String']['output']; + target: Scalars["String"]["output"]; }; /** * An auto-generated type for paginating through multiple UrlRedirects. - * */ export type UrlRedirectConnection = { /** A list of edges. */ @@ -7625,11 +7328,10 @@ export type UrlRedirectConnection = { /** * An auto-generated type which holds one UrlRedirect and a cursor during pagination. - * */ export type UrlRedirectEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of UrlRedirectEdge. */ node: UrlRedirect; }; @@ -7637,25 +7339,25 @@ export type UrlRedirectEdge = { /** Represents an error in the input of a mutation. */ export type UserError = DisplayableError & { /** The path to the input field that caused the error. */ - field?: Maybe>; + field?: Maybe>; /** The error message. */ - message: Scalars['String']['output']; + message: Scalars["String"]["output"]; }; /** The input fields for a filter used to view a subset of products in a collection matching a specific variant option. */ export type VariantOptionFilter = { /** The name of the variant option to filter on. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The value of the variant option to filter on. */ - value: Scalars['String']['input']; + value: Scalars["String"]["input"]; }; /** Represents a Shopify hosted video. */ export type Video = Media & Node & { /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe; + alt?: Maybe; /** A globally-unique ID. */ - id: Scalars['ID']['output']; + id: Scalars["ID"]["output"]; /** The media content type. */ mediaContentType: MediaContentType; /** The presentation for a media. */ @@ -7669,91 +7371,723 @@ export type Video = Media & Node & { /** Represents a source for a Shopify hosted video. */ export type VideoSource = { /** The format of the video source. */ - format: Scalars['String']['output']; + format: Scalars["String"]["output"]; /** The height of the video. */ - height: Scalars['Int']['output']; + height: Scalars["Int"]["output"]; /** The video MIME type. */ - mimeType: Scalars['String']['output']; + mimeType: Scalars["String"]["output"]; /** The URL of the video. */ - url: Scalars['String']['output']; + url: Scalars["String"]["output"]; /** The width of the video. */ - width: Scalars['Int']['output']; + width: Scalars["Int"]["output"]; }; /** Units of measurement for weight. */ export type WeightUnit = /** Metric system unit of mass. */ - | 'GRAMS' + | "GRAMS" /** 1 kilogram equals 1000 grams. */ - | 'KILOGRAMS' + | "KILOGRAMS" /** Imperial system unit of mass. */ - | 'OUNCES' + | "OUNCES" /** 1 pound equals 16 ounces. */ - | 'POUNDS'; - -export type AddItemToCartMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; - lines: Array | CartLineInput; -}>; - - -export type AddItemToCartMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; - -export type AddCouponMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; - discountCodes: Array | Scalars['String']['input']; -}>; - - -export type AddCouponMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null, userErrors: Array<{ field?: Array | null, message: string }> } | null }; + | "POUNDS"; + +export type ProductVariantFragment = { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; +}; + +export type ProductFragment = { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; +}; + +export type CartFragment = { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; +}; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; + +export type CreateCartMutation = { + payload?: { cart?: { id: string } | null } | null; +}; -export type UpdateItemsMutationVariables = Exact<{ - cartId: Scalars['ID']['input']; - lines: Array | CartLineUpdateInput; +export type GetCartQueryVariables = Exact<{ + id: Scalars["ID"]["input"]; }>; - -export type UpdateItemsMutation = { payload?: { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null } | null }; +export type GetCartQuery = { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; +}; export type GetProductQueryVariables = Exact<{ - handle?: InputMaybe; + handle?: InputMaybe; }>; - -export type GetProductQuery = { product?: { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } } | null }; +export type GetProductQuery = { + product?: { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: { amount: any; currencyCode: CurrencyCode } | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } | null; +}; export type ListProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; - -export type ListProductsQuery = { products: { nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; +export type ListProductsQuery = { + products: { + nodes: Array< + { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: + | { amount: any; currencyCode: CurrencyCode } + | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } + >; + }; +}; export type SearchProductsQueryVariables = Exact<{ - first?: InputMaybe; - after?: InputMaybe; - query?: InputMaybe; + first?: InputMaybe; + after?: InputMaybe; + query?: InputMaybe; }>; +export type SearchProductsQuery = { + products: { + pageInfo: { hasNextPage: boolean }; + nodes: Array< + { + availableForSale: boolean; + createdAt: any; + description: string; + descriptionHtml: any; + handle: string; + id: string; + isGiftCard: boolean; + onlineStoreUrl?: any | null; + productType: string; + publishedAt: any; + requiresSellingPlan: boolean; + tags: Array; + title: string; + totalInventory?: number | null; + updatedAt: any; + vendor: string; + featuredImage?: { altText?: string | null; url: any } | null; + images: { nodes: Array<{ altText?: string | null; url: any }> }; + media: { + nodes: Array< + { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } | { + alt?: string | null; + mediaContentType: MediaContentType; + previewImage?: { altText?: string | null; url: any } | null; + } + >; + }; + options: Array<{ name: string; values: Array }>; + priceRange: { + minVariantPrice: { amount: any; currencyCode: CurrencyCode }; + maxVariantPrice: { amount: any; currencyCode: CurrencyCode }; + }; + seo: { title?: string | null; description?: string | null }; + variants: { + nodes: Array< + { + availableForSale: boolean; + barcode?: string | null; + currentlyNotInStock: boolean; + id: string; + quantityAvailable?: number | null; + requiresShipping: boolean; + sku?: string | null; + title: string; + weight?: number | null; + weightUnit: WeightUnit; + compareAtPrice?: + | { amount: any; currencyCode: CurrencyCode } + | null; + image?: { altText?: string | null; url: any } | null; + price: { amount: any; currencyCode: CurrencyCode }; + selectedOptions: Array<{ name: string; value: string }>; + unitPrice?: { amount: any; currencyCode: CurrencyCode } | null; + unitPriceMeasurement?: { + measuredType?: UnitPriceMeasurementMeasuredType | null; + quantityValue: number; + referenceUnit?: UnitPriceMeasurementMeasuredUnit | null; + quantityUnit?: UnitPriceMeasurementMeasuredUnit | null; + } | null; + } + >; + }; + } + >; + }; +}; -export type SearchProductsQuery = { products: { pageInfo: { hasNextPage: boolean }, nodes: Array<{ availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }> } }; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; - - -export type CreateCartMutation = { payload?: { cart?: { id: string } | null } | null }; - -export type GetCartQueryVariables = Exact<{ - id: Scalars['ID']['input']; +export type AddItemToCartMutationVariables = Exact<{ + cartId: Scalars["ID"]["input"]; + lines: Array | CartLineInput; }>; +export type AddItemToCartMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + } | null; +}; -export type GetCartQuery = { cart?: { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> } | null }; +export type AddCouponMutationVariables = Exact<{ + cartId: Scalars["ID"]["input"]; + discountCodes: Array | Scalars["String"]["input"]; +}>; -export type CartFragment = { id: string, checkoutUrl: any, totalQuantity: number, lines: { nodes: Array<{ id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } } | { id: string, quantity: number, merchandise: { id: string, title: string, image?: { url: any, altText?: string | null } | null, product: { title: string }, price: { amount: any, currencyCode: CurrencyCode } }, cost: { totalAmount: { amount: any, currencyCode: CurrencyCode }, subtotalAmount: { amount: any, currencyCode: CurrencyCode }, amountPerQuantity: { amount: any, currencyCode: CurrencyCode }, compareAtAmountPerQuantity?: { amount: any, currencyCode: CurrencyCode } | null } }> }, cost: { subtotalAmount: { amount: any, currencyCode: CurrencyCode }, totalAmount: { amount: any, currencyCode: CurrencyCode }, checkoutChargeAmount: { amount: any, currencyCode: CurrencyCode } }, discountCodes: Array<{ code: string, applicable: boolean }>, discountAllocations: Array<{ discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } } | { discountedAmount: { amount: any, currencyCode: CurrencyCode } }> }; +export type AddCouponMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + userErrors: Array<{ field?: Array | null; message: string }>; + } | null; +}; -export type ProductFragment = { availableForSale: boolean, createdAt: any, description: string, descriptionHtml: any, handle: string, id: string, isGiftCard: boolean, onlineStoreUrl?: any | null, productType: string, publishedAt: any, requiresSellingPlan: boolean, tags: Array, title: string, totalInventory?: number | null, updatedAt: any, vendor: string, featuredImage?: { altText?: string | null, url: any } | null, images: { nodes: Array<{ altText?: string | null, url: any }> }, media: { nodes: Array<{ alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null } | { alt?: string | null, mediaContentType: MediaContentType, previewImage?: { altText?: string | null, url: any } | null }> }, options: Array<{ name: string, values: Array }>, priceRange: { minVariantPrice: { amount: any, currencyCode: CurrencyCode }, maxVariantPrice: { amount: any, currencyCode: CurrencyCode } }, seo: { title?: string | null, description?: string | null }, variants: { nodes: Array<{ availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }> } }; +export type UpdateItemsMutationVariables = Exact<{ + cartId: Scalars["ID"]["input"]; + lines: Array | CartLineUpdateInput; +}>; -export type ProductVariantFragment = { availableForSale: boolean, barcode?: string | null, currentlyNotInStock: boolean, id: string, quantityAvailable?: number | null, requiresShipping: boolean, sku?: string | null, title: string, weight?: number | null, weightUnit: WeightUnit, compareAtPrice?: { amount: any, currencyCode: CurrencyCode } | null, image?: { altText?: string | null, url: any } | null, price: { amount: any, currencyCode: CurrencyCode }, selectedOptions: Array<{ name: string, value: string }>, unitPrice?: { amount: any, currencyCode: CurrencyCode } | null, unitPriceMeasurement?: { measuredType?: UnitPriceMeasurementMeasuredType | null, quantityValue: number, referenceUnit?: UnitPriceMeasurementMeasuredUnit | null, quantityUnit?: UnitPriceMeasurementMeasuredUnit | null } | null }; +export type UpdateItemsMutation = { + payload?: { + cart?: { + id: string; + checkoutUrl: any; + totalQuantity: number; + lines: { + nodes: Array< + { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } | { + id: string; + quantity: number; + merchandise: { + id: string; + title: string; + image?: { url: any; altText?: string | null } | null; + product: { title: string }; + price: { amount: any; currencyCode: CurrencyCode }; + }; + cost: { + totalAmount: { amount: any; currencyCode: CurrencyCode }; + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + amountPerQuantity: { amount: any; currencyCode: CurrencyCode }; + compareAtAmountPerQuantity?: { + amount: any; + currencyCode: CurrencyCode; + } | null; + }; + } + >; + }; + cost: { + subtotalAmount: { amount: any; currencyCode: CurrencyCode }; + totalAmount: { amount: any; currencyCode: CurrencyCode }; + checkoutChargeAmount: { amount: any; currencyCode: CurrencyCode }; + }; + discountCodes: Array<{ code: string; applicable: boolean }>; + discountAllocations: Array< + { discountedAmount: { amount: any; currencyCode: CurrencyCode } } | { + discountedAmount: { amount: any; currencyCode: CurrencyCode }; + } | { discountedAmount: { amount: any; currencyCode: CurrencyCode } } + >; + } | null; + } | null; +}; diff --git a/shopify/utils/storefront.graphql.json b/shopify/utils/storefront/storefront.graphql.json similarity index 100% rename from shopify/utils/storefront.graphql.json rename to shopify/utils/storefront/storefront.graphql.json diff --git a/shopify/utils/transform.ts b/shopify/utils/transform.ts index 3de607d28..daa89d1aa 100644 --- a/shopify/utils/transform.ts +++ b/shopify/utils/transform.ts @@ -9,7 +9,7 @@ import { DEFAULT_IMAGE } from "../../commerce/utils/constants.ts"; import { ProductFragment as ProductShopify, ProductVariantFragment as SkuShopify, -} from "./storefront.graphql.gen.ts"; +} from "./storefront/storefront.graphql.gen.ts"; import { SelectedOption as SelectedOptionShopify } from "./types.ts"; const getPath = ({ handle }: ProductShopify, sku?: SkuShopify) => diff --git a/wake/actions/cart/addCoupon.ts b/wake/actions/cart/addCoupon.ts index 84e632d62..1904f8c2e 100644 --- a/wake/actions/cart/addCoupon.ts +++ b/wake/actions/cart/addCoupon.ts @@ -1,8 +1,7 @@ -import { gql } from "../../../utils/graphql.ts"; import { HttpError } from "../../../utils/http.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { AddCoupon } from "../../utils/graphql/queries.ts"; import { AddCouponMutation, AddCouponMutationVariables, @@ -30,13 +29,7 @@ const action = async ( AddCouponMutationVariables >({ variables: { checkoutId: cartId, ...props }, - fragments: [fragment], - query: gql`mutation AddCoupon($checkoutId: Uuid!, $coupon: String!) { - checkout: checkoutAddCoupon( - checkoutId: $checkoutId - coupon: $coupon - ) { ...Checkout } - }`, + ...AddCoupon, }); const checkoutId = data.checkout?.checkoutId; diff --git a/wake/actions/cart/addItem.ts b/wake/actions/cart/addItem.ts index 95b148c1d..12846acec 100644 --- a/wake/actions/cart/addItem.ts +++ b/wake/actions/cart/addItem.ts @@ -1,8 +1,7 @@ -import { gql } from "../../../utils/graphql.ts"; import { HttpError } from "../../../utils/http.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { AddItemToCart } from "../../utils/graphql/queries.ts"; import { AddItemToCartMutation, AddItemToCartMutationVariables, @@ -33,9 +32,7 @@ const action = async ( AddItemToCartMutationVariables >({ variables: { input: { id: cartId, products: [props] } }, - fragments: [fragment], - query: - gql`mutation AddItemToCart($input: CheckoutProductInput!) { checkout: checkoutAddProduct(input: $input) { ...Checkout }}`, + ...AddItemToCart, }); const checkoutId = data.checkout?.checkoutId; diff --git a/wake/actions/cart/removeCoupon.ts b/wake/actions/cart/removeCoupon.ts index 3f0da7e20..74ded4d72 100644 --- a/wake/actions/cart/removeCoupon.ts +++ b/wake/actions/cart/removeCoupon.ts @@ -1,8 +1,7 @@ -import { gql } from "../../../utils/graphql.ts"; import { HttpError } from "../../../utils/http.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { RemoveCoupon } from "../../utils/graphql/queries.ts"; import { CheckoutFragment, RemoveCouponMutation, @@ -26,12 +25,7 @@ const action = async ( RemoveCouponMutationVariables >({ variables: { checkoutId: cartId }, - fragments: [fragment], - query: gql`mutation RemoveCoupon($checkoutId: Uuid!) { - checkout: checkoutRemoveCoupon(checkoutId: $checkoutId) { - ...Checkout - } - }`, + ...RemoveCoupon, }); const checkoutId = data.checkout?.checkoutId; diff --git a/wake/actions/cart/updateItemQuantity.ts b/wake/actions/cart/updateItemQuantity.ts index 885ea17ab..a0411a615 100644 --- a/wake/actions/cart/updateItemQuantity.ts +++ b/wake/actions/cart/updateItemQuantity.ts @@ -1,8 +1,10 @@ -import { gql } from "../../../utils/graphql.ts"; import { HttpError } from "../../../utils/http.ts"; import { AppContext } from "../../mod.ts"; import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; -import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { + AddItemToCart, + RemoveItemFromCart, +} from "../../utils/graphql/queries.ts"; import { AddItemToCartMutation, AddItemToCartMutationVariables, @@ -30,9 +32,7 @@ const addToCart = ( variables: { input: { id: cartId, products: [props] }, }, - fragments: [fragment], - query: - gql`mutation AddItemToCart($input: CheckoutProductInput!) { checkout: checkoutAddProduct(input: $input) { ...Checkout }}`, + ...AddItemToCart, }); const removeFromCart = ( @@ -47,9 +47,7 @@ const removeFromCart = ( variables: { input: { id: cartId, products: [{ ...props, quantity: 1e6 }] }, }, - fragments: [fragment], - query: - gql`mutation RemoveItemFromCart($input: CheckoutProductInput!) { checkout: checkoutRemoveProduct(input: $input) { ...Checkout }}`, + ...RemoveItemFromCart, }); const action = async ( diff --git a/wake/loaders/cart.ts b/wake/loaders/cart.ts index 7026a43e7..0b31ef8a5 100644 --- a/wake/loaders/cart.ts +++ b/wake/loaders/cart.ts @@ -1,7 +1,6 @@ -import { gql } from "../../utils/graphql.ts"; import { AppContext } from "../mod.ts"; import { getCartCookie, setCartCookie } from "../utils/cart.ts"; -import { fragment } from "../utils/graphql/fragments/checkout.ts"; +import { CreateCart, GetCart } from "../utils/graphql/queries.ts"; import { CheckoutFragment, CreateCartMutation, @@ -25,14 +24,10 @@ const loader = async ( const data = cartId ? await storefront.query({ variables: { checkoutId: cartId }, - fragments: [fragment], - query: - gql`query GetCart($checkoutId: String!) { checkout(checkoutId: $checkoutId) { ...Checkout } }`, + ...GetCart, }) : await storefront.query({ - fragments: [fragment], - query: - gql`mutation CreateCart { checkout: createCheckout { ...Checkout } }`, + ...CreateCart, }); const checkoutId = data.checkout?.checkoutId; diff --git a/wake/loaders/productDetailsPage.ts b/wake/loaders/productDetailsPage.ts index 28dbc2d98..58ecc197e 100644 --- a/wake/loaders/productDetailsPage.ts +++ b/wake/loaders/productDetailsPage.ts @@ -1,13 +1,12 @@ import type { ProductDetailsPage } from "../../commerce/types.ts"; -import { gql } from "../../utils/graphql.ts"; import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; import { AppContext } from "../mod.ts"; +import { GetProduct } from "../utils/graphql/queries.ts"; import { GetProductQuery, GetProductQueryVariables, } from "../utils/graphql/storefront.graphql.gen.ts"; import { parseSlug, toBreadcrumbList, toProduct } from "../utils/transform.ts"; -import { fragment } from "../utils/graphql/fragments/singleProduct.ts"; export interface Props { slug: RequestURLParam; @@ -39,10 +38,8 @@ async function loader( GetProductQuery, GetProductQueryVariables >({ - fragments: [fragment], - query: - gql`query GetProduct($productId: Long!) { product(productId: $productId) { ...SingleProduct } }`, variables: { productId }, + ...GetProduct, }); if (!wakeProduct) { diff --git a/wake/loaders/productList.ts b/wake/loaders/productList.ts index 20f330cd7..45dce8d3d 100644 --- a/wake/loaders/productList.ts +++ b/wake/loaders/productList.ts @@ -1,7 +1,6 @@ import type { Product } from "../../commerce/types.ts"; -import { gql } from "../../utils/graphql.ts"; import type { AppContext } from "../mod.ts"; -import { fragment } from "../utils/graphql/fragments/product.ts"; +import { GetProducts } from "../utils/graphql/queries.ts"; import { GetProductsQuery, GetProductsQueryVariables, @@ -103,9 +102,7 @@ const productListLoader = async ( GetProductsQueryVariables >({ variables: props, - fragments: [fragment], - query: - gql`query GetProducts($filters: ProductExplicitFiltersInput!, $first: Int!, $sortDirection: SortDirection!, $sortKey: ProductSortKeys) { products(filters: $filters, first: $first, sortDirection: $sortDirection, sortKey: $sortKey) { nodes { ...Product } }}`, + ...GetProducts, }); const products = data.products?.nodes; diff --git a/wake/loaders/productListingPage.ts b/wake/loaders/productListingPage.ts index 515c500c7..990f59b53 100644 --- a/wake/loaders/productListingPage.ts +++ b/wake/loaders/productListingPage.ts @@ -1,8 +1,7 @@ import type { ProductListingPage } from "../../commerce/types.ts"; import { SortOption } from "../../commerce/types.ts"; -import { gql } from "../../utils/graphql.ts"; import type { AppContext } from "../mod.ts"; -import { fragment } from "../utils/graphql/fragments/product.ts"; +import { Search } from "../utils/graphql/queries.ts"; import { ProductFragment, ProductSortKeys, @@ -79,43 +78,7 @@ const searchLoader = async ( const data = await storefront.query({ variables: { query, operation, first, sortDirection, sortKey, filters }, - fragments: [fragment], - query: - gql`query Search($operation: Operation!, $query: String, $first: Int!, $sortDirection: SortDirection, $sortKey: ProductSearchSortKeys, $filters: [ProductFilterInput]) { - search(query: $query, operation: $operation) { - aggregations { - filters { - field - origin - values { - quantity - name - } - } - } - breadcrumbs { - link - text - } - forbiddenTerm { - text - suggested - } - pageSize - redirectUrl - searchTime - products(first: $first, sortDirection: $sortDirection, sortKey: $sortKey, filters: $filters) { - nodes { - ...Product - } - pageInfo { - hasNextPage - hasPreviousPage - } - totalCount - } - } - }`, + ...Search, }); const products = data.search?.products?.nodes ?? []; diff --git a/wake/utils/graphql/fragments/checkout.ts b/wake/utils/graphql/fragments/checkout.ts deleted file mode 100644 index 36b4299b5..000000000 --- a/wake/utils/graphql/fragments/checkout.ts +++ /dev/null @@ -1,25 +0,0 @@ -import { gql } from "../../../../utils/graphql.ts"; - -export const fragment = gql` -fragment Checkout on Checkout { - checkoutId - shippingFee - subtotal - total - completed - coupon - products { - imageUrl - brand - ajustedPrice - listPrice - price - name - productId - productVariantId - quantity - sku - url - } -} -`; diff --git a/wake/utils/graphql/fragments/product.ts b/wake/utils/graphql/fragments/product.ts deleted file mode 100644 index 6c6384b12..000000000 --- a/wake/utils/graphql/fragments/product.ts +++ /dev/null @@ -1,86 +0,0 @@ -import { gql } from "../../../../utils/graphql.ts"; - -export const fragment = gql` -fragment Product on Product { - mainVariant - productName - productId - alias - attributes { - value - name - } - productCategories { - name - url - hierarchy - main - googleCategories - } - informations { - title - value - type - } - available - averageRating - condition - createdAt - ean - id - images { - url - fileName - print - } - minimumOrderQuantity - prices { - bestInstallment { - discount - displayName - fees - name - number - value - } - discountPercentage - discounted - installmentPlans { - displayName - installments { - discount - fees - number - value - } - name - } - listPrice - multiplicationFactor - price - priceTables { - discountPercentage - id - listPrice - price - } - wholesalePrices { - price - quantity - } - } - productBrand { - fullUrlLogo - logoUrl - name - alias - } - productVariantId - seller { - name - } - sku - stock - variantName -} -`; diff --git a/wake/utils/graphql/fragments/singleProduct.ts b/wake/utils/graphql/fragments/singleProduct.ts deleted file mode 100644 index a4f90605e..000000000 --- a/wake/utils/graphql/fragments/singleProduct.ts +++ /dev/null @@ -1,104 +0,0 @@ -import { gql } from "../../../../utils/graphql.ts"; - -export const fragment = gql` -fragment SingleProduct on SingleProduct { - mainVariant - productName - productId - alias - attributes { - value - name - } - productCategories { - name - url - hierarchy - main - googleCategories - } - informations { - title - value - type - } - available - averageRating - breadcrumbs { - text - link - } - condition - createdAt - ean - id - images { - url - fileName - print - } - minimumOrderQuantity - prices { - bestInstallment { - discount - displayName - fees - name - number - value - } - discountPercentage - discounted - installmentPlans { - displayName - installments { - discount - fees - number - value - } - name - } - listPrice - multiplicationFactor - price - priceTables { - discountPercentage - id - listPrice - price - } - wholesalePrices { - price - quantity - } - } - productBrand { - fullUrlLogo - logoUrl - name - alias - } - productVariantId - reviews { - rating - review - reviewDate - email - customer - } - seller { - name - } - seo { - name - scheme - type - httpEquiv - content - } - sku - stock - variantName -} -`; diff --git a/wake/utils/graphql/queries.ts b/wake/utils/graphql/queries.ts new file mode 100644 index 000000000..fb5eec84d --- /dev/null +++ b/wake/utils/graphql/queries.ts @@ -0,0 +1,311 @@ +import { gql } from "../../../utils/graphql.ts"; + +const Checkout = gql` +fragment Checkout on Checkout { + checkoutId + shippingFee + subtotal + total + completed + coupon + products { + imageUrl + brand + ajustedPrice + listPrice + price + name + productId + productVariantId + quantity + sku + url + } +} +`; + +const Product = gql` +fragment Product on Product { + mainVariant + productName + productId + alias + attributes { + value + name + } + productCategories { + name + url + hierarchy + main + googleCategories + } + informations { + title + value + type + } + available + averageRating + condition + createdAt + ean + id + images { + url + fileName + print + } + minimumOrderQuantity + prices { + bestInstallment { + discount + displayName + fees + name + number + value + } + discountPercentage + discounted + installmentPlans { + displayName + installments { + discount + fees + number + value + } + name + } + listPrice + multiplicationFactor + price + priceTables { + discountPercentage + id + listPrice + price + } + wholesalePrices { + price + quantity + } + } + productBrand { + fullUrlLogo + logoUrl + name + alias + } + productVariantId + seller { + name + } + sku + stock + variantName +} +`; + +const SingleProduct = gql` +fragment SingleProduct on SingleProduct { + mainVariant + productName + productId + alias + attributes { + value + name + } + productCategories { + name + url + hierarchy + main + googleCategories + } + informations { + title + value + type + } + available + averageRating + breadcrumbs { + text + link + } + condition + createdAt + ean + id + images { + url + fileName + print + } + minimumOrderQuantity + prices { + bestInstallment { + discount + displayName + fees + name + number + value + } + discountPercentage + discounted + installmentPlans { + displayName + installments { + discount + fees + number + value + } + name + } + listPrice + multiplicationFactor + price + priceTables { + discountPercentage + id + listPrice + price + } + wholesalePrices { + price + quantity + } + } + productBrand { + fullUrlLogo + logoUrl + name + alias + } + productVariantId + reviews { + rating + review + reviewDate + email + customer + } + seller { + name + } + seo { + name + scheme + type + httpEquiv + content + } + sku + stock + variantName +} +`; + +export const GetProduct = { + fragments: [SingleProduct], + query: gql`query GetProduct($productId: Long!) { + product(productId: $productId) { ...SingleProduct } + }`, +}; + +export const GetCart = { + fragments: [Checkout], + query: gql`query GetCart($checkoutId: String!) { + checkout(checkoutId: $checkoutId) { ...Checkout } + }`, +}; + +export const CreateCart = { + fragments: [Checkout], + query: gql`mutation CreateCart { checkout: createCheckout { ...Checkout } }`, +}; + +export const GetProducts = { + fragments: [Product], + query: + gql`query GetProducts($filters: ProductExplicitFiltersInput!, $first: Int!, $sortDirection: SortDirection!, $sortKey: ProductSortKeys) { products(filters: $filters, first: $first, sortDirection: $sortDirection, sortKey: $sortKey) { nodes { ...Product } }}`, +}; + +export const Search = { + fragments: [Product], + query: + gql`query Search($operation: Operation!, $query: String, $first: Int!, $sortDirection: SortDirection, $sortKey: ProductSearchSortKeys, $filters: [ProductFilterInput]) { + search(query: $query, operation: $operation) { + aggregations { + filters { + field + origin + values { + quantity + name + } + } + } + breadcrumbs { + link + text + } + forbiddenTerm { + text + suggested + } + pageSize + redirectUrl + searchTime + products(first: $first, sortDirection: $sortDirection, sortKey: $sortKey, filters: $filters) { + nodes { + ...Product + } + pageInfo { + hasNextPage + hasPreviousPage + } + totalCount + } + } + }`, +}; + +export const AddCoupon = { + fragments: [Checkout], + query: gql`mutation AddCoupon($checkoutId: Uuid!, $coupon: String!) { + checkout: checkoutAddCoupon( + checkoutId: $checkoutId + coupon: $coupon + ) { ...Checkout } + }`, +}; + +export const AddItemToCart = { + fragments: [Checkout], + query: gql`mutation AddItemToCart($input: CheckoutProductInput!) { + checkout: checkoutAddProduct(input: $input) { ...Checkout } + }`, +}; + +export const RemoveCoupon = { + fragments: [Checkout], + query: gql`mutation RemoveCoupon($checkoutId: Uuid!) { + checkout: checkoutRemoveCoupon(checkoutId: $checkoutId) { + ...Checkout + } + }`, +}; + +export const RemoveItemFromCart = { + fragments: [Checkout], + query: gql`mutation RemoveItemFromCart($input: CheckoutProductInput!) { + checkout: checkoutRemoveProduct(input: $input) { ...Checkout } + }`, +}; diff --git a/wake/utils/graphql/storefront.graphql.gen.ts b/wake/utils/graphql/storefront.graphql.gen.ts index 46a86fa2f..acc743578 100644 --- a/wake/utils/graphql/storefront.graphql.gen.ts +++ b/wake/utils/graphql/storefront.graphql.gen.ts @@ -4,100 +4,112 @@ // This file SHOULD be checked into source version control. // To generate this file: deno task start // + export type Maybe = T | null; export type InputMaybe = Maybe; -export type Exact = { [K in keyof T]: T[K] }; -export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; -export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; -export type MakeEmpty = { [_ in K]?: never }; -export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +export type Exact = { + [K in keyof T]: T[K]; +}; +export type MakeOptional = + & Omit + & { [SubKey in K]?: Maybe }; +export type MakeMaybe = + & Omit + & { [SubKey in K]: Maybe }; +export type MakeEmpty = + { [_ in K]?: never }; +export type Incremental = + | T + | { + [P in keyof T]?: P extends " $fragmentName" | "__typename" ? T[P] : never; + }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { - ID: { input: string; output: string; } - String: { input: string; output: string; } - Boolean: { input: boolean; output: boolean; } - Int: { input: number; output: number; } - Float: { input: number; output: number; } - Any: { input: any; output: any; } - CEP: { input: any; output: any; } - CountryCode: { input: any; output: any; } - DateTime: { input: any; output: any; } - Decimal: { input: any; output: any; } - EmailAddress: { input: any; output: any; } - Long: { input: any; output: any; } - Upload: { input: any; output: any; } - Uuid: { input: any; output: any; } + ID: { input: string; output: string }; + String: { input: string; output: string }; + Boolean: { input: boolean; output: boolean }; + Int: { input: number; output: number }; + Float: { input: number; output: number }; + Any: { input: any; output: any }; + CEP: { input: any; output: any }; + CountryCode: { input: any; output: any }; + DateTime: { input: any; output: any }; + Decimal: { input: any; output: any }; + EmailAddress: { input: any; output: any }; + Long: { input: any; output: any }; + Upload: { input: any; output: any }; + Uuid: { input: any; output: any }; }; /** Price alert input parameters. */ export type AddPriceAlertInput = { /** The alerted's email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The alerted's name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product variant id to create the price alert. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The target price to alert. */ - targetPrice: Scalars['Decimal']['input']; + targetPrice: Scalars["Decimal"]["input"]; }; export type AddressNode = { /** Zip code. */ - cep?: Maybe; + cep?: Maybe; /** Address city. */ - city?: Maybe; + city?: Maybe; /** Address country. */ - country?: Maybe; + country?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Address state. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type Answer = { - id?: Maybe; - value?: Maybe; + id?: Maybe; + value?: Maybe; }; export type ApplyPolicy = - | 'AFTER_RESOLVER' - | 'BEFORE_RESOLVER'; + | "AFTER_RESOLVER" + | "BEFORE_RESOLVER"; /** Attributes available for the variant products from the given productId. */ export type Attribute = Node & { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The values of the attribute. */ values?: Maybe>>; }; export type AttributeFilterInput = { - attributeId: Scalars['Long']['input']; - value: Scalars['String']['input']; + attributeId: Scalars["Long"]["input"]; + value: Scalars["String"]["input"]; }; /** Input to specify which attributes to match. */ export type AttributeInput = { /** The attribute Ids to match. */ - id?: InputMaybe>; + id?: InputMaybe>; /** The attribute name to match. */ - name?: InputMaybe>>; + name?: InputMaybe>>; /** The attribute type to match. */ - type?: InputMaybe>>; + type?: InputMaybe>>; /** The attribute value to match */ - value?: InputMaybe>>; + value?: InputMaybe>>; }; export type AttributeMatrix = { @@ -110,32 +122,31 @@ export type AttributeMatrix = { }; export type AttributeMatrixInfo = { - displayType?: Maybe; - name?: Maybe; + displayType?: Maybe; + name?: Maybe; values?: Maybe>>; }; export type AttributeMatrixProduct = { - available: Scalars['Boolean']['output']; - productVariantId: Scalars['Long']['output']; - stock: Scalars['Long']['output']; + available: Scalars["Boolean"]["output"]; + productVariantId: Scalars["Long"]["output"]; + stock: Scalars["Long"]["output"]; }; export type AttributeMatrixRowColumnInfoValue = { - printUrl?: Maybe; - value?: Maybe; + printUrl?: Maybe; + value?: Maybe; }; - export type AttributeMatrixRowColumnInfoValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes available for the variant products from the given productId. */ export type AttributeSelection = { /** Check if the current product attributes can be rendered as a matrix. */ - canBeMatrix: Scalars['Boolean']['output']; + canBeMatrix: Scalars["Boolean"]["output"]; /** The candidate variant given the current input filters. Variant may be from brother product Id. */ candidateVariant?: Maybe; /** Informations about the attribute matrix. */ @@ -149,30 +160,29 @@ export type AttributeSelection = { /** Attributes available for the variant products from the given productId. */ export type AttributeSelectionOption = { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The values of the attribute. */ values?: Maybe>>; /** If the attributes varies by parent. */ - varyByParent: Scalars['Boolean']['output']; + varyByParent: Scalars["Boolean"]["output"]; }; export type AttributeSelectionOptionValue = { - alias?: Maybe; - available: Scalars['Boolean']['output']; - printUrl?: Maybe; - selected: Scalars['Boolean']['output']; + alias?: Maybe; + available: Scalars["Boolean"]["output"]; + printUrl?: Maybe; + selected: Scalars["Boolean"]["output"]; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; - export type AttributeSelectionOptionValuePrintUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Attributes values with variants */ @@ -180,7 +190,7 @@ export type AttributeValue = { /** Product variants that have the attribute. */ productVariants?: Maybe>>; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; /** Get query completion suggestion. */ @@ -188,57 +198,57 @@ export type Autocomplete = { /** Suggested products based on the current query. */ products?: Maybe>>; /** List of possible query completions. */ - suggestions?: Maybe>>; + suggestions?: Maybe>>; }; /** A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click. */ export type Banner = Node & { /** Banner's alternative text. */ - altText?: Maybe; + altText?: Maybe; /** Banner unique identifier. */ - bannerId: Scalars['Long']['output']; + bannerId: Scalars["Long"]["output"]; /** Banner's name. */ - bannerName?: Maybe; + bannerName?: Maybe; /** URL where the banner is stored. */ - bannerUrl?: Maybe; + bannerUrl?: Maybe; /** The date the banner was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** Field to check if the banner should be displayed on all pages. */ - displayOnAllPages: Scalars['Boolean']['output']; + displayOnAllPages: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on category pages. */ - displayOnCategories: Scalars['Boolean']['output']; + displayOnCategories: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on search pages. */ - displayOnSearches: Scalars['Boolean']['output']; + displayOnSearches: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed on the website. */ - displayOnWebsite: Scalars['Boolean']['output']; + displayOnWebsite: Scalars["Boolean"]["output"]; /** Field to check if the banner should be displayed to partners. */ - displayToPartners: Scalars['Boolean']['output']; + displayToPartners: Scalars["Boolean"]["output"]; /** The banner's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Field to check if the banner URL should open in another tab on click. */ - openNewTab: Scalars['Boolean']['output']; + openNewTab: Scalars["Boolean"]["output"]; /** The displaying order of the banner. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** The displaying position of the banner. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the banner on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The banner's title. */ - title?: Maybe; + title?: Maybe; /** URL to be redirected on click. */ - urlOnClick?: Maybe; + urlOnClick?: Maybe; /** The banner's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the banner attribute which the result set will be sorted on. */ export type BannerSortKeys = /** The banner's creation date. */ - | 'CREATION_DATE' + | "CREATION_DATE" /** The banner's unique identifier. */ - | 'ID'; + | "ID"; /** A connection to a list of items. */ export type BannersConnection = { @@ -253,69 +263,67 @@ export type BannersConnection = { /** An edge in a connection. */ export type BannersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; export type BestInstallment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** The custom display name of the best installment plan option. */ - displayName?: Maybe; + displayName?: Maybe; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The name of the best installment plan option. */ - name?: Maybe; + name?: Maybe; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Informations about brands and its products. */ export type Brand = Node & { /** If the brand is active at the platform. */ - active: Scalars['Boolean']['output']; + active: Scalars["Boolean"]["output"]; /** The alias for the brand's hotsite. */ - alias?: Maybe; + alias?: Maybe; /** Brand unique identifier. */ - brandId: Scalars['Long']['output']; + brandId: Scalars["Long"]["output"]; /** The date the brand was created in the database. */ - createdAt: Scalars['DateTime']['output']; + createdAt: Scalars["DateTime"]["output"]; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The brand's name. */ - name?: Maybe; + name?: Maybe; /** A list of products from the brand. */ products?: Maybe; /** The last update date. */ - updatedAt: Scalars['DateTime']['output']; + updatedAt: Scalars["DateTime"]["output"]; /** A web address to be redirected. */ - urlCarrossel?: Maybe; + urlCarrossel?: Maybe; /** A web address linked to the brand. */ - urlLink?: Maybe; + urlLink?: Maybe; /** The url of the brand's logo. */ - urlLogo?: Maybe; + urlLogo?: Maybe; }; - /** Informations about brands and its products. */ export type BrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; - /** Informations about brands and its products. */ export type BrandProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -323,21 +331,21 @@ export type BrandProductsArgs = { /** Filter brand results based on giving attributes. */ export type BrandFilterInput = { /** Its unique identifier (you may provide a list of IDs if needed). */ - brandIds?: InputMaybe>; + brandIds?: InputMaybe>; /** Its brand group unique identifier (you may provide a list of IDs if needed). */ - groupIds?: InputMaybe>; + groupIds?: InputMaybe>; /** The set of group brand names which the result item name must be included in. */ - groupNames?: InputMaybe>>; + groupNames?: InputMaybe>>; /** The set of brand names which the result item name must be included in. */ - names?: InputMaybe>>; + names?: InputMaybe>>; }; /** Define the brand attribute which the result set will be sorted on. */ export type BrandSortKeys = /** The brand unique identifier. */ - | 'ID' + | "ID" /** The brand name. */ - | 'NAME'; + | "NAME"; /** A connection to a list of items. */ export type BrandsConnection = { @@ -347,13 +355,13 @@ export type BrandsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** An edge in a connection. */ export type BrandsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -361,9 +369,9 @@ export type BrandsEdge = { /** Informations about breadcrumb. */ export type Breadcrumb = { /** Breadcrumb link. */ - link?: Maybe; + link?: Maybe; /** Breadcrumb text. */ - text?: Maybe; + text?: Maybe; }; /** BuyBox informations. */ @@ -371,11 +379,11 @@ export type BuyBox = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** Maximum price among sellers. */ - maximumPrice?: Maybe; + maximumPrice?: Maybe; /** Minimum price among sellers. */ - minimumPrice?: Maybe; + minimumPrice?: Maybe; /** Quantity of offers. */ - quantityOffers?: Maybe; + quantityOffers?: Maybe; /** List of sellers. */ sellers?: Maybe>>; }; @@ -383,61 +391,61 @@ export type BuyBox = { /** A buy list represents a list of items for sale in the store. */ export type BuyList = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ buyBox?: Maybe; - buyListId: Scalars['Int']['output']; + buyListId: Scalars["Int"]["output"]; buyListProducts?: Maybe>>; /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -445,13 +453,13 @@ export type BuyList = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -463,46 +471,45 @@ export type BuyList = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A buy list represents a list of items for sale in the store. */ export type BuyListImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Contains the id and quantity of a product in the buy list. */ export type BuyListProduct = { - productId: Scalars['Long']['output']; - quantity: Scalars['Int']['output']; + productId: Scalars["Long"]["output"]; + quantity: Scalars["Int"]["output"]; }; /** The products to calculate prices. */ export type CalculatePricesProductsInput = { - productVariantId: Scalars['Long']['input']; - quantity: Scalars['Int']['input']; + productVariantId: Scalars["Long"]["input"]; + quantity: Scalars["Int"]["input"]; }; /** A connection to a list of items. */ @@ -518,7 +525,7 @@ export type CategoriesConnection = { /** An edge in a connection. */ export type CategoriesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -526,45 +533,44 @@ export type CategoriesEdge = { /** Categories are used to arrange your products into different sections by similarity. */ export type Category = Node & { /** Category unique identifier. */ - categoryId: Scalars['Long']['output']; + categoryId: Scalars["Long"]["output"]; /** A list of child categories, if it exists. */ children?: Maybe>>; /** A description to the category. */ - description?: Maybe; + description?: Maybe; /** Field to check if the category is displayed in the store's menu. */ - displayMenu: Scalars['Boolean']['output']; + displayMenu: Scalars["Boolean"]["output"]; /** The hotsite alias. */ - hotsiteAlias?: Maybe; + hotsiteAlias?: Maybe; /** The URL path for the category. */ - hotsiteUrl?: Maybe; + hotsiteUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url to access the image linked to the category. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The web address to access the image linked to the category. */ - imageUrlLink?: Maybe; + imageUrlLink?: Maybe; /** The category's name. */ - name?: Maybe; + name?: Maybe; /** The parent category, if it exists. */ parent?: Maybe; /** The parent category unique identifier. */ - parentCategoryId: Scalars['Long']['output']; + parentCategoryId: Scalars["Long"]["output"]; /** The position the category will be displayed. */ - position: Scalars['Int']['output']; + position: Scalars["Int"]["output"]; /** A list of products associated with the category. */ products?: Maybe; /** A web address linked to the category. */ - urlLink?: Maybe; + urlLink?: Maybe; }; - /** Categories are used to arrange your products into different sections by similarity. */ export type CategoryProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; @@ -572,24 +578,24 @@ export type CategoryProductsArgs = { /** Define the category attribute which the result set will be sorted on. */ export type CategorySortKeys = /** The category unique identifier. */ - | 'ID' + | "ID" /** The category name. */ - | 'NAME'; + | "NAME"; export type Checkout = Node & { /** The CEP. */ - cep?: Maybe; + cep?: Maybe; /** The checkout unique identifier. */ - checkoutId: Scalars['Uuid']['output']; + checkoutId: Scalars["Uuid"]["output"]; /** Indicates if the checkout is completed. */ - completed: Scalars['Boolean']['output']; + completed: Scalars["Boolean"]["output"]; /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** The customer associated with the checkout. */ customer?: Maybe; /** The node unique identifier. */ - id?: Maybe; - login?: Maybe; + id?: Maybe; + login?: Maybe; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The checkout orders informations. */ @@ -603,67 +609,67 @@ export type Checkout = Node & { /** Selected Shipping. */ selectedShipping?: Maybe; /** The shipping fee. */ - shippingFee: Scalars['Decimal']['output']; + shippingFee: Scalars["Decimal"]["output"]; /** The subtotal value. */ - subtotal: Scalars['Decimal']['output']; + subtotal: Scalars["Decimal"]["output"]; /** The total value. */ - total: Scalars['Decimal']['output']; + total: Scalars["Decimal"]["output"]; /** The last update date. */ - updateDate: Scalars['DateTime']['output']; + updateDate: Scalars["DateTime"]["output"]; /** Url for the current checkout id. */ - url?: Maybe; + url?: Maybe; }; /** Represents an address node in the checkout. */ export type CheckoutAddress = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep: Scalars['Int']['output']; + cep: Scalars["Int"]["output"]; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The neighborhood of the address. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; /** Represents a customer node in the checkout. */ export type CheckoutCustomer = { /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** The credit limit of the customer. */ - creditLimit: Scalars['Decimal']['output']; + creditLimit: Scalars["Decimal"]["output"]; /** The credit limit balance of the customer. */ - creditLimitBalance: Scalars['Decimal']['output']; + creditLimitBalance: Scalars["Decimal"]["output"]; /** Customer's unique identifier. */ - customerId: Scalars['Long']['output']; + customerId: Scalars["Long"]["output"]; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** The email address of the customer. */ - email?: Maybe; + email?: Maybe; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; }; export type CheckoutCustomizationInput = { - customizationId: Scalars['Long']['input']; - value?: InputMaybe; + customizationId: Scalars["Long"]["input"]; + value?: InputMaybe; }; export type CheckoutMetadataInput = { - key?: InputMaybe; - value?: InputMaybe; + key?: InputMaybe; + value?: InputMaybe; }; /** Represents a node in the checkout order. */ @@ -671,17 +677,17 @@ export type CheckoutOrder = { /** The list of adjustments applied to the order. */ adjustments?: Maybe>>; /** The date of the order. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** Details of the delivery or store pickup. */ delivery?: Maybe; /** The discount value of the order. */ - discountValue: Scalars['Decimal']['output']; + discountValue: Scalars["Decimal"]["output"]; /** The dispatch time text from the shop settings. */ - dispatchTimeText?: Maybe; + dispatchTimeText?: Maybe; /** The interest value of the order. */ - interestValue: Scalars['Decimal']['output']; + interestValue: Scalars["Decimal"]["output"]; /** The ID of the order. */ - orderId: Scalars['Long']['output']; + orderId: Scalars["Long"]["output"]; /** The order status. */ orderStatus: OrderStatus; /** The payment information. */ @@ -689,39 +695,39 @@ export type CheckoutOrder = { /** The list of products in the order. */ products?: Maybe>>; /** The shipping value of the order. */ - shippingValue: Scalars['Decimal']['output']; + shippingValue: Scalars["Decimal"]["output"]; /** The total value of the order. */ - totalValue: Scalars['Decimal']['output']; + totalValue: Scalars["Decimal"]["output"]; }; /** The delivery or store Pickup Address. */ export type CheckoutOrderAddress = { /** The street address. */ - address?: Maybe; + address?: Maybe; /** The ZIP code. */ - cep?: Maybe; + cep?: Maybe; /** The city. */ - city?: Maybe; + city?: Maybe; /** Additional information or details about the address. */ - complement?: Maybe; + complement?: Maybe; /** Indicates whether the order is for store pickup. */ - isPickupStore: Scalars['Boolean']['output']; + isPickupStore: Scalars["Boolean"]["output"]; /** The name. */ - name?: Maybe; + name?: Maybe; /** The neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** . */ - pickupStoreText?: Maybe; + pickupStoreText?: Maybe; }; /** Represents an adjustment applied to checkout. */ export type CheckoutOrderAdjustment = { /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** The delivery or store pickup details. */ @@ -729,19 +735,19 @@ export type CheckoutOrderDelivery = { /** The delivery or store pickup address. */ address?: Maybe; /** The cost of delivery or pickup. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** The estimated delivery or pickup time, in days. */ - deliveryTime: Scalars['Int']['output']; + deliveryTime: Scalars["Int"]["output"]; /** The name of the recipient. */ - name?: Maybe; + name?: Maybe; }; /** The invoice payment information. */ export type CheckoutOrderInvoicePayment = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; /** The checkout order payment. */ @@ -749,7 +755,7 @@ export type CheckoutOrderPayment = { /** The bank invoice payment information. */ invoice?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; /** The Pix payment information. */ pix?: Maybe; }; @@ -757,11 +763,11 @@ export type CheckoutOrderPayment = { /** This represents a Pix payment node in the checkout order. */ export type CheckoutOrderPixPayment = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; /** Represents a node in the checkout order products. */ @@ -771,157 +777,156 @@ export type CheckoutOrderProduct = { /** The list of attributes of the product. */ attributes?: Maybe>>; /** The image URL of the product. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the product. */ - name?: Maybe; + name?: Maybe; /** The ID of the product variant. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The quantity of the product. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The value of the product. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Represents an adjustment applied to a product in the checkout order. */ export type CheckoutOrderProductAdjustment = { /** Additional information about the adjustment. */ - additionalInformation?: Maybe; + additionalInformation?: Maybe; /** The name of the adjustment. */ - name?: Maybe; + name?: Maybe; /** The type of the adjustment. */ - type?: Maybe; + type?: Maybe; /** The value of the adjustment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; /** Represents an attribute of a product. */ export type CheckoutOrderProductAttribute = { /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductAttributeNode = { /** The attribute name */ - name?: Maybe; + name?: Maybe; /** The attribute type */ - type: Scalars['Int']['output']; + type: Scalars["Int"]["output"]; /** The attribute value */ - value?: Maybe; + value?: Maybe; }; export type CheckoutProductInput = { - id: Scalars['Uuid']['input']; + id: Scalars["Uuid"]["input"]; products: Array>; }; export type CheckoutProductItemInput = { customization?: InputMaybe>>; metadata?: InputMaybe>>; - productVariantId: Scalars['Long']['input']; - quantity: Scalars['Int']['input']; + productVariantId: Scalars["Long"]["input"]; + quantity: Scalars["Int"]["input"]; subscription?: InputMaybe; }; export type CheckoutProductNode = { /** The product adjusted price */ - ajustedPrice: Scalars['Decimal']['output']; + ajustedPrice: Scalars["Decimal"]["output"]; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** The product brand */ - brand?: Maybe; + brand?: Maybe; /** The product category */ - category?: Maybe; + category?: Maybe; /** If the product is a gift */ - gift: Scalars['Boolean']['output']; + gift: Scalars["Boolean"]["output"]; /** The product Google category */ - googleCategory?: Maybe>>; + googleCategory?: Maybe>>; /** The product URL image */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The product informations */ - informations?: Maybe>>; + informations?: Maybe>>; /** The product installment fee */ - installmentFee: Scalars['Boolean']['output']; + installmentFee: Scalars["Boolean"]["output"]; /** The product installment value */ - installmentValue: Scalars['Decimal']['output']; + installmentValue: Scalars["Decimal"]["output"]; /** The product list price */ - listPrice: Scalars['Decimal']['output']; + listPrice: Scalars["Decimal"]["output"]; /** The metadata related to this checkout. */ metadata?: Maybe>>; /** The product name */ - name?: Maybe; + name?: Maybe; /** The product number of installments */ - numberOfInstallments: Scalars['Int']['output']; + numberOfInstallments: Scalars["Int"]["output"]; /** The product price */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** The product attributes */ productAttributes?: Maybe>>; /** The product unique identifier */ - productId: Scalars['Long']['output']; + productId: Scalars["Long"]["output"]; /** The product variant unique identifier */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The product quantity */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The product shipping deadline */ shippingDeadline?: Maybe; /** The product SKU */ - sku?: Maybe; + sku?: Maybe; /** The product URL */ - url?: Maybe; + url?: Maybe; }; - export type CheckoutProductNodeAttributeSelectionsArgs = { selected?: InputMaybe>>; }; export type CheckoutShippingDeadlineNode = { /** The shipping deadline */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The shipping description */ - description?: Maybe; + description?: Maybe; /** The shipping second description */ - secondDescription?: Maybe; + secondDescription?: Maybe; /** The shipping second title */ - secondTitle?: Maybe; + secondTitle?: Maybe; /** The shipping title */ - title?: Maybe; + title?: Maybe; }; export type CheckoutSubscriptionInput = { - recurringTypeId: Scalars['Int']['input']; - subscriptionGroupId: Scalars['Long']['input']; + recurringTypeId: Scalars["Int"]["input"]; + subscriptionGroupId: Scalars["Long"]["input"]; }; /** Contents are used to show things to the user. */ export type Content = Node & { /** The content in html to be displayed. */ - content?: Maybe; + content?: Maybe; /** Content unique identifier. */ - contentId: Scalars['Long']['output']; + contentId: Scalars["Long"]["output"]; /** The date the content was created. */ - creationDate?: Maybe; + creationDate?: Maybe; /** The content's height in px. */ - height?: Maybe; + height?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The content's position. */ - position?: Maybe; + position?: Maybe; /** A list of terms to display the content on search. */ - searchTerms?: Maybe>>; + searchTerms?: Maybe>>; /** The content's title. */ - title?: Maybe; + title?: Maybe; /** The content's width in px. */ - width?: Maybe; + width?: Maybe; }; /** Define the content attribute which the result set will be sorted on. */ export type ContentSortKeys = /** The content's creation date. */ - | 'CreationDate' + | "CreationDate" /** The content's unique identifier. */ - | 'ID'; + | "ID"; /** A connection to a list of items. */ export type ContentsConnection = { @@ -936,24 +941,24 @@ export type ContentsConnection = { /** An edge in a connection. */ export type ContentsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; export type CreateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber: Scalars['String']['input']; - cep: Scalars['CEP']['input']; - city: Scalars['String']['input']; - country: Scalars['CountryCode']['input']; - email: Scalars['EmailAddress']['input']; - name: Scalars['String']['input']; - neighborhood: Scalars['String']['input']; - phone: Scalars['String']['input']; - referencePoint?: InputMaybe; - state: Scalars['String']['input']; - street: Scalars['String']['input']; + addressDetails?: InputMaybe; + addressNumber: Scalars["String"]["input"]; + cep: Scalars["CEP"]["input"]; + city: Scalars["String"]["input"]; + country: Scalars["CountryCode"]["input"]; + email: Scalars["EmailAddress"]["input"]; + name: Scalars["String"]["input"]; + neighborhood: Scalars["String"]["input"]; + phone: Scalars["String"]["input"]; + referencePoint?: InputMaybe; + state: Scalars["String"]["input"]; + street: Scalars["String"]["input"]; }; /** A customer from the store. */ @@ -961,35 +966,35 @@ export type Customer = Node & { /** Customer's addresses. */ addresses?: Maybe>>; /** Customer's birth date. */ - birthDate: Scalars['DateTime']['output']; + birthDate: Scalars["DateTime"]["output"]; /** Customer's business phone number. */ - businessPhoneNumber?: Maybe; + businessPhoneNumber?: Maybe; /** Taxpayer identification number for businesses. */ - cnpj?: Maybe; + cnpj?: Maybe; /** Entities legal name. */ - companyName?: Maybe; + companyName?: Maybe; /** Brazilian individual taxpayer registry identification. */ - cpf?: Maybe; + cpf?: Maybe; /** Creation Date. */ - creationDate: Scalars['DateTime']['output']; + creationDate: Scalars["DateTime"]["output"]; /** Customer's unique identifier. */ - customerId: Scalars['Long']['output']; + customerId: Scalars["Long"]["output"]; /** Customer's name. */ - customerName?: Maybe; + customerName?: Maybe; /** Indicates if it is a natural person or company profile. */ - customerType?: Maybe; + customerType?: Maybe; /** Customer's delivery address. */ deliveryAddress?: Maybe; /** Customer's email address. */ - email?: Maybe; + email?: Maybe; /** Customer's gender. */ - gender?: Maybe; + gender?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Customer information groups. */ informationGroups?: Maybe>>; /** Customer's mobile phone number. */ - mobilePhoneNumber?: Maybe; + mobilePhoneNumber?: Maybe; /** List of orders placed by the customer. */ orders?: Maybe; /** Statistics about the orders the customer made in a specific timeframe. */ @@ -997,335 +1002,332 @@ export type Customer = Node & { /** Get info about the associated partners. */ partners?: Maybe>>; /** Customer's phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Customer's residential address. */ residentialAddress?: Maybe; /** Responsible's name. */ - responsibleName?: Maybe; + responsibleName?: Maybe; /** Registration number Id. */ - rg?: Maybe; + rg?: Maybe; /** State registration number. */ - stateRegistration?: Maybe; + stateRegistration?: Maybe; /** Date of the last update. */ - updateDate: Scalars['DateTime']['output']; + updateDate: Scalars["DateTime"]["output"]; /** Customer wishlist. */ wishlist?: Maybe; }; - /** A customer from the store. */ export type CustomerOrdersArgs = { - offset?: InputMaybe; + offset?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** A customer from the store. */ export type CustomerOrdersStatisticsArgs = { - dateGte?: InputMaybe; - dateLt?: InputMaybe; - onlyPaidOrders?: Scalars['Boolean']['input']; - partnerId?: InputMaybe; + dateGte?: InputMaybe; + dateLt?: InputMaybe; + onlyPaidOrders?: Scalars["Boolean"]["input"]; + partnerId?: InputMaybe; }; - /** A customer from the store. */ export type CustomerWishlistArgs = { - productsIds?: InputMaybe>>; + productsIds?: InputMaybe>>; }; export type CustomerAccessToken = { - isMaster: Scalars['Boolean']['output']; - token?: Maybe; + isMaster: Scalars["Boolean"]["output"]; + token?: Maybe; /** The user login type */ type?: Maybe; - validUntil: Scalars['DateTime']['output']; + validUntil: Scalars["DateTime"]["output"]; }; /** The input to authenticate a user. */ export type CustomerAccessTokenInput = { - email: Scalars['String']['input']; - password: Scalars['String']['input']; + email: Scalars["String"]["input"]; + password: Scalars["String"]["input"]; }; export type CustomerAddressNode = Node & { /** Address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** zip code. */ - cep?: Maybe; + cep?: Maybe; /** address city. */ - city?: Maybe; + city?: Maybe; /** Country. */ - country?: Maybe; + country?: Maybe; /** The email of the customer address. */ - email?: Maybe; + email?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the customer address. */ - name?: Maybe; + name?: Maybe; /** Address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** The phone of the customer address. */ - phone?: Maybe; + phone?: Maybe; /** Address reference point. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** State. */ - state?: Maybe; + state?: Maybe; /** Address street. */ - street?: Maybe; + street?: Maybe; }; export type CustomerCreateInput = { /** The street address for the registered address. */ - address?: InputMaybe; + address?: InputMaybe; /** The street address for the registered address. */ - address2?: InputMaybe; + address2?: InputMaybe; /** Any additional information related to the registered address. */ - addressComplement?: InputMaybe; + addressComplement?: InputMaybe; /** The building number for the registered address. */ - addressNumber?: InputMaybe; + addressNumber?: InputMaybe; /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The CEP for the registered address. */ - cep?: InputMaybe; + cep?: InputMaybe; /** The city for the registered address. */ - city?: InputMaybe; + city?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The country for the registered address. */ - country?: InputMaybe; + country?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The neighborhood for the registered address. */ - neighborhood?: InputMaybe; + neighborhood?: InputMaybe; /** Indicates if the customer has subscribed to the newsletter. */ - newsletter?: InputMaybe; + newsletter?: InputMaybe; /** The password for the customer's account. */ - password?: InputMaybe; + password?: InputMaybe; /** The password confirmation for the customer's account. */ - passwordConfirmation?: InputMaybe; + passwordConfirmation?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The name of the receiver for the registered address. */ - receiverName?: InputMaybe; + receiverName?: InputMaybe; /** A reference point or description to help locate the registered address. */ - reference?: InputMaybe; + reference?: InputMaybe; /** Indicates if the customer is a reseller. */ - reseller?: InputMaybe; + reseller?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state for the registered address. */ - state?: InputMaybe; + state?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** The input to change the user email. */ export type CustomerEmailChangeInput = { /** The new email. */ - newEmail: Scalars['String']['input']; + newEmail: Scalars["String"]["input"]; }; export type CustomerInformationGroupFieldNode = { /** The field name. */ - name?: Maybe; + name?: Maybe; /** The field order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** If the field is required. */ - required: Scalars['Boolean']['output']; + required: Scalars["Boolean"]["output"]; /** The field value. */ - value?: Maybe; + value?: Maybe; }; export type CustomerInformationGroupNode = { /** The group exibition name. */ - exibitionName?: Maybe; + exibitionName?: Maybe; /** The group fields. */ fields?: Maybe>>; /** The group name. */ - name?: Maybe; + name?: Maybe; }; export type CustomerOrderCollectionSegment = { items?: Maybe>>; - page: Scalars['Int']['output']; - pageSize: Scalars['Int']['output']; - totalCount: Scalars['Int']['output']; + page: Scalars["Int"]["output"]; + pageSize: Scalars["Int"]["output"]; + totalCount: Scalars["Int"]["output"]; }; /** Define the order attribute which the result set will be sorted on. */ export type CustomerOrderSortKeys = /** The total order value. */ - | 'AMOUNT' + | "AMOUNT" /** The date the order was placed. */ - | 'DATE' + | "DATE" /** The order ID. */ - | 'ID' + | "ID" /** The order current status. */ - | 'STATUS'; + | "STATUS"; export type CustomerOrdersStatistics = { /** The number of products the customer made from the number of orders. */ - productsQuantity: Scalars['Int']['output']; + productsQuantity: Scalars["Int"]["output"]; /** The number of orders the customer made. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; export type CustomerPartnerNode = { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; }; /** The input to change the user password. */ export type CustomerPasswordChangeInputGraphInput = { /** The current password. */ - currentPassword: Scalars['String']['input']; + currentPassword: Scalars["String"]["input"]; /** The new password. */ - newPassword: Scalars['String']['input']; + newPassword: Scalars["String"]["input"]; }; export type CustomerSimpleCreateInputGraphInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The email of the customer. */ - email?: InputMaybe; + email?: InputMaybe; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** Indicates if the customer is state registration exempt. */ - isStateRegistrationExempt?: InputMaybe; + isStateRegistrationExempt?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; export type CustomerUpdateInput = { /** The date of birth of the customer. */ - birthDate?: InputMaybe; + birthDate?: InputMaybe; /** The Brazilian tax identification number for corporations. */ - cnpj?: InputMaybe; + cnpj?: InputMaybe; /** The legal name of the corporate customer. */ - corporateName?: InputMaybe; + corporateName?: InputMaybe; /** The Brazilian tax identification number for individuals. */ - cpf?: InputMaybe; + cpf?: InputMaybe; /** Indicates if it is a natural person or company profile. */ customerType: EntityType; /** The full name of the customer. */ - fullName?: InputMaybe; + fullName?: InputMaybe; /** The gender of the customer. */ gender?: InputMaybe; /** The area code for the customer's primary phone number. */ - primaryPhoneAreaCode?: InputMaybe; + primaryPhoneAreaCode?: InputMaybe; /** The customer's primary phone number. */ - primaryPhoneNumber?: InputMaybe; + primaryPhoneNumber?: InputMaybe; /** The Brazilian register identification number for individuals. */ - rg?: InputMaybe; + rg?: InputMaybe; /** The area code for the customer's secondary phone number. */ - secondaryPhoneAreaCode?: InputMaybe; + secondaryPhoneAreaCode?: InputMaybe; /** The customer's secondary phone number. */ - secondaryPhoneNumber?: InputMaybe; + secondaryPhoneNumber?: InputMaybe; /** The state registration number for businesses. */ - stateRegistration?: InputMaybe; + stateRegistration?: InputMaybe; }; /** Some products can have customizations, such as writing your name on it or other predefined options. */ export type Customization = Node & { /** Cost of customization. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** Customization unique identifier. */ - customizationId: Scalars['Long']['output']; + customizationId: Scalars["Long"]["output"]; /** Customization group's name. */ - groupName?: Maybe; + groupName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Maximum allowed size of the field. */ - maxLength: Scalars['Int']['output']; + maxLength: Scalars["Int"]["output"]; /** The customization's name. */ - name?: Maybe; + name?: Maybe; /** Priority order of customization. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Type of customization. */ - type?: Maybe; + type?: Maybe; /** Value of customization. */ - values?: Maybe>>; + values?: Maybe>>; }; /** The delivery schedule detail. */ export type DeliveryScheduleDetail = { /** The date of the delivery schedule. */ - date?: Maybe; + date?: Maybe; /** The end date and time of the delivery schedule. */ - endDateTime: Scalars['DateTime']['output']; + endDateTime: Scalars["DateTime"]["output"]; /** The end time of the delivery schedule. */ - endTime?: Maybe; + endTime?: Maybe; /** The start date and time of the delivery schedule. */ - startDateTime: Scalars['DateTime']['output']; + startDateTime: Scalars["DateTime"]["output"]; /** The start time of the delivery schedule. */ - startTime?: Maybe; + startTime?: Maybe; }; /** Input for delivery scheduling. */ export type DeliveryScheduleInput = { /** The date. */ - date: Scalars['DateTime']['input']; + date: Scalars["DateTime"]["input"]; /** The period ID. */ - periodId: Scalars['Long']['input']; + periodId: Scalars["Long"]["input"]; }; /** Define the entity type of the customer registration. */ export type EntityType = /** Legal entity, a company, business, organization. */ - | 'COMPANY' + | "COMPANY" /** An international person, a legal international entity. */ - | 'INTERNATIONAL' + | "INTERNATIONAL" /** An individual person, a physical person. */ - | 'PERSON'; + | "PERSON"; export type FilterPosition = /** Both filter position. */ - | 'BOTH' + | "BOTH" /** Horizontal filter position. */ - | 'HORIZONTAL' + | "HORIZONTAL" /** Vertical filter position. */ - | 'VERTICAL'; + | "VERTICAL"; /** The customer's gender. */ export type Gender = - | 'FEMALE' - | 'MALE'; + | "FEMALE" + | "MALE"; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type Hotsite = Node & { @@ -1334,38 +1336,37 @@ export type Hotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars['Long']['output']; + hotsiteId: Scalars["Long"]["output"]; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A list of products associated with the hotsite. */ products?: Maybe; /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type HotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -1373,11 +1374,11 @@ export type HotsiteProductsArgs = { /** Define the hotsite attribute which the result set will be sorted on. */ export type HotsiteSortKeys = /** The hotsite id. */ - | 'ID' + | "ID" /** The hotsite name. */ - | 'NAME' + | "NAME" /** The hotsite url. */ - | 'URL'; + | "URL"; export type HotsiteSorting = { direction?: Maybe; @@ -1386,13 +1387,13 @@ export type HotsiteSorting = { export type HotsiteSubtype = /** Hotsite created from a brand. */ - | 'BRAND' + | "BRAND" /** Hotsite created from a buy list (lista de compra). */ - | 'BUY_LIST' + | "BUY_LIST" /** Hotsite created from a category. */ - | 'CATEGORY' + | "CATEGORY" /** Hotsite created from a portfolio. */ - | 'PORTFOLIO'; + | "PORTFOLIO"; /** A connection to a list of items. */ export type HotsitesConnection = { @@ -1407,7 +1408,7 @@ export type HotsitesConnection = { /** An edge in a connection. */ export type HotsitesEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -1415,162 +1416,160 @@ export type HotsitesEdge = { /** Informations about an image of a product. */ export type Image = { /** The name of the image file. */ - fileName?: Maybe; + fileName?: Maybe; /** Check if the image is used for the product main image. */ - mini: Scalars['Boolean']['output']; + mini: Scalars["Boolean"]["output"]; /** Numeric order the image should be displayed. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Check if the image is used for the product prints only. */ - print: Scalars['Boolean']['output']; + print: Scalars["Boolean"]["output"]; /** The url to retrieve the image */ - url?: Maybe; + url?: Maybe; }; /** The additional information about in-store pickup */ export type InStorePickupAdditionalInformationInput = { /** The document */ - document?: InputMaybe; + document?: InputMaybe; /** The name */ - name?: InputMaybe; + name?: InputMaybe; }; /** Information registred to the product. */ export type Information = { /** The information id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The information title. */ - title?: Maybe; + title?: Maybe; /** The information type. */ - type?: Maybe; + type?: Maybe; /** The information value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupFieldNode = Node & { /** The information group field display type. */ - displayType?: Maybe; + displayType?: Maybe; /** The information group field name. */ - fieldName?: Maybe; + fieldName?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The information group field order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** If the information group field is required. */ - required: Scalars['Boolean']['output']; + required: Scalars["Boolean"]["output"]; /** The information group field preset values. */ values?: Maybe>>; }; export type InformationGroupFieldValueNode = { /** The information group field value order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** The information group field value. */ - value?: Maybe; + value?: Maybe; }; export type InformationGroupValueInput = { /** The information group field unique identifier. */ - id?: InputMaybe; + id?: InputMaybe; /** The information group field value. */ - value?: InputMaybe; + value?: InputMaybe; }; export type Installment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type InstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; /** The name of this installment plan. */ - name?: Maybe; + name?: Maybe; }; /** The user login type. */ export type LoginType = - | 'AUTHENTICATED' - | 'NEW' - | 'SIMPLE'; + | "AUTHENTICATED" + | "NEW" + | "SIMPLE"; /** Informations about menu items. */ export type Menu = Node & { /** Menu css class to apply. */ - cssClass?: Maybe; + cssClass?: Maybe; /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu image url address. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu hierarchy level. */ - level: Scalars['Int']['output']; + level: Scalars["Int"]["output"]; /** Menu link address. */ - link?: Maybe; + link?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars['Int']['output']; + menuGroupId: Scalars["Int"]["output"]; /** Menu identifier. */ - menuId: Scalars['Int']['output']; + menuId: Scalars["Int"]["output"]; /** Menu name. */ - name: Scalars['String']['output']; + name: Scalars["String"]["output"]; /** Menu hierarchy level. */ - openNewTab: Scalars['Boolean']['output']; + openNewTab: Scalars["Boolean"]["output"]; /** Menu position order. */ - order: Scalars['Int']['output']; + order: Scalars["Int"]["output"]; /** Parent menu identifier. */ - parentMenuId?: Maybe; + parentMenuId?: Maybe; /** Menu extra text. */ - text?: Maybe; + text?: Maybe; }; - /** Informations about menu items. */ export type MenuFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Informations about menu groups. */ export type MenuGroup = Node & { /** The full image URL. */ - fullImageUrl?: Maybe; + fullImageUrl?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** Menu group image url. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** Menu group identifier. */ - menuGroupId: Scalars['Int']['output']; + menuGroupId: Scalars["Int"]["output"]; /** List of menus associated with the current group */ menus?: Maybe>>; /** Menu group name. */ - name?: Maybe; + name?: Maybe; /** Menu group partner id. */ - partnerId?: Maybe; + partnerId?: Maybe; /** Menu group position. */ - position?: Maybe; + position?: Maybe; }; - /** Informations about menu groups. */ export type MenuGroupFullImageUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Some products can have metadata, like diferent types of custom information. A basic key value pair. */ export type Metadata = { /** Metadata key. */ - key?: Maybe; + key?: Maybe; /** Metadata value. */ - value?: Maybe; + value?: Maybe; }; export type Mutation = { @@ -1661,406 +1660,367 @@ export type Mutation = { wishlistRemoveProduct?: Maybe>>; }; - export type MutationCheckoutAddCouponArgs = { - checkoutId: Scalars['Uuid']['input']; - coupon: Scalars['String']['input']; - customerAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + coupon: Scalars["String"]["input"]; + customerAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCheckoutAddMetadataArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; metadata: Array>; }; - export type MutationCheckoutAddMetadataForProductVariantArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; metadata: Array>; - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; }; - export type MutationCheckoutAddProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; - export type MutationCheckoutAddressAssociateArgs = { - addressId: Scalars['ID']['input']; - checkoutId: Scalars['Uuid']['input']; - customerAccessToken: Scalars['String']['input']; + addressId: Scalars["ID"]["input"]; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutCloneArgs = { - checkoutId: Scalars['Uuid']['input']; - copyUser?: Scalars['Boolean']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + copyUser?: Scalars["Boolean"]["input"]; + customerAccessToken?: InputMaybe; }; - export type MutationCheckoutCompleteArgs = { - checkoutId: Scalars['Uuid']['input']; - comments?: InputMaybe; - customerAccessToken?: InputMaybe; - paymentData: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + comments?: InputMaybe; + customerAccessToken?: InputMaybe; + paymentData: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCheckoutCustomerAssociateArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutGiftVariantSelectionArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - productVariantId: Scalars['Long']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + productVariantId: Scalars["Long"]["input"]; }; - export type MutationCheckoutPartnerAssociateArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - partnerAccessToken: Scalars['String']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + partnerAccessToken: Scalars["String"]["input"]; }; - export type MutationCheckoutRemoveCouponArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; }; - export type MutationCheckoutRemoveProductArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; input: CheckoutProductInput; }; - export type MutationCheckoutSelectInstallmentArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - installmentNumber: Scalars['Int']['input']; - selectedPaymentMethodId: Scalars['Uuid']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + installmentNumber: Scalars["Int"]["input"]; + selectedPaymentMethodId: Scalars["Uuid"]["input"]; }; - export type MutationCheckoutSelectPaymentMethodArgs = { - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; - paymentMethodId: Scalars['ID']['input']; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; + paymentMethodId: Scalars["ID"]["input"]; }; - export type MutationCheckoutSelectShippingQuoteArgs = { additionalInformation?: InputMaybe; - checkoutId: Scalars['Uuid']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["Uuid"]["input"]; + customerAccessToken?: InputMaybe; deliveryScheduleInput?: InputMaybe; - shippingQuoteId: Scalars['Uuid']['input']; + shippingQuoteId: Scalars["Uuid"]["input"]; }; - export type MutationCreateCheckoutArgs = { products?: InputMaybe>>; }; - export type MutationCreateNewsletterRegisterArgs = { input: NewsletterInput; }; - export type MutationCreateProductReviewArgs = { input: ReviewCreateInput; }; - export type MutationCreateSearchTermRecordArgs = { input: SearchRecordInput; }; - export type MutationCustomerAccessTokenCreateArgs = { input: CustomerAccessTokenInput; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCustomerAddressCreateArgs = { address: CreateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; }; - export type MutationCustomerAddressUpdateArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - export type MutationCustomerCompletePartialRegistrationArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerCreateArgs = { input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerEmailChangeArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; }; - export type MutationCustomerImpersonateArgs = { - customerAccessToken: Scalars['String']['input']; - input: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; + input: Scalars["String"]["input"]; }; - export type MutationCustomerPasswordChangeArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input?: InputMaybe; - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerPasswordRecoveryArgs = { - input: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + input: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSimpleLoginStartArgs = { - input?: InputMaybe; - recaptchaToken?: InputMaybe; + input?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSimpleLoginVerifyAnwserArgs = { - anwserId: Scalars['Uuid']['input']; - input?: InputMaybe; - questionId: Scalars['Uuid']['input']; - recaptchaToken?: InputMaybe; + anwserId: Scalars["Uuid"]["input"]; + input?: InputMaybe; + questionId: Scalars["Uuid"]["input"]; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSocialLoginFacebookArgs = { - facebookAccessToken?: InputMaybe; - recaptchaToken?: InputMaybe; + facebookAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationCustomerSocialLoginGoogleArgs = { - clientId?: InputMaybe; - recaptchaToken?: InputMaybe; - userCredential?: InputMaybe; + clientId?: InputMaybe; + recaptchaToken?: InputMaybe; + userCredential?: InputMaybe; }; - export type MutationCustomerUpdateArgs = { - customerAccessToken: Scalars['String']['input']; + customerAccessToken: Scalars["String"]["input"]; input: CustomerUpdateInput; }; - export type MutationPartnerAccessTokenCreateArgs = { input: PartnerAccessTokenInput; }; - export type MutationProductPriceAlertArgs = { input: AddPriceAlertInput; }; - export type MutationProductRestockAlertArgs = { input: RestockAlertInput; - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; }; - export type MutationSendGenericFormArgs = { - body?: InputMaybe; - file?: InputMaybe; - recaptchaToken?: InputMaybe; + body?: InputMaybe; + file?: InputMaybe; + recaptchaToken?: InputMaybe; }; - export type MutationUpdateAddressArgs = { address: UpdateCustomerAddressInput; - customerAccessToken: Scalars['String']['input']; - id: Scalars['ID']['input']; + customerAccessToken: Scalars["String"]["input"]; + id: Scalars["ID"]["input"]; }; - export type MutationWishlistAddProductArgs = { - customerAccessToken: Scalars['String']['input']; - productId: Scalars['Long']['input']; + customerAccessToken: Scalars["String"]["input"]; + productId: Scalars["Long"]["input"]; }; - export type MutationWishlistRemoveProductArgs = { - customerAccessToken: Scalars['String']['input']; - productId: Scalars['Long']['input']; + customerAccessToken: Scalars["String"]["input"]; + productId: Scalars["Long"]["input"]; }; export type NewsletterInput = { - email: Scalars['String']['input']; - informationGroupValues?: InputMaybe>>; - name: Scalars['String']['input']; - recaptchaToken?: InputMaybe; + email: Scalars["String"]["input"]; + informationGroupValues?: InputMaybe< + Array> + >; + name: Scalars["String"]["input"]; + recaptchaToken?: InputMaybe; }; export type NewsletterNode = { /** Newsletter creation date. */ - createDate: Scalars['DateTime']['output']; + createDate: Scalars["DateTime"]["output"]; /** The newsletter receiver email. */ - email?: Maybe; + email?: Maybe; /** The newsletter receiver name. */ - name?: Maybe; + name?: Maybe; /** Newsletter update date. */ - updateDate?: Maybe; + updateDate?: Maybe; }; export type Node = { - id?: Maybe; + id?: Maybe; }; /** Types of operations to perform between query terms. */ export type Operation = /** Performs AND operation between query terms. */ - | 'AND' + | "AND" /** Performs OR operation between query terms. */ - | 'OR'; + | "OR"; /** Result of the operation. */ export type OperationResult = { /** If the operation is a success. */ - isSuccess: Scalars['Boolean']['output']; + isSuccess: Scalars["Boolean"]["output"]; }; export type OrderAdjustNode = { /** The adjust name. */ - name?: Maybe; + name?: Maybe; /** Note about the adjust. */ - note?: Maybe; + note?: Maybe; /** Type of adjust. */ - type?: Maybe; + type?: Maybe; /** Amount to be adjusted. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type OrderAttributeNode = { /** The attribute name. */ - name?: Maybe; + name?: Maybe; /** The attribute value. */ - value?: Maybe; + value?: Maybe; }; export type OrderCustomizationNode = { /** The customization cost. */ - cost?: Maybe; + cost?: Maybe; /** The customization name. */ - name?: Maybe; + name?: Maybe; /** The customization value. */ - value?: Maybe; + value?: Maybe; }; export type OrderDeliveryAddressNode = { /** The street number of the address. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** The ZIP code of the address. */ - cep?: Maybe; + cep?: Maybe; /** The city of the address. */ - city?: Maybe; + city?: Maybe; /** The additional address information. */ - complement?: Maybe; + complement?: Maybe; /** The country of the address. */ - country?: Maybe; + country?: Maybe; /** The neighborhood of the address. */ - neighboorhood?: Maybe; + neighboorhood?: Maybe; /** The receiver's name. */ - receiverName?: Maybe; + receiverName?: Maybe; /** The reference point for the address. */ - referencePoint?: Maybe; + referencePoint?: Maybe; /** The state of the address, abbreviated. */ - state?: Maybe; + state?: Maybe; /** The street name of the address. */ - street?: Maybe; + street?: Maybe; }; export type OrderInvoiceNode = { /** The invoice access key. */ - accessKey?: Maybe; + accessKey?: Maybe; /** The invoice identifier code. */ - invoiceCode?: Maybe; + invoiceCode?: Maybe; /** The invoice serial digit. */ - serialDigit?: Maybe; + serialDigit?: Maybe; /** The invoice URL. */ - url?: Maybe; + url?: Maybe; }; export type OrderNoteNode = { /** Date the note was added to the order. */ - date?: Maybe; + date?: Maybe; /** The note added to the order. */ - note?: Maybe; + note?: Maybe; /** The user who added the note to the order. */ - user?: Maybe; + user?: Maybe; }; export type OrderPackagingNode = { /** The packaging cost. */ - cost: Scalars['Decimal']['output']; + cost: Scalars["Decimal"]["output"]; /** The packaging description. */ - description?: Maybe; + description?: Maybe; /** The message added to the packaging. */ - message?: Maybe; + message?: Maybe; /** The packaging name. */ - name?: Maybe; + name?: Maybe; }; export type OrderPaymentAdditionalInfoNode = { /** Additional information key. */ - key?: Maybe; + key?: Maybe; /** Additional information value. */ - value?: Maybe; + value?: Maybe; }; export type OrderPaymentBoletoNode = { /** The digitable line. */ - digitableLine?: Maybe; + digitableLine?: Maybe; /** The payment link. */ - paymentLink?: Maybe; + paymentLink?: Maybe; }; export type OrderPaymentCardNode = { /** The brand of the card. */ - brand?: Maybe; + brand?: Maybe; /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe; + maskedNumber?: Maybe; }; export type OrderPaymentNode = { @@ -2071,32 +2031,32 @@ export type OrderPaymentNode = { /** The card information. */ card?: Maybe; /** Order discounted value. */ - discount?: Maybe; + discount?: Maybe; /** Order additional fees value. */ - fees?: Maybe; + fees?: Maybe; /** Value per installment. */ - installmentValue?: Maybe; + installmentValue?: Maybe; /** Number of installments. */ - installments?: Maybe; + installments?: Maybe; /** Message about payment transaction. */ - message?: Maybe; + message?: Maybe; /** The chosen payment option for the order. */ - paymentOption?: Maybe; + paymentOption?: Maybe; /** The pix information. */ pix?: Maybe; /** Current payment status. */ - status?: Maybe; + status?: Maybe; /** Order total value. */ - total?: Maybe; + total?: Maybe; }; export type OrderPaymentPixNode = { /** The QR code. */ - qrCode?: Maybe; + qrCode?: Maybe; /** The expiration date of the QR code. */ - qrCodeExpirationDate?: Maybe; + qrCodeExpirationDate?: Maybe; /** The image URL of the QR code. */ - qrCodeUrl?: Maybe; + qrCodeUrl?: Maybe; }; export type OrderProductNode = { @@ -2105,244 +2065,243 @@ export type OrderProductNode = { /** The product attributes. */ attributes?: Maybe>>; /** The cost of the customizations, if any. */ - customizationPrice: Scalars['Decimal']['output']; + customizationPrice: Scalars["Decimal"]["output"]; /** List of customizations for the product. */ customizations?: Maybe>>; /** Amount of discount in the product price, if any. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** If the product is a gift. */ - gift?: Maybe; + gift?: Maybe; /** The product image. */ - image?: Maybe; + image?: Maybe; /** The product list price. */ - listPrice: Scalars['Decimal']['output']; + listPrice: Scalars["Decimal"]["output"]; /** The product name. */ - name?: Maybe; + name?: Maybe; /** The cost of the packagings, if any. */ - packagingPrice: Scalars['Decimal']['output']; + packagingPrice: Scalars["Decimal"]["output"]; /** List of packagings for the product. */ packagings?: Maybe>>; /** The product price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** Information about the product seller. */ productSeller?: Maybe; /** Variant unique identifier. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** Quantity of the given product in the order. */ - quantity: Scalars['Long']['output']; + quantity: Scalars["Long"]["output"]; /** The product sale price. */ - salePrice: Scalars['Decimal']['output']; + salePrice: Scalars["Decimal"]["output"]; /** The product SKU. */ - sku?: Maybe; + sku?: Maybe; /** List of trackings for the order. */ trackings?: Maybe>>; /** Value of an unit of the product. */ - unitaryValue: Scalars['Decimal']['output']; + unitaryValue: Scalars["Decimal"]["output"]; }; export type OrderSellerNode = { /** The seller's name. */ - name?: Maybe; + name?: Maybe; }; export type OrderShippingNode = { /** Limit date of delivery, in days. */ - deadline?: Maybe; + deadline?: Maybe; /** Deadline text message. */ - deadlineText?: Maybe; + deadlineText?: Maybe; /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The order pick up unique identifier. */ - pickUpId?: Maybe; + pickUpId?: Maybe; /** The products belonging to the order. */ products?: Maybe>>; /** Amount discounted from shipping costs, if any. */ - promotion?: Maybe; + promotion?: Maybe; /** Shipping company connector identifier code. */ - refConnector?: Maybe; + refConnector?: Maybe; /** Start date of shipping schedule. */ - scheduleFrom?: Maybe; + scheduleFrom?: Maybe; /** Limit date of shipping schedule. */ - scheduleUntil?: Maybe; + scheduleUntil?: Maybe; /** Shipping fee value. */ - shippingFee?: Maybe; + shippingFee?: Maybe; /** The shipping name. */ - shippingName?: Maybe; + shippingName?: Maybe; /** Shipping rate table unique identifier. */ - shippingTableId?: Maybe; + shippingTableId?: Maybe; /** The total value. */ - total?: Maybe; + total?: Maybe; /** Order package size. */ - volume?: Maybe; + volume?: Maybe; /** The order weight, in grams. */ - weight?: Maybe; + weight?: Maybe; }; export type OrderShippingProductNode = { /** Distribution center unique identifier. */ - distributionCenterId?: Maybe; + distributionCenterId?: Maybe; /** The product price. */ - price?: Maybe; + price?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Quantity of the given product. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** Define the sort orientation of the result set. */ export type OrderSortDirection = /** The results will be sorted in an ascending order. */ - | 'ASC' + | "ASC" /** The results will be sorted in an descending order. */ - | 'DESC'; + | "DESC"; /** Represents the status of an order. */ export type OrderStatus = /** Order has been approved in analysis. */ - | 'APPROVED_ANALYSIS' + | "APPROVED_ANALYSIS" /** Order has been authorized. */ - | 'AUTHORIZED' + | "AUTHORIZED" /** Order is awaiting payment. */ - | 'AWAITING_PAYMENT' + | "AWAITING_PAYMENT" /** Order is awaiting change of payment method. */ - | 'AWAITING_PAYMENT_CHANGE' + | "AWAITING_PAYMENT_CHANGE" /** Order has been cancelled. */ - | 'CANCELLED' + | "CANCELLED" /** Order has been cancelled - Card Denied. */ - | 'CANCELLED_DENIED_CARD' + | "CANCELLED_DENIED_CARD" /** Order has been cancelled - Fraud. */ - | 'CANCELLED_FRAUD' + | "CANCELLED_FRAUD" /** Order has been cancelled. */ - | 'CANCELLED_ORDER_CANCELLED' + | "CANCELLED_ORDER_CANCELLED" /** Order has been cancelled - Suspected Fraud. */ - | 'CANCELLED_SUSPECT_FRAUD' + | "CANCELLED_SUSPECT_FRAUD" /** Order has been cancelled - Card Temporarily Denied. */ - | 'CANCELLED_TEMPORARILY_DENIED_CARD' + | "CANCELLED_TEMPORARILY_DENIED_CARD" /** Order has been checked. */ - | 'CHECKED_ORDER' + | "CHECKED_ORDER" /** Order has been credited. */ - | 'CREDITED' + | "CREDITED" /** Order has been delivered. */ - | 'DELIVERED' + | "DELIVERED" /** Payment denied, but the order has not been cancelled. */ - | 'DENIED_PAYMENT' + | "DENIED_PAYMENT" /** Documents needed for purchase. */ - | 'DOCUMENTS_FOR_PURCHASE' + | "DOCUMENTS_FOR_PURCHASE" /** Order has been placed. */ - | 'ORDERED' + | "ORDERED" /** Order has been paid. */ - | 'PAID' + | "PAID" /** Available for pick-up in store. */ - | 'PICK_UP_IN_STORE' + | "PICK_UP_IN_STORE" /** Order has been received - Gift Card. */ - | 'RECEIVED_GIFT_CARD' + | "RECEIVED_GIFT_CARD" /** Order has been returned. */ - | 'RETURNED' + | "RETURNED" /** Order has been sent. */ - | 'SENT' + | "SENT" /** Order has been sent - Invoiced. */ - | 'SENT_INVOICED' + | "SENT_INVOICED" /** Order has been separated. */ - | 'SEPARATED'; + | "SEPARATED"; export type OrderStatusNode = { /** The date when status has changed. */ - changeDate?: Maybe; + changeDate?: Maybe; /** Order status. */ - status?: Maybe; + status?: Maybe; /** Status unique identifier. */ - statusId: Scalars['Long']['output']; + statusId: Scalars["Long"]["output"]; }; export type OrderTrackingNode = { /** The tracking code. */ - code?: Maybe; + code?: Maybe; /** The URL for tracking. */ - url?: Maybe; + url?: Maybe; }; /** Information about pagination in a connection. */ export type PageInfo = { /** When paginating forwards, the cursor to continue. */ - endCursor?: Maybe; + endCursor?: Maybe; /** Indicates whether more edges exist following the set defined by the clients arguments. */ - hasNextPage: Scalars['Boolean']['output']; + hasNextPage: Scalars["Boolean"]["output"]; /** Indicates whether more edges exist prior the set defined by the clients arguments. */ - hasPreviousPage: Scalars['Boolean']['output']; + hasPreviousPage: Scalars["Boolean"]["output"]; /** When paginating backwards, the cursor to continue. */ - startCursor?: Maybe; + startCursor?: Maybe; }; /** Partners are used to assign specific products or price tables depending on its scope. */ export type Partner = Node & { /** The partner alias. */ - alias?: Maybe; + alias?: Maybe; /** The partner is valid until this date. */ - endDate: Scalars['DateTime']['output']; + endDate: Scalars["DateTime"]["output"]; /** The full partner logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The partner logo's URL. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The partner's name. */ - name?: Maybe; + name?: Maybe; /** The partner's origin. */ - origin?: Maybe; + origin?: Maybe; /** The partner's access token. */ - partnerAccessToken?: Maybe; + partnerAccessToken?: Maybe; /** Partner unique identifier. */ - partnerId: Scalars['Long']['output']; + partnerId: Scalars["Long"]["output"]; /** Portfolio identifier assigned to this partner. */ - portfolioId: Scalars['Int']['output']; + portfolioId: Scalars["Int"]["output"]; /** Price table identifier assigned to this partner. */ - priceTableId: Scalars['Int']['output']; + priceTableId: Scalars["Int"]["output"]; /** The partner is valid from this date. */ - startDate: Scalars['DateTime']['output']; + startDate: Scalars["DateTime"]["output"]; /** The type of scoped the partner is used. */ - type?: Maybe; + type?: Maybe; }; - /** Partners are used to assign specific products or price tables depending on its scope. */ export type PartnerFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type PartnerAccessToken = { - token?: Maybe; - validUntil?: Maybe; + token?: Maybe; + validUntil?: Maybe; }; /** The input to authenticate closed scope partners. */ export type PartnerAccessTokenInput = { - password: Scalars['String']['input']; - username: Scalars['String']['input']; + password: Scalars["String"]["input"]; + username: Scalars["String"]["input"]; }; /** Input for partners. */ export type PartnerByRegionInput = { /** CEP to get the regional partners. */ - cep?: InputMaybe; + cep?: InputMaybe; /** Region ID to get the regional partners. */ - regionId?: InputMaybe; + regionId?: InputMaybe; }; /** Define the partner attribute which the result set will be sorted on. */ export type PartnerSortKeys = /** The partner unique identifier. */ - | 'ID' + | "ID" /** The partner name. */ - | 'NAME'; + | "NAME"; export type PartnerSubtype = /** Partner 'client' subtype. */ - | 'CLIENT' + | "CLIENT" /** Partner 'closed' subtype. */ - | 'CLOSED' + | "CLOSED" /** Partner 'open' subtype. */ - | 'OPEN'; + | "OPEN"; /** A connection to a list of items. */ export type PartnersConnection = { @@ -2357,7 +2316,7 @@ export type PartnersConnection = { /** An edge in a connection. */ export type PartnersEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2365,62 +2324,62 @@ export type PartnersEdge = { /** Informations about the physical store. */ export type PhysicalStore = { /** Additional text. */ - additionalText?: Maybe; + additionalText?: Maybe; /** Physical store address. */ - address?: Maybe; + address?: Maybe; /** Physical store address details. */ - addressDetails?: Maybe; + addressDetails?: Maybe; /** Physical store address number. */ - addressNumber?: Maybe; + addressNumber?: Maybe; /** Physical store address city. */ - city?: Maybe; + city?: Maybe; /** Physical store country. */ - country?: Maybe; + country?: Maybe; /** Physical store DDD. */ - ddd: Scalars['Int']['output']; + ddd: Scalars["Int"]["output"]; /** Delivery deadline. */ - deliveryDeadline: Scalars['Int']['output']; + deliveryDeadline: Scalars["Int"]["output"]; /** Physical store email. */ - email?: Maybe; + email?: Maybe; /** Physical store latitude. */ - latitude?: Maybe; + latitude?: Maybe; /** Physical store longitude. */ - longitude?: Maybe; + longitude?: Maybe; /** Physical store name. */ - name?: Maybe; + name?: Maybe; /** Physical store address neighborhood. */ - neighborhood?: Maybe; + neighborhood?: Maybe; /** Physical store phone number. */ - phoneNumber?: Maybe; + phoneNumber?: Maybe; /** Physical store ID. */ - physicalStoreId: Scalars['Int']['output']; + physicalStoreId: Scalars["Int"]["output"]; /** If the physical store allows pickup. */ - pickup: Scalars['Boolean']['output']; + pickup: Scalars["Boolean"]["output"]; /** Pickup deadline. */ - pickupDeadline: Scalars['Int']['output']; + pickupDeadline: Scalars["Int"]["output"]; /** Physical store state. */ - state?: Maybe; + state?: Maybe; /** Physical store zip code. */ - zipCode?: Maybe; + zipCode?: Maybe; }; /** Range of prices for this product. */ export type PriceRange = { /** The quantity of products in this range. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; /** The price range. */ - range?: Maybe; + range?: Maybe; }; export type PriceTable = { /** The amount of discount in percentage. */ - discountPercentage: Scalars['Decimal']['output']; + discountPercentage: Scalars["Decimal"]["output"]; /** The id of this price table. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The listed regular price of this table. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price of this table. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; }; /** The prices of the product. */ @@ -2428,17 +2387,17 @@ export type Prices = { /** The best installment option available. */ bestInstallment?: Maybe; /** The amount of discount in percentage. */ - discountPercentage: Scalars['Decimal']['output']; + discountPercentage: Scalars["Decimal"]["output"]; /** Wether the current price is discounted. */ - discounted: Scalars['Boolean']['output']; + discounted: Scalars["Boolean"]["output"]; /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The multiplication factor used for items that are sold by quantity. */ - multiplicationFactor: Scalars['Float']['output']; + multiplicationFactor: Scalars["Float"]["output"]; /** The current working price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** * List of the product different price tables. * @@ -2452,63 +2411,63 @@ export type Prices = { /** Input to specify the range of prices to return. */ export type PricesInput = { /** The product discount must be greater than or equal to. */ - discount_gte?: InputMaybe; + discount_gte?: InputMaybe; /** The product discount must be lesser than or equal to. */ - discount_lte?: InputMaybe; + discount_lte?: InputMaybe; /** Return only products where the listed price is more than the price. */ - discounted?: InputMaybe; + discounted?: InputMaybe; /** The product price must be greater than or equal to. */ - price_gte?: InputMaybe; + price_gte?: InputMaybe; /** The product price must be lesser than or equal to. */ - price_lte?: InputMaybe; + price_lte?: InputMaybe; }; /** A product represents an item for sale in the store. */ export type Product = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** BuyBox informations. */ buyBox?: Maybe; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -2516,13 +2475,13 @@ export type Product = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** The product seller. */ @@ -2530,48 +2489,46 @@ export type Product = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A product represents an item for sale in the store. */ export type ProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type ProductAggregations = { /** List of product filters which can be used to filter subsequent queries. */ filters?: Maybe>>; /** Minimum price of the products. */ - maximumPrice: Scalars['Decimal']['output']; + maximumPrice: Scalars["Decimal"]["output"]; /** Maximum price of the products. */ - minimumPrice: Scalars['Decimal']['output']; + minimumPrice: Scalars["Decimal"]["output"]; /** List of price ranges for the selected products. */ priceRanges?: Maybe>>; }; - export type ProductAggregationsFiltersArgs = { position?: InputMaybe; }; @@ -2579,61 +2536,60 @@ export type ProductAggregationsFiltersArgs = { /** The attributes of the product. */ export type ProductAttribute = Node & { /** The id of the attribute. */ - attributeId: Scalars['Long']['output']; + attributeId: Scalars["Long"]["output"]; /** The display type of the attribute. */ - displayType?: Maybe; + displayType?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The name of the attribute. */ - name?: Maybe; + name?: Maybe; /** The type of the attribute. */ - type?: Maybe; + type?: Maybe; /** The value of the attribute. */ - value?: Maybe; + value?: Maybe; }; export type ProductBrand = { /** The hotsite url alias fot this brand. */ - alias?: Maybe; + alias?: Maybe; /** The full brand logo URL. */ - fullUrlLogo?: Maybe; + fullUrlLogo?: Maybe; /** The brand id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The url that contains the brand logo image. */ - logoUrl?: Maybe; + logoUrl?: Maybe; /** The name of the brand. */ - name?: Maybe; + name?: Maybe; }; - export type ProductBrandFullUrlLogoArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Information about the category of a product. */ export type ProductCategory = { /** Wether the category is currently active. */ - active: Scalars['Boolean']['output']; + active: Scalars["Boolean"]["output"]; /** The categories in google format. */ - googleCategories?: Maybe; + googleCategories?: Maybe; /** The category hierarchy. */ - hierarchy?: Maybe; + hierarchy?: Maybe; /** The id of the category. */ - id: Scalars['Int']['output']; + id: Scalars["Int"]["output"]; /** Wether this category is the main category for this product. */ - main: Scalars['Boolean']['output']; + main: Scalars["Boolean"]["output"]; /** The category name. */ - name?: Maybe; + name?: Maybe; /** The category hotsite url alias. */ - url?: Maybe; + url?: Maybe; }; export type ProductCollectionSegment = { items?: Maybe>>; - page: Scalars['Int']['output']; - pageSize: Scalars['Int']['output']; - totalCount: Scalars['Int']['output']; + page: Scalars["Int"]["output"]; + pageSize: Scalars["Int"]["output"]; + totalCount: Scalars["Int"]["output"]; }; /** Filter product results based on giving attributes. */ @@ -2641,45 +2597,45 @@ export type ProductExplicitFiltersInput = { /** The set of attributes do filter. */ attributes?: InputMaybe; /** Choose if you want to retrieve only the available products in stock. */ - available?: InputMaybe; + available?: InputMaybe; /** The set of brand IDs which the result item brand ID must be included in. */ - brandId?: InputMaybe>; + brandId?: InputMaybe>; /** The set of category IDs which the result item category ID must be included in. */ - categoryId?: InputMaybe>; + categoryId?: InputMaybe>; /** The set of EANs which the result item EAN must be included. */ - ean?: InputMaybe>>; + ean?: InputMaybe>>; /** Retrieve the product variant only if it contains images. */ - hasImages?: InputMaybe; + hasImages?: InputMaybe; /** Retrieve the product variant only if it is the main product variant. */ - mainVariant?: InputMaybe; + mainVariant?: InputMaybe; /** The set of prices to filter. */ prices?: InputMaybe; /** The product unique identifier (you may provide a list of IDs if needed). */ - productId?: InputMaybe>; + productId?: InputMaybe>; /** The product variant unique identifier (you may provide a list of IDs if needed). */ - productVariantId?: InputMaybe>; + productVariantId?: InputMaybe>; /** A product ID or a list of IDs to search for other products with the same parent ID. */ - sameParentAs?: InputMaybe>; + sameParentAs?: InputMaybe>; /** The set of SKUs which the result item SKU must be included. */ - sku?: InputMaybe>>; + sku?: InputMaybe>>; /** Show products with a quantity of available products in stock greater than or equal to the given number. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** Show products with a quantity of available products in stock less than or equal to the given number. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; /** The set of stocks to filter. */ stocks?: InputMaybe; /** Retrieve products which the last update date is greater than or equal to the given date. */ - updatedAt_gte?: InputMaybe; + updatedAt_gte?: InputMaybe; /** Retrieve products which the last update date is less than or equal to the given date. */ - updatedAt_lte?: InputMaybe; + updatedAt_lte?: InputMaybe; }; /** Custom attribute defined on store's admin may also be used as a filter. */ export type ProductFilterInput = { /** The attribute name. */ - field: Scalars['String']['input']; + field: Scalars["String"]["input"]; /** The set of values which the result filter item value must be included in. */ - values: Array>; + values: Array>; }; /** Options available for the given product. */ @@ -2689,10 +2645,9 @@ export type ProductOption = Node & { /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; }; - /** Options available for the given product. */ export type ProductOptionAttributesArgs = { filter?: InputMaybe>>; @@ -2701,81 +2656,80 @@ export type ProductOptionAttributesArgs = { /** A product price alert. */ export type ProductPriceAlert = { /** The alerted's email. */ - email?: Maybe; + email?: Maybe; /** The alerted's name. */ - name?: Maybe; + name?: Maybe; /** The price alert ID. */ - priceAlertId: Scalars['Long']['output']; + priceAlertId: Scalars["Long"]["output"]; /** The product variant ID. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** The request date. */ - requestDate: Scalars['DateTime']['output']; + requestDate: Scalars["DateTime"]["output"]; /** The target price. */ - targetPrice: Scalars['Decimal']['output']; + targetPrice: Scalars["Decimal"]["output"]; }; -export type ProductRecommendationAlgorithm = - | 'DEFAULT'; +export type ProductRecommendationAlgorithm = "DEFAULT"; /** Define the product attribute which the result set will be sorted on. */ export type ProductSearchSortKeys = /** The applied discount to the product variant price. */ - | 'DISCOUNT' + | "DISCOUNT" /** The product name. */ - | 'NAME' + | "NAME" /** The product variant price. */ - | 'PRICE' + | "PRICE" /** Sort in a random way. */ - | 'RANDOM' + | "RANDOM" /** The date the product was released. */ - | 'RELEASE_DATE' + | "RELEASE_DATE" /** The relevance that the search engine gave to the possible result item based on own criteria. */ - | 'RELEVANCE' + | "RELEVANCE" /** The sales number on a period of time. */ - | 'SALES' + | "SALES" /** The quantity in stock of the product variant. */ - | 'STOCK'; + | "STOCK"; /** Define the product attribute which the result set will be sorted on. */ export type ProductSortKeys = /** The applied discount to the product variant price. */ - | 'DISCOUNT' + | "DISCOUNT" /** The product name. */ - | 'NAME' + | "NAME" /** The product variant price. */ - | 'PRICE' + | "PRICE" /** Sort in a random way. */ - | 'RANDOM' + | "RANDOM" /** The date the product was released. */ - | 'RELEASE_DATE' + | "RELEASE_DATE" /** The sales number on a period of time. */ - | 'SALES' + | "SALES" /** The quantity in stock of the product variant. */ - | 'STOCK'; + | "STOCK"; export type ProductSubscription = { /** The amount of discount if this product is sold as a subscription. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** The price of the product when sold as a subscription. */ - price?: Maybe; + price?: Maybe; /** Wether this product is sold only as a subscrition. */ - subscriptionOnly: Scalars['Boolean']['output']; + subscriptionOnly: Scalars["Boolean"]["output"]; }; /** Product variants that have the attribute. */ export type ProductVariant = Node & { /** The available stock at the default distribution center. */ - aggregatedStock?: Maybe; + aggregatedStock?: Maybe; /** The product alias. */ - alias?: Maybe; + alias?: Maybe; /** List of the selected variant attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product's EAN. */ - ean?: Maybe; + ean?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The product's images. */ images?: Maybe>>; /** The seller's product offers. */ @@ -2783,24 +2737,23 @@ export type ProductVariant = Node & { /** The product prices. */ prices?: Maybe; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** Product variant name. */ - productVariantName?: Maybe; + productVariantName?: Maybe; /** List of promotions this product variant belongs to. */ promotions?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; }; - /** Product variants that have the attribute. */ export type ProductVariantImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** A connection to a list of items. */ @@ -2811,13 +2764,13 @@ export type ProductsConnection = { nodes?: Maybe>>; /** Information to aid in pagination. */ pageInfo: PageInfo; - totalCount: Scalars['Int']['output']; + totalCount: Scalars["Int"]["output"]; }; /** An edge in a connection. */ export type ProductsEdge = { /** A cursor for use in pagination. */ - cursor: Scalars['String']['output']; + cursor: Scalars["String"]["output"]; /** The item at the end of the edge. */ node?: Maybe; }; @@ -2825,24 +2778,23 @@ export type ProductsEdge = { /** Information about promotions of a product. */ export type Promotion = { /** The promotion html content. */ - content?: Maybe; + content?: Maybe; /** Where the promotion is shown (spot, product page, etc..). */ - disclosureType?: Maybe; + disclosureType?: Maybe; /** The stamp URL of the promotion. */ - fullStampUrl?: Maybe; + fullStampUrl?: Maybe; /** The promotion id. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The stamp of the promotion. */ - stamp?: Maybe; + stamp?: Maybe; /** The promotion title. */ - title?: Maybe; + title?: Maybe; }; - /** Information about promotions of a product. */ export type PromotionFullStampUrlArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; export type QueryRoot = { @@ -2873,7 +2825,9 @@ export type QueryRoot = { /** List of menu groups. */ menuGroups?: Maybe>>; /** Get newsletter information group fields. */ - newsletterInformationGroupFields?: Maybe>>; + newsletterInformationGroupFields?: Maybe< + Array> + >; node?: Maybe; nodes?: Maybe>>; /** Get single partner. */ @@ -2909,315 +2863,287 @@ export type QueryRoot = { uri?: Maybe; }; - export type QueryRootAddressArgs = { - cep?: InputMaybe; + cep?: InputMaybe; }; - export type QueryRootAutocompleteArgs = { - limit?: InputMaybe; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + limit?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; - export type QueryRootBannersArgs = { - after?: InputMaybe; - bannerIds?: InputMaybe>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + bannerIds?: InputMaybe>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: BannerSortKeys; }; - export type QueryRootBrandsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; brandInput?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: BrandSortKeys; }; - export type QueryRootBuyListArgs = { - id: Scalars['Long']['input']; - partnerAccessToken?: InputMaybe; + id: Scalars["Long"]["input"]; + partnerAccessToken?: InputMaybe; }; - export type QueryRootCalculatePricesArgs = { - partnerAccessToken?: InputMaybe; + partnerAccessToken?: InputMaybe; products: Array>; }; - export type QueryRootCategoriesArgs = { - after?: InputMaybe; - before?: InputMaybe; - categoryIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + categoryIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: CategorySortKeys; }; - export type QueryRootCheckoutArgs = { - checkoutId: Scalars['String']['input']; - customerAccessToken?: InputMaybe; + checkoutId: Scalars["String"]["input"]; + customerAccessToken?: InputMaybe; }; - export type QueryRootContentsArgs = { - after?: InputMaybe; - before?: InputMaybe; - contentIds?: InputMaybe>; - first?: InputMaybe; - last?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + contentIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; sortDirection?: SortDirection; sortKey?: ContentSortKeys; }; - export type QueryRootCustomerArgs = { - customerAccessToken?: InputMaybe; + customerAccessToken?: InputMaybe; }; - export type QueryRootHotsiteArgs = { - hotsiteId?: InputMaybe; - partnerAccessToken?: InputMaybe; - url?: InputMaybe; + hotsiteId?: InputMaybe; + partnerAccessToken?: InputMaybe; + url?: InputMaybe; }; - export type QueryRootHotsitesArgs = { - after?: InputMaybe; - before?: InputMaybe; - first?: InputMaybe; - hotsiteIds?: InputMaybe>; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + hotsiteIds?: InputMaybe>; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: HotsiteSortKeys; }; - export type QueryRootMenuGroupsArgs = { - partnerAccessToken?: InputMaybe; - position?: InputMaybe; - url: Scalars['String']['input']; + partnerAccessToken?: InputMaybe; + position?: InputMaybe; + url: Scalars["String"]["input"]; }; - export type QueryRootNodeArgs = { - id: Scalars['ID']['input']; + id: Scalars["ID"]["input"]; }; - export type QueryRootNodesArgs = { - ids: Array; + ids: Array; }; - export type QueryRootPartnerArgs = { - partnerAccessToken: Scalars['String']['input']; + partnerAccessToken: Scalars["String"]["input"]; }; - export type QueryRootPartnerByRegionArgs = { input: PartnerByRegionInput; }; - export type QueryRootPartnersArgs = { - after?: InputMaybe; - alias?: InputMaybe>>; - before?: InputMaybe; - first?: InputMaybe; - last?: InputMaybe; - names?: InputMaybe>>; - priceTableIds?: InputMaybe>; + after?: InputMaybe; + alias?: InputMaybe>>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + names?: InputMaybe>>; + priceTableIds?: InputMaybe>; sortDirection?: SortDirection; sortKey?: PartnerSortKeys; }; - export type QueryRootPaymentMethodsArgs = { - checkoutId: Scalars['Uuid']['input']; + checkoutId: Scalars["Uuid"]["input"]; }; - export type QueryRootProductArgs = { - partnerAccessToken?: InputMaybe; - productId: Scalars['Long']['input']; + partnerAccessToken?: InputMaybe; + productId: Scalars["Long"]["input"]; }; - export type QueryRootProductOptionsArgs = { - productId: Scalars['Long']['input']; + productId: Scalars["Long"]["input"]; }; - export type QueryRootProductRecommendationsArgs = { algorithm?: ProductRecommendationAlgorithm; - partnerAccessToken?: InputMaybe; - productId: Scalars['Long']['input']; - quantity?: Scalars['Int']['input']; + partnerAccessToken?: InputMaybe; + productId: Scalars["Long"]["input"]; + quantity?: Scalars["Int"]["input"]; }; - export type QueryRootProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters: ProductExplicitFiltersInput; - first?: InputMaybe; - last?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: SortDirection; sortKey?: ProductSortKeys; }; - export type QueryRootScriptsArgs = { - name?: InputMaybe; + name?: InputMaybe; pageType?: InputMaybe>; position?: InputMaybe; - url?: InputMaybe; + url?: InputMaybe; }; - export type QueryRootSearchArgs = { operation?: Operation; - partnerAccessToken?: InputMaybe; - query?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; }; - export type QueryRootShippingQuotesArgs = { - cep?: InputMaybe; - checkoutId?: InputMaybe; - productVariantId?: InputMaybe; - quantity?: InputMaybe; - useSelectedAddress?: InputMaybe; + cep?: InputMaybe; + checkoutId?: InputMaybe; + productVariantId?: InputMaybe; + quantity?: InputMaybe; + useSelectedAddress?: InputMaybe; }; - export type QueryRootShopSettingsArgs = { - settingNames?: InputMaybe>>; + settingNames?: InputMaybe>>; }; - export type QueryRootUriArgs = { - url: Scalars['String']['input']; + url: Scalars["String"]["input"]; }; export type Question = { answers?: Maybe>>; - question?: Maybe; - questionId?: Maybe; + question?: Maybe; + questionId?: Maybe; }; /** Back in stock registration input parameters. */ export type RestockAlertInput = { /** Email to be notified. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** Name of the person to be notified. */ - name?: InputMaybe; + name?: InputMaybe; /** The product variant id of the product to be notified. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; }; export type RestockAlertNode = { /** Email to be notified. */ - email?: Maybe; + email?: Maybe; /** Name of the person to be notified. */ - name?: Maybe; + name?: Maybe; /** The product variant id. */ - productVariantId: Scalars['Long']['output']; + productVariantId: Scalars["Long"]["output"]; /** Date the alert was requested. */ - requestDate: Scalars['DateTime']['output']; + requestDate: Scalars["DateTime"]["output"]; }; /** A product review written by a customer. */ export type Review = { /** The reviewer name. */ - customer?: Maybe; + customer?: Maybe; /** The reviewer e-mail. */ - email?: Maybe; + email?: Maybe; /** The review rating. */ - rating: Scalars['Int']['output']; + rating: Scalars["Int"]["output"]; /** The review content. */ - review?: Maybe; + review?: Maybe; /** The review date. */ - reviewDate: Scalars['DateTime']['output']; + reviewDate: Scalars["DateTime"]["output"]; }; /** Review input parameters. */ export type ReviewCreateInput = { /** The reviewer's email. */ - email: Scalars['String']['input']; + email: Scalars["String"]["input"]; /** The reviewer's name. */ - name: Scalars['String']['input']; + name: Scalars["String"]["input"]; /** The product variant id to add the review to. */ - productVariantId: Scalars['Long']['input']; + productVariantId: Scalars["Long"]["input"]; /** The review rating. */ - rating: Scalars['Int']['input']; + rating: Scalars["Int"]["input"]; /** The google recaptcha token. */ - recaptchaToken?: InputMaybe; + recaptchaToken?: InputMaybe; /** The review content. */ - review: Scalars['String']['input']; + review: Scalars["String"]["input"]; }; /** Entity SEO information. */ export type Seo = { /** Content of SEO. */ - content?: Maybe; + content?: Maybe; /** Equivalent SEO type for HTTP. */ - httpEquiv?: Maybe; + httpEquiv?: Maybe; /** Name of SEO. */ - name?: Maybe; + name?: Maybe; /** Scheme for SEO. */ - scheme?: Maybe; + scheme?: Maybe; /** Type of SEO. */ - type?: Maybe; + type?: Maybe; }; /** Returns the scripts registered in the script manager. */ export type Script = { /** The script content. */ - content?: Maybe; + content?: Maybe; /** The script name. */ - name?: Maybe; + name?: Maybe; /** The script page type. */ pageType: ScriptPageType; /** The script position. */ position: ScriptPosition; /** The script priority. */ - priority: Scalars['Int']['output']; + priority: Scalars["Int"]["output"]; }; export type ScriptPageType = - | 'ALL' - | 'BRAND' - | 'CATEGORY' - | 'HOME' - | 'PRODUCT' - | 'SEARCH'; + | "ALL" + | "BRAND" + | "CATEGORY" + | "HOME" + | "PRODUCT" + | "SEARCH"; export type ScriptPosition = - | 'BODY_END' - | 'BODY_START' - | 'FOOTER_END' - | 'FOOTER_START' - | 'HEADER_END' - | 'HEADER_START'; + | "BODY_END" + | "BODY_START" + | "FOOTER_END" + | "FOOTER_START" + | "HEADER_END" + | "HEADER_START"; /** Search for relevant products to the searched term. */ export type Search = { @@ -3232,41 +3158,39 @@ export type Search = { /** Information about forbidden term. */ forbiddenTerm?: Maybe; /** The quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A cursor based paginated list of products from the search. */ products?: Maybe; /** An offset based paginated list of products from the search. */ productsByOffset?: Maybe; /** Redirection url in case a term in the search triggers a redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; /** Time taken to perform the search. */ - searchTime?: Maybe; + searchTime?: Maybe; }; - /** Search for relevant products to the searched term. */ export type SearchProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** Search for relevant products to the searched term. */ export type SearchProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3274,9 +3198,9 @@ export type SearchProductsByOffsetArgs = { /** Aggregated filters of a list of products. */ export type SearchFilter = { /** The name of the field. */ - field?: Maybe; + field?: Maybe; /** The origin of the field. */ - origin?: Maybe; + origin?: Maybe; /** List of the values of the field. */ values?: Maybe>>; }; @@ -3284,41 +3208,41 @@ export type SearchFilter = { /** Details of a filter value. */ export type SearchFilterItem = { /** The name of the value. */ - name?: Maybe; + name?: Maybe; /** The quantity of product with this value. */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** The response data */ export type SearchRecord = { /** The date time of the processed request */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** If the record was successful */ - isSuccess: Scalars['Boolean']['output']; + isSuccess: Scalars["Boolean"]["output"]; /** The searched query */ - query?: Maybe; + query?: Maybe; }; /** The information to be saved for reports. */ export type SearchRecordInput = { /** The search operation (And, Or) */ - operation?: InputMaybe; + operation?: InputMaybe; /** The current page */ - page: Scalars['Int']['input']; + page: Scalars["Int"]["input"]; /** How many products show in page */ - pageSize: Scalars['Int']['input']; + pageSize: Scalars["Int"]["input"]; /** The client search page url */ - pageUrl?: InputMaybe; + pageUrl?: InputMaybe; /** The user search query */ - query?: InputMaybe; + query?: InputMaybe; /** How many products the search returned */ - totalResults: Scalars['Int']['input']; + totalResults: Scalars["Int"]["input"]; }; /** The selected payment method details. */ export type SelectedPaymentMethod = { /** The unique identifier for the selected payment method. */ - id: Scalars['Uuid']['output']; + id: Scalars["Uuid"]["output"]; /** The list of installments associated with the selected payment method. */ installments?: Maybe>>; /** The selected installment. */ @@ -3328,46 +3252,46 @@ export type SelectedPaymentMethod = { /** Details of an installment of the selected payment method. */ export type SelectedPaymentMethodInstallment = { /** The adjustment value applied to the installment. */ - adjustment: Scalars['Float']['output']; + adjustment: Scalars["Float"]["output"]; /** The installment number. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The total value of the installment. */ - total: Scalars['Float']['output']; + total: Scalars["Float"]["output"]; /** The individual value of each installment. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** Seller informations. */ export type Seller = { /** Seller name */ - name?: Maybe; + name?: Maybe; }; export type SellerInstallment = { /** Wether the installment has discount. */ - discount: Scalars['Boolean']['output']; + discount: Scalars["Boolean"]["output"]; /** Wether the installment has fees. */ - fees: Scalars['Boolean']['output']; + fees: Scalars["Boolean"]["output"]; /** The number of installments. */ - number: Scalars['Int']['output']; + number: Scalars["Int"]["output"]; /** The value of the installment. */ - value: Scalars['Decimal']['output']; + value: Scalars["Decimal"]["output"]; }; export type SellerInstallmentPlan = { /** The custom display name of this installment plan. */ - displayName?: Maybe; + displayName?: Maybe; /** List of the installments. */ installments?: Maybe>>; }; /** The seller's product offer */ export type SellerOffer = { - name?: Maybe; + name?: Maybe; /** The product prices. */ prices?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; }; /** The prices of the product. */ @@ -3375,68 +3299,68 @@ export type SellerPrices = { /** List of the possibles installment plans. */ installmentPlans?: Maybe>>; /** The listed regular price of the product. */ - listPrice?: Maybe; + listPrice?: Maybe; /** The current working price. */ - price?: Maybe; + price?: Maybe; }; export type ShippingNode = { /** The shipping deadline. */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The delivery schedule detail. */ deliverySchedule?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars['Uuid']['output']; + shippingQuoteId: Scalars["Uuid"]["output"]; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** The product informations related to the shipping. */ export type ShippingProduct = { /** The product unique identifier. */ - productVariantId: Scalars['Int']['output']; + productVariantId: Scalars["Int"]["output"]; /** The shipping value related to the product. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** A shipping quote. */ export type ShippingQuote = Node & { /** The shipping deadline. */ - deadline: Scalars['Int']['output']; + deadline: Scalars["Int"]["output"]; /** The available time slots for scheduling the delivery of the shipping quote. */ deliverySchedules?: Maybe>>; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The shipping name. */ - name?: Maybe; + name?: Maybe; /** The products related to the shipping. */ products?: Maybe>>; /** The shipping quote unique identifier. */ - shippingQuoteId: Scalars['Uuid']['output']; + shippingQuoteId: Scalars["Uuid"]["output"]; /** The shipping type. */ - type?: Maybe; + type?: Maybe; /** The shipping value. */ - value: Scalars['Float']['output']; + value: Scalars["Float"]["output"]; }; /** Informations about the store. */ export type Shop = { /** Checkout URL */ - checkoutUrl?: Maybe; + checkoutUrl?: Maybe; /** Store main URL */ - mainUrl?: Maybe; + mainUrl?: Maybe; /** Mobile checkout URL */ - mobileCheckoutUrl?: Maybe; + mobileCheckoutUrl?: Maybe; /** Mobile URL */ - mobileUrl?: Maybe; + mobileUrl?: Maybe; /** Store modified name */ - modifiedName?: Maybe; + modifiedName?: Maybe; /** Store name */ - name?: Maybe; + name?: Maybe; /** Physical stores */ physicalStores?: Maybe>>; }; @@ -3444,28 +3368,27 @@ export type Shop = { /** Store setting. */ export type ShopSetting = { /** Setting name */ - name?: Maybe; + name?: Maybe; /** Setting value */ - value?: Maybe; + value?: Maybe; }; /** Information about a similar product. */ export type SimilarProduct = { /** The url alias of this similar product. */ - alias?: Maybe; + alias?: Maybe; /** The file name of the similar product image. */ - image?: Maybe; + image?: Maybe; /** The URL of the similar product image. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the similar product. */ - name?: Maybe; + name?: Maybe; }; - /** Information about a similar product. */ export type SimilarProductImageUrlArgs = { - h?: InputMaybe; - w?: InputMaybe; + h?: InputMaybe; + w?: InputMaybe; }; export type SimpleLogin = { @@ -3479,8 +3402,8 @@ export type SimpleLogin = { /** The simple login type. */ export type SimpleLoginType = - | 'NEW' - | 'SIMPLE'; + | "NEW" + | "SIMPLE"; /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsite = Node & { @@ -3493,17 +3416,17 @@ export type SingleHotsite = Node & { /** A list of contents associated with the hotsite. */ contents?: Maybe>>; /** The hotsite will be displayed until this date. */ - endDate?: Maybe; + endDate?: Maybe; /** Expression used to associate products to the hotsite. */ - expression?: Maybe; + expression?: Maybe; /** Hotsite unique identifier. */ - hotsiteId: Scalars['Long']['output']; + hotsiteId: Scalars["Long"]["output"]; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The hotsite's name. */ - name?: Maybe; + name?: Maybe; /** Set the quantity of products displayed per page. */ - pageSize: Scalars['Int']['output']; + pageSize: Scalars["Int"]["output"]; /** A list of products associated with the hotsite. Cursor pagination. */ products?: Maybe; /** A list of products associated with the hotsite. Offset pagination. */ @@ -3513,41 +3436,39 @@ export type SingleHotsite = Node & { /** Sorting information to be used by default on the hotsite. */ sorting?: Maybe; /** The hotsite will be displayed from this date. */ - startDate?: Maybe; + startDate?: Maybe; /** The subtype of the hotsite. */ subtype?: Maybe; /** The template used for the hotsite. */ - template?: Maybe; + template?: Maybe; /** The hotsite's URL. */ - url?: Maybe; + url?: Maybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsArgs = { - after?: InputMaybe; - before?: InputMaybe; + after?: InputMaybe; + before?: InputMaybe; filters?: InputMaybe>>; - first?: InputMaybe; - last?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; - /** A hotsite is a group of products used to organize them or to make them easier to browse. */ export type SingleHotsiteProductsByOffsetArgs = { filters?: InputMaybe>>; - limit?: InputMaybe; - maximumPrice?: InputMaybe; - minimumPrice?: InputMaybe; - offset?: InputMaybe; - onlyMainVariant?: InputMaybe; - partnerAccessToken?: InputMaybe; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; sortDirection?: InputMaybe; sortKey?: InputMaybe; }; @@ -3555,17 +3476,17 @@ export type SingleHotsiteProductsByOffsetArgs = { /** A product represents an item for sale in the store. */ export type SingleProduct = Node & { /** Check if the product can be added to cart directly from spot. */ - addToCartFromSpot?: Maybe; + addToCartFromSpot?: Maybe; /** The product url alias. */ - alias?: Maybe; + alias?: Maybe; /** Information about the possible selection attributes. */ attributeSelections?: Maybe; /** List of the product attributes. */ attributes?: Maybe>>; /** Field to check if the product is available in stock. */ - available?: Maybe; + available?: Maybe; /** The product average rating. From 0 to 5. */ - averageRating?: Maybe; + averageRating?: Maybe; /** List of product breadcrumbs. */ breadcrumbs?: Maybe>>; /** BuyBox informations. */ @@ -3573,41 +3494,41 @@ export type SingleProduct = Node & { /** Buy together products. */ buyTogether?: Maybe>>; /** The product condition. */ - condition?: Maybe; + condition?: Maybe; /** The product creation date. */ - createdAt?: Maybe; + createdAt?: Maybe; /** A list of customizations available for the given products. */ customizations?: Maybe>>; /** The product delivery deadline. */ - deadline?: Maybe; + deadline?: Maybe; /** Check if the product should be displayed. */ - display?: Maybe; + display?: Maybe; /** Check if the product should be displayed only for partners. */ - displayOnlyPartner?: Maybe; + displayOnlyPartner?: Maybe; /** Check if the product should be displayed on search. */ - displaySearch?: Maybe; + displaySearch?: Maybe; /** The product's unique EAN. */ - ean?: Maybe; + ean?: Maybe; /** Check if the product offers free shipping. */ - freeShipping?: Maybe; + freeShipping?: Maybe; /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** List of the product images. */ images?: Maybe>>; /** List of the product insformations. */ informations?: Maybe>>; /** Check if its the main variant. */ - mainVariant?: Maybe; + mainVariant?: Maybe; /** The product minimum quantity for an order. */ - minimumOrderQuantity?: Maybe; + minimumOrderQuantity?: Maybe; /** Check if the product is a new release. */ - newRelease?: Maybe; + newRelease?: Maybe; /** The number of votes that the average rating consists of. */ - numberOfVotes?: Maybe; + numberOfVotes?: Maybe; /** Product parallel options information. */ - parallelOptions?: Maybe>>; + parallelOptions?: Maybe>>; /** Parent product unique identifier. */ - parentId?: Maybe; + parentId?: Maybe; /** The product prices. */ prices?: Maybe; /** Summarized informations about the brand of the product. */ @@ -3615,13 +3536,13 @@ export type SingleProduct = Node & { /** Summarized informations about the categories of the product. */ productCategories?: Maybe>>; /** Product unique identifier. */ - productId?: Maybe; + productId?: Maybe; /** The product name. */ - productName?: Maybe; + productName?: Maybe; /** Summarized informations about the subscription of the product. */ productSubscription?: Maybe; /** Variant unique identifier. */ - productVariantId?: Maybe; + productVariantId?: Maybe; /** List of promotions this product belongs to. */ promotions?: Maybe>>; /** List of customer reviews for this product. */ @@ -3633,106 +3554,104 @@ export type SingleProduct = Node & { /** List of similar products. */ similarProducts?: Maybe>>; /** The product's unique SKU. */ - sku?: Maybe; + sku?: Maybe; /** The values of the spot attribute. */ - spotAttributes?: Maybe>>; + spotAttributes?: Maybe>>; /** The product spot information. */ - spotInformation?: Maybe; + spotInformation?: Maybe; /** Check if the product is on spotlight. */ - spotlight?: Maybe; + spotlight?: Maybe; /** The available stock at the default distribution center. */ - stock?: Maybe; + stock?: Maybe; /** List of the product stocks on different distribution centers. */ stocks?: Maybe>>; /** List of subscription groups this product belongs to. */ subscriptionGroups?: Maybe>>; /** Check if the product is a telesale. */ - telesales?: Maybe; + telesales?: Maybe; /** The product last update date. */ - updatedAt?: Maybe; + updatedAt?: Maybe; /** The product video url. */ - urlVideo?: Maybe; + urlVideo?: Maybe; /** The variant name. */ - variantName?: Maybe; + variantName?: Maybe; }; - /** A product represents an item for sale in the store. */ export type SingleProductAttributeSelectionsArgs = { selected?: InputMaybe>>; }; - /** A product represents an item for sale in the store. */ export type SingleProductImagesArgs = { - height?: InputMaybe; - width?: InputMaybe; + height?: InputMaybe; + width?: InputMaybe; }; /** Define the sort orientation of the result set. */ export type SortDirection = /** The results will be sorted in an ascending order. */ - | 'ASC' + | "ASC" /** The results will be sorted in an descending order. */ - | 'DESC'; + | "DESC"; /** Information about a product stock in a particular distribution center. */ export type Stock = { /** The id of the distribution center. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The number of physical items in stock at this DC. */ - items: Scalars['Long']['output']; + items: Scalars["Long"]["output"]; /** The name of the distribution center. */ - name?: Maybe; + name?: Maybe; }; /** Input to specify the range of stocks, distribution center ID, and distribution center name to return. */ export type StocksInput = { /** The distribution center Ids to match. */ - dcId?: InputMaybe>; + dcId?: InputMaybe>; /** The distribution center names to match. */ - dcName?: InputMaybe>>; + dcName?: InputMaybe>>; /** The product stock must be greater than or equal to. */ - stock_gte?: InputMaybe; + stock_gte?: InputMaybe; /** The product stock must be lesser than or equal to. */ - stock_lte?: InputMaybe; + stock_lte?: InputMaybe; }; export type SubscriptionGroup = { /** The recurring types for this subscription group. */ recurringTypes?: Maybe>>; /** The status name of the group. */ - status?: Maybe; + status?: Maybe; /** The status id of the group. */ - statusId: Scalars['Int']['output']; + statusId: Scalars["Int"]["output"]; /** The subscription group id. */ - subscriptionGroupId: Scalars['Long']['output']; + subscriptionGroupId: Scalars["Long"]["output"]; /** Wether the product is only avaible for subscription. */ - subscriptionOnly: Scalars['Boolean']['output']; + subscriptionOnly: Scalars["Boolean"]["output"]; }; export type SubscriptionRecurringType = { /** The number of days of the recurring type. */ - days: Scalars['Int']['output']; + days: Scalars["Int"]["output"]; /** The recurring type display name. */ - name?: Maybe; + name?: Maybe; /** The recurring type id. */ - recurringTypeId: Scalars['Long']['output']; + recurringTypeId: Scalars["Long"]["output"]; }; export type UpdateCustomerAddressInput = { - addressDetails?: InputMaybe; - addressNumber?: InputMaybe; - cep?: InputMaybe; - city?: InputMaybe; - country?: InputMaybe; - email?: InputMaybe; - name?: InputMaybe; - neighborhood?: InputMaybe; - phone?: InputMaybe; - referencePoint?: InputMaybe; - state?: InputMaybe; - street?: InputMaybe; + addressDetails?: InputMaybe; + addressNumber?: InputMaybe; + cep?: InputMaybe; + city?: InputMaybe; + country?: InputMaybe; + email?: InputMaybe; + name?: InputMaybe; + neighborhood?: InputMaybe; + phone?: InputMaybe; + referencePoint?: InputMaybe; + state?: InputMaybe; + street?: InputMaybe; }; /** Node of URI Kind. */ @@ -3744,34 +3663,34 @@ export type Uri = { /** The partner subtype. */ partnerSubtype?: Maybe; /** Product alias. */ - productAlias?: Maybe; + productAlias?: Maybe; /** Product categories IDs. */ - productCategoriesIds?: Maybe>; + productCategoriesIds?: Maybe>; /** Redirect status code. */ - redirectCode?: Maybe; + redirectCode?: Maybe; /** Url to redirect. */ - redirectUrl?: Maybe; + redirectUrl?: Maybe; }; export type UriKind = - | 'BUY_LIST' - | 'HOTSITE' - | 'NOT_FOUND' - | 'PARTNER' - | 'PRODUCT' - | 'REDIRECT'; + | "BUY_LIST" + | "HOTSITE" + | "NOT_FOUND" + | "PARTNER" + | "PRODUCT" + | "REDIRECT"; export type WholesalePrices = { /** The wholesale price. */ - price: Scalars['Decimal']['output']; + price: Scalars["Decimal"]["output"]; /** The minimum quantity required for the wholesale price to be applied */ - quantity: Scalars['Int']['output']; + quantity: Scalars["Int"]["output"]; }; /** A representation of available time slots for scheduling a delivery. */ export type DeliverySchedule = { /** The date of the delivery schedule. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** The list of time periods available for scheduling a delivery. */ periods?: Maybe>>; }; @@ -3779,40 +3698,40 @@ export type DeliverySchedule = { /** Informations about a forbidden search term. */ export type ForbiddenTerm = { /** The suggested search term instead. */ - suggested?: Maybe; + suggested?: Maybe; /** The text to display about the term. */ - text?: Maybe; + text?: Maybe; }; export type Order = { /** The coupon for discounts. */ - coupon?: Maybe; + coupon?: Maybe; /** Current account value used for the order. */ - currentAccount: Scalars['Decimal']['output']; + currentAccount: Scalars["Decimal"]["output"]; /** The date when te order was placed. */ - date: Scalars['DateTime']['output']; + date: Scalars["DateTime"]["output"]; /** The address where the order will be delivered. */ deliveryAddress?: Maybe; /** Order discount amount, if any. */ - discount: Scalars['Decimal']['output']; + discount: Scalars["Decimal"]["output"]; /** Order interest fee, if any. */ - interestFee: Scalars['Decimal']['output']; + interestFee: Scalars["Decimal"]["output"]; /** Information about order invoices. */ invoices?: Maybe>>; /** Information about order notes. */ notes?: Maybe>>; /** Order unique identifier. */ - orderId: Scalars['Long']['output']; + orderId: Scalars["Long"]["output"]; /** The date when the order was payed. */ - paymentDate?: Maybe; + paymentDate?: Maybe; /** Information about payments. */ payments?: Maybe>>; /** Products belonging to the order. */ products?: Maybe>>; /** List of promotions applied to the order. */ - promotions?: Maybe>; + promotions?: Maybe>; /** The shipping fee. */ - shippingFee: Scalars['Decimal']['output']; + shippingFee: Scalars["Decimal"]["output"]; /** Information about order shippings. */ shippings?: Maybe>>; /** The order current status. */ @@ -3820,30 +3739,30 @@ export type Order = { /** List of the order status history. */ statusHistory?: Maybe>>; /** Order subtotal value. */ - subtotal: Scalars['Decimal']['output']; + subtotal: Scalars["Decimal"]["output"]; /** Order total value. */ - total: Scalars['Decimal']['output']; + total: Scalars["Decimal"]["output"]; /** Information about order trackings. */ trackings?: Maybe>>; }; export type PaymentMethod = Node & { /** The node unique identifier. */ - id?: Maybe; + id?: Maybe; /** The url link that displays for the payment. */ - imageUrl?: Maybe; + imageUrl?: Maybe; /** The name of the payment method. */ - name?: Maybe; + name?: Maybe; }; /** Represents a time period available for scheduling a delivery. */ export type Period = { /** The end time of the time period. */ - end?: Maybe; + end?: Maybe; /** The unique identifier of the time period. */ - id: Scalars['Long']['output']; + id: Scalars["Long"]["output"]; /** The start time of the time period. */ - start?: Maybe; + start?: Maybe; }; export type Wishlist = { @@ -3851,78 +3770,817 @@ export type Wishlist = { products?: Maybe>>; }; -export type AddCouponMutationVariables = Exact<{ - checkoutId: Scalars['Uuid']['input']; - coupon: Scalars['String']['input']; -}>; - - -export type AddCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; - -export type AddItemToCartMutationVariables = Exact<{ - input: CheckoutProductInput; -}>; - - -export type AddItemToCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; - -export type RemoveCouponMutationVariables = Exact<{ - checkoutId: Scalars['Uuid']['input']; -}>; - - -export type RemoveCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type CheckoutFragment = { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; +}; + +export type ProductFragment = { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { discount: boolean; fees: boolean; number: number; value: any } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + | { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } + | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; +}; + +export type SingleProductFragment = { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + breadcrumbs?: + | Array<{ text?: string | null; link?: string | null } | null> + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { discount: boolean; fees: boolean; number: number; value: any } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + | { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } + | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + reviews?: + | Array< + { + rating: number; + review?: string | null; + reviewDate: any; + email?: string | null; + customer?: string | null; + } | null + > + | null; + seller?: { name?: string | null } | null; + seo?: + | Array< + { + name?: string | null; + scheme?: string | null; + type?: string | null; + httpEquiv?: string | null; + content?: string | null; + } | null + > + | null; +}; -export type RemoveItemFromCartMutationVariables = Exact<{ - input: CheckoutProductInput; +export type GetProductQueryVariables = Exact<{ + productId: Scalars["Long"]["input"]; }>; - -export type RemoveItemFromCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; +export type GetProductQuery = { + product?: { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + | { title?: string | null; value?: string | null; type?: string | null } + | null + > + | null; + breadcrumbs?: + | Array<{ text?: string | null; link?: string | null } | null> + | null; + images?: + | Array< + { url?: string | null; fileName?: string | null; print: boolean } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + | { + discount: boolean; + fees: boolean; + number: number; + value: any; + } + | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: Array<{ price: any; quantity: number } | null> | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + reviews?: + | Array< + { + rating: number; + review?: string | null; + reviewDate: any; + email?: string | null; + customer?: string | null; + } | null + > + | null; + seller?: { name?: string | null } | null; + seo?: + | Array< + { + name?: string | null; + scheme?: string | null; + type?: string | null; + httpEquiv?: string | null; + content?: string | null; + } | null + > + | null; + } | null; +}; export type GetCartQueryVariables = Exact<{ - checkoutId: Scalars['String']['input']; + checkoutId: Scalars["String"]["input"]; }>; - -export type GetCartQuery = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; - -export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; - - -export type CreateCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; - -export type GetProductQueryVariables = Exact<{ - productId: Scalars['Long']['input']; -}>; - - -export type GetProductQuery = { product?: { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null } | null }; +export type GetCartQuery = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never }>; + +export type CreateCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; export type GetProductsQueryVariables = Exact<{ filters: ProductExplicitFiltersInput; - first: Scalars['Int']['input']; + first: Scalars["Int"]["input"]; sortDirection: SortDirection; sortKey?: InputMaybe; }>; - -export type GetProductsQuery = { products?: { nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null } | null }; +export type GetProductsQuery = { + products?: { + nodes?: + | Array< + { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + { + title?: string | null; + value?: string | null; + type?: string | null; + } | null + > + | null; + images?: + | Array< + | { + url?: string | null; + fileName?: string | null; + print: boolean; + } + | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + { + discount: boolean; + fees: boolean; + number: number; + value: any; + } | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: + | Array<{ price: any; quantity: number } | null> + | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; + } | null + > + | null; + } | null; +}; export type SearchQueryVariables = Exact<{ operation: Operation; - query?: InputMaybe; - first: Scalars['Int']['input']; + query?: InputMaybe; + first: Scalars["Int"]["input"]; sortDirection?: InputMaybe; sortKey?: InputMaybe; - filters?: InputMaybe> | InputMaybe>; + filters?: InputMaybe< + Array> | InputMaybe + >; }>; +export type SearchQuery = { + search?: { + pageSize: number; + redirectUrl?: string | null; + searchTime?: string | null; + aggregations?: { + filters?: + | Array< + { + field?: string | null; + origin?: string | null; + values?: + | Array<{ quantity: number; name?: string | null } | null> + | null; + } | null + > + | null; + } | null; + breadcrumbs?: + | Array<{ link?: string | null; text?: string | null } | null> + | null; + forbiddenTerm?: { text?: string | null; suggested?: string | null } | null; + products?: { + totalCount: number; + nodes?: + | Array< + { + mainVariant?: boolean | null; + productName?: string | null; + productId?: any | null; + alias?: string | null; + available?: boolean | null; + averageRating?: number | null; + condition?: string | null; + createdAt?: any | null; + ean?: string | null; + id?: string | null; + minimumOrderQuantity?: number | null; + productVariantId?: any | null; + sku?: string | null; + stock?: any | null; + variantName?: string | null; + attributes?: + | Array<{ value?: string | null; name?: string | null } | null> + | null; + productCategories?: + | Array< + { + name?: string | null; + url?: string | null; + hierarchy?: string | null; + main: boolean; + googleCategories?: string | null; + } | null + > + | null; + informations?: + | Array< + { + title?: string | null; + value?: string | null; + type?: string | null; + } | null + > + | null; + images?: + | Array< + { + url?: string | null; + fileName?: string | null; + print: boolean; + } | null + > + | null; + prices?: { + discountPercentage: any; + discounted: boolean; + listPrice?: any | null; + multiplicationFactor: number; + price: any; + bestInstallment?: { + discount: boolean; + displayName?: string | null; + fees: boolean; + name?: string | null; + number: number; + value: any; + } | null; + installmentPlans?: + | Array< + { + displayName?: string | null; + name?: string | null; + installments?: + | Array< + { + discount: boolean; + fees: boolean; + number: number; + value: any; + } | null + > + | null; + } | null + > + | null; + priceTables?: + | Array< + { + discountPercentage: any; + id: any; + listPrice?: any | null; + price: any; + } | null + > + | null; + wholesalePrices?: + | Array<{ price: any; quantity: number } | null> + | null; + } | null; + productBrand?: { + fullUrlLogo?: string | null; + logoUrl?: string | null; + name?: string | null; + alias?: string | null; + } | null; + seller?: { name?: string | null } | null; + } | null + > + | null; + pageInfo: { hasNextPage: boolean; hasPreviousPage: boolean }; + } | null; + } | null; +}; -export type SearchQuery = { search?: { pageSize: number, redirectUrl?: string | null, searchTime?: string | null, aggregations?: { filters?: Array<{ field?: string | null, origin?: string | null, values?: Array<{ quantity: number, name?: string | null } | null> | null } | null> | null } | null, breadcrumbs?: Array<{ link?: string | null, text?: string | null } | null> | null, forbiddenTerm?: { text?: string | null, suggested?: string | null } | null, products?: { totalCount: number, nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null, pageInfo: { hasNextPage: boolean, hasPreviousPage: boolean } } | null } | null }; +export type AddCouponMutationVariables = Exact<{ + checkoutId: Scalars["Uuid"]["input"]; + coupon: Scalars["String"]["input"]; +}>; + +export type AddCouponMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; + +export type AddItemToCartMutationVariables = Exact<{ + input: CheckoutProductInput; +}>; + +export type AddItemToCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; -export type CheckoutFragment = { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null }; +export type RemoveCouponMutationVariables = Exact<{ + checkoutId: Scalars["Uuid"]["input"]; +}>; -export type ProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null }; +export type RemoveCouponMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; -export type SingleProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null }; +export type RemoveItemFromCartMutationVariables = Exact<{ + input: CheckoutProductInput; +}>; + +export type RemoveItemFromCartMutation = { + checkout?: { + checkoutId: any; + shippingFee: any; + subtotal: any; + total: any; + completed: boolean; + coupon?: string | null; + products?: + | Array< + { + imageUrl?: string | null; + brand?: string | null; + ajustedPrice: any; + listPrice: any; + price: any; + name?: string | null; + productId: any; + productVariantId: any; + quantity: number; + sku?: string | null; + url?: string | null; + } | null + > + | null; + } | null; +}; From e2108291b282bf7119adc5ab89a3440cc07b25f3 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:05:45 -0300 Subject: [PATCH 09/21] lint & format --- scripts/start.ts | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/scripts/start.ts b/scripts/start.ts index d1e2b14e1..863ec5eef 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -185,8 +185,10 @@ const generateOpenAPI = async () => { await Deno.writeTextFile(outfile, final); // Format using deno - const fmt = new Deno.Command(Deno.execPath(), { args: ["fmt", outfile] }); - await fmt.output(); + await new Deno.Command(Deno.execPath(), { args: ["fmt", outfile] }) + .output(); + await new Deno.Command(Deno.execPath(), { args: ["lint", outfile] }) + .output(); } }; @@ -221,6 +223,15 @@ const generateGraphQL = async () => { }; await generate({ ...config, cwd: folder }, true); + + await new Deno.Command(Deno.execPath(), { + args: ["fmt", join(folder, outfile)], + }) + .output(); + await new Deno.Command(Deno.execPath(), { + args: ["lint", join(folder, outfile)], + }) + .output(); } }; From 4d290560ec398984dbcda05ce9c01cc218b2e9c4 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:08:44 -0300 Subject: [PATCH 10/21] start script lint&fmt --- scripts/start.ts | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/scripts/start.ts b/scripts/start.ts index 863ec5eef..b778f78e5 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -40,6 +40,13 @@ const BANNER = ` // `; +const fmtAndLint = async (file: string) => { + const deno = Deno.execPath(); + + await new Deno.Command(deno, { args: ["fmt", file] }).output(); + await new Deno.Command(deno, { args: ["lint", file] }).output(); +}; + const toOutfile = (path: string) => path.replace(".json", ".gen.ts"); // transforms: /a/{b}/c => /a/:b/c @@ -183,12 +190,7 @@ const generateOpenAPI = async () => { ); await Deno.writeTextFile(outfile, final); - - // Format using deno - await new Deno.Command(Deno.execPath(), { args: ["fmt", outfile] }) - .output(); - await new Deno.Command(Deno.execPath(), { args: ["lint", outfile] }) - .output(); + await fmtAndLint(outfile); } }; @@ -223,15 +225,7 @@ const generateGraphQL = async () => { }; await generate({ ...config, cwd: folder }, true); - - await new Deno.Command(Deno.execPath(), { - args: ["fmt", join(folder, outfile)], - }) - .output(); - await new Deno.Command(Deno.execPath(), { - args: ["lint", join(folder, outfile)], - }) - .output(); + await fmtAndLint(join(folder, outfile)); } }; From 64c08c889a96582d41551830b08f8b6b41a8a37e Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:12:33 -0300 Subject: [PATCH 11/21] add admin graphql client --- shopify/mod.ts | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/shopify/mod.ts b/shopify/mod.ts index 1e45f4b32..1117bf556 100644 --- a/shopify/mod.ts +++ b/shopify/mod.ts @@ -18,6 +18,12 @@ export interface Props { */ storefrontAccessToken: string; + /** + * @ttile Access Token + * @description Shopify admin access token. + */ + adminAccessToken: string; + /** @description Disable password protection on the store */ storefrontDigestCookie?: string; @@ -29,13 +35,14 @@ export interface Props { export interface State extends Props { storefront: ReturnType; + admin: ReturnType; } /** * @title Shopify */ export default function App(props: Props): App { - const { storeName, storefrontAccessToken } = props; + const { storeName, storefrontAccessToken, adminAccessToken } = props; const storefront = createGraphqlClient({ fetcher: fetchSafe, endpoint: `https://${storeName}.myshopify.com/api/2023-07/graphql.json`, @@ -44,6 +51,15 @@ export default function App(props: Props): App { "X-Shopify-Storefront-Access-Token": storefrontAccessToken, }), }); + const admin = createGraphqlClient({ + fetcher: fetchSafe, + endpoint: + `https://${storeName}.myshopify.com/admin/api/2023-07/graphql.json`, + headers: new Headers({ + "Content-Type": "application/json", + "X-Shopify-Access-Token": adminAccessToken || "", + }), + }); - return { state: { ...props, storefront }, manifest }; + return { state: { ...props, admin, storefront }, manifest }; } From 5e66095ebfe2a4f9ee023948279c177f708ea032 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:21:41 -0300 Subject: [PATCH 12/21] workflow --- .github/workflows/ci.yaml | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 5f8a4f215..61e18fd59 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -30,14 +30,7 @@ jobs: with: deno-version: v1.x - name: Build Deno Module - run: deno run -A --lock=deno.lock --lock-write --reload mod.ts - - name: fetch any uncached dependencies - run: | - deno cache --lock=deno.lock --lock-write --reload=file: ./mod.ts - - ## Generate updated live.gen.ts - - run: | - deno run --unstable --lock=deno.lock --lock-write -A dev.ts + run: deno run -A --lock=deno.lock --lock-write --reload scripts/start.ts - name: Check if there are changes on ${{ matrix.os }} id: changes @@ -49,15 +42,11 @@ jobs: exit 1 fi - - run: | - deno test --lock=deno.lock --lock-write -A . - - run: | - deno bench --lock=deno.lock --lock-write -A . + - run: deno test --lock=deno.lock --lock-write -A . + - run: deno bench --lock=deno.lock --lock-write -A . - name: check lint continue-on-error: true - run: | - deno --unstable lint + run: deno --unstable lint - name: check formatting continue-on-error: true - run: | - deno fmt --check \ No newline at end of file + run: deno fmt --check \ No newline at end of file From 82ada584eb7147c5f17e1f53ec866b41543cf326 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:25:02 -0300 Subject: [PATCH 13/21] workflow --- .github/workflows/ci.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 61e18fd59..95955de7b 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -42,8 +42,12 @@ jobs: exit 1 fi - - run: deno test --lock=deno.lock --lock-write -A . - - run: deno bench --lock=deno.lock --lock-write -A . + - name: Test + continue-on-error: true + run: deno test --lock=deno.lock --lock-write -A . + - name: Benchmark + continue-on-error: true + run: deno bench --lock=deno.lock --lock-write -A . - name: check lint continue-on-error: true run: deno --unstable lint From 0759e863f016dd016dce9987a9dd36814711eed9 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:32:55 -0300 Subject: [PATCH 14/21] workflow --- .github/workflows/ci.yaml | 16 ++++++---------- deno.json | 2 +- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 95955de7b..10f7e8a42 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -29,9 +29,12 @@ jobs: - uses: denoland/setup-deno@v1 with: deno-version: v1.x - - name: Build Deno Module + - name: Bundle Apps run: deno run -A --lock=deno.lock --lock-write --reload scripts/start.ts + - name: Check + run: deno task check + - name: Check if there are changes on ${{ matrix.os }} id: changes shell: bash @@ -43,14 +46,7 @@ jobs: fi - name: Test - continue-on-error: true run: deno test --lock=deno.lock --lock-write -A . + - name: Benchmark - continue-on-error: true - run: deno bench --lock=deno.lock --lock-write -A . - - name: check lint - continue-on-error: true - run: deno --unstable lint - - name: check formatting - continue-on-error: true - run: deno fmt --check \ No newline at end of file + run: deno bench --lock=deno.lock --lock-write -A . \ No newline at end of file diff --git a/deno.json b/deno.json index 9b17fcb65..159728c16 100644 --- a/deno.json +++ b/deno.json @@ -1,7 +1,7 @@ { "lock": false, "tasks": { - "check": "deno fmt && deno lint", + "check": "deno fmt && deno lint && deno check **/*.ts", "release": "deno eval 'import \"deco/scripts/release.ts\"'", "start": "deno run -A ./scripts/start.ts", "link": "deno eval 'import \"deco/scripts/apps/link.ts\"'", From 7215ce4b22db4c9cefcca17d5e7d4ef15ab0a9e1 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:37:29 -0300 Subject: [PATCH 15/21] workflow --- .github/workflows/ci.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 10f7e8a42..50ba03e5e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -46,7 +46,9 @@ jobs: fi - name: Test + continue-on-error: true run: deno test --lock=deno.lock --lock-write -A . - + - name: Benchmark + continue-on-error: true run: deno bench --lock=deno.lock --lock-write -A . \ No newline at end of file From 49b3eeb19005367a9db30952790fb8be0772b6d3 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:38:50 -0300 Subject: [PATCH 16/21] check mod --- deno.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deno.json b/deno.json index 159728c16..791453564 100644 --- a/deno.json +++ b/deno.json @@ -1,7 +1,7 @@ { "lock": false, "tasks": { - "check": "deno fmt && deno lint && deno check **/*.ts", + "check": "deno fmt && deno lint && deno check **/mod.ts", "release": "deno eval 'import \"deco/scripts/release.ts\"'", "start": "deno run -A ./scripts/start.ts", "link": "deno eval 'import \"deco/scripts/apps/link.ts\"'", @@ -23,4 +23,4 @@ "jsx": "react-jsx", "jsxImportSource": "preact" } -} +} \ No newline at end of file From c511e8b3b1e0f8c502c7be0128494d51cbfacfd4 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:40:42 -0300 Subject: [PATCH 17/21] workflow --- deno.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deno.json b/deno.json index 791453564..5f84067ec 100644 --- a/deno.json +++ b/deno.json @@ -23,4 +23,4 @@ "jsx": "react-jsx", "jsxImportSource": "preact" } -} \ No newline at end of file +} From 9d5843d3ca5fb9d83c974bf6602859ef37d43fd0 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:45:02 -0300 Subject: [PATCH 18/21] fix windows --- scripts/start.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/start.ts b/scripts/start.ts index b778f78e5..9c610bbda 100644 --- a/scripts/start.ts +++ b/scripts/start.ts @@ -203,7 +203,7 @@ const generateGraphQL = async () => { const config: CodegenConfig = { silent: true, schema: join(Deno.cwd(), path), - documents: [`./**/*.ts`], + documents: [`**/*.ts`], generates: { [outfile]: { // This order matters From 19bf8cf94c3de6e45c2e19355b9f940983592a1f Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:49:39 -0300 Subject: [PATCH 19/21] use ubuntu only --- .github/workflows/ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 50ba03e5e..46f6d9927 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -13,7 +13,7 @@ jobs: test: strategy: matrix: - os: [ubuntu-latest, windows-latest] + os: [ubuntu-latest] runs-on: ${{ matrix.os }} name: "Setup deno" steps: From 82fb06844bebd3d7ba7951e86b5d1fea2507fb01 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 11:51:01 -0300 Subject: [PATCH 20/21] improve name --- .github/workflows/ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 46f6d9927..b7384362d 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -15,7 +15,7 @@ jobs: matrix: os: [ubuntu-latest] runs-on: ${{ matrix.os }} - name: "Setup deno" + name: "Bundle & Check Apps" steps: - uses: actions/checkout@v3 - name: cache deno installation and deno.land dependencies From 4989da7b8f12e4249ce03d0c752503a32051c400 Mon Sep 17 00:00:00 2001 From: gimenes Date: Tue, 12 Sep 2023 12:07:06 -0300 Subject: [PATCH 21/21] fix proxy --- shopify/loaders/proxy.ts | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/shopify/loaders/proxy.ts b/shopify/loaders/proxy.ts index 2164ab4f3..6cd8545e2 100644 --- a/shopify/loaders/proxy.ts +++ b/shopify/loaders/proxy.ts @@ -14,6 +14,15 @@ const PATHS_TO_PROXY = [ ]; const decoSiteMapUrl = "/sitemap/deco.xml"; +const PATHS_WITH_DIGEST = new Set([ + "/account", + "/account/*", + "/password", + "/password/*", + "/challenge", + "/challenge/*", +]); + const buildProxyRoutes = ( { ctx, @@ -50,7 +59,9 @@ const buildProxyRoutes = ( __resolveType: "website/handlers/proxy.ts", url: urlToProxy, host: hostToUse, - customHeaders: withDigestCookie(ctx), + customHeaders: PATHS_WITH_DIGEST.has(pathTemplate) + ? withDigestCookie(ctx) + : [], }, }, });